利用gulp进行静态资源版本控制(url?v=md5)

遇到的问题

服务器端静态资源更新,客户端有缓存,未能获取到最新的静态资源,导致前端效果未达到预期。

期望

服务器端静态资源更新后,客户端访问时能够获取到最新的静态资源。客户端尽量发送少的请求,服务器端未发生变化时,客户端依然读取本地缓存。尽量少的人工操作。

解决方案

借助基于nodejs的工具gulp,计算静态资源的MD5值做为版本号追加在静态资源的链接后,当静态资源发生变更时,MD5亦会发生变化,客户端会发起新的链接从而拉取到最新的静态资源。

弊端:加载静态资源的页面必须不能缓存,否则无法加载到最新的静态资源链接。频繁更新静态资源导致客户端的缓存过大,不过对于现在PC或者手机来说,空间是足够的。

实施步骤

以linux操作系统为例,注意各种版本号,目录仅为示例,按实际需求位置安装,注意操作用户的权限。

为.html文件中引用的静态添加版本号。

1.安装nodejs

访问NodeJS的官方网站,根据自己的操作系统下载对应的安装包

http://nodejs.cn/download/

linux系统下载后解压即可。

wget https://npm.taobao.org/mirrors/node/v8.4.0/node-v8.4.0-linux-x64.tar.gz

tar xf node-v8.4.0-linux-x64.tar.gz -C /opt/taobao/install/

配置全局命令

ln -s /opt/taobao/install/node-v8.4.0-linux-x64/bin/node /usr/local/bin

ln -s /opt/taobao/install/node-v8.4.0-linux-x64/bin/npm /usr/local/bin

2.可选步骤,npm为nodejs插件管理,因为是国外的下载源,可能网络不稳定。淘宝建立了一个完整npmjs.org镜像,可以用此代替官方版本(只读),同步频率目前为10分钟一次以保证尽量与官方服务同步。

npm install cnpm -g --registry=https://registry.npm.taobao.org

配置全局命令

ln -s /opt/taobao/install/node-v8.4.0-linux-x64/bin/cnpm /usr/local/bin

cnpm和npm的功能一致,只是下载源不同。以下出现的npm和cnpm可以互换。

3.安装全局的gulp

cnpm install gulp -g

配置全局命令

ln -s /opt/taobao/install/node-v8.4.0-linux-x64/bin/gulp /usr/local/bin

4.选择一个目录开始编写脚本。此目录为模块位置,后续需要更改此位置下插件的源码。

按默认配置创建模块

cnpm init -y

会自动生成一个模块描述文件package.json

5.安装需要的插件

采用局部安装,仅此模块依赖

cnpm install --save-dev gulp

cnpm install --save-dev gulp-rev

cnpm install --save-dev gulp-rev-collector

cnpm install --save-dev gulp-asset-rev

cnpm install --save-dev run-sequence

安装完成后package.json的文件内容如下(注意各插件版本号):


{

"name": "res_ver",

"version": "1.0.0",

"description": "",

"main": "index.js",

"scripts": {

"test": "echo \"Error: no test specified\" && exit 1"

},

"keywords": [],

"author": "",

"license": "ISC",

"devDependencies": {

"gulp": "^3.9.1",

"gulp-asset-rev": "^0.0.15",

"gulp-rev": "^8.1.0",

"gulp-rev-collector": "^1.2.2",

"run-sequence": "^2.2.0"

}

}



6.编写脚本

目录未变更,创建一个文件gulpfile.js。文件内容如下


//引入gulp和gulp插件

var gulp = require('gulp'),

assetRev = require('gulp-asset-rev'),

runSequence = require('run-sequence'),

rev = require('gulp-rev'),

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

// 定义css、js源文件路径

var opt = new Object();

//静态资源的源目录

opt.staticSrcFolder = '/WEB-INF/classes/static';

//html文件的源目标

opt.htmlSrcFolder = '/WEB-INF/classes/templates';

//生成静态资源的目录。可与源目录相同,会覆盖。

opt.staticDestFolder = '/WEB-INF/classes/static';

//生成html文件的目录。可与源目录相同,会覆盖。

opt.htmlDestFolder = '/WEB-INF/classes/templates';

// 为css中引入的图片/字体等添加hash编码

gulp.task('assetRev', function() {

return gulp.src(opt.staticSrcFolder + "/**/*.css") // 该任务针对的文件

.pipe(assetRev()) // 该任务调用的模块

.pipe(gulp.dest(opt.staticDestFolder)); // 编译后的路径

});

// CSS、js生成文件hash编码并生成 rev-manifest.json文件名对照映射。可加入.jpg、.png、.svg等

gulp.task('revStatic', function() {

return gulp.src([ opt.staticSrcFolder + "/**/*.css",opt.staticSrcFolder + "/**/*.js" ])

.pipe(rev())

.pipe(rev.manifest())

.pipe(gulp.dest(opt.staticDestFolder));

});

// Html替换css、js文件版本

gulp.task('revHtml', function() {

return gulp.src([ opt.staticDestFolder + '/**/rev-manifest.json', opt.htmlSrcFolder + '/**/*.html' ])

.pipe(revCollector())

.pipe(gulp.dest(opt.htmlDestFolder));

});

// 开发构建

//gulp.run是最大限度的并行执行这些任务,而在添加版本号时需要顺序执行这些任务,故使用了runSequence.也有不使用runSequence的写法,阅读起来比较费劲。

gulp.task('default', function(done) {

condition = false;

runSequence(

[ 'assetRev' ],

[ 'revStatic' ],

[ 'revHtml' ],

done);

});


7.修改部分插件源码

1.打开 模块位置/node_modules/gulp-rev/index.js

修改134行 manifest[originalFile] = revisionedFile;

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


2.打开 模块位置/node_modules/rev-path/index.js

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

更新为: return filename + ext;


3.打开 模块位置/node_modules/gulp-rev-collector/index.js

修改40行 let cleanReplacement = path.basename(json[key]).replace(new RegExp( opts.revSuffix ), '' );

更新为:let cleanReplacement = path.basename(json[key]).replace(new RegExp( opts.revSuffix ), '' ).split('?')[0];

修改163行 regexp: new RegExp( prefixDelim + pattern, 'g' ),

修改为: regexp: new RegExp( prefixDelim + pattern + '(\\?v=\\w{10})?', 'g' ),


4.打开 模块位置/node_modules/gulp-asset-rev/index.js

修改78~80行:var verStr = (options.verConnecter || "-") + md5;

src = src.replace(verStr, '').replace(/(\.[^\.]+)$/, verStr + "$1");

改为:var verStr = (options.verConnecter || "") + md5;

src = src + "?v=" + verStr;

8.运行脚本观察结果

可以在模块目录下直接运行命令gulp

或者在任意位置使用gulp --gulpfile <gulpfile path>指定一个脚本执行。




待续

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

推荐阅读更多精彩内容