yii組件的說明

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齐莲,了解這個特性之后痢站,我們就可以明白在配置文件中可以配置的屬性:

  1. CWebApplication及其所有上級類的公共成員變量
  2. 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ò)展性怜跑。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末样勃,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子性芬,更是在濱河造成了極大的恐慌峡眶,老刑警劉巖,帶你破解...
    沈念sama閱讀 222,627評論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件植锉,死亡現(xiàn)場離奇詭異辫樱,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)俊庇,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,180評論 3 399
  • 文/潘曉璐 我一進(jìn)店門狮暑,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人辉饱,你說我怎么就攤上這事搬男。” “怎么了鞋囊?”我有些...
    開封第一講書人閱讀 169,346評論 0 362
  • 文/不壞的土叔 我叫張陵止后,是天一觀的道長。 經(jīng)常有香客問我溜腐,道長译株,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 60,097評論 1 300
  • 正文 為了忘掉前任挺益,我火速辦了婚禮歉糜,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘望众。我一直安慰自己匪补,他們只是感情好伞辛,可當(dāng)我...
    茶點故事閱讀 69,100評論 6 398
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著夯缺,像睡著了一般蚤氏。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上踊兜,一...
    開封第一講書人閱讀 52,696評論 1 312
  • 那天竿滨,我揣著相機(jī)與錄音,去河邊找鬼捏境。 笑死于游,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的垫言。 我是一名探鬼主播贰剥,決...
    沈念sama閱讀 41,165評論 3 422
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼筷频!你這毒婦竟也來了蚌成?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 40,108評論 0 277
  • 序言:老撾萬榮一對情侶失蹤截驮,失蹤者是張志新(化名)和其女友劉穎笑陈,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體葵袭,經(jīng)...
    沈念sama閱讀 46,646評論 1 319
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 38,709評論 3 342
  • 正文 我和宋清朗相戀三年乖菱,在試婚紗的時候發(fā)現(xiàn)自己被綠了坡锡。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 40,861評論 1 353
  • 序言:一個原本活蹦亂跳的男人離奇死亡窒所,死狀恐怖鹉勒,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情吵取,我是刑警寧澤禽额,帶...
    沈念sama閱讀 36,527評論 5 351
  • 正文 年R本政府宣布,位于F島的核電站皮官,受9級特大地震影響脯倒,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜捺氢,卻給世界環(huán)境...
    茶點故事閱讀 42,196評論 3 336
  • 文/蒙蒙 一藻丢、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧摄乒,春花似錦悠反、人聲如沸残黑。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,698評論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽梨水。三九已至,卻和暖如春茵臭,著一層夾襖步出監(jiān)牢的瞬間疫诽,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,804評論 1 274
  • 我被黑心中介騙來泰國打工笼恰, 沒想到剛下飛機(jī)就差點兒被人妖公主榨干…… 1. 我叫王不留踊沸,地道東北人。 一個月前我還...
    沈念sama閱讀 49,287評論 3 379
  • 正文 我出身青樓社证,卻偏偏與公主長得像逼龟,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子追葡,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 45,860評論 2 361

推薦閱讀更多精彩內(nèi)容

  • Spring Cloud為開發(fā)人員提供了快速構(gòu)建分布式系統(tǒng)中一些常見模式的工具(例如配置管理腺律,服務(wù)發(fā)現(xiàn),斷路器宜肉,智...
    卡卡羅2017閱讀 134,715評論 18 139
  • Android 自定義View的各種姿勢1 Activity的顯示之ViewRootImpl詳解 Activity...
    passiontim閱讀 172,324評論 25 707
  • 國家電網(wǎng)公司企業(yè)標(biāo)準(zhǔn)(Q/GDW)- 面向?qū)ο蟮挠秒娦畔?shù)據(jù)交換協(xié)議 - 報批稿:20170802 前言: 排版 ...
    庭說閱讀 11,010評論 6 13
  • Spring Boot 參考指南 介紹 轉(zhuǎn)載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 46,867評論 6 342
  • 跳轉(zhuǎn)方式 1匀钧、查看控制臺,自帶ID屬性谬返,可以進(jìn)行跳轉(zhuǎn)之斯,使用 ;2遣铝、自定義名稱佑刷,使用a標(biāo)簽進(jìn)行跳轉(zhuǎn); 關(guān)于切片 1酿炸、...
    jia林閱讀 1,111評論 2 3