使用gulp自动化打包合并前端静态资源（CSS、JS文件压缩、添加版本号）

现在正在做的项目更新迭代比较频繁，会经常对前端代码打包部署，手动整合代码文件很麻烦并且浪费时间，所以决定使用gulp来代替手工完成这项工作。

前端静态资源在发版更新时会面临客户端浏览器缓存的问题（可参考这篇文章），解决这个问题可以采用两类方法：覆盖方法（引用资源时加版本号，不修改资源文件名）、非覆盖方法（修改资源文件名），本篇文章主要采用的是第一种加版本号的方式，主要用gulp给静态资源自动加版本号和压缩CSS、JS。

原理：通过对JS，CSS文件内容进行Hash运算，生成一个文件的唯一Hash字符串，若对文件内容进行了修改则Hash号会发生变化。在HTML中引用文件时将版本号加在后面。

原始HTML：

<link href="css/global.css" rel="stylesheet" type="text/css" />
<script src="js/fun.js"></script>

使用后HTML：

<link href="css/global.css?v=b40a6f2a9f" rel="stylesheet" type="text/css" />
<script src="js/fun.js?v=3a08b5fa87"></script>

一、环境配置（安装gulp）

首先安装node、npm（此处省略）

安装gulp以及用到的插件，并在项目目录下创建文件gulpfile.js。

$ npm install --global gulp    --安装全局gulp
$ npm install --save-dev gulp
$ npm install --save-dev gulp-rev
$ npm install --save-dev gulp-rev-collector
$ npm install --save-dev run-sequence
$ npm install --save-dev gulp-clean
$ npm install --save-dev gulp-minify-css
$ npm install --save-dev gulp-uglify

在项目目录下创建文件gulpfile.js

项目目录结构：

node_modules中是安装的gulp和各种插件

二、编写gulpfile.js

//引入gulp和gulp插件
var gulp = require('gulp'),
    runSequence = require('run-sequence'),
    rev = require('gulp-rev'),
    clean = require('gulp-clean'),
    minifycss=require('gulp-minify-css'),
    uglify=require('gulp-uglify'),
    revCollector = require('gulp-rev-collector');

//定义css、js源文件路径
var cssSrc = './**/*.css',            //选择目录下所有css
      jsSrc = './**/*.js',     //选择目录下所有css
      srcExclude = '!./node_modules/**/*',    //排除node_modules中的文件
      cssFile = 'css/**/*',    //css文件夹
      imageFile = 'image/**/*',    //图片文件夹
      jsFile = 'js/**/*',    //js文件夹
      jsCompressPath = 'Publish/js/*.js',    //压缩Publish中的js
      cssCompressPath = 'Publish/css/*.css';    //压缩Publish中的css


//CSS生成文件hash编码并生成 rev-manifest.json文件名对照映射
gulp.task('revCss', function(){
    return gulp.src([cssSrc, srcExclude])
        .pipe(rev())
        .pipe(rev.manifest())
        .pipe(gulp.dest('rev/css'));
});

//js生成文件hash编码并生成 rev-manifest.json文件名对照映射
gulp.task('revJs', function(){
    return gulp.src([jsSrc, srcExclude])
        .pipe(rev())
        .pipe(rev.manifest())
        .pipe(gulp.dest('rev/js'));
});


//Html替换css、js文件版本
gulp.task('revHtml', function () {
    return gulp.src(['rev/**/*.json', '*.html'])
        .pipe(revCollector())
        .pipe(gulp.dest('Publish'));
});

//拷贝除HTML外其他的文件
gulp.task('copy', function(){
    return gulp.src([cssFile, jsFile, imageFile],{ base: '.'})
        .pipe(gulp.dest('Publish'));
});

//压缩JS
gulp.task('jscompress', function(){
    return gulp.src(jsCompressPath)
        .pipe(uglify())
        .pipe(gulp.dest("Publish/js"));
});

//压缩CSS
gulp.task('csscompress', function(){
    return gulp.src(cssCompressPath)
        .pipe(minifycss())
        .pipe(gulp.dest("Publish/css"));
});

//开发构建
gulp.task('dev', function (done) {
    condition = false;
    runSequence(
        ['clean'],
        ['revCss'],
        ['revJs'],
        ['revHtml'],
        ['copy'],
        ['jscompress'],
        ['csscompress'],
        done);
});

gulp.task('clean', function(){
    gulp.src('rev',{read:false}).pipe(clean());
    return gulp.src('Publish',{read:false}).pipe(clean());
});


gulp.task('default', ['dev']);

三、更改插件代码

在项目目录下直接执行gulp命令

$ gulp

会得到如下效果：

<link href="css/global-b40a6f2a9f.css" rel="stylesheet" type="text/css" />
<script src="js/fun-3a08b5fa87.js"></script>

需要更改gulp-rev、rev-path、gulpl-rev-collector插件的代码：

1.node_modules/gulp-rev/index.js

第135行：manifest[originalFile] = revisionedFile;

更改为：manifest[originalFile] = originalFile + '?v=' + file.revHash;

2.node_modules/rev-path/index.js

第9行：return modifyFilename(pth, (filename, ext) => `${filename}-${hash}${ext}`);

更改为：return modifyFilename(pth, (filename, ext) => `${filename}${ext}`);

3.node_modules/gulp-rev-collector/index.js

第40行：var cleanReplacement =  path.basename(json[key]).replace(new RegExp( opts.revSuffix ), '' );

更改为：var cleanReplacement = path.basename(json[key]).split('?')[0];

这里需要注意插件的版本不一样，需要改动的地方会有不同；

本文这里所有插件的版本为：

gulp@3.9.1
gulp-rev@8.1.1
gulp-rev-collector@1.2.4
rev-path@2.0.0
run-sequence@2.2.1
gulp-clean@0.4.0
gulp-minify-css@1.2.4
gulp-uglify@3.0.0

改完之后的效果

<link href="css/global.css?v=b40a6f2a9f" rel="stylesheet" type="text/css" />
<script src="js/fun.js?v=3a08b5fa87"></script>

四、小结

gulp的任务的执行是异步的，想要保证任务执行的顺序，需要使用run-sequence插件

gulp.task('dev', function (done) {
    condition = false;
    runSequence(
        ['clean'],
        ['revCss'],
        ['revJs'],
        ['revHtml'],
        ['copy'],
        ['jscompress'],
        ['csscompress'],
        done);
});

这里顺序执行任务：

先清除旧的rev和Pulish文件夹及其目录下所有文件（clean），之后生成CSS文件名对照映射的JSON文件（revCSS），再之后生成JS文件名对照映射的JSON文件（revJS），之后替换掉HTML中的链接，加上版本号（revHTML），将除了HTML之外其他的静态资源拷贝到Publish中（copy），然后压缩Publish/js中的JS文件，并将压缩后的文件替换掉原来的未压缩文件（jscompress），最后压缩Publish/css中的CSS文件，并替换掉未压缩文件（csscompress）。

PS：

1.在写路径时，"!"是排除的标识，可以排除一些文件，如：

gulp.src(['./**/*.css', '!./node_modules/**/*'])

这里选中的文件就是除了node_modules中的其他文件夹下的CSS文件

2.拷贝时若要保持路径，需要加一个base选项，即：

gulp.src('Publish/css/*.css',{ base: '.'})

 之后也可以分别对测试环境和生产环境编写任务，使用命令分开打包。