使用grunt完成requirejs的合併壓縮和js文件的版本控制

最近有一個項目使用了 requirejs 來解決前端的模塊化，可是隨着頁面和模塊的愈來愈多，我發現我快要hold不住這些可愛的js文件了，具體表如今每一個頁面都要設置一堆 requirejs 的配置( baseUrl ， paths 之類的)。

不知誰說過，一些事重複作了三次，就該考慮一下自動化了，因而我當心翼翼的掏出了個人 grunt 。

咱們得使用 grunt-contrib-requirejs 這個插件來實現如上所說的自動化功能，這個就是根據 r.js 封裝的 grunt 插件。

 

安裝 grunt-contrib-requirejs

npm i --save-dev grunt-contrib-requirejs

 

配置 Grantfile

首先咱們來看下項目目錄

src 是每一個頁面的依賴文件

modules 和 lib 是一些模塊和庫

dist 是合併壓縮後的文件

在 Gruntfile 中首先獲得須要處理的文件列表，並建立一個空對象，用來裝requirejs的配置

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

而後遍歷這個文件列表數組，獲得js文件的名稱：

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

接下來爲每一個js文件配置一個任務，任務名稱就是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 配置並加載並註冊任務

grunt.initConfig({
    requirejs: requireOptions }) grunt.loadNpmTasks('grunt-contrib-requirejs'); grunt.registerTask('require', ['requirejs']);

到這裏 requirejs 的配置部分就結束了，在命令行輸入 grunt require 就會看到 static/js/dist 目錄下面有東西蹦出來了，並且所有都是合併後並壓縮好的。

在html頁面中只須要：

<script src="static/js/require.js"></script> <script src="static/js/dist/index.js"></script>

就能成功加載了。

 

增長js文件的版本號

瀏覽器有時會對加載過的js或css進行緩存，若是你的某些js依賴發生改變，那麼就可能發生錯誤，解決辦法是在文件後面增長查詢字符串，例如 a.js?v=dsd712sd

那麼如何控制版本，首先咱們確定想到用 new Date() ，可是若是每次發佈都讓瀏覽器從新加載（儘管有些文件根本就沒有改變），不免會形成浪費。正確的方案是根據文件內容生成MD5值來做爲版本號，這樣當文件沒有改變時，hash就不會變。

那麼如何自動解決版本號的問題，咱們能夠用到 asset-cache-control 這個grunt插件

首先安裝：

npm i --save-dev asset-cache-control

asset-cache-control 的用法個很簡單，只要設置一個源文件，再設置html文件的路徑就能夠了

grunt.initConfig({
    cache: { demo: { assetUrl: 'js/demo.js', tmp: ['demo.html'] } } })

注意的是：html文件中須要引入 js/demo.js

<script src='js/demo.js'></script>

而後加載和註冊 asset-cache-control 插件

grunt.loadNpmTasks('asset-cache-control'); grunt.registerTask('cache', ['cache']);

接着在命令行敲 grunt cache 就會發現 index.html 中的 script 標籤加上了查詢字符串。

<script src='js/demo.js?t=92e26c5d'></script>

對每一個js文件配置 cache 的任務：

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 中配置：

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 任務。

 

完整配置清單

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', 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' } }; cacheOptions[filename] = { assetUrl: 'static/js/dist/' + filename +'.js', files: { 'tmp': [filename+'.php'] } } }); grunt.initConfig({ requirejs: requireOptions, cache: cacheOptions, watch: { files: ['static/js/src/*.js','static/js/modules/*.js'], tasks: ['requirejs', 'cache'], options: { spawn: false } } }); grunt.loadNpmTasks('asset-cache-control'); grunt.loadNpmTasks('grunt-contrib-requirejs'); grunt.loadNpmTasks('grunt-contrib-watch'); grunt.registerTask('require', ['requirejs','cache']) };

另外，瀏覽器加載一個大文件比加載n個小文件的效率要高不少，因此模塊的合併對性能也有很大的提升。