基于 gulp 的自动化构建之“静态资源版本管理”

在静态资源版本管理方面,以前用过两种方案(都是通过后端实现) :
第一种:获取文件最新修改时间。可以实现比较好的版本管理效果,但客户端每一次访问一个资源文件,服务器都会动态读取一次该文件的最新修改时间。对这种方案,头脑有限,暂时无法评估其对性能和访问速度的影响。但就版本管理效果来说,更倾向于这一种。
第二种:设置日期常量。版本管理效果非常差。

目前已实现的新方案如下:
在构建阶段计算静态资源的 hash 值,并将该值以参数的形式追加到<link><script>中的 URL。
大家需要知道的是,如果某个文件发生了修改,我这里会自动修改引用了该文件的各个模块的view文件。
此方案可实现真正的版本管理效果,并且可以确定对性能和访问速度无影响。

1. 默认方案:

如果使用gulp-rev + gulp-rev-collector,默认效果如下:

"/css/style.css" => "/dist/css/style-1d87bebe.css"    
"/js/script1.js" => "/dist/script1-61e0be79.js"    
"cdn/image.gif"  => "//cdn8.example.dot/img/image-35c3af8134.gif"

但是如果用上面方法,实现的是非覆盖式更新:即每次修改文件之后,生成带新版本号的文件,但是带旧版本号的文件不会被删除,长此以往,最后你会发现文件夹里累积了大量带旧版本号的无用文件。例如,style.css文件经过三次更新之后,会累积一下三个文件:

style-a3654c03aa.css
style-98c5f098bd.css
style-6e4cfcf9de.css

2. 改良方案:

期望效果:

href="dist/css/style.css" => href="dist/css/style.css?v=1d87bebe"
src="dist/js/all.min.js" => src="dist/js/all.min.js?v=98c5f098bd"
src="dist/img/image.gif"  => src="dist/img/image.gif?v=35c3af8134"

原理:

(1)gulp-rev根据文件内容计算生成一个 hash 字符串,如:98c5f098bd
(2)gulp-rev生成一个映射表,列出映射关系

{
  "all.min.js": "all.min.js?v=98c5f098bd"
}

(3)gulp-rev-collector根据该映射表 将<link><script>URL中的文件名all.min.js替换为all.min.js?v=98c5f098bd

如何修改?

需要对gulp-revgulp-rev-collector进行修改。修改如下:

修改映射表中 属性值的格式:
打开node_modules\gulp-rev\index.js

第133行 manifest[originalFile] = revisionedFile;
修改为: manifest[originalFile] = originalFile + '?v=' + file.revHash;

修改生成文件的文件名(原来是将 hash 值加入到文件名中,现要文件名保持不变):
打开node_modules\rev-path\index.js

第10行 return filename + '-' + hash + ext;
修改为: return filename + ext;

打开node_modules\gulp-rev-collector\index.js

第31行 if ( path.basename(json[key]).replace(new RegExp( opts.revSuffix ), '' ) !== path.basename(key) ) {
修改为: if ( path.basename(json[key]).split('?')[0] !== path.basename(key) ) {

避免引用 URL 中的版本号累积:dist/js/all.min.js?v=6e4cfcf9de => dist/js/all.min.js?v=54a62a8eb6?v=6e4cfcf9de
打开node_modules\gulp-rev-collector\index.js

第107行 regexp: new RegExp( '([\/\\\\\'"])' + pattern, 'g' ),
修改为: regexp: new RegExp( '([\/\\\\\'"])' + pattern+'(\\?v=\\w{10})?', 'g' ),

3. gulpfile.js 部分配置

var rev = require('gulp-rev');
var revCollector = require('gulp-rev-collector');

gulp.task('css-rev', ['cleanCss'], function() {
    console.log('开始--计算 css 资源版本号,并生成映射表...');
    return gulp.src(['src/css/tmp/*.css'])
        .pipe(rev())
        .pipe(gulp.dest('dist/css'))
        .pipe(rev.manifest({
            path: 'rev-manifest-css.json'
        }))
        .pipe(gulp.dest('src/rev'));
});

gulp.task('css', ['css-rev'], function() {
    console.log('开始--修改 css 引用链接的资源版本号...');
    return gulp.src(['src/rev/rev-manifest-css.json', 'views/**/*.php'])
        .pipe(revCollector())
        .pipe(gulp.dest('views'));
});

gulp.task('js-rev', ['js-move'], function() {
    console.log('开始--计算 js 资源版本号,并生成映射表...');
    return gulp.src(['dist/js/**/*.js'])
        .pipe(rev())
        // .pipe(gulp.dest('dist/js'))
        .pipe(rev.manifest({
            path: 'rev-manifest-js.json'
        }))
        .pipe(gulp.dest('src/rev'));
});

gulp.task('js', ['js-rev'], function() {
    console.log('开始--修改 js 引用链接的资源版本号...');
    return gulp.src(['src/rev/rev-manifest-js.json', 'views/**/*.php'])
        .pipe(revCollector())
        .pipe(gulp.dest('views'));
});

参考:
Gulp自动添加版本号
前端静态资源版本更新与缓存之——通过gulp 在原html文件上自动化添加js、css版本号

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,736评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,167评论 1 291
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,442评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,902评论 0 204
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,302评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,573评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,847评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,562评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,260评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,531评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,021评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,367评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,016评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,068评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,827评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,610评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,514评论 2 269

推荐阅读更多精彩内容