组件是 yii 应用的主要基石。是 yii\base\component 类或其子类的实例。三个用以区分它和其它类的主要功能有:
- 属性(property)
- 事件(event)
- 行为(behavior)
或单独使用,或彼此配合,这些功能的应用让 yii 的类变得更加灵活和易用。以小部件 yii\jui\datepicker 来举例,这是个方便你在 视图中生成一个交互式日期选择器的 ui 组件:
1
2
3
4
5
6
7
8
9
|
use yii\jui\datepicker; echo datepicker::widget([ 'language' => 'zh-cn' , 'name' => 'country' , 'clientoptions' => [ 'dateformat' => 'yy-mm-dd' , ], ]); |
这个小部件继承自 yii\base\component,它的各项属性改写起来会很容易。
正是因为组件功能的强大,他们比常规的对象(object)稍微重量级一点,因为他们要使用额外的内存和 cpu 时间来处理 事件 和 行为 。如果你不需要这两项功能,可以继承 yii\base\object 而不是 yii\base\component。这样组件可以像普通 php 对象一样高效,同时还支持属性(property)功能。
当继承 yii\base\component 或 yii\base\object 时,推荐你使用如下的编码风格:
若你需要重写构造方法(constructor),传入 $config 作为构造器方法最后一个参数,然后把它传递给父类的构造方法。
永远在你重写的构造方法结尾处调用一下父类的构造方法。
如果你重写了 yii\base\object::init() 方法,请确保你在 init 方法的开头处调用了父类的 init 方法。
例子如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
namespace yii\components\myclass; use yii\base\object; class myclass extends object { public $prop1 ; public $prop2 ; public function __construct( $param1 , $param2 , $config = []) { // ... 配置生效前的初始化过程 parent::__construct( $config ); } public function init() { parent::init(); // ... 配置生效后的初始化过程 } } |
另外,为了让组件可以在创建实例时能被正确配置,请遵照以下操作流程:
1
2
3
4
5
6
7
|
$component = new myclass(1, 2, [ 'prop1' => 3, 'prop2' => 4]); // 方法二: $component = \yii::createobject([ 'class' => myclass::classname(), 'prop1' => 3, 'prop2' => 4, ], [1, 2]); |
补充:尽管调用 yii::createobject() 的方法看起来更加复杂,但这主要因为它更加灵活强大,它是基于依赖注入容器实现的。
yii\base\object 类执行时的生命周期如下:
构造方法内的预初始化过程。你可以在这儿给各属性设置缺省值。
通过 $config 配置对象。配置的过程可能会覆盖掉先前在构造方法内设置的默认值。
在 yii\base\object::init() 方法内进行初始化后的收尾工作。你可以通过重写此方法,进行一些良品检验,属性的初始化之类的工作。
对象方法调用。
前三步都是在对象的构造方法内发生的。这意味着一旦你获得了一个对象实例,那么它就已经初始化就绪可供使用。
应用程序cwebapplication组件
在说明yii中各个组件使用方法前,先了解最重要的一个组件cwebapplication。cwebapplication即应用程序对象,它的根类也是ccomponent,故它也是一个组件,具有yii组件的共同特征。
具体来说,cwebapplication组件的主要作用是根据配置文件,加载必要的辅助组件,并在这些组件的帮助下(如urlmanager)创建并运行控制器。故也将其称为前端控制器。
我们可以在配置文件中指定cwebapplication组件本身的配置参数,这些参数被设置为其公共成员变量,或是自动调用setter方法设置属性,这个特性可以在cwebapplication的构造函数中发现:$this->configure($config);
如在配置文件protected/config/main.php全局中指定:
1
|
'charset' => 'utf-8' , |
这实际是设置当前应用程序的charset公共属性(在capplication中声明)而如果在配置文件中指定'language' => 'zh_cn', 我们发现cwebapplication及其所有上级类均未声明$language属性,这时将使用setter模式方法即setlanuage(此方法定义在capplication类中)。
ok,了解这个特性之后,我们就可以明白在配置文件中可以配置的属性:
- cwebapplication及其所有上级类的公共成员变量
- cwebapplication及其所有上级类的setter方法指定的属性当然我们也可以通过继承cwebapplication构造自己的应用程序类。
cwebapplication的继承层次为:capplication -> cmodule -> ccomponent, 我们将默认的配置文件中常见的配置项及其生效位置予以说明:
- basepath : capplication::setbasepath()
- name: capplication::$name
- preload: cmodule::$preload
- import: cmodule::setimport()
- defaultcontroller: cwebapplication::$defaultcontroller
- components: cmodule::setcomponents()
类似地,再列出几个默认配置文件中并未列出的配置项:timezone: capplication::settimezone() #配置时区
再例如,如果我们继承cwebapplication, 扩展自己的应用程序类myapp, 并定义方法seterror_reporting(不区分大小写), 那么就可以直接在配置文件中指定error_reporting选项。
辅助组件可以将cwebapplication组件视为一部机器,那么辅助组件就可以视为组成这部机器的各个零件,没有零件的正确组合,机器就无法正常工作,这在yii中也是同样的概念。而一些组件对整部机器的运转是必须的,这就是核心组件。在应用程序对象构造后,yii会将辅助组件基本信息进行登记(组件名称与类名,属性配置的对照表),以供后续使用,对web应用程序而言,存在以下核心组件(通过cwebapplication::registercorecomponents,capplication::registercorecomponents注册):
cwebapplication::registercorecomponents中注册的核心组件
capplication::registercorecomponents中注册的核心组件
配置文本中注册的核心组件:log clogrouter 日志路由管理器
以上标记为红色的条目,是最重要的辅助组件,其它的核心组件我们未必会使用到。
如何定义辅助组件的属性?通过在配置文件protected/config/main.php中设置components项的值,实现组件属性定义。这里的定义主要是三个要素:指定组件的名称(核心组件已经预先设置)、指定组件使用的类(核心组件无须定义),组件的属性(可选、视情况而定)
如以下配置:
1
2
3
4
5
6
7
|
'components' => array ( 'db' => array ( 'class' => 'mycdbconnection' , 'connnectionstring' => 'mysql:host=localhost;dbname=test;charset=utf8' , 'user' => 'root' , ), ); |
就设置了db组件使用的类为mycdbconnection, 并且在后面指定了连接串及账号等信息。提示: mycdbconnection类可能就是通过继承cdbconnection类定义。核心组件无须指定class参数(因为已经预先定义好)
问题:如何得知某个组件可配置的属性?这个问题至关重要,如果我们掌握了规律,就可以举一反三,所有组件的配置均可以灵活设定。授之以鱼不如授之以渔。在本节会说明通用的方法。要得知组件的所有可定义属性,按以下步骤进行:
1. 组件所使用的类是什么?(无论是核心组件还是自定义组件)
2. 组件类的公共成员变量都有哪些?(注意从父类继承而来的公共成员变量)
3. 组件类都有哪些settter方法?(注意从父类继承而来的方法)
明白了以上三个要点,我们就可以按规律定义组件的属性,比如对最重要的db组件,我们发现这是一个核心组件,使用的类为cdbconnection, 我们查阅这个类的定义文件,发现这个类的公共成员变量有:
$connectionstring;
- $username='';
- $password='';
- $autoconnect=true;
- $charset;
- $emulateprepare;
- $tableprefix;
- $initsqls;
- ... ...
setter方法定义的属性:
- setactive($value)
- setattributes($values)
- setautocommit($value)
- setcolumncase($value)
- setnullconversion($value)
- setpersistent($value)
提示:setter方法定义的属性名称不区分大小写以上所列的属性,均可以在配置文件中指定,具体每个属性的作用,请参阅yii类文件的详细注释(yii代码的注释也是相当棒,通俗易懂,而又很详细)
再来一个例子,定义urlmanager组件的属性这个组件使用的类为curlmanager, 我们查阅它的属性:
- $rules=array();
- $urlsuffix='';
- $showscriptname=true;
- $appendparams=true;
- $routevar='r';
- $casesensitive=true;
通过setter方法定义的属性:
- seturlformat($value)
- setbaseurl($value)
即urlmanager组件的上述属性可以在配置文件中定义(每项配置的作用请参阅其注释)。其它组件的配置均可按上述方法处理。
如何使用组件应用程序运行后,会将所有已经定义过的组件注册(并未实例化)到cwebapplication对象上,同时cwebapplication应用程序对象会被注册到yii::$_app,在程序的任何位置均可通过yii::app()得到当前应用程序对象引用,再通过$app对象得到组件实例引用,如:yii::app()->getcomponent('urlmanager'); #会查找组件配置并实例化之yii::app()->urlmanager; #通过cmodule::__get()魔术方法实现
如何自定义组件?这是很常见的需求,比如我们可能希望db组件(数据库连接)使用我们自定义的类,也或者我们希望使用多个数据库连接,这种情况下就需要自定义组件,使用多数据库的例子:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
components=> array ( 'db' => array ( ... ... ), 'mydb' => array ( 'class' => 'mydbconnection' , 'connectionstring' => 'mysql:host=localhost;dbname=test;charset=utf8' , 'tableprefix' => 'cdb_' , 'username' => 'root' , ), ), 修改默认的db组件所使用的类: components=> array ( 'db' => array ( 'class' => 'mydbconnection' , ... ... ), ), |
经过本文的分析,我是深切理解了yii组件化机制给应用程序带来的极大的扩展性,哈哈哈哈~