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!