《PHP教程：详解PHP的Yii框架中自带的前端资源包的使用》要点：
本文介绍了PHP教程：详解PHP的Yii框架中自带的前端资源包的使用，希望对您有用。如果有疑问，可以联系我们。
相关主题：YII框架
Yii中的资源是和Web页面相关的文件,可为CSS文件,JavaScript文件,图片或视频等, 资源放在Web可访问的目录下,直接被Web服务器调用.PHP教程
通过程序自动管理资源更好一点,例如,当你在页面中使用 yii\jui\DatePicker 小部件时, 它会自动包含需要的CSS和JavaScript文件,而不是要求你手工去找到这些文件并包含, 当你升级小部件时,它会自动使用新版本的资源文件,在本教程中,我们会详述Yii提供的强大的资源管理功能.PHP教程
资源包PHP教程
Yii在资源包中管理资源,资源包简单的说就是放在一个目录下的资源集合, 当在视图中注册一个资源包,在渲染Web页面时会包含包中的CSS和JavaScript文件.PHP教程
定义资源包PHP教程
资源包指定为继承yii\web\AssetBundle的PHP类,包名为可自动加载的PHP类名, 在资源包类中,要指定资源所在位置,包含哪些CSS和JavaScript文件以及和其他包的依赖关系.PHP教程
如下代码定义基础应用模板使用的主要资源包：PHP教程
<?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 的属性的更多详细如下所述：PHP教程
yii\web\AssetBundle::baseUrl: 指定对应到yii\web\AssetBundle::basePath目录的URL, 和 yii\web\AssetBundle::basePath 类似,如果你指定 yii\web\AssetBundle::sourcePath 属性, 资源管理器 会发布这些资源并覆盖该属性,路径别名 可在此处使用.
yii\web\AssetBundle::js: 一个包含该资源包JavaScript文件的数组,注意正斜杠"/"应作为目录分隔符, 每个JavaScript文件可指定为以下两种格式之一：PHP教程
资源位置PHP教程
资源根据它们的位置可以分为：PHP教程
源资源: 资源文件和PHP源代码放在一起,不能被Web直接访问,为了使用这些源资源,它们要拷贝到一个可Web访问的Web目录中 成为发布的资源,这个过程称为发布资源,随后会详细介绍.
发布资源: 资源文件放在可通过Web直接访问的Web目录中；
外部资源: 资源文件放在你的Web应用不同的Web服务器上；
当定义资源包类时候,如果你指定了yii\web\AssetBundle::sourcePath 属性,就表示任何使用相对路径的资源会被 当作源资源；如果没有指定该属性,就表示这些资源为发布资源(因此应指定yii\web\AssetBundle::basePath 和 yii\web\AssetBundle::baseUrl 让Yii知道它们的位置).PHP教程
推荐将资源文件放到Web目录以避免不必要的发布资源过程,这就是之前的例子指定 yii\web\AssetBundle::basePath 而不是 yii\web\AssetBundle::sourcePath.PHP教程
对于 扩展来说,由于它们的资源和源代码都在不能Web访问的目录下, 在定义资源包类时必须指定yii\web\AssetBundle::sourcePath属性.PHP教程
注意: yii\web\AssetBundle::sourcePath 属性不要用@webroot/assets,该路径默认为 yii\web\AssetManager资源管理器将源资源发布后存储资源的路径,该路径的所有内容会认为是临时文件, 可能会被删除.
资源依赖PHP教程
当Web页面包含多个CSS或JavaScript文件时,它们有一定的先后顺序以避免属性覆盖, 例如,Web页面在使用jQuery UI小部件前必须确保jQuery JavaScript文件已经被包含了, 我们称这种资源先后次序称为资源依赖.PHP教程
资源依赖主要通过yii\web\AssetBundle::depends 属性来指定, 在AppAsset 示例中,资源包依赖其他两个资源包： yii\web\YiiAsset 和 yii\bootstrap\BootstrapAsset 也就是该资源包的CSS和JavaScript文件要在这两个依赖包的文件包含 之后 才包含.PHP教程
资源依赖关系是可传递,也就是人说A依赖B,B依赖C,那么A也依赖C.PHP教程
资源选项PHP教程
可指定yii\web\AssetBundle::cssOptions 和 yii\web\AssetBundle::jsOptions 属性来自定义页面包含CSS和JavaScript文件的方式, 这些属性值会分别传递给 yii\web\View::registerCssFile() 和 yii\web\View::registerJsFile() 方法, 在视图 调用这些方法包含CSS和JavaScript文件时.PHP教程
注意: 在资源包类中设置的选项会应用到该包中 每个 CSS/JavaScript 文件,如果想对每个文件使用不同的选项, 应创建不同的资源包并在每个包中使用一个选项集.
例如,只想IE9或更高的浏览器包含一个CSS文件,可以使用如下选项：PHP教程
public $cssOptions = ['condition' => 'lte IE9'];
这会是包中的CSS文件使用以下HTML标签包含进来：PHP教程
<!--[if lte IE9]> <link rel="stylesheet" href="path/to/foo.css"> <![endif]-->
为链接标签包含<noscript>可使用如下代码：PHP教程
public $cssOptions = ['noscript' => true];
为使JavaScript文件包含在页面head区域(JavaScript文件默认包含在body的结束处)使用以下选项：PHP教程
public $jsOptions = ['position' => \yii\web\View::POS_HEAD];
Bower 和 NPM 资源PHP教程
大多数 JavaScript/CSS 包通过Bower 和/或 NPM管理, 如果你的应用或扩展使用这些包,推荐你遵循以下步骤来管理库中的资源：PHP教程
修改应用或扩展的 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.
使用资源包PHP教程
为使用资源包,在视图中调用yii\web\AssetBundle::register()方法先注册资源, 例如,在视图模板可使用如下代码注册资源包：PHP教程
use app\assets\AppAsset; AppAsset::register($this); // $this 代表视图对象
如果在其他地方注册资源包,应提供视图对象,如在 小部件 类中注册资源包, 可以通过 $this->view 获取视图对象.PHP教程
当在视图中注册一个资源包时,在背后Yii会注册它所依赖的资源包,如果资源包是放在Web不可访问的目录下,会被发布到可访问的目录, 后续当视图渲染页面时,会生成这些注册包包含的CSS和JavaScript文件对应的<link> 和 <script> 标签, 这些标签的先后顺序取决于资源包的依赖关系以及在 yii\web\AssetBundle::css和yii\web\AssetBundle::js 的列出来的前后顺序.PHP教程
自定义资源包PHP教程
Yii通过名为 assetManager的应用组件实现[[yii\web\AssetManager] 来管理应用组件, 通过配置yii\web\AssetManager::bundles 属性,可以自定义资源包的行为, 例如,yii\web\JqueryAsset 资源包默认从jquery Bower包中使用jquery.js 文件, 为了提高可用性和性能,你可能需要从Google服务器上获取jquery文件,可以在应用配置中配置assetManager,如下所示：PHP教程
return [
// ...
'components' => [
'assetManager' => [
'bundles' => [
'yii\web\JqueryAsset' => [
'sourcePath' => null, // 一定不要发布该资源
'js' => [
'//ajax.googleapis.com/ajax/libs/jquery/2.1.1/jquery.min.js',
]
],
],
],
],
];
提示: 可以根据条件判断使用哪个资源,如下示例为如何在开发环境用jquery.js,否则用jquery.min.js：PHP教程
'yii\web\JqueryAsset' => [ 'js' => [ YII_ENV_DEV ? 'jquery.js' : 'jquery.min.js' ] ],
可以设置资源包的名称对应false来禁用想禁用的一个或多个资源包,当视图中注册一个禁用资源包, 视图不会包含任何该包的资源以及不会注册它所依赖的包,例如,为禁用yii\web\JqueryAsset,可以使用如下配置：PHP教程
return [
// ...
'components' => [
'assetManager' => [
'bundles' => [
'yii\web\JqueryAsset' => false,
],
],
],
];
可设置yii\web\AssetManager::bundles为false禁用 所有 的资源包.PHP教程
资源部署PHP教程
有时你想"修复" 多个资源包中资源文件的错误/不兼容,例如包A使用1.11.1版本的jquery.min.js, 包B使用2.1.1版本的jquery.js,可自定义每个包来解决这个问题,更好的方式是使用资源部署特性来部署不正确的资源为想要的, 为此,配置yii\web\AssetManager::assetMap属性,如下所示：PHP教程
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.PHP教程
注意: 只有相对相对路径指定的资源对应到资源部署,替换的资源路径可以为绝对路径,也可为和yii\web\AssetManager::basePath相关的路径.
资源发布PHP教程
如前所述,如果资源包放在Web不能访问的目录,当视图注册资源时资源会被拷贝到一个Web可访问的目录中, 这个过程称为资源发布,yii\web\AssetManager会自动处理该过程.PHP教程
资源默认会发布到@webroot/assets目录,对应的URL为@web/assets, 可配置yii\web\AssetManager::basePath 和 yii\web\AssetManager::baseUrl 属性自定义发布位置.PHP教程
除了拷贝文件方式发布资源,如果操作系统和Web服务器允许可以使用符号链接,该功能可以通过设置 yii\web\AssetManager::linkAssets 为 true 来启用.PHP教程
return [ // ... 'components' => [ 'assetManager' => [ 'linkAssets' => true, ], ], ];
使用以上配置,资源管理器会创建一个符号链接到要发布的资源包源路径,这比拷贝文件方式快并能确保发布的资源一直为最新的.PHP教程
常用资源包PHP教程
Yii框架定义许多资源包,如下资源包是最常用,可在你的应用或扩展代码中引用它们.PHP教程
如果你的代码需要jQuery, jQuery UI 或 Bootstrap,应尽量使用这些预定义资源包而非自己创建, 如果这些包的默认配置不能满足你的需求,可以自定义配置,详情参考自定义资源包.PHP教程
资源转换PHP教程
除了直接编写CSS 和/或 JavaScript代码,开发人员经常使用扩展语法来编写,再使用特殊的工具将它们转换成CSS/Javascript. 例如,对于CSS代码可使用LESS 或 SCSS, 对于JavaScript 可使用 TypeScript.PHP教程
可将使用扩展语法的资源文件列到资源包的yii\web\AssetBundle::css 和 yii\web\AssetBundle::js中,如下所示：PHP教程
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文件,而不是原始的扩展语法代码文件.PHP教程
Yii使用文件扩展名来表示资源使用哪种扩展语法,默认可以识别如下语法和文件扩展名：PHP教程
Yii依靠安装的预处理工具来转换资源,例如,为使用LESS,应安装lessc 预处理命令.PHP教程
可配置yii\web\AssetManager::converter自定义预处理命令和支持的扩展语法,如下所示：PHP教程
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}会分别被源资源文件路径和目标资源文件路径替代.PHP教程
补充: 除了以上方式,也有其他的方式来处理扩展语法资源,例如,可使用编译工具如grunt 来监控并自动转换扩展语法资源,此时,应使用资源包中编译后的CSS/Javascript文件而不是原始文件.
合并和压缩资源PHP教程
一个Web页面可以包含很多CSS 和/或 JavaScript 文件,为减少HTTP 请求和这些下载文件的大小, 通常的方式是在页面中合并并压缩多个CSS/JavaScript 文件为一个或很少的几个文件,并使用压缩后的文件而不是原始文件.PHP教程
补充: 合并和压缩资源通常在应用在产品上线模式,在开发模式下使用原始的CSS/JavaScript更方便调试.
接下来介绍一种合并和压缩资源文件而不需要修改已有代码的方式：PHP教程
找出应用中所有你想要合并和压缩的资源包,
将这些包分成一个或几个组,注意每个包只能属于其中一个组,
合并/压缩每个组里CSS文件到一个文件,同样方式处理JavaScript文件,
为每个组定义新的资源包：
设置yii\web\AssetBundle::css 和 yii\web\AssetBundle::js 属性分别为压缩后的CSS和JavaScript文件；
自定义设置每个组内的资源包,设置资源包的yii\web\AssetBundle::css 和 yii\web\AssetBundle::js 属性为空, 并设置它们的 yii\web\AssetBundle::depends 属性为每个组新创建的资源包.
使用这种方式,当在视图中注册资源包时,会自动触发原始包所属的组资源包的注册,然后,页面就会包含以合并/压缩的资源文件, 而不是原始文件.PHP教程
示例PHP教程
使用一个示例来解释以上这种方式：PHP教程
鉴定你的应用有两个页面X 和 Y,页面X使用资源包A,B和C,页面Y使用资源包B,C和D.PHP教程
有两种方式划分这些资源包,一种使用一个组包含所有资源包,另一种是将(A,B,C)放在组X,(B,C,C)放在组Y, 哪种方式更好?第一种方式优点是两个页面使用相同的已合并CSS和JavaScript文件使HTTP缓存更高效,另一方面,由于单个组包含所有文件, 已合并的CSS和Javascipt文件会更大,因此会增加文件传输时间,在这个示例中,我们使用第一种方式,也就是用一个组包含所有包.PHP教程
补充: 将资源包分组并不是无价值的,通常要求分析现实中不同页面各种资源的数据量,开始时为简便使用一个组.
在所有包中使用工具(例如 Closure Compiler, YUI Compressor) 来合并和压缩CSS和JavaScript文件, 注意合并后的文件满足包间的先后依赖关系,例如,如果包A依赖B,B依赖C和D,那么资源文件列表以C和D开始,然后为B最后为A.PHP教程
合并和压缩之后,会得到一个CSS文件和一个JavaScript文件,假定它们的名称为all-xyz.css 和 all-xyz.js, xyz 为使文件名唯一以避免HTTP缓存问题的时间戳或哈希值.PHP教程
现在到最后一步了,在应用配置中配置yii\web\AssetManager 资源管理器如下所示：PHP教程
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也是如此.PHP教程
最后有个方法更好地处理上述方式,除了直接修改应用配置文件,可将自定义包数组放到一个文件,在应用配置中根据条件包含该文件,例如：PHP教程
return [ 'components' => [ 'assetManager' => [ 'bundles' => require(__DIR__ . '/' . (YII_ENV_PROD ? 'assets-prod.php' : 'assets-dev.php')), ], ], ];
如上所示,在产品上线模式下资源包数组存储在assets-prod.php文件中,不是产品上线模式存储在assets-dev.php文件中.PHP教程
使用 asset 命令PHP教程
Yii提供一个名为asset控制台命令来使上述操作自动处理.PHP教程
为使用该命令,应先创建一个配置文件设置哪些资源包要合并以及分组方式,可使用asset/template 子命令来生成一个模板, 然后修改模板成你想要的.PHP教程
yii asset/template assets.php
该命令在当前目录下生成一个名为assets.php的文件,文件的内容类似如下：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选项中应指定这些包如何分组,如前述的可以指定一个或多个组.PHP教程
注意: 由于在控制台应用别名 @webroot and @web 不可用,应在配置中明确指定它们.
JavaScript文件会被合并压缩后写入到js/all-{hash}.js文件,其中 {hash} 会被结果文件的哈希值替换.PHP教程
jsCompressor 和 cssCompressor 选项指定控制台命令或PHP回调函数来执行JavaScript和CSS合并和压缩, Yii默认使用Closure Compiler来合并JavaScript文件, 使用YUI Compressor来合并CSS文件, 你应手工安装这些工具或修改选项使用你喜欢的工具.PHP教程
根据配置文件,可执行asset 命令来合并和压缩资源文件并生成一个新的资源包配置文件assets-prod.php:PHP教程
yii asset assets.php config/assets-prod.php
PHP教程
维易PHP培训学院每天发布《PHP教程：详解PHP的Yii框架中自带的前端资源包的使用》等实战技能，PHP、MYSQL、LINUX、APP、JS,CSS全面培养人才。
转载请注明本页网址：
http://www.vephp.com/jiaocheng/7000.html
