PHP的Yii框架中組件化機(jī)制的示例分析

這篇文章主要為大家展示了“PHP的Yii框架中組件化機(jī)制的示例分析”，內(nèi)容簡(jiǎn)而易懂，條理清晰，希望能夠幫助大家解決疑惑，下面讓小編帶領(lǐng)大家一起研究并學(xué)習(xí)一下“PHP的Yii框架中組件化機(jī)制的示例分析”這篇文章吧。

組件是 Yii 應(yīng)用的主要基石。是 yii\base\Component 類或其子類的實(shí)例。三個(gè)用以區(qū)分它和其它類的主要功能有：

• 屬性（Property）

• 事件（Event）

• 行為（Behavior）

或單獨(dú)使用，或彼此配合，這些功能的應(yīng)用讓 Yii 的類變得更加靈活和易用。以小部件 yii\jui\DatePicker 來(lái)舉例，這是個(gè)方便你在 視圖中生成一個(gè)交互式日期選擇器的 UI 組件：

use yii\jui\DatePicker;

echo DatePicker::widget([
  'language' => 'zh-CN',
  'name' => 'country',
  'clientOptions' => [
    'dateFormat' => 'yy-mm-dd',
  ],
]);

這個(gè)小部件繼承自 yii\base\Component，它的各項(xiàng)屬性改寫(xiě)起來(lái)會(huì)很容易。

正是因?yàn)榻M件功能的強(qiáng)大，他們比常規(guī)的對(duì)象（Object）稍微重量級(jí)一點(diǎn)，因?yàn)樗麄円褂妙~外的內(nèi)存和 CPU 時(shí)間來(lái)處理 事件 和 行為 。如果你不需要這兩項(xiàng)功能，可以繼承 yii\base\Object 而不是 yii\base\Component。這樣組件可以像普通 PHP 對(duì)象一樣高效，同時(shí)還支持屬性（Property）功能。

當(dāng)繼承 yii\base\Component 或 yii\base\Object 時(shí)，推薦你使用如下的編碼風(fēng)格：

若你需要重寫(xiě)構(gòu)造方法（Constructor），傳入 $config 作為構(gòu)造器方法最后一個(gè)參數(shù)，然后把它傳遞給父類的構(gòu)造方法。
永遠(yuǎn)在你重寫(xiě)的構(gòu)造方法結(jié)尾處調(diào)用一下父類的構(gòu)造方法。
如果你重寫(xiě)了 yii\base\Object::init() 方法，請(qǐng)確保你在 init 方法的開(kāi)頭處調(diào)用了父類的 init 方法。
例子如下：

namespace yii\components\MyClass;

use yii\base\Object;

class MyClass extends Object
{
  public $prop1;
  public $prop2;

  public function __construct($param1, $param2, $config = [])
  {
    // ... 配置生效前的初始化過(guò)程

    parent::__construct($config);
  }

  public function init()
  {
    parent::init();

    // ... 配置生效后的初始化過(guò)程
  }
}

另外，為了讓組件可以在創(chuàng)建實(shí)例時(shí)能被正確配置，請(qǐng)遵照以下操作流程：

$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() 的方法看起來(lái)更加復(fù)雜，但這主要因?yàn)樗屿`活強(qiáng)大，它是基于依賴注入容器實(shí)現(xiàn)的。
yii\base\Object 類執(zhí)行時(shí)的生命周期如下：

構(gòu)造方法內(nèi)的預(yù)初始化過(guò)程。你可以在這兒給各屬性設(shè)置缺省值。
通過(guò) $config 配置對(duì)象。配置的過(guò)程可能會(huì)覆蓋掉先前在構(gòu)造方法內(nèi)設(shè)置的默認(rèn)值。
在 yii\base\Object::init() 方法內(nèi)進(jìn)行初始化后的收尾工作。你可以通過(guò)重寫(xiě)此方法，進(jìn)行一些良品檢驗(yàn)，屬性的初始化之類的工作。
對(duì)象方法調(diào)用。
前三步都是在對(duì)象的構(gòu)造方法內(nèi)發(fā)生的。這意味著一旦你獲得了一個(gè)對(duì)象實(shí)例，那么它就已經(jīng)初始化就緒可供使用。

應(yīng)用程序CWebApplication組件
在說(shuō)明Yii中各個(gè)組件使用方法前，先了解最重要的一個(gè)組件CWebApplication。CWebApplication即應(yīng)用程序?qū)ο?，它的根類也是CComponent，故它也是一個(gè)組件，具有Yii組件的共同特征。
具體來(lái)說(shuō)，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全局中指定：

'charset' => 'utf-8',

這實(shí)際是設(shè)置當(dāng)前應(yīng)用程序的charset公共屬性（在CApplication中聲明）而如果在配置文件中指定'language' => 'zh_cn', 我們發(fā)現(xiàn)CWebApplication及其所有上級(jí)類均未聲明$language屬性，這時(shí)將使用setter模式方法即setlanuage(此方法定義在CApplication類中)。
OK，了解這個(gè)特性之后，我們就可以明白在配置文件中可以配置的屬性：

• CWebApplication及其所有上級(jí)類的公共成員變量

• CWebApplication及其所有上級(jí)類的setter方法指定的屬性當(dāng)然我們也可以通過(guò)繼承CWebApplication構(gòu)造自己的應(yīng)用程序類。

CWebApplication的繼承層次為：CApplication -> CModule -> CComponent， 我們將默認(rèn)的配置文件中常見(jiàn)的配置項(xiàng)及其生效位置予以說(shuō)明：

• 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ū)分大小寫(xiě)), 那么就可以直接在配置文件中指定error_reporting選項(xiàng)。
輔助組件可以將CWebApplication組件視為一部機(jī)器，那么輔助組件就可以視為組成這部機(jī)器的各個(gè)零件，沒(méi)有零件的正確組合，機(jī)器就無(wú)法正常工作，這在Yii中也是同樣的概念。而一些組件對(duì)整部機(jī)器的運(yùn)轉(zhuǎn)是必須的，這就是核心組件。在應(yīng)用程序?qū)ο髽?gòu)造后，Yii會(huì)將輔助組件基本信息進(jìn)行登記（組件名稱與類名，屬性配置的對(duì)照表），以供后續(xù)使用，對(duì)web應(yīng)用程序而言，存在以下核心組件（通過(guò)CWebApplication::registerCoreComponents，CApplication::registerCoreComponents注冊(cè)）：

CWebApplication::registerCoreComponents中注冊(cè)的核心組件

CApplication::registerCoreComponents中注冊(cè)的核心組件

配置文本中注冊(cè)的核心組件：log CLogRouter 日志路由管理器
以上標(biāo)記為紅色的條目，是最重要的輔助組件，其它的核心組件我們未必會(huì)使用到。
如何定義輔助組件的屬性？通過(guò)在配置文件protected/config/main.php中設(shè)置components項(xiàng)的值，實(shí)現(xiàn)組件屬性定義。這里的定義主要是三個(gè)要素：指定組件的名稱（核心組件已經(jīng)預(yù)先設(shè)置）、指定組件使用的類（核心組件無(wú)須定義），組件的屬性（可選、視情況而定）
如以下配置：

'components' => array(
'db' => array(
'class' => 'myCDbConnection',
'connnectionString' => 'mysql:host=localhost;dbname=test;charset=utf8',
'user' => 'root',
),
);

就設(shè)置了db組件使用的類為myCDbConnection, 并且在后面指定了連接串及賬號(hào)等信息。提示： myCDbConnection類可能就是通過(guò)繼承CDbConnection類定義。核心組件無(wú)須指定class參數(shù)（因?yàn)橐呀?jīng)預(yù)先定義好）
問(wèn)題：如何得知某個(gè)組件可配置的屬性？這個(gè)問(wèn)題至關(guān)重要，如果我們掌握了規(guī)律，就可以舉一反三，所有組件的配置均可以靈活設(shè)定。授之以魚(yú)不如授之以漁。在本節(jié)會(huì)說(shuō)明通用的方法。要得知組件的所有可定義屬性，按以下步驟進(jìn)行：
1. 組件所使用的類是什么？(無(wú)論是核心組件還是自定義組件)
2. 組件類的公共成員變量都有哪些？（注意從父類繼承而來(lái)的公共成員變量）
3. 組件類都有哪些settter方法？（注意從父類繼承而來(lái)的方法）
明白了以上三個(gè)要點(diǎn)，我們就可以按規(guī)律定義組件的屬性，比如對(duì)最重要的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ū)分大小寫(xiě)以上所列的屬性，均可以在配置文件中指定，具體每個(gè)屬性的作用，請(qǐng)參閱Yii類文件的詳細(xì)注釋（Yii代碼的注釋也是相當(dāng)棒，通俗易懂，而又很詳細(xì)）

再來(lái)一個(gè)例子，定義urlManager組件的屬性這個(gè)組件使用的類為CUrlManager, 我們查閱它的屬性：

• $rules=array();

• $urlSuffix='';

• $showScriptName=true;

• $appendParams=true;

• $routeVar='r';

• $caseSensitive=true;

通過(guò)setter方法定義的屬性：

• setUrlFormat($value)

• setBaseUrl($value)

即urlManager組件的上述屬性可以在配置文件中定義（每項(xiàng)配置的作用請(qǐng)參閱其注釋）。其它組件的配置均可按上述方法處理。

如何使用組件應(yīng)用程序運(yùn)行后，會(huì)將所有已經(jīng)定義過(guò)的組件注冊(cè)（并未實(shí)例化）到CWebApplication對(duì)象上，同時(shí)CWebApplication應(yīng)用程序?qū)ο髸?huì)被注冊(cè)到Y(jié)ii::$_app，在程序的任何位置均可通過(guò)Yii::app()得到當(dāng)前應(yīng)用程序?qū)ο笠?，再通過(guò)$app對(duì)象得到組件實(shí)例引用，如：Yii::app()->getComponent('urlManager');  #會(huì)查找組件配置并實(shí)例化之Yii::app()->urlManager;  #通過(guò)CModule::__get()魔術(shù)方法實(shí)現(xiàn)
如何自定義組件？這是很常見(jiàn)的需求，比如我們可能希望db組件（數(shù)據(jù)庫(kù)連接）使用我們自定義的類，也或者我們希望使用多個(gè)數(shù)據(jù)庫(kù)連接，這種情況下就需要自定義組件，使用多數(shù)據(jù)庫(kù)的例子：

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',
... ...
),
),

以上是“PHP的Yii框架中組件化機(jī)制的示例分析”這篇文章的所有內(nèi)容，感謝各位的閱讀！相信大家都有了一定的了解，希望分享的內(nèi)容對(duì)大家有所幫助，如果還想學(xué)習(xí)更多知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！