详解PHP的Yii框架中自带的前端资源包的使用

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',
 ];
 public $js = [
 ];
 public $depends = [
  'yii\web\yiiasset',
  'yii\bootstrap\bootstrapasset',
 ];
}

如上appasset 类指定资源文件放在 @webroot 目录下，对应的url为 @web，资源包中包含一个css文件 css/site.css，没有javascript文件， 依赖其他两个包 yii\web\yiiasset 和 yii\bootstrap\bootstrapasset， 关于yii\web\assetbundle 的属性的更多详细如下所述：

• yii\web\assetbundle::sourcepath: 指定包包含资源文件的根目录， 当根目录不能被web访问时该属性应设置，否则，应设置 yii\web\assetbundle::basepath 属性和yii\web\assetbundle::baseurl。 路径别名 可在此处使用；
• yii\web\assetbundle::basepath: 指定包含资源包中资源文件并可web访问的目录， 当指定yii\web\assetbundle::sourcepath 属性， 资源管理器 会发布包的资源到一个可web访问并覆盖该属性， 如果你的资源文件在一个web可访问目录下，应设置该属性，这样就不用再发布了。 路径别名 可在此处使用。

yii\web\assetbundle::baseurl: 指定对应到yii\web\assetbundle::basepath目录的url， 和 yii\web\assetbundle::basepath 类似，如果你指定 yii\web\assetbundle::sourcepath 属性， 资源管理器 会发布这些资源并覆盖该属性，路径别名 可在此处使用。
yii\web\assetbundle::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.
• yii\web\assetbundle::css: 一个包含该资源包javascript文件的数组，该数组格式和 yii\web\assetbundle::js 相同。
• yii\web\assetbundle::depends: 一个列出该资源包依赖的其他资源包（后两节有详细介绍）。
• yii\web\assetbundle::jsoptions: 当调用yii\web\view::registerjsfile()注册该包 每个 javascript文件时， 指定传递到该方法的选项。
• yii\web\assetbundle::cssoptions: 当调用yii\web\view::registercssfile()注册该包 每个 css文件时， 指定传递到该方法的选项。
• yii\web\assetbundle::publishoptions: 当调用yii\web\assetmanager::publish()发布该包资源文件到web目录时 指定传递到该方法的选项，仅在指定了yii\web\assetbundle::sourcepath属性时使用。

资源位置

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

源资源: 资源文件和php源代码放在一起，不能被web直接访问，为了使用这些源资源，它们要拷贝到一个可web访问的web目录中 成为发布的资源，这个过程称为发布资源，随后会详细介绍。
发布资源: 资源文件放在可通过web直接访问的web目录中；
外部资源: 资源文件放在你的web应用不同的web服务器上；
当定义资源包类时候，如果你指定了yii\web\assetbundle::sourcepath 属性，就表示任何使用相对路径的资源会被 当作源资源；如果没有指定该属性，就表示这些资源为发布资源（因此应指定yii\web\assetbundle::basepath 和 yii\web\assetbundle::baseurl 让yii知道它们的位置）。

推荐将资源文件放到web目录以避免不必要的发布资源过程，这就是之前的例子指定 yii\web\assetbundle::basepath 而不是 yii\web\assetbundle::sourcepath.

对于 扩展来说，由于它们的资源和源代码都在不能web访问的目录下， 在定义资源包类时必须指定yii\web\assetbundle::sourcepath属性。

注意: yii\web\assetbundle::sourcepath 属性不要用@webroot/assets，该路径默认为 yii\web\assetmanager资源管理器将源资源发布后存储资源的路径，该路径的所有内容会认为是临时文件， 可能会被删除。
资源依赖

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

资源依赖主要通过yii\web\assetbundle::depends 属性来指定， 在appasset 示例中，资源包依赖其他两个资源包： yii\web\yiiasset 和 yii\bootstrap\bootstrapasset 也就是该资源包的css和javascript文件要在这两个依赖包的文件包含 之后 才包含。

资源依赖关系是可传递，也就是人说a依赖b，b依赖c，那么a也依赖c。

资源选项

可指定yii\web\assetbundle::cssoptions 和 yii\web\assetbundle::jsoptions 属性来自定义页面包含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];

bower 和 npm 资源

大多数 javascript/css 包通过bower 和/或 npm管理， 如果你的应用或扩展使用这些包，推荐你遵循以下步骤来管理库中的资源：

修改应用或扩展的 composer.json 文件将包列入require 中， 应使用bower-asset/packagename (bower包) 或 npm-asset/packagename (npm包)来对应库。
创建一个资源包类并将你的应用或扩展要使用的javascript/css 文件列入到类中， 应设置 yii\web\assetbundle::sourcepath 属性为@bower/packagename 或 @npm/packagename， 因为根据别名composer会安装bower或npm包到对应的目录下。
注意: 一些包会将它们分布式文件放到一个子目录中，对于这种情况，应指定子目录作为 yii\web\assetbundle::sourcepath属性值，例如，yii\web\jqueryasset使用 @bower/jquery/dist 而不是 @bower/jquery。
使用资源包

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

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

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

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

自定义资源包

yii通过名为 assetmanager的应用组件实现[[yii\web\assetmanager] 来管理应用组件， 通过配置yii\web\assetmanager::bundles 属性，可以自定义资源包的行为， 例如，yii\web\jqueryasset 资源包默认从jquery bower包中使用jquery.js 文件， 为了提高可用性和性能，你可能需要从google服务器上获取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::bundles为false禁用 所有 的资源包。

资源部署

有时你想"修复" 多个资源包中资源文件的错误/不兼容，例如包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',
   ],
  ],
 ],
];

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

注意: 只有相对相对路径指定的资源对应到资源部署，替换的资源路径可以为绝对路径，也可为和yii\web\assetmanager::basepath相关的路径。
资源发布

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

资源默认会发布到@webroot/assets目录，对应的url为@web/assets， 可配置yii\web\assetmanager::basepath 和 yii\web\assetmanager::baseurl 属性自定义发布位置。

除了拷贝文件方式发布资源，如果操作系统和web服务器允许可以使用符号链接，该功能可以通过设置 yii\web\assetmanager::linkassets 为 true 来启用。

return [
 // ...
 'components' => [
  'assetmanager' => [
   'linkassets' => true,
  ],
 ],
];

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

常用资源包

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

• yii\web\yiiasset: 主要包含yii.js 文件，该文件完成模块javascript代码组织功能， 也为 data-method 和 data-confirm属性提供特别支持和其他有用的功能。
• 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代码可使用less 或 scss， 对于javascript 可使用 typescript。

可将使用扩展语法的资源文件列到资源包的yii\web\assetbundle::css 和 yii\web\assetbundle::js中，如下所示：

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',
 ];
}

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

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

• less: .less
• scss: .scss
• stylus: .styl
• coffeescript: .coffee
• typescript: .ts

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更方便调试。
接下来介绍一种合并和压缩资源文件而不需要修改已有代码的方式：

找出应用中所有你想要合并和压缩的资源包，
将这些包分成一个或几个组，注意每个包只能属于其中一个组，
合并/压缩每个组里css文件到一个文件，同样方式处理javascript文件，
为每个组定义新的资源包：
设置yii\web\assetbundle::css 和 yii\web\assetbundle::js 属性分别为压缩后的css和javascript文件；
自定义设置每个组内的资源包，设置资源包的yii\web\assetbundle::css 和 yii\web\assetbundle::js 属性为空, 并设置它们的 yii\web\assetbundle::depends 属性为每个组新创建的资源包。
使用这种方式，当在视图中注册资源包时，会自动触发原始包所属的组资源包的注册，然后，页面就会包含以合并/压缩的资源文件， 而不是原始文件。

示例

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

鉴定你的应用有两个页面x 和 y，页面x使用资源包a，b和c，页面y使用资源包b，c和d。

有两种方式划分这些资源包，一种使用一个组包含所有资源包，另一种是将（a,b,c）放在组x，（b，c，c）放在组y， 哪种方式更好？第一种方式优点是两个页面使用相同的已合并css和javascript文件使http缓存更高效，另一方面，由于单个组包含所有文件， 已合并的css和javascipt文件会更大，因此会增加文件传输时间，在这个示例中，我们使用第一种方式，也就是用一个组包含所有包。

补充: 将资源包分组并不是无价值的，通常要求分析现实中不同页面各种资源的数据量，开始时为简便使用一个组。
在所有包中使用工具(例如 closure compiler, yui compressor) 来合并和压缩css和javascript文件， 注意合并后的文件满足包间的先后依赖关系，例如，如果包a依赖b，b依赖c和d，那么资源文件列表以c和d开始，然后为b最后为a。

合并和压缩之后，会得到一个css文件和一个javascript文件，假定它们的名称为all-xyz.css 和 all-xyz.js， xyz 为使文件名唯一以避免http缓存问题的时间戳或哈希值。

现在到最后一步了，在应用配置中配置yii\web\assetmanager 资源管理器如下所示：

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.css 和 all-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文件中。

使用 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}',
 // 要压缩的资源包列表
 '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 and @web 不可用，应在配置中明确指定它们。
javascript文件会被合并压缩后写入到js/all-{hash}.js文件，其中 {hash} 会被结果文件的哈希值替换。

jscompressor 和 csscompressor 选项指定控制台命令或php回调函数来执行javascript和css合并和压缩， yii默认使用closure compiler来合并javascript文件， 使用yui compressor来合并css文件， 你应手工安装这些工具或修改选项使用你喜欢的工具。

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

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