Yii的组件机制详解
应用程序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中注册的核心组件
组件名称 对应的类 配置参数说明
session CHttpSession session的封装
assetManager CAssetManager 管理静态资源(css, js等等)
user CWebUser 当前访问用户的封装
themeManager CThemeManager 实现多套模板管理
authManager CPhpAuthManager 通过文件中的用户信息进行验证
clientScript CClientScript 管理客户端使用到的js脚本
widgetFactory CWidgetFactory 生成wiget小部件
CApplication::registerCoreComponents中注册的核心组件
组件名称 对应的类 配置参数说明
coreMessages CPhpMessageSource 框架文本消息()语言翻译
db CDbConnection 数据库连接
errorHandler CErrorHandler 错误及异常处理(日志记录、错误呈现)
securityManager CSecurityManager 较少使用
statePersister CStatePersister 基于文件的用户状态数据持久化实现
urlManager CUrlManager URL管理(路由双解析实现)
request CHttpRequest 当前请求数据的的封装
format CFormatter 数据格式化功能实现
配置文本中注册的核心组件:
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组件化机制给应用程序带来的极大的扩展性。
网友评论