微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

详解使用grunt完成requirejs的合并压缩和js文件的版本控制

最近有一个项目使用了 requirejs 解决前端的模块化,但是随着页面和模块的越来越多,我发现我快要hold不住这些可爱的js文件了,具体表现在每个页面都要设置一堆 requirejs 的配置( baseUrl paths 之类的)。

不知谁说过,一些事重复做了三次,就该考虑一下自动化了,于是我小心翼翼的掏出了我的 grunt

我们得使用 grunt-contrib-requirejs 这个插件来实现如上所说的自动功能,这个就是根据 r.js 封装的 grunt 插件

安装 grunt-contrib-requirejs

rush:bash;"> npm i --save-dev grunt-contrib-requirejs

配置 Grantfile

首先我们来看下项目目录

src 是每个页面的依赖文件

moduleslib 是一些模块和库

dist 是合并压缩后的文件

Gruntfile 中首先得到需要处理的文件列表,并创建一个空对象,用来装requirejs的配置

rush:js;"> var files = grunt.file.expand('static/js/src/*.js'); var requireOptions = {};

然后遍历这个文件列表数组,得到js文件名称

rush:js;"> files.forEach(function (file) { var filenamelist = file.split('/'); var num = filenamelist.length; var filename = filenamelist[num - 1].replace(/\.js$/,''); }

接下来为每个js文件配置一个任务,任务名称就是js的文件名称

rush:js;"> files.forEach(function (file) { requireOptions[filename] = { options: { baseUrl: 'static/js',paths: { jquery: 'lib/jquery.min',lrz: 'lib/lrz.all.bundle',zepto: 'lib/zepto.min',ajax: 'modules/ajax',validators: 'modules/validators',page: 'modules/mixins/to_page',dialog: 'modules/mixins/toggle_login_dialog',},optimizeAllPluginResources: true,name: 'src/' + filename,out: 'static/js/dist/' + filename + '.js' } }; }

接着初始化 grunt 配置并加载并注册任务

rush:js;"> grunt.initConfig({ requirejs: requireOptions })

grunt.loadNpmtasks('grunt-contrib-requirejs');
grunt.registerTask('require',['requirejs']);

到这里 requirejs 的配置部分就结束了,在命令行输入 grunt require 就会看到 static/js/dist 目录下面有东西蹦出来了,而且全部都是合并后并压缩好的。

在html页面中只需要:

rush:js;">

就能成功加载了。

增加js文件的版本号

浏览器有时会对加载过的js或css进行缓存,如果你的某些js依赖发生改变,那么就可能发生错误解决办法是在文件后面增加查询字符串,例如 a.js?v=dsd712sd

那么如何控制版本,首先我们肯定想到用 new Date() ,但是如果每次发布都让浏览器重新加载(尽管有些文件根本就没有改变),难免会造成浪费。正确的方案是根据文件内容生成MD5值来作为版本号,这样当文件没有改变时,hash就不会变。

那么如何自动解决版本号的问题,我们可以用到 asset-cache-control 这个grunt插件

首先安装:

rush:bash;"> npm i --save-dev asset-cache-control

asset-cache-control 用法个很简单,只要设置一个文件,再设置html文件的路径就可以了

rush:bash;"> grunt.initConfig({ cache: { demo: { assetUrl: 'js/demo.js',tmp: ['demo.html'] } } })

注意的是:html文件中需要引入 js/demo.js

rush:js;">

然后加载和注册 asset-cache-control 插件

rush:js;"> grunt.loadNpmtasks('asset-cache-control'); grunt.registerTask('cache',['cache']);

接着在命令行敲 grunt cache 就会发现 index.html 中的 script 标签加上查询字符串。

rush:js;">

对每个js文件配置 cache 的任务:

rush:js;"> var files = grunt.file.expand('static/js/src/*.js'); var cacheOptions ={}; files.forEach(function (file) { var filenamelist = file.split('/'); var num = filenamelist.length; var filename = filenamelist[num - 1].replace(/\.js$/,''); cacheOptions[filename] = { assetUrl: 'static/js/dist/' + filename +'.js',files: { 'tmp': [filename+'.PHP'] } } });

检测每个文件的变化,自动执行任务

用到 grunt-contrib-watch 这个官方组件

grunt.initConfig 中配置:

rush:js;"> watch: { files: ['static/js/src/*.js','static/js/modules/*.js'],tasks: ['requirejs','cache'],options: { spawn: false } }

这样,当你修改 static/js/src/ static/js/modules/ 下的所有js文件时,就会执行 requirejs cache 任务。

完整配置清单

rush:js;"> module.exports = function (grunt) { var files = grunt.file.expand('static/js/src/*.js'); var requireOptions = {}; var cacheOptions ={}; files.forEach(function (file) { var filenamelist = file.split('/'); var num = filenamelist.length; var filename = filenamelist[num - 1].replace(/\.js$/,''); requireOptions[filename] = { options: { baseUrl: 'static/js',paths: { jquery: 'lib/jquery.min',out: 'static/js/dist/' + filename + '.js' } }; cacheOptions[filename] = { assetUrl: 'static/js/dist/' + filename +'.js',files: { 'tmp': [filename+'.PHP'] } } });

grunt.initConfig({
requirejs: requireOptions,cache: cacheOptions,watch: {
files: ['static/js/src/*.js',options: {
spawn: false
}
}
});

grunt.loadNpmtasks('asset-cache-control');
grunt.loadNpmtasks('grunt-contrib-requirejs');
grunt.loadNpmtasks('grunt-contrib-watch');
grunt.registerTask('require',['requirejs','cache'])
};

另外,浏览器加载一个文件比加载n个小文件的效率要高很多,所以模块的合并对性能也有很大的提高。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持编程之家。

原文地址:https://www.jb51.cc/js/41148.html

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。

相关推荐