组件

组件是 Yii 应用程序的主要基石。一个组件通常是 yii\base\Component 类或其子类的实例，与其他类相比，它有以下几个特色功能：

这些功能，或单独使用，或彼此配合，它们的应用让 Yii 的类变得更加灵活和易用。

组件功能的强大，也使得它们比常规的对象稍重一些，因为它们需要使用额外的内存和 CPU 开销来处理事件和行为。如果你不需要这两项功能，可以继承它的的父类 yii\base\Object。这样，组件可以像普通 PHP 对象一样高效，同时还支持属性功能。

自定义组件

当继承 yii\base\Component 或 yii\base\Object 时，推荐你使用如下的编码风格：

  • 若你需要重写构造方法（Constructor），传入 $config 作为构造器方法最后一个参数，然后把它传递给父类的构造方法。
  • 永远在你重写的构造方法结尾处调用一下父类的构造方法。
  • 如果你重写了 [[yii\base\BaseObject::init()]] 方法，请确保你在 init 方法的开头处调用了父类的 init 方法。

例子如下：

<?php

namespace yii\components\MyClass;

use yii\base\BaseObject;

class MyClass extends BaseObject
{
    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::class,
    'prop1' => 3,
    'prop2' => 4,
], [1, 2]);

Info: 尽管调用 [[Yii::createObject()]] 的方法看起来更加复杂，但这主要因为它更加灵活强大，它是基于 依赖注入容器 实现的。

组件执行生命周期

[[yii\base\BaseObject]] 类执行时的生命周期如下：

  1. 构造方法内的预初始化过程。你可以在这儿给各属性设置缺省值。
  2. 通过 $config 配置对象。配置的过程可能会覆盖掉先前在构造方法内设置的默认值。
  3. 在 [[yii\base\BaseObject::init()|init()]] 方法内进行初始化后的收尾工作。你可以通过重写此方法，进行一些良品检验，属性的初始化之类的工作。
  4. 对象方法调用。

前三步都是在对象的构造方法内发生的。这意味着一旦你获得了一个对象实例（即一个对象），
那么它就已经初始化就绪可供使用。

UI 组件

以小部件 [[yii\jui\DatePicker|日期选择器]] 来举例，这是个方便你在 视图 中生成一个交互式日期选择器的 UI 组件：

use yii\jui\DatePicker;

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

这个小部件继承自 yii\base\Component，它的各项属性改写起来会很容易。

应用组件

应用主体是 服务定位器，它部署一组提供各种不同功能的 应用组件 来处理请求。例如，urlManager 组件负责处理网页请求路由到对应的控制器，db 组件提供数据库相关服务等。

在同一个应用中，每个应用组件都有一个独一无二的 ID 用来区分其他应用组件，你可以通过如下表达式访问应用组件：

\Yii::$app->componentID

例如，可以使用 \Yii::$app->db 来获取到已注册到应用的数据库连接（yii\db\Connection）组件， 使用 \Yii::$app->cache 来获取到已注册到应用的主缓存（yii\caching\Cache）组件。

第一次使用以上表达式时候会创建应用组件实例，后续再访问会返回此实例，无需再次创建。

应用组件可以是任意对象，可以在 应用主体配置 中配置 [[yii\base\Application::components]] 属性。 例如：

[
    'components' => [
        // 使用类名注册 "cache" 组件
        'cache' => 'yii\caching\ApcCache',

        // 使用配置数组注册 "db" 组件
        'db' => [
            'class' => 'yii\db\Connection',
            'dsn' => 'mysql:host=localhost;dbname=demo',
            'username' => 'root',
            'password' => '',
        ],

        // 使用函数注册"search" 组件
        'search' => function () {
            return new app\components\SolrService;
        },
    ],
]

Info: 请谨慎注册太多应用组件，应用组件就像全局变量，使用太多可能加大测试和维护的难度。 一般情况下可以在需要时再创建本地组件。

引导启动组件

上面提到一个应用组件只会在第一次访问时实例化，如果处理请求过程没有访问的话就不实例化。有时，你想在每个请求处理过程都实例化某个组件即便它不会被访问，可以将该组件ID加入到应用主体的 [[yii\base\Application::bootstrap]] 属性中。

你还可以使用闭包来引导启动自定义的组件。不需要直接返回一个实例化的组件。在应用主体 yii\base\Application 实例化后，闭包也会被调用。

例如, 如下的应用主体配置保证了 log 组件一直被加载。

[
    'bootstrap' => [
        'log',
        function($app){
            return new ComponentX();
        },
        function($app){
            // 可以写自定义的代码
           return;
        }
    ],
    'components' => [
        'log' => [
            // "log" 组件的配置
        ],
    ],
]

核心应用组件

Yii 定义了一组固定ID和默认配置的 核心 组件，例如 [[yii\web\Application::request]] 组件用来收集用户请求并解析 路由； [[yii\base\Application::db]] 代表一个可以执行数据库操作的数据库连接。通过这些组件，Yii应用主体能处理用户请求。

下面是预定义的核心应用组件列表，可以和普通应用组件一样配置和自定义它们。当你配置一个核心组件，不指定它的类名的话就会使用 Yii 默认指定的类。

  • yii\web\AssetManager: assetManager 组件，管理资源包和资源发布，详情请参考 管理资源 一节。
  • yii\db\Connection: db 组件，代表一个可以执行数据库操作的数据库连接， 注意配置该组件时必须指定组件类名和其他相关组件属性，如 [[yii\db\Connection::dsn]]。详情请参考 数据访问对象 一节。
  • yii\base\Application::errorHandler: errorHandler 组件，处理 PHP 错误和异常，详情请参考 错误处理 一节。
  • yii\i18n\Formatter: formatter 组件，格式化输出显示给终端用户的数据，例如数字可能要带分隔符，日期使用长格式。详情请参考 格式化输出数据 一节。
  • yii\i18n\I18N: i18n 组件，支持信息翻译和格式化。 详情请参考 国际化 一节。
  • yii\log\Dispatcher: log 组件，管理日志对象。详情请参考 日志 一节。
  • yii\swiftmailer\Mailer: mail 组件，支持生成邮件结构并发送，详情请参考 邮件 一节。
  • yii\base\Application::response: response 组件，代表发送给用户的响应，详情请参考 响应 一节。
  • yii\base\Application::request: request 组件，代表从终端用户处接收到的请求，详情请参考 请求 一节。
  • yii\web\Session: session 组件，代表会话信息，仅在 yii\web\Application 网页应用中可用，详情请参考 Sessions (会话) and Cookies 一节。
  • yii\web\UrlManager: urlManager 组件，支持URL地址解析和创建，详情请参考 URL 解析和生成 一节。
  • yii\web\User: user 组件，代表认证登录用户信息，仅在 yii\web\Application 网页应用中可用，详情请参考 认证 一节。
  • yii\web\View: view 组件，支持渲染视图，详情请参考 视图 一节。

💖喜欢本文档的，欢迎点赞、收藏、留言或转发，谢谢支持！
作者邮箱：zhuzixian520@126.com，github地址：github.com/zhuzixian520

Last Updated:
Contributors: Hans