位置:首页 > 框架 > Yii2在线教程 > 组件(Component)

组件(Component)

组件(Component)

组件是 Yii 应用的主要基石。是 [[yiiaseComponent]] 类或其子类的实例。三个用以区分它和其它类的主要功能有:

  • 属性(Property)
  • 事件(Event)
  • 行为(Behavior)

或单独使用,或彼此配合,这些功能的应用让 Yii 的类变得更加灵活和易用。以小部件 [[yiijuiDatePicker|日期选择器]] 来举例,这是个方便你在 视图 中生成一个交互式日期选择器的 UI 组件:

  1. use yii\jui\DatePicker; 
  2.  
  3. echo DatePicker::widget([ 
  4.     'language' => 'zh-CN', 
  5.     'name'  => 'country', 
  6.     'clientOptions' => [ 
  7.         'dateFormat' => 'yy-mm-dd', 
  8.     ], 
  9. ]);

这个小部件继承自 [[yiiaseComponent]],它的各项属性改写起来会很容易。

正是因为组件功能的强大,他们比常规的对象(Object)稍微重量级一点,因为他们要使用额外的内存和 CPU 时间来处理 事件 和 行为 。如果你不需要这两项功能,可以继承 [[yiiaseObject]] 而不是 [[yiiaseComponent]]。这样组件可以像普通 PHP 对象一样高效,同时还支持性(Property)功能。

当继承 [[yiiaseComponent]] 或 [[yiiaseObject]] 时,推荐你使用如下的编码风格:

  • 若你需要重写构造方法(Constructor),传入 $config 作为构造器方法最后一个参数,然后把它传递给父类的构造方法。
  • 永远在你重写的构造方法结尾处调用一下父类的构造方法。
  • 如果你重写了 [[yiiaseObject::init()]] 方法,请确保你在 init 方法的开头处调用了父类的 init 方法。

例子如下:

  1. namespace yii\components\MyClass; 
  2.  
  3. use yii\base\Object; 
  4.  
  5. class MyClass extends Object 
  6.     public $prop1; 
  7.     public $prop2; 
  8.  
  9.     public function __construct($param1, $param2, $config = []) 
  10.     { 
  11.         // ... 配置生效前的初始化过程 
  12.  
  13.         parent::__construct($config); 
  14.     } 
  15.  
  16.     public function init() 
  17.     { 
  18.         parent::init(); 
  19.  
  20.         // ... 配置生效后的初始化过程 
  21.     } 
  22. }

另外,为了让组件可以在创建实例时能被正确配置,请遵照以下操作流程:

  1. $component = new MyClass(1, 2, ['prop1' => 3, 'prop2' => 4]); 
  2. // 方法二: 
  3. $component = \Yii::createObject([ 
  4.     'class' => MyClass::className(), 
  5.     'prop1' => 3, 
  6.     'prop2' => 4, 
  7. ], [1, 2]);

补充:尽管调用 [[Yii::createObject()]] 的方法看起来更加复杂,但这主要因为它更加灵活强大,它是基于赖注入容器实现的。

[[yiiaseObject]] 类执行时的生命周期如下:

  1. 构造方法内的预初始化过程。你可以在这儿给各属性设置缺省值。
  2. 通过 $config 配置对象。配置的过程可能会覆盖掉先前在构造方法内设置的默认值。
  3. 在 [[yiiaseObject::init()|init()]] 方法内进行初始化后的收尾工作。你可以通过重写此方法,进行一些良品检验,属性的初始化之类的工作。
  4. 对象方法调用。

前三步都是在对象的构造方法内发生的。这意味着一旦你获得了一个对象实例,那么它就已经初始化就绪可供使用。