組件是 yii 應(yīng)用的主要基石。是 yii\base\component 類或其子類的實(shí)例。三個(gè)用以區(qū)分它和其它類的主要功能有:
- 屬性(property)
- 事件(event)
- 行為(behavior)
或單獨(dú)使用,或彼此配合,這些功能的應(yīng)用讓 yii 的類變得更加靈活和易用。以小部件 yii\jui\datepicker 來舉例,這是個(gè)方便你在 視圖中生成一個(gè)交互式日期選擇器的 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' , ], ]); |
這個(gè)小部件繼承自 yii\base\component,它的各項(xiàng)屬性改寫起來會(huì)很容易。
正是因?yàn)榻M件功能的強(qiáng)大,他們比常規(guī)的對象(object)稍微重量級一點(diǎn),因?yàn)樗麄円褂妙~外的內(nèi)存和 cpu 時(shí)間來處理 事件 和 行為 。如果你不需要這兩項(xiàng)功能,可以繼承 yii\base\object 而不是 yii\base\component。這樣組件可以像普通 php 對象一樣高效,同時(shí)還支持屬性(property)功能。
當(dāng)繼承 yii\base\component 或 yii\base\object 時(shí),推薦你使用如下的編碼風(fēng)格:
若你需要重寫構(gòu)造方法(constructor),傳入 $config 作為構(gòu)造器方法最后一個(gè)參數(shù),然后把它傳遞給父類的構(gòu)造方法。
永遠(yuǎn)在你重寫的構(gòu)造方法結(jié)尾處調(diào)用一下父類的構(gòu)造方法。
如果你重寫了 yii\base\object::init() 方法,請確保你在 init 方法的開頭處調(diào)用了父類的 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(); // ... 配置生效后的初始化過程 } } |
另外,為了讓組件可以在創(chuàng)建實(shí)例時(shí)能被正確配置,請遵照以下操作流程:
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]); |
補(bǔ)充:盡管調(diào)用 yii::createobject() 的方法看起來更加復(fù)雜,但這主要因?yàn)樗屿`活強(qiáng)大,它是基于依賴注入容器實(shí)現(xiàn)的。
yii\base\object 類執(zhí)行時(shí)的生命周期如下:
構(gòu)造方法內(nèi)的預(yù)初始化過程。你可以在這兒給各屬性設(shè)置缺省值。
通過 $config 配置對象。配置的過程可能會(huì)覆蓋掉先前在構(gòu)造方法內(nèi)設(shè)置的默認(rèn)值。
在 yii\base\object::init() 方法內(nèi)進(jìn)行初始化后的收尾工作。你可以通過重寫此方法,進(jìn)行一些良品檢驗(yàn),屬性的初始化之類的工作。
對象方法調(diào)用。
前三步都是在對象的構(gòu)造方法內(nèi)發(fā)生的。這意味著一旦你獲得了一個(gè)對象實(shí)例,那么它就已經(jīng)初始化就緒可供使用。
應(yīng)用程序cwebapplication組件
在說明yii中各個(gè)組件使用方法前,先了解最重要的一個(gè)組件cwebapplication。cwebapplication即應(yīng)用程序?qū)ο螅母愐彩莄component,故它也是一個(gè)組件,具有yii組件的共同特征。
具體來說,cwebapplication組件的主要作用是根據(jù)配置文件,加載必要的輔助組件,并在這些組件的幫助下(如urlmanager)創(chuàng)建并運(yùn)行控制器。故也將其稱為前端控制器。
我們可以在配置文件中指定cwebapplication組件本身的配置參數(shù),這些參數(shù)被設(shè)置為其公共成員變量,或是自動(dòng)調(diào)用setter方法設(shè)置屬性,這個(gè)特性可以在cwebapplication的構(gòu)造函數(shù)中發(fā)現(xiàn):$this->configure($config);
如在配置文件protected/config/main.php全局中指定:
1
|
'charset' => 'utf-8' , |
這實(shí)際是設(shè)置當(dāng)前應(yīng)用程序的charset公共屬性(在capplication中聲明)而如果在配置文件中指定'language' => 'zh_cn', 我們發(fā)現(xiàn)cwebapplication及其所有上級類均未聲明$language屬性,這時(shí)將使用setter模式方法即setlanuage(此方法定義在capplication類中)。
ok,了解這個(gè)特性之后,我們就可以明白在配置文件中可以配置的屬性:
- cwebapplication及其所有上級類的公共成員變量
- cwebapplication及其所有上級類的setter方法指定的屬性當(dāng)然我們也可以通過繼承cwebapplication構(gòu)造自己的應(yīng)用程序類。
cwebapplication的繼承層次為:capplication -> cmodule -> ccomponent, 我們將默認(rèn)的配置文件中常見的配置項(xiàng)及其生效位置予以說明:
- basepath : capplication::setbasepath()
- name: capplication::$name
- preload: cmodule::$preload
- import: cmodule::setimport()
- defaultcontroller: cwebapplication::$defaultcontroller
- components: cmodule::setcomponents()
類似地,再列出幾個(gè)默認(rèn)配置文件中并未列出的配置項(xiàng):timezone: capplication::settimezone() #配置時(shí)區(qū)
再例如,如果我們繼承cwebapplication, 擴(kuò)展自己的應(yīng)用程序類myapp, 并定義方法seterror_reporting(不區(qū)分大小寫), 那么就可以直接在配置文件中指定error_reporting選項(xiàng)。
輔助組件可以將cwebapplication組件視為一部機(jī)器,那么輔助組件就可以視為組成這部機(jī)器的各個(gè)零件,沒有零件的正確組合,機(jī)器就無法正常工作,這在yii中也是同樣的概念。而一些組件對整部機(jī)器的運(yùn)轉(zhuǎn)是必須的,這就是核心組件。在應(yīng)用程序?qū)ο髽?gòu)造后,yii會(huì)將輔助組件基本信息進(jìn)行登記(組件名稱與類名,屬性配置的對照表),以供后續(xù)使用,對web應(yīng)用程序而言,存在以下核心組件(通過cwebapplication::registercorecomponents,capplication::registercorecomponents注冊):
cwebapplication::registercorecomponents中注冊的核心組件
capplication::registercorecomponents中注冊的核心組件
配置文本中注冊的核心組件:log clogrouter 日志路由管理器
以上標(biāo)記為紅色的條目,是最重要的輔助組件,其它的核心組件我們未必會(huì)使用到。
如何定義輔助組件的屬性?通過在配置文件protected/config/main.php中設(shè)置components項(xiàng)的值,實(shí)現(xiàn)組件屬性定義。這里的定義主要是三個(gè)要素:指定組件的名稱(核心組件已經(jīng)預(yù)先設(shè)置)、指定組件使用的類(核心組件無須定義),組件的屬性(可選、視情況而定)
如以下配置:
1
2
3
4
5
6
7
|
'components' => array ( 'db' => array ( 'class' => 'mycdbconnection' , 'connnectionstring' => 'mysql:host=localhost;dbname=test;charset=utf8' , 'user' => 'root' , ), ); |
就設(shè)置了db組件使用的類為mycdbconnection, 并且在后面指定了連接串及賬號(hào)等信息。提示: mycdbconnection類可能就是通過繼承cdbconnection類定義。核心組件無須指定class參數(shù)(因?yàn)橐呀?jīng)預(yù)先定義好)
問題:如何得知某個(gè)組件可配置的屬性?這個(gè)問題至關(guān)重要,如果我們掌握了規(guī)律,就可以舉一反三,所有組件的配置均可以靈活設(shè)定。授之以魚不如授之以漁。在本節(jié)會(huì)說明通用的方法。要得知組件的所有可定義屬性,按以下步驟進(jìn)行:
1. 組件所使用的類是什么?(無論是核心組件還是自定義組件)
2. 組件類的公共成員變量都有哪些?(注意從父類繼承而來的公共成員變量)
3. 組件類都有哪些settter方法?(注意從父類繼承而來的方法)
明白了以上三個(gè)要點(diǎn),我們就可以按規(guī)律定義組件的屬性,比如對最重要的db組件,我們發(fā)現(xiàn)這是一個(gè)核心組件,使用的類為cdbconnection, 我們查閱這個(gè)類的定義文件,發(fā)現(xiàn)這個(gè)類的公共成員變量有:
$connectionstring;
- $username='';
- $password='';
- $autoconnect=true;
- $charset;
- $emulateprepare;
- $tableprefix;
- $initsqls;
- ... ...
setter方法定義的屬性:
- setactive($value)
- setattributes($values)
- setautocommit($value)
- setcolumncase($value)
- setnullconversion($value)
- setpersistent($value)
提示:setter方法定義的屬性名稱不區(qū)分大小寫以上所列的屬性,均可以在配置文件中指定,具體每個(gè)屬性的作用,請參閱yii類文件的詳細(xì)注釋(yii代碼的注釋也是相當(dāng)棒,通俗易懂,而又很詳細(xì))
再來一個(gè)例子,定義urlmanager組件的屬性這個(gè)組件使用的類為curlmanager, 我們查閱它的屬性:
- $rules=array();
- $urlsuffix='';
- $showscriptname=true;
- $appendparams=true;
- $routevar='r';
- $casesensitive=true;
通過setter方法定義的屬性:
- seturlformat($value)
- setbaseurl($value)
即urlmanager組件的上述屬性可以在配置文件中定義(每項(xiàng)配置的作用請參閱其注釋)。其它組件的配置均可按上述方法處理。
如何使用組件應(yīng)用程序運(yùn)行后,會(huì)將所有已經(jīng)定義過的組件注冊(并未實(shí)例化)到cwebapplication對象上,同時(shí)cwebapplication應(yīng)用程序?qū)ο髸?huì)被注冊到y(tǒng)ii::$_app,在程序的任何位置均可通過yii::app()得到當(dāng)前應(yīng)用程序?qū)ο笠茫偻ㄟ^$app對象得到組件實(shí)例引用,如:yii::app()->getcomponent('urlmanager'); #會(huì)查找組件配置并實(shí)例化之yii::app()->urlmanager; #通過cmodule::__get()魔術(shù)方法實(shí)現(xiàn)
如何自定義組件?這是很常見的需求,比如我們可能希望db組件(數(shù)據(jù)庫連接)使用我們自定義的類,也或者我們希望使用多個(gè)數(shù)據(jù)庫連接,這種情況下就需要自定義組件,使用多數(shù)據(jù)庫的例子:
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' , ), ), 修改默認(rèn)的db組件所使用的類: components=> array ( 'db' => array ( 'class' => 'mydbconnection' , ... ... ), ), |
經(jīng)過本文的分析,我是深切理解了yii組件化機(jī)制給應(yīng)用程序帶來的極大的擴(kuò)展性,哈哈哈哈~