簡要剖析PHP的Yii架構的組件化機制的基本知識,yii架構
組件是 Yii 應用的主要基石。是 yii\base\Component 類或其子類的執行個體。三個用以區分它和其它類的主要功能有:
- 屬性(Property)
- 事件(Event)
- 行為(Behavior)
或單獨使用,或彼此配合,這些功能的應用讓 Yii 的類變得更加靈活和易用。以小組件 yii\jui\DatePicker 來舉例,這是個方便你在 視圖中產生一個互動式日期選取器的 UI 組件:
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 方法。
例子如下:
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(); // ... 配置生效後的初始化過程 }}
另外,為了讓組件可以在建立執行個體時能被正確配置,請遵照以下操作流程:
$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全域中指定:
'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項的值,實現組件屬性定義。這裡的定義主要是三個要素:指定組件的名稱(核心組件已經預先設定)、指定組件使用的類(核心組件無須定義),組件的屬性(可選、視情況而定)
如以下配置:
'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組件(資料庫連接)使用我們自訂的類,也或者我們希望使用多個資料庫連接,這種情況下就需要自訂群組件,使用多資料庫的例子:
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組件化機制給應用程式帶來的極大的擴充性,哈哈哈哈~
您可能感興趣的文章:
- PHP的Yii架構中行為的定義與Binder 方法講解
- 詳解在PHP的Yii架構中使用行為Behaviors的方法
- 深入講解PHP的Yii架構中的屬性(Property)
- 解讀PHP的Yii架構中請求與響應的處理流程
- PHP的Yii架構中使用資料庫的配置和SQL操作執行個體教程
- 執行個體講解如何在PHP的Yii架構中進行錯誤和異常處理
- 解析PHP的Yii架構中cookie和session功能的相關操作
- PHP的Yii架構中YiiBase入口類的擴充寫法樣本
- 詳解PHP的Yii架構的運行機制及其路由功能
- 深入解析PHP的Yii架構中的event事件機制
- 全面解讀PHP的Yii架構中的日誌功能
- PHP的Yii架構中移除組件所綁定的行為的方法
http://www.bkjia.com/PHPjc/1111321.htmlwww.bkjia.comtruehttp://www.bkjia.com/PHPjc/1111321.htmlTechArticle簡要剖析PHP的Yii架構的組件化機制的基本知識,yii架構 組件是 Yii 應用的主要基石。是 yii\base\Component 類或其子類的執行個體。三個用以區分它...