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,了解这个特性之后,我们就可以明白在配置文件中可以配置的属性:
1. CWebApplication及其所有上级类的公共成员变量
2. 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组件化机制给应用程序带来的极大的扩展性。如有任何疑惑,请联系zhangxugg@163.com。另外,Java Beans也是此种机制。常规的编程方式是在使用某个对象时,其所使用的类是已经预先定死的,若要实现扩展,就得修改类代码,这给项目的迭代,版本升级带来极大的麻烦。而使用组件机制就很好地规避了这个问题。
相关推荐
2. **组件化编程**:学习如何在 Yii 2.0 中创建和使用组件,以及如何扩展内置组件以满足特定需求。 3. **数据库设计与 ORM**:掌握 Active Record 模式,理解如何定义数据模型,进行数据库操作。 4. **性能优化**:...
在使用yii2tags组件时,开发者需要注意以下步骤: 1. **安装**:首先,通过Composer(PHP的依赖管理工具)来安装这个组件,通常会使用`composer require`命令来添加到项目中。 2. **配置**:在Yii2的配置文件中,...
安装和使用时,需将代码库中的文件整合到你的 Yiiframework 1.x 项目中,并按照文档配置数据库连接、RBAC 组件等。通过这样的集成,你可以快速构建出一个功能完备的用户管理系统,极大地提高了开发效率和项目质量。
Twitter Bootstrap 4 Yii 2... 它按照Yii小部件封装了组件和插件,因此在Yii应用程序中使用Bootstrap组件/插件非常容易。 有关许可证信息,请检查文件。 文档位于 。 安装 安装此扩展的首选方法是通过 。 无论运行 ...
yii-resque, 基于 php Resque的Yii组件,基于 Resque我是 php的一个组件,它基于 php-resque resque和 php-resque-scheduler的组件,我们还通过使用 ResqueBoard测试了日志处理程序 using 。需求php函数扩展。Red
Yii 2 的 Redis 缓存、会话和 ActiveRecord此扩展为Yii 框架 2.0提供了redis键值存储支持。它包含一个存储处理程序,并实现了允许您在 redis 中存储活动记录的模式。CacheSessionActiveRecord有关许可信息,请检查...
Twitter Yii 2的Bootstrap... 它根据Yii小部件封装了组件和插件,因此在Yii应用程序中使用Bootstrap组件/插件非常容易。 有关许可证信息,请检查文件。 文档位于 。 安装 安装此扩展的首选方法是通过 。 无论运行 ...
"Yii框架调试辅助扩展yiidebugtb"是针对Yii框架的一个专门用于调试的应用扩展,它极大地便利了开发者在开发过程中对代码性能、数据库查询、会话状态等关键信息的监控。 该扩展的核心功能包括: 1. **性能监控**:...
然后,你需要在Yii项目中创建一个扩展,或者使用已有的扩展,来处理这个数据库文件并提供查询接口。 创建扩展时,你可以编写一个服务类,该类包含读取和解析`qqwry.dat`文件的方法。解析过程可能涉及到二进制搜索和...
Yii2 设置组件 安装 安装此扩展的首选方法是通过 。 要么跑 php composer.phar require --prefer-dist pendalf89/yii2-settings "*" 或添加 "pendalf89/yii2-settings": "*" 到composer.json文件的 require 部分...
Yii2 jsTree 组件jsTree 是 jquery 插件,提供交互式树。 它是完全免费的、开源的,并在 MIT 许可下分发。 jsTree 易于扩展、主题化和可配置,它支持 HTML 和 JSON 数据源以及 AJAX 加载。 这个包允许你在几分钟内将...
YII扩展 IP地址识别组件 采用QQWRY数据库 使用条件: 解压到相应的目录。 确定QQWRY.DAT 放入 protacted/data 确定IpLocation 放入 protacted/components 修改main.php 'components'=>array( //......
Yii框架的核心是基于组件的设计理念,这使得开发者可以通过创建扩展组件来增强框架的功能。扩展组件的编写方法和实现技巧对于掌握Yii框架具有重要意义。本文将详细介绍Yii扩展组件的编写方法,并通过实例分析扩展...
9. **扩展和模块**:如何创建和使用自定义组件,以及Yii的模块化设计。 10. **性能优化**:提供性能调优技巧,如开启调试模式,使用预编译等。 11. **测试驱动开发**:使用Yii内置的PHPUnit支持进行单元测试和集成...
小部件(Widgets)是Yii框架中用于封装可重用组件的一种机制。它类似于其他框架中的组件或插件,但更侧重于提供简单、独立且可配置的功能单元。小部件可以用来实现常见的UI组件(如分页导航、数据表格等),也可以...
Yii 2的Redis缓存,会话和ActiveRecord 该扩展为提供了键值存储支持。 它包括一个Cache和Session存储处理程序,并实现...要使用此扩展,您必须在应用程序配置中配置Connection类: return [ //.... 'components
php composer.phar require --prefer-dist peterfrench/yii2-curl " * " 一旦 composer 安装了扩展,在您的配置文件中包含该组件。 'curl' => ['class' => 'peterfrench\curl\Curl' ,'options' => [/* curl options...
Yii2全日历组件 安装 安装此扩展的首选方法是通过 。 要安装,请运行 $ php composer.phar require edofre/yii2-fullcalendar "V1.0.11" 或添加 "edofre/yii2-fullcalendar": "V1.0.11" 到composer.json文件的...