Yii的組件機(jī)制詳解
應(yīng)用程序CWebApplication組件
在說明Yii中各個組件使用方法前,先了解最重要的一個組件CWebApplication。
CWebApplication即應(yīng)用程序?qū)ο螅母愐彩荂Component,故它也是一個組件,具有Yii組件的共同特征晨仑。
具體來說,CWebApplication組件的主要作用是根據(jù)配置文件拆檬,加載必要的輔助組件洪己,并在這些組件的幫助下(如urlManager)創(chuàng)建并運行控制器。故也將其稱為前端控制器竟贯。
我們可以在配置文件中指定CWebApplication組件本身的配置參數(shù)答捕,這些參數(shù)被設(shè)置為其公共成員變量,或是自動調(diào)用setter方法設(shè)置屬性澄耍,這個特性可以在CWebApplication的構(gòu)造函數(shù)中發(fā)現(xiàn):$this->configure($config);
如在配置文件protected/config/main.php全局中指定:
'charset' => 'utf-8',
這實際是設(shè)置當(dāng)前應(yīng)用程序的charset公共屬性(在CApplication中聲明)
而如果在配置文件中指定'language' => 'zh_cn', 我們發(fā)現(xiàn)CWebApplication及其所有上級類均未聲明$language屬性噪珊,這時將使用setter模式方法即setlanuage(此方法定義在CApplication類中)。
OK齐莲,了解這個特性之后痢站,我們就可以明白在配置文件中可以配置的屬性:
- CWebApplication及其所有上級類的公共成員變量
- CWebApplication及其所有上級類的setter方法指定的屬性
當(dāng)然我們也可以通過繼承CWebApplication構(gòu)造自己的應(yīng)用程序類。
CWebApplication的繼承層次為:CApplication -> CModule -> CComponent选酗, 我們將默認(rèn)的配置文件中常見的配置項及其生效位置予以說明:
basePath : CApplication::setBasePath()
name: CApplication::$name
preload: CModule::$preload
import: CModule::setImport()
defaultController: CWebApplication::$defaultController
components: CModule::setComponents()
類似地阵难,再列出幾個默認(rèn)配置文件中并未列出的配置項:
timezone: CApplication::setTimeZone() #配置時區(qū)
再例如,如果我們繼承CWebApplication, 擴(kuò)展自己的應(yīng)用程序類myApp, 并定義方法setError_reporting(不區(qū)分大小寫), 那么就可以直接在配置文件中指定error_reporting選項芒填。
輔助組件
可以將CWebApplication組件視為一部機(jī)器呜叫,那么輔助組件就可以視為組成這部機(jī)器的各個零件,沒有零件的正確組合殿衰,機(jī)器就無法正常工作朱庆,這在Yii中也是同樣的概念。而一些組件對整部機(jī)器的運轉(zhuǎn)是必須的闷祥,這就是核心組件娱颊。在應(yīng)用程序?qū)ο髽?gòu)造后,Yii會將輔助組件基本信息進(jìn)行登記(組件名稱與類名,屬性配置的對照表)箱硕,以供后續(xù)使用拴竹,對web應(yīng)用程序而言,存在以下核心組件(通過CWebApplication::registerCoreComponents剧罩,CApplication::registerCoreComponents注冊):
CWebApplication::registerCoreComponents中注冊的核心組件
組件名稱 對應(yīng)的類 配置參數(shù)說明
session CHttpSession session的封裝
assetManager CAssetManager 管理靜態(tài)資源(css, js等等)
user CWebUser 當(dāng)前訪問用戶的封裝
themeManager CThemeManager 實現(xiàn)多套模板管理
authManager CPhpAuthManager 通過文件中的用戶信息進(jìn)行驗證
clientScript CClientScript 管理客戶端使用到的js腳本
widgetFactory CWidgetFactory 生成wiget小部件
CApplication::registerCoreComponents中注冊的核心組件
組件名稱 對應(yīng)的類 配置參數(shù)說明
coreMessages CPhpMessageSource 框架文本消息()語言翻譯
db CDbConnection 數(shù)據(jù)庫連接
errorHandler CErrorHandler 錯誤及異常處理(日志記錄栓拜、錯誤呈現(xiàn))
securityManager CSecurityManager 較少使用
statePersister CStatePersister 基于文件的用戶狀態(tài)數(shù)據(jù)持久化實現(xiàn)
urlManager CUrlManager URL管理(路由雙解析實現(xiàn))
request CHttpRequest 當(dāng)前請求數(shù)據(jù)的的封裝
format CFormatter 數(shù)據(jù)格式化功能實現(xiàn)
配置文本中注冊的核心組件:
log CLogRouter 日志路由管理器
以上標(biāo)記為紅色的條目,是最重要的輔助組件惠昔,其它的核心組件我們未必會使用到幕与。
如何定義輔助組件的屬性?
通過在配置文件protected/config/main.php中設(shè)置components項的值舰罚,實現(xiàn)組件屬性定義纽门。這里的定義主要是三個要素:指定組件的名稱(核心組件已經(jīng)預(yù)先設(shè)置)、指定組件使用的類(核心組件無須定義)营罢,組件的屬性(可選、視情況而定)
如以下配置:
'components' => array(
'db' => array(
'class' => 'myCDbConnection',
'connnectionString' => 'mysql:host=localhost;dbname=test;charset=utf8',
'user' => 'root',
),
);
就設(shè)置了db組件使用的類為myCDbConnection, 并且在后面指定了連接串及賬號等信息饼齿。
提示: myCDbConnection類可能就是通過繼承CDbConnection類定義饲漾。
核心組件無須指定class參數(shù)(因為已經(jīng)預(yù)先定義好)
問題:如何得知某個組件可配置的屬性?
這個問題至關(guān)重要缕溉,如果我們掌握了規(guī)律考传,就可以舉一反三,所有組件的配置均可以靈活設(shè)定证鸥。授之以魚不如授之以漁僚楞。在本節(jié)會說明通用的方法。
要得知組件的所有可定義屬性枉层,按以下步驟進(jìn)行:
1. 組件所使用的類是什么泉褐?(無論是核心組件還是自定義組件)
2. 組件類的公共成員變量都有哪些?(注意從父類繼承而來的公共成員變量)
3. 組件類都有哪些settter方法鸟蜡?(注意從父類繼承而來的方法)
明白了以上三個要點膜赃,我們就可以按規(guī)律定義組件的屬性,比如對最重要的db組件揉忘,我們發(fā)現(xiàn)這是一個核心組件跳座,使用的類為CDbConnection, 我們查閱這個類的定義文件,發(fā)現(xiàn)這個類的公共成員變量有:
$connectionString;
$username='';
$password='';
$autoConnect=true;
$charset;
$emulatePrepare;
$tablePrefix;
$initSQLs;
... ...
setter方法定義的屬性:
setActive($value)
setAttributes($values)
setAutoCommit($value)
setColumnCase($value)
setNullConversion($value)
setPersistent($value)
提示:setter方法定義的屬性名稱不區(qū)分大小寫
以上所列的屬性泣矛,均可以在配置文件中指定疲眷,具體每個屬性的作用,請參閱Yii類文件的詳細(xì)注釋(Yii代碼的注釋也是相當(dāng)棒您朽,通俗易懂狂丝,而又很詳細(xì))
再來一個例子,定義urlManager組件的屬性
這個組件使用的類為CUrlManager, 我們查閱它的屬性:
$rules=array();
$urlSuffix='';
$showScriptName=true;
$appendParams=true;
$routeVar='r';
$caseSensitive=true;
通過setter方法定義的屬性:
setUrlFormat($value)
setBaseUrl($value)
即urlManager組件的上述屬性可以在配置文件中定義(每項配置的作用請參閱其注釋)。
其它組件的配置均可按上述方法處理美侦。
如何使用組件
應(yīng)用程序運行后产舞,會將所有已經(jīng)定義過的組件注冊(并未實例化)到CWebApplication對象上,同時CWebApplication應(yīng)用程序?qū)ο髸蛔缘結(jié)ii::$_app菠剩,在程序的任何位置均可通過Yii::app()得到當(dāng)前應(yīng)用程序?qū)ο笠靡酌ǎ偻ㄟ^$app對象得到組件實例引用,如:
Yii::app()->getComponent('urlManager'); #會查找組件配置并實例化之
Yii::app()->urlManager; #通過CModule::__get()魔術(shù)方法實現(xiàn)
如何自定義組件具壮?
這是很常見的需求准颓,比如我們可能希望db組件(數(shù)據(jù)庫連接)使用我們自定義的類,也或者我們希望使用多個數(shù)據(jù)庫連接棺妓,這種情況下就需要自定義組件攘已,使用多數(shù)據(jù)庫的例子:
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ò)展性怜跑。