Yii2.0 Behaviors的基本用法

简介

Behavior顾名思义,即使一种行为,准确的说是类的行为。目的用于功能扩展。注意,这里用了扩展,扩展意味着是在原有的基础上扩展,不同于从父类那里继承而来。请注意琢磨这个特点,清楚了功能扩展有利于判断清楚什么时候使用behavior。举个例子,假如有一个类被定义为人,那么一些最基本的人的元素,如胳膊、腿、大脑等,就适合定义在自身里边,或者从父类那里继承而来。而一些附加的能力,如弹琴画画,就适合集成扩展。当然,你如果非喜欢用搭积木的方式生成一个人,就像定义一个胳膊的behavior、一个腿的behavior等,然后组装成为一个人。可行性上讲,那也可以,但是这样就有点属于滥用。

PHP中有traits,与behavior有点类似。但是traits更像是把一段代码生硬地插进来,有点像C语言里的include。所以traits不能像behavior一样在运行时加入。同样不能对要加入的功能进行参数设置,类似这样:

 public function behaviors() {
        return [
            TimestampBehavior::className(),
            [
                'class' => AttachmentsBehavior::className(),
                'uploadFiles' => 'attachmentsToBe',
                'uploadedFiles' => 'attachments',
            ]
        ];
    }

在这里对AttachmentsBehavior的两个属性进行了设置。这非常有用,比如对于同一个衣服behavior,大人需要大码,小孩需要小码,而用traits是很难做到的。说白了,traits是一个代码片段,而behavior是一个类,功能更为强大。

用法

我在编写一个网站时遇到了这样一个情景,网站中有新闻和商城两大板块,要求对新闻与商城的商品都能上传附件。心中一喜,这不正是用behavior的大好时机?附件对于新闻与商城来讲都是可有可无的扩展功能。于是定义了新闻model、商品Model,以及attachmentBehavior。如下:

class News extends  \yii\db\ActiveRecord
{
//behavior就是上一段代码,在此不再赘述
}
class Goods extends  \yii\db\ActiveRecord
{
//behavior如前
}

class AttachmentsBehavior extends Behavior {

    private $_files;
    /**
     * 需要上传的文件属性
     * @var string
     */
    public $uploadFiles = 'uploadfiles';
    /**
     * 已经上传了的文件属性
     * @var string
     */
    public $uploadedFiles = 'uploadedfiles';

    /**
     * 保存路径
     * @var string
     */
    public $savePath = '@common/upload';

    /**
     * 访问路径
     * @var string
     */
    public $saveUrl = '@commonurl/upload';

    public function events() {
        return [
            BaseActiveRecord::EVENT_BEFORE_VALIDATE => 'beforeValidate',
            BaseActiveRecord::EVENT_AFTER_INSERT => 'afterSave',
            BaseActiveRecord::EVENT_AFTER_UPDATE => 'afterSave',
            BaseActiveRecord::EVENT_BEFORE_DELETE => 'beforeDelete',
        ];
    }

    /**
     * This method is invoked before validation starts.
     */
    public function beforeValidate()
    {
       $this->_files = UploadedFile::getInstances($this->owner, $this->uploadFiles);
    }

    /**
     * 返回拥有者的唯一Id
     * @return string
     */
    public function getIdentityId(){
        return  $this->owner->className().'.'.$this->owner->id;
    }

    /**
     * 明确拥有者与附件的关系
     * @return mixed
     */
    public function getAttachments(){
        return $this->owner->hasMany(Attachments::className(),['ownerId' => 'identityId']);
    }

    /**
     * 在主模型保存后挨个保存附件
     */
    public function afterSave(){

        foreach ($this->_files as $file){
            $model = new Attachments();
            $model->fileName = $file->name;
            $model->url = date('Ymd') . Yii::$app->getSecurity()->generateRandomString(8) .'.'. $file->extension;
            $model->ownerId = $this->owner->identityId;
            $model->savePath = Yii::getAlias($this->savePath);
            $file->saveAs(Yii::getAlias($this->savePath) . DIRECTORY_SEPARATOR .$model->url);
            $model->save();
        }

    }

    /**
     * 在主模型删除之前删除所有附件
     * @return bool
     */
    public function beforeDelete(){

        foreach ($this->owner->{$this->uploadedFiles} as $file){
            $file->delete();
        }
        return true;
    }


    public function getFilesUrl($url){
        return Yii::getAlias($this->saveUrl) . DIRECTORY_SEPARATOR. $url;
    }

}

在这里我特别把附件behavior的所有源码都贴上了,原因有二、1、这个Behavior基本上用到了所有behavior常要用到的东西,2、文件上传是我们常用的一个功能。详解如下:

  • 一定要继承yii的Behavior类。Behavior需要与Component配合使用,这里news和goods继承了activerecord。activerecord是继承了component的。
  • public属性可以被配置,private不能被配置
  • 在Behavior中$this->owner表示父类,准确的说是父对象。所以,例如要获得父类的类名称,采用$this->owner->className()。
  • 在Behavior中可以定义多种event,这些事件的触发与父类中的触发时间一致。特别的是需要手动绑定。而不像父类中afterSave等已经自动绑定。我想,这是由于有些Behavior是不与model所绑定的。
  • 在Behavior中要访问数据库,需要通过model。就像在afterSave函数中所定义的那样。

结束语

Behavior极大的增强了yii2的灵活性,这里仅展示了Behavior与model的结合,常常我们也会把Behavior与Controller结合,但是要注意,在于Controller结合时,Behavior中定义的action在Controller中不会被自动索引到,亦需要手动指定。所以,仅仅为了增加action,最好采用yii2中单独action的复用方法。

多多琢磨Behavior,能够极大的节约开发量,提升我们的开发效率,并且增强扩展性维护性。况且,很多现成的功能模块都是利用Behavior而形成的,就奔着用好别人的劳动成果也要多学学Behavior。Good luck!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,015评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,262评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,727评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,986评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,363评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,610评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,871评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,582评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,297评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,551评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,053评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,385评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,035评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,079评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,841评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,648评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,550评论 2 270

推荐阅读更多精彩内容