Gulp4.0实现静态资源自动添加版本号清缓存

为什么要给静态资源添加版本号


浏览器默认会缓存网站的静态资源文件,缓存虽然在一般情况下可以提供网站的访问速度,以及减少服务器压力,但有时也会造成静态资源修改了却不能及时更新的困扰。解决这种问题最简单的方式就是在资源后添加一个版本号。形如:
js?v=1.0.0

目前前端实现自动添加版本号方案的主流方案有两种,分别通过Gulp和Webpack实现。本文旨在探讨Gulp4.0下的实现方式(网上关于Gulp添加版本号的文章虽然诸多,但大部分是基于Gulp3.0的。偶有基于4.0的,又因为依赖组件版本不对导致出问题)。

gulp实现流程

准备工作


首先安装好gulp及其环境(教程很多)。
进去本地项目。依次执行

npm install --save-dev gulp

npm install --save-dev gulp-rev

npm install --save-dev gulp-rev-collector

Gulp实现自动添加版本号主要依赖的就是gulp-rev组件。但是只靠这个组件是我们追求的版本号效果的。gulp-rev安装后实现的效果如下:

<link rel="stylesheet" href="css/test-8688d776d1.css">
但实际上我们想要的效果如下:
<link rel="stylesheet" href="css/test.css?v=8688d776d1">

为了实现这个效果,我们需要手动修改node_modules下相关依赖组件的源码。

1、打开node_modules\gulp-rev\index.js找到
manifest[originalFile] = revisionedFile;
替换为:
manifest[originalFile] = originalFile + '?v=' + file.revHash;

2、打开node_modules\gulp-rev-collector\index.js找到
var cleanReplacement = path.basename(json[key]).replace(new RegExp( opts.revSuffix ), '' );
替换为:
var cleanReplacement = path.basename(json[key]).split('?')[0];

找到
regexp: new RegExp( prefixDelim + pattern, 'g' ),
替换为:
regexp: new RegExp( prefixDelim + pattern + '(\\?v=\\w{10})?', 'g' ),

编写gulpfile.js文件

以我的项目为例:

const gulp = require('gulp'),
       rev = require('gulp-rev'),
       revCollector = require('gulp-rev-collector');
 gulp.task('revCss', (done) => {
    gulp.src(cssSrc)
        .pipe(rev())
        .pipe(rev.manifest())
        .pipe(gulp.dest('rev/css'));
    done();
});
//js生成文件hash编码并生成 rev-manifest.json文件名对照映射
gulp.task('revJs', (done) => {
    gulp.src(jsSrc)
        .pipe(rev())
        .pipe(rev.manifest())
        .pipe(gulp.dest('rev/js'));
    done();
});

gulp.task('revHtml', () => {
    return gulp.src(['rev/**/*.json', 'public/*.html'])
        .pipe(revCollector())
        .pipe(gulp.dest('public/'));
});

gulp.task('revAll', gulp.series('revCss', 'revJs', 'revHtml', (done) => { done()}));

gulp.task('watch', (done) => {
    gulp.watch(cssSrc, gulp.series('revAll'));
    gulp.watch(jsSrc, gulp.series('revAll'));
    done();
})

最后运行gulp即可。
微信截图_20191113111708.png

评论

暂无评论