介绍(Introduction) 入门(Getting Started) 应用结构(Application Structure) 请求处理(Handling Requests) 关键概念(Key Concepts) 配合数据库工作(Working with Databases) 接收用户数据(Getting Data from Users) 显示数据(Displaying Data) 安全(Security) 缓存(Caching) RESTful Web 服务(RESTful Web Services) 开发工具(Development Tools) 测试(Testing) 高级专题(Special Topics) 小部件(Widgets) 助手类(Helpers)

资源

Yii 中的资源是和 Web 页面相关的文件,可为 CSS 文件,JavaScript 文件,图片或视频等, 资源放在 Web 可访问的目录下,直接被 Web 服务器调用。

通过程序自动管理资源更好一点,例如,当你在页面中使用 yii\jui\DatePicker 小部件时, 它会自动包含需要的 CSS 和 JavaScript 文件, 而不是要求你手工去找到这些文件并包含, 当你升级小部件时,它会自动使用新版本的资源文件, 在本教程中,我们会详述 Yii 提供的强大的资源管理功能。

资源包

Yii 在资源包中管理资源,资源包简单的说就是放在一个目录下的资源集合, 当在视图中注册一个资源包, 在渲染 Web 页面时会包含包中的 CSS 和 JavaScript 文件。

定义资源包

资源包指定为继承 yii\web\AssetBundle 的 PHP 类, 包名为可自动加载的 PHP 类名, 在资源包类中,要指定资源所在位置, 包含哪些 CSS 和 JavaScript 文件以及和其他包的依赖关系。

如下代码定义基础应用模板使用的主要资源包:

<?php

namespace app\assets;

use yii\web\AssetBundle;

class AppAsset extends AssetBundle
{
    public $basePath = '@webroot';
    public $baseUrl = '@web';
    public $css = [
        'css/site.css',
        ['css/print.css', 'media' => 'print'],
    ];
    public $js = [
    ];
    public $depends = [
        'yii\web\YiiAsset',
        'yii\bootstrap\BootstrapAsset',
    ];
}

如上 AppAsset 类指定资源文件放在 @webroot 目录下,对应的 URL 为 @web,资源包中包含一个 CSS 文件 css/site.css,没有 JavaScript 文件, 依赖其他两个包 yii\web\YiiAssetyii\bootstrap\BootstrapAsset, 关于 yii\web\AssetBundle 的属性的更多详细如下所述:

  • sourcePath:指定包包含资源文件的根目录, 当根目录不能被 Web 访问时该属性应设置,否则,应设置 basePath 属性和 baseUrl路径别名 可在此处使用;
  • basePath:指定包含资源包中资源文件并可Web访问的目录, 当指定 sourcePath 属性, 资源管理器 会发布包的资源到一个可 Web 访问并覆盖该属性, 如果你的资源文件在一个 Web 可访问目录下,应设置该属性,这样就不用再发布了。 路径别名 可在此处使用。
  • baseUrl:指定对应到 basePath 目录的 URL, 和 basePath 类似, 如果你指定 sourcePath 属性, 资源管理器 会发布这些资源并覆盖该属性,路径别名 可在此处使用。
  • css:列出此包中包含的 CSS 文件的数组。 请注意,只应使用正斜杠“/”作为目录分隔符。每个文件都可以单独指定为字符串, 也可以与属性标记及其值一起指定在数组中。
  • js:列出此包中包含的 JavaScript 文件的数组。 请注意,只应使用正斜杠“/”作为目录分隔符。 每个 JavaScript 文件可指定为以下两种格式之一:
    • 相对路径表示为本地 JavaScript 文件 (如 js/main.js),文件实际的路径在该相对路径前加上 yii\web\AssetManager::$basePath,文件实际的 URL 在该路径前加上 yii\web\AssetManager::$baseUrl
    • 绝对 URL 地址表示为外部 JavaScript 文件,如 http://ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js
  • depends:一个列出该资源包依赖的 其他资源包(后两节有详细介绍)。
  • jsOptions:当调用 yii\web\View::registerJsFile() 注册该包 每个 JavaScript 文件时, 指定传递到该方法的选项。
  • cssOptions:当调用 yii\web\View::registerCssFile() 注册该包 每个 CSS 文件时, 指定传递到该方法的选项。
  • publishOptions:当调用 yii\web\AssetManager::publish() 发布该包资源文件到 Web 目录时 指定传递到该方法的选项,仅在指定了 sourcePath 属性时使用。

资源位置

资源根据它们的位置可以分为:

  • 源资源: 资源文件和 PHP 源代码放在一起,不能被 Web 直接访问,为了使用这些源资源, 它们要拷贝到一个可 Web 访问的 Web 目录中 成为发布的资源,这个过程称为发布资源,随后会详细介绍。
  • 发布资源: 资源文件放在可通过 Web 直接访问的 Web 目录中;
  • 外部资源: 资源文件放在与你的 Web 应用不同的 Web 服务器上;

当定义资源包类时候,如果你指定了sourcePath 属性, 就表示任何使用相对路径的资源会被当作源资源; 如果没有指定该属性,就表示这些资源为发布资源(因此应指定basePathbaseUrl 让 Yii 知道它们的位置)。

推荐将资源文件放到 Web 目录以避免不必要的发布资源过程,这就是之前的例子:指定 basePath 而不是 sourcePath.

对于扩展来说, 由于它们的资源和源代码都在不能Web访问的目录下, 在定义资源包类时必须指定sourcePath属性。

注意: source path 属性不要用 @webroot/assets,该路径默认为 asset manager 资源管理器将源资源发布后存储资源的路径, 该路径的所有内容会认为是临时文件, 可能会被删除。

资源依赖

当 Web 页面包含多个 CSS 或 JavaScript 文件时, 它们有一定的先后顺序以避免属性覆盖, 例如,Web 页面在使用 jQuery UI 小部件前必须确保 jQuery JavaScript 文件已经被包含了, 我们称这种资源先后次序称为资源依赖。

资源依赖主要通过 yii\web\AssetBundle::$depends 属性来指定, 在 AppAsset 示例中,资源包依赖其他两个资源包: yii\web\YiiAssetyii\bootstrap\BootstrapAsset 也就是该资源包的 CSS 和 JavaScript 文件要在这两个依赖包的文件包含之后才包含。

资源依赖关系是可传递,也就是说 A 依赖 B,B 依赖 C,那么 A 也依赖 C。

资源选项

可指定 cssOptionsjsOptions 属性来自定义页面包含 CSS 和 JavaScript 文件的方式, 这些属性值会分别传递给 yii\web\View::registerCssFile()yii\web\View::registerJsFile() 方法, 在视图调用这些方法包含 CSS 和 JavaScript 文件时。

注意: 在资源包类中设置的选项会应用到该包中 每个 CSS/JavaScript 文件, 如果想对每个文件使用不同的选项, 应创建不同的资源包并在每个包中使用一个选项集。

例如,只想 IE9 或更高的浏览器包含一个 CSS 文件,可以使用如下选项:

public $cssOptions = ['condition' => 'lte IE9'];

这会使包中的 CSS 文件使用以下 HTML 标签包含进来:

<!--[if lte IE9]>
<link rel="stylesheet" href="path/to/foo.css">
<![endif]-->

为链接标签包含 <noscript> 可使用如下代码:

public $cssOptions = ['noscript' => true];

为使 JavaScript 文件包含在页面 head 区域(JavaScript 文件默认包含在 body 的结束处) 使用以下选项:

public $jsOptions = ['position' => \yii\web\View::POS_HEAD];

默认情况下,当发布资源包时,所有在 yii\web\AssetBundle::$sourcePath 目录里的内容都会发布。 你可以通过配置 publishOptions 属性来自定义这种行为。 比如,为了只发布 yii\web\AssetBundle::$sourcePath 其中的某些内容或子目录里的内容, 可以在资源类中试试下面的做法:

<?php
namespace app\assets;

use yii\web\AssetBundle;

class FontAwesomeAsset extends AssetBundle 
{
    public $sourcePath = '@bower/font-awesome'; 
    public $css = [ 
        'css/font-awesome.min.css', 
    ];
    public $publishOptions = [
        'only' => [
            'fonts/',
            'css/',
        ]
    ];
}  

上述的代码为 "fontawesome" package 定义了资源包。 通过配置发布选项的 only 下标,只有 fontscss 子目录会发布。

Bower 和 NPM 资源安装

大多数 JavaScript/CSS 包使用 BowerNPM 来管理。 在 PHP 中,我们用 Composer 来管理 PHP 依赖。像 PHP 包一样, 也可以使用 composer.json 管理 Bower 和 NPM 包。

要实现这一点,需要配置一下 Composer 。有两种方法:


使用 asset-packagist 库

这种方式将满足大多数需要使用 NPM 或 Bower 包项目的要求。

注意: 从 2.0.13 开始,基本和高级应用程序模板都默认配置使用 asset-packagist , 因此你可以跳过本节。

在你项目 composer.json 文件中,添加下面几行代码:

"repositories": [
    {
        "type": "composer",
        "url": "https://asset-packagist.org"
    }
]

在你的 配置数组 中设置 @npm@bower别名

$config = [
    ...
    'aliases' => [
        '@bower' => '@vendor/bower-asset',
        '@npm'   => '@vendor/npm-asset',
    ],
    ...
];

你可以访问 asset-packagist.org 来了解它是如何工作的。

使用 fxp/composer-asset-plugin

与 asset-packagist 相比,composer-asset-plugin 不需要对应用程序配置进行任何更改。 而是需要运行以下命令来全局安装一个特殊的 Composer 插件:

composer global require "fxp/composer-asset-plugin:^1.4.1"

这个命令会全局安装 composer asset plugin 插件, 以便使用 Composer 来管理对 Bower 和 NPM 包的依赖。 在这个插件安装后, 你计算机上的每个项目都可以通过 composer.json 来管理 Bower 和 NPM 包。

如果你想要通过 Yii 来发布它们,将以下行添加到项目的 composer.json 文件中, 来调整 Bower 和 NPM 安装包的放置目录:

"config": {
    "asset-installer-paths": {
        "npm-asset-library": "vendor/npm",
        "bower-asset-library": "vendor/bower"
    }
}

注意: 与 asset-packagist 相比,使用 fxp/composer-asset-plugin 的方式, 会显著减慢 composer update 命令的速度。


在配置好 Composer 支持使用 Bower 和 NPM 之后:

  1. 编辑项目或扩展中的 composer.json 文件,在该文件的 require 字段中列举出相关包。 你应该使用 bower-asset/PackageName(对于 Bower 包)或者 npm-asset/PackageName (对于 NPM 包)的方式来引入这些包。
  2. 运行 composer update
  3. 创建资源类并列出在应用程序或扩展中所需使用的 JavaScript/CSS 文件。 你还需要配置 sourcePath 属性为 @bower/PackageName@npm/PackageName。 这是因为 Composer 会将 Bower 或 NPM 软件包安装在与此别名对应的目录中。

注意: 某些包可能会将其所有发布文件放在子目录中。在这种情况下, 你应该把子目录设为 sourcePath 的值。例如, 在 yii\web\JqueryAsset 这个资源包中,使用 @bower/jquery/dist 而不是 @bower/jquery

使用资源包

为使用资源包,先在视图中调用 yii\web\AssetBundle::register() 方法注册资源, 例如,在视图模板可使用如下代码注册资源包:

use app\assets\AppAsset;
AppAsset::register($this);  // $this 代表视图对象

信息: yii\web\AssetBundle::register() 方法返回资源包对象,该对象包含了发布资源的信息比如 basePathbaseUrl

如果在其他地方注册资源包,应提供视图对象,如在 小部件 类中注册资源包, 可以通过 $this->view 获取视图对象。

当在视图中注册一个资源包时,在背后 Yii 会注册它所依赖的资源包, 如果资源包是放在 Web 不可访问的目录下,会被发布到可访问的目录, 后续当视图渲染页面时, 会生成这些注册包包含的 CSS 和 JavaScript 文件对应的 <link><script> 标签, 这些标签的先后顺序取决于资源包的依赖关系以及在 yii\web\AssetBundle::$cssyii\web\AssetBundle::$js 的列出来的前后顺序。

动态资源包

作为常规 PHP 类,资源包可以承担一些与之相关的额外逻辑,并可以动态调整其内部参数。 比如:你也许用到某些复杂的 JavaScript 库,它提供一些用于国际化的包,并分成单独的源文件:每个文件对应于国际化中所支持的语言。 为了让这个 JavaScript 库正常工作,你需要把这些单独的语言源文件加载到页面中。 这可以通过覆盖 yii\web\AssetBundle::init() 方法来实现:

namespace app\assets;

use yii\web\AssetBundle;
use Yii;

class SophisticatedAssetBundle extends AssetBundle
{
    public $sourcePath = '/path/to/sophisticated/src';
    public $js = [
        'sophisticated.js' // file, which is always used
    ];

    public function init()
    {
        parent::init();
        $this->js[] = 'i18n/' . Yii::$app->language . '.js'; // dynamic file added
    }
}

特定的资源包也可以通过 yii\web\AssetBundle::register() 返回的实例进行调整。 例如:

use app\assets\SophisticatedAssetBundle;
use Yii;

$bundle = SophisticatedAssetBundle::register(Yii::$app->view);
$bundle->js[] = 'i18n/' . Yii::$app->language . '.js'; // dynamic file added

注意: 虽然支持资源包的动态调整,但这是一种不好的做法, 可能导致意想不到的副作用,应尽可能避免。

自定义资源包

Yii 通过配置名为 assetManager 的应用组件来使用 yii\web\AssetManager, 通过配置 yii\web\AssetManager::$bundles 属性,可以自定义资源包的行为, 例如,yii\web\JqueryAsset 资源包默认从 jquery Bower 包中使用 jquery.js 文件, 为了提高可用性和性能,你可能需要从 CDN 服务器上获取 jquery 文件, 可以在应用配置中配置 assetManager,如下所示:

return [
    // ...
    'components' => [
        'assetManager' => [
            'bundles' => [
                'yii\web\JqueryAsset' => [
                    'sourcePath' => null,   // 一定不要发布该资源
                    'js' => [
                        '//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js',
                    ]
                ],
            ],
        ],
    ],
];

可通过类似 yii\web\AssetManager::$bundles 配置多个资源包, 数组的键应为资源包的类名(最开头不要反斜杠), 数组的值为对应的配置数组.

提示: 可以根据条件判断使用哪个资源,如下示例为如何在开发环境用 jquery.js, 否则用jquery.min.js

'yii\web\JqueryAsset' => [
    'js' => [
        YII_ENV_DEV ? 'jquery.js' : 'jquery.min.js'
    ]
],

可以将资源包名称设置为 false 来禁用一个或多个资源包, 当视图中注册一个禁用资源包, 视图不会包含任何该包的资源以及不会注册它所依赖的包, 例如,为禁用 yii\web\JqueryAsset,可以使用如下配置:

return [
    // ...
    'components' => [
        'assetManager' => [
            'bundles' => [
                'yii\web\JqueryAsset' => false,
            ],
        ],
    ],
];

可以设置 yii\web\AssetManager::$bundlesfalse 来禁用 所有 的资源包。

需要记住,使用 yii\web\AssetManager::$bundles 进行自定义时,只在创建资源包时起作用,例如,在对象的构造函数阶段。 这意味着在此之后对该资源包对象所做的任何调整都将覆盖在配置数组中 yii\web\AssetManager::$bundles 的配置。 特别是:在 yii\web\AssetBundle::init() 方法内或在注册的资源包对象上进行的调整优先于 AssetManager 配置。 下面给个例子来说明在配置数组中对 yii\web\AssetManager::$bundles 的配置是不起作用的:

// Program source code:

namespace app\assets;

use yii\web\AssetBundle;
use Yii;

class LanguageAssetBundle extends AssetBundle
{
    // ...

    public function init()
    {
        parent::init();
        $this->baseUrl = '@web/i18n/' . Yii::$app->language; // 将不能通过 `AssetManager` 来管理!
    }
}
// ...

$bundle = \app\assets\LargeFileAssetBundle::register(Yii::$app->view);
$bundle->baseUrl = YII_DEBUG ? '@web/large-files': '@web/large-files/minified'; // 将不能通过 `AssetManager` 来管理!


// Application config :

return [
    // ...
    'components' => [
        'assetManager' => [
            'bundles' => [
                'app\assets\LanguageAssetBundle' => [
                    'baseUrl' => 'http://some.cdn.com/files/i18n/en' // 这行代码不起作用!
                ],
                'app\assets\LargeFileAssetBundle' => [
                    'baseUrl' => 'http://some.cdn.com/files/large-files' // 这行代码不起作用!
                ],
            ],
        ],
    ],
];

资源映射

有时你想“修复”多个资源包中资源文件的错误或者不兼容,例如包 A 使用 1.11.1 版本的 jquery.min.js, 包 B 使用 2.1.1 版本的 jquery.js,可自定义每个包来解决这个问题, 但更好的方式是使用资源部署的特性来把不正确的资源部署为想要的, 为此,配置 yii\web\AssetManager::$assetMap 属性,如下所示:

return [
    // ...
    'components' => [
        'assetManager' => [
            'assetMap' => [
                'jquery.js' => '//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js',
            ],
        ],
    ],
];

assetMap 的键为你想要修复的资源名,值为你想要使用的资源路径, 当视图注册资源包,在 cssjs 数组中每个相关资源文件会和该部署进行对比, 如果数组任何键对比为资源文件的最后文件名 (如果有的话前缀为 yii\web\AssetBundle::$sourcePath),对应的值为替换原来的资源。 例如,资源文件 my/path/to/jquery.js 匹配键 jquery.js.

注意: 只有相对路径指定的资源对应到资源部署,替换的资源路径可以为绝对路径, 也可为和 yii\web\AssetManager::$basePath 相关的路径。

资源发布

如前所述,如果资源包放在 Web 不能访问的目录, 当视图注册资源时资源会被拷贝到一个 Web 可访问的目录中, 这个过程称为资源发布asset manager 会自动处理该过程。

资源默认会发布到 @webroot/assets 目录,对应的 URL 为 @web/assets, 可配置 basePathbaseUrl 属性自定义发布位置。

除了拷贝文件方式发布资源,如果操作系统和 Web 服务器允许可以使用符号链接,该功能可以通过设置 linkAssetstrue 来启用。

return [
    // ...
    'components' => [
        'assetManager' => [
            'linkAssets' => true,
        ],
    ],
];

使用以上配置, 资源管理器会创建一个符号链接到要发布的资源包源路径, 这比拷贝文件方式快并能确保发布的资源一直为最新的。

清除缓存

对于运行在生产模式的 Web 应用程序,通常会为资源包和其他静态资源开启 HTTP 缓存。 但这种做法有个不好的地方就是,当你更新某个资源并部署到生产环境时, 客户端可能由于 HTTP 缓存而仍然使用旧版本的资源。 为了克服该不足,你可以试试清除缓存特性,它由 2.0.3 版本引入,只需如下配置 yii\web\AssetManager 即可:

return [
    // ...
    'components' => [
        'assetManager' => [
            'appendTimestamp' => true,
        ],
    ],
];

通过上述配置后,每个已发布资源的 URL 都会附加一个最后更新时间戳的信息。 比如,yii.js 的 URL 可能是 /assets/5515a87c/yii.js?v=1423448645", 这里的参数 v 表示 yii.js 文件的最后更新时间戳。 现在一旦你更新了某个资源,它的 URL 也会改变进而强制客户端获取该资源的最新版本。

常用资源包

Yii框架定义许多资源包,如下资源包是最常用, 可在你的应用或扩展代码中引用它们。

  • yii\web\YiiAsset:主要包含 yii.js 文件,该文件完成模块 JavaScript 代码组织功能, 也为 data-methoddata-confirm 属性提供特别支持和其他有用的功能。 有关 yii.js 的更多信息可以在 客户端脚本部分 中找到。
  • yii\web\JqueryAsset:包含 jQuery Bower 包的 jquery.js 文件。
  • yii\bootstrap\BootstrapAsset:包含 Twitter Bootstrap 框架的 CSS 文件。
  • yii\bootstrap\BootstrapPluginAsset:包含 Twitter Bootstrap 框架的 JavaScript 文件 来支持 Bootstrap JavaScript 插件。
  • yii\jui\JuiAsset:包含 jQuery UI 库的 CSS 和 JavaScript 文件。

如果你的代码需要 jQuery,jQuery UI 或 Bootstrap,应尽量使用这些预定义资源包而非自己创建, 如果这些包的默认配置不能满足你的需求,可以自定义配置, 详情参考自定义资源包

资源转换

除了直接编写 CSS 或 JavaScript 代码,开发人员经常使用扩展语法来编写,再使用特殊的工具将它们转换成 CSS/JavaScript。 例如,对于 CSS 代码可使用 LESSSCSS, 对于 JavaScript 可使用 TypeScript

可将使用扩展语法的资源文件列到资源包的 cssjs 中,如下所示:

class AppAsset extends AssetBundle
{
    public $basePath = '@webroot';
    public $baseUrl = '@web';
    public $css = [
        'css/site.less',
    ];
    public $js = [
        'js/site.ts',
    ];
    public $depends = [
        'yii\web\YiiAsset',
        'yii\bootstrap\BootstrapAsset',
    ];
}

当在视图中注册一个这样的资源包,asset manager 资源管理器会自动运行预处理工具将使用扩展语法 的资源转换成 CSS/JavaScript,当视图最终渲染页面时, 在页面中包含的是 CSS/Javascipt 文件, 而不是原始的扩展语法代码文件。

Yii 使用文件扩展名来表示资源使用哪种扩展语法, 默认可以识别如下语法和文件扩展名:

Yii 依靠安装的预处理工具来转换资源,例如, 为使用 LESS,应安装 lessc 预处理命令。

可配置 yii\web\AssetManager::$converter 自定义预处理命令和支持的扩展语法, 如下所示:

return [
    'components' => [
        'assetManager' => [
            'converter' => [
                'class' => 'yii\web\AssetConverter',
                'commands' => [
                    'less' => ['css', 'lessc {from} {to} --no-color'],
                    'ts' => ['js', 'tsc --out {to} {from}'],
                ],
            ],
        ],
    ],
];

如上所示,通过 yii\web\AssetConverter::$commands 属性指定支持的扩展语法, 数组的键为文件扩展名(前面不需要这样的一个小点:.), 数组的值为目标资源文件扩展名和执行资源转换的命令, 命令中的标记 {from}{to} 会分别被源资源文件路径和目标资源文件路径替代。

信息: 除了以上方式,也有其他的方式来处理扩展语法资源, 例如,可使用编译工具如grunt 来监控并自动转换扩展语法资源,此时, 应使用资源包中编译后的CSS/JavaScript文件而不是原始文件。

合并和压缩资源

一个 Web 页面可以包含很多 CSS 和 JavaScript 文件,为减少 HTTP 请求和这些下载文件的大小, 通常的方式是在页面中合并并压缩多个 CSS/JavaScript 文件为一个或很少的几个文件, 并使用压缩后的文件而不是原始文件。

信息: 合并和压缩资源通常应用在产品上线模式, 在开发模式下使用原始的 CSS/JavaScript 更方便调试。

接下来介绍一种合并和压缩资源文件 而不需要修改已有代码的方式:

  1. 找出应用中所有你想要合并和压缩的资源包,
  2. 将这些包分成一个或几个组,注意每个包只能属于其中一个组,
  3. 合并/压缩每个组里 CSS 文件到一个文件,同样方式处理 JavaScript 文件,
  4. 为每个组定义新的资源包:
    • 设置 cssjs 属性分别为压缩后的 CSS 和 JavaScript 文件;
    • 自定义设置每个组内的资源包,设置资源包的 cssjs 属性为空, 并设置它们的 depends 属性为每个组新创建的资源包。

使用这种方式,当在视图中注册资源包时,会自动触发原始包所属的组资源包的注册, 然后,页面就会包含以合并/压缩的资源文件, 而不是原始文件。

示例

使用一个示例来解释以上这种方式:

假定你的应用有两个页面 X 和 Y,页面 X 使用资源包 A,B 和 C,页面 Y 使用资源包 B,C 和 D。

有两种方式划分这些资源包,一种使用一个组包含所有资源包, 另一种是将(A,B,C)放在组 X,(B,C,D)放在组 Y, 哪种方式更好?第一种方式优点是两个页面使用相同的已合并 CSS 和 JavaScript 文件,从而使 HTTP 缓存更高效, 另一方面,由于单个组包含所有文件, 已合并的 CSS 和 JavaScipt 文件会更大,因此会增加文件传输时间,在这个示例中, 我们使用第一种方式,也就是用一个组包含所有包。

信息: 将资源包分组并不是无意义的,通常要求分析现实中不同页面各种资源的数据量, 开始时为简便使用一个组。

在所有包中使用工具(例如 Closure CompilerYUI Compressor) 来合并和压缩 CSS 和 JavaScript 文件, 注意合并后的文件满足包间的先后依赖关系, 例如,如果包 A 依赖 B,B 依赖 C 和 D,那么资源文件列表以 C 和 D 开始, 然后为 B 最后为 A。

合并和压缩之后,会得到一个 CSS 文件和一个 JavaScript 文件, 假定它们的名称为 all-xyz.cssall-xyz.jsxyz 为使文件名唯一以避免HTTP缓存问题的时间戳或哈希值。

现在到最后一步了,在应用配置中配置 asset manager 资源管理器如下所示:

return [
    'components' => [
        'assetManager' => [
            'bundles' => [
                'all' => [
                    'class' => 'yii\web\AssetBundle',
                    'basePath' => '@webroot/assets',
                    'baseUrl' => '@web/assets',
                    'css' => ['all-xyz.css'],
                    'js' => ['all-xyz.js'],
                ],
                'A' => ['css' => [], 'js' => [], 'depends' => ['all']],
                'B' => ['css' => [], 'js' => [], 'depends' => ['all']],
                'C' => ['css' => [], 'js' => [], 'depends' => ['all']],
                'D' => ['css' => [], 'js' => [], 'depends' => ['all']],
            ],
        ],
    ],
];

自定义资源包 小节中所述,如上配置改变每个包的默认行为, 特别是包 A、B、C 和 D 不再包含任何资源文件, 都依赖包含合并后的 all-xyz.cssall-xyz.js 文件的包 all, 因此,对于页面X会包含这两个合并后的文件而不是包 A、B、C 的原始文件, 对于页面 Y 也是如此。

最后有个方法更好地处理上述方式,除了直接修改应用配置文件, 可将自定义包数组放到一个文件,在应用配置中根据条件包含该文件, 例如:

return [
    'components' => [
        'assetManager' => [
            'bundles' => require __DIR__ . '/' . (YII_ENV_PROD ? 'assets-prod.php' : 'assets-dev.php'),  
        ],
    ],
];

如上所示,在产品上线模式下资源包数组存储在 assets-prod.php 文件中, 不是产品上线模式存储在 assets-dev.php 文件中。

注意: 这种资源合并的机制是基于 yii\web\AssetManager::$bundles 能够覆盖已经注册的资源包。 但是,正如前面提到的, 并不能覆盖到使用 yii\web\AssetBundle::init() 方法或在资源包对象上进行调整的资源包。 你应该避免在资源合并时使用此类动态捆绑的资源包。

使用 asset 命令

Yii 提供一个名为 asset 控制台命令来使上述操作自动处理。

为使用该命令,应先创建一个配置文件设置哪些资源包要合并以及分组方式, 可使用 asset/template 子命令来生成一个模板, 然后修改成你想要的模板。

yii asset/template assets.php

该命令在当前目录下生成一个名为 assets.php 的文件,文件的内容类似如下:

<?php
/**
 * 为控制台命令"yii asset"使用的配置文件
 * 注意在控制台环境下,一些路径别名如 '@webroot' 和 '@web' 不会存在
 * 请定义不存在的路径别名
 */
return [
    // 为JavaScript文件压缩修改 command/callback 
    'jsCompressor' => 'java -jar compiler.jar --js {from} --js_output_file {to}',
    // 为CSS文件压缩修改command/callback 
    'cssCompressor' => 'java -jar yuicompressor.jar --type css {from} -o {to}',
    // 是否在压缩后删除资源来源:
    'deleteSource' => false,
    // 要压缩的资源包列表
    'bundles' => [
        // 'yii\web\YiiAsset',
        // 'yii\web\JqueryAsset',
    ],
    // 资源包压缩后的输出
    'targets' => [
        'all' => [
            'class' => 'yii\web\AssetBundle',
            'basePath' => '@webroot/assets',
            'baseUrl' => '@web/assets',
            'js' => 'js/all-{hash}.js',
            'css' => 'css/all-{hash}.css',
        ],
    ],
    // 资源管理器配置:
    'assetManager' => [
    ],
];

应修改该文件的 bundles 的选项指定哪些包你想要合并, 在 targets 选项中应指定这些包如何分组, 如前述的可以指定一个或多个组。

注意: 由于在控制台应用别名 @webroot@web 不可用, 应在配置中明确指定它们。

JavaScript 文件会被合并压缩后写入到 js/all-{hash}.js 文件, 其中 {hash} 会被结果文件的哈希值替换。

jsCompressorcssCompressor 选项指定控制台命令或PHP回调函数来执行 JavaScript 和 CSS 合并和压缩, Yii 默认使用 Closure Compiler 来合并 JavaScript 文件, 使用 YUI Compressor 来合并 CSS 文件, 你应手工安装这些工具或修改选项使用你喜欢的工具。

根据配置文件,可执行 asset 命令来合并和压缩资源文件 并生成一个新的资源包配置文件 assets-prod.php

yii asset assets.php config/assets-prod.php

生成的配置文件可以在应用配置中包含, 如最后一小节所描述的。

注意: 如果你使用 yii\web\AssetManager::$bundlesyii\web\AssetManager::$assetMap 来自定义应用程序的资源包,并希望将此自定义应用于压缩的源文件中, 你应该在 asset 命令配置文件中的 assetManager 部分包含这些自定义的内容。

注意: 在指定压缩源时,应避免使用那些根据参数动态调整的资源包(即在 init() 方法或注册后根据参数进行动态调整的包), 因为在压缩后它们可能无法正常工作。

信息: 使用 asset 命令并不是合并和压缩资源的唯一方法。 你也可以使用能够自动运行设定任务的项目构建工具 grunt 来实现同样的目的。

资源包分组

上一小节,介绍了如何压缩所有的资源包到一个文件, 减少对应用中引用资源文件的 HTTP 请求数,但是在实践中很少这样做。 比如,应用有一个“前端”和一个“后端”, 每一个都用了一个不同 JavaScript 和 CSS 文件集合。 在这种情况下,把所有的资源包压缩到一个文件毫无意义,“前端”不会用到“后端”的资源文件, 当请求“前端”页面时,“后端”的资源文件也会被发送过来,浪费网络带宽。

为了解决这个问题,可以吧资源包分成若干组,每个组里面有若干个资源包。 下面的配置展示了如何对资源包分组:

return [
    ...
    // Specify output bundles with groups:
    'targets' => [
        'allShared' => [
            'js' => 'js/all-shared-{hash}.js',
            'css' => 'css/all-shared-{hash}.css',
            'depends' => [
                // 包含由'backend' 和 'frontend' 共享的资源包
                'yii\web\YiiAsset',
                'app\assets\SharedAsset',
            ],
        ],
        'allBackEnd' => [
            'js' => 'js/all-{hash}.js',
            'css' => 'css/all-{hash}.css',
            'depends' => [
                // 只包含 'backend' 资源:
                'app\assets\AdminAsset'
            ],
        ],
        'allFrontEnd' => [
            'js' => 'js/all-{hash}.js',
            'css' => 'css/all-{hash}.css',
            'depends' => [], // 包含所有的剩余资源
        ],
    ],
    ...
];

如上所示,资源包分成了三个组:allSharedallBackEndallFrontEnd 它们每个都依赖各自的资源包集合。 比如, allBackEnd 依赖 app\assets\AdminAsset。 当对该配置运行 asset 命令时,将会根据各自依赖合并资源包。

信息: 你也可以把某个分组的 depends 配置留空。 这样做得话, 这个分组将会依赖剩余的资源包,剩余资源包是指不被其他分组依赖的那些资源包。

亿速云
发现错别字或您认为此页面需要改进?
点此进入 Github 编辑!