起源
大部分的網(wǎng)頁(yè),必須聯(lián)網(wǎng)才能訪問(wèn),這其實(shí)也是web的特色,但對(duì)于現(xiàn)在的移動(dòng)互聯(lián)網(wǎng)時(shí)代,設(shè)備終端位置不再固定,依賴無(wú)線信號(hào),網(wǎng)絡(luò)的可靠性變得降低,比如坐在火車上,過(guò)了一個(gè)隧道(15分鐘),便無(wú)法訪問(wèn)網(wǎng)站,這對(duì)于web的用戶體驗(yàn)是大打折扣的。
html5便引入了cache manifest(離線緩存)文件來(lái)解決這個(gè)問(wèn)題。那么什么是cache manifest呢?
什么是Cache Manifest
首先manifest是一個(gè)后綴名為minifest的文件,在文件中定義那些需要緩存的文件,支持manifest的瀏覽器,會(huì)將按照manifest文件的規(guī)則,像文件保存在本地,從而在沒(méi)有網(wǎng)絡(luò)鏈接的情況下,也能訪問(wèn)頁(yè)面。
當(dāng)我們第一次正確配置app cache后,當(dāng)我們?cè)俅卧L問(wèn)該應(yīng)用時(shí),瀏覽器會(huì)首先檢查manifest文件是否有變動(dòng),如果有變動(dòng)就會(huì)把相應(yīng)的變得跟新下來(lái),同時(shí)改變?yōu)g覽器里面的app cache,如果沒(méi)有變動(dòng),就會(huì)直接把a(bǔ)pp cache的資源返回,基本流程如下所示。
Manifest的特點(diǎn)
- 離線瀏覽: 用戶可以在離線狀態(tài)下瀏覽網(wǎng)站內(nèi)容。
- 更快的速度: 因?yàn)閿?shù)據(jù)被存儲(chǔ)在本地,所以速度會(huì)更快.
- 減輕服務(wù)器的負(fù)載: 瀏覽器只會(huì)下載在服務(wù)器上發(fā)生改變的資源。
瀏覽器支持情況
所有主流瀏覽器均支持應(yīng)用程序緩存,除了 Internet Explorer。caniuse給出的答案如下圖所示。
如何使用
html新增了一個(gè)manifest屬性,可以用來(lái)指定當(dāng)前頁(yè)面的manifest文件。創(chuàng)建一個(gè)和html同名的manifest文件,比如頁(yè)面為index.html,那么可以建一個(gè)index.manifest的文件,然后給index.html的html標(biāo)簽添加如下屬性即可:
<html lang="en" manifest="index.manifest">
index.maifest 要存在于web服務(wù)器中,路徑可以隨意置頂,但是要確保能找到此文件。對(duì)于java的tomcat來(lái)說(shuō),需要在web.xml添加一個(gè)屬性來(lái)支持此文件的類型。如下所示
<mime-mapping>
<extension>manifest</extension>
<mime-type>text/cache-manifest</mime-type>
</mime-mapping>
Manifest文件
接下來(lái)詳細(xì)說(shuō)說(shuō)manifest的細(xì)節(jié),一個(gè)典型的manifest文件代碼結(jié)構(gòu)像下面這樣:
CACHE MANIFEST
# This manifest was generated by grunt-manifest HTML5 Cache Manifest Generator
# Time: Mon Nov 14 2016 16:52:07 GMT+0800 (中國(guó)標(biāo)準(zhǔn)時(shí)間)
CACHE:
suimobile/dist/js/suimobileApp.js
suimobile/css/mobile-app-sui.css
suimobile/js/lib/suimobile/sm.css
suimobile/font/fontawesome/font-awesome.css
suimobile/font/iconfont/iconfont.css
NETWORK:
*
# hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
manifest文件,基本格式為三段: CACHE, NETWORK,與 FALLBACK,其中NETWORK和FALLBACK為可選項(xiàng)。
而第一行CACHE MANIFEST為固定格式,必須寫在前面。
以#號(hào)開(kāi)頭的是注釋,一般會(huì)在第二行寫個(gè)版本號(hào),用來(lái)在緩存的文件更新時(shí),更改manifest的作用,可以是版本號(hào),時(shí)間戳或者md5碼等等。
- CACHE:(必須)標(biāo)識(shí)出哪些文件需要緩存,可以是相對(duì)路徑也可以是絕對(duì)路徑。
-
NETWORK:(可選)這一部分是要繞過(guò)緩存直接讀取的文件,可以使用通配符*。
下面的代碼 “l(fā)ogin.asp” 永遠(yuǎn)不會(huì)被緩存,且離線時(shí)是不可用的:
NETWORK:login.asp
可以使用星號(hào)來(lái)指示所有其他資源/文件都需要因特網(wǎng)連接:
-
FALLBACK:(可選)
指定了一個(gè)后備頁(yè)面,當(dāng)資源無(wú)法訪問(wèn)時(shí),瀏覽器會(huì)使用該頁(yè)面。該段落的每條記錄都列出兩個(gè) URI—第一個(gè)表示資源,第二個(gè)表示后備頁(yè)面。兩個(gè) URI 都必須使用相對(duì)路徑并且與清單文件同源。可以使用通配符。
下面的例子中,如果無(wú)法建立因特網(wǎng)連接,則用 “404.html” 替代 /html5/ 目錄中的所有文件。
FALLBACK:/html5/ /404.html
下面的例子中,則用 “404.html” 替代所有文件。
如何更新緩存
如下三種方式,可以更新緩存:
- 更新manifest文件:給manifest添加或刪除文件,都可更新緩存,如果我們更改了js,而沒(méi)有新增或刪除,前面例子中注釋中的版本號(hào),可以很好的用來(lái)更新manifest文件
- 通過(guò)javascript操作:html5中引入了js操作離線緩存的方法,下面的js可以手動(dòng)更新本地緩存。
window.applicationCache.update();
- 清除瀏覽器緩存:如果用戶清除了瀏覽器緩存(手動(dòng)或用其他一些工具)都會(huì)重新下載文件。
注意事項(xiàng)
- 瀏覽器對(duì)緩存數(shù)據(jù)的容量限制可能不太一樣(某些瀏覽器設(shè)置的限制是每個(gè)站點(diǎn) 5MB)。
- 如果manifest文件,或者內(nèi)部列舉的某一個(gè)文件不能正常下載,整個(gè)更新過(guò)程都將失敗,瀏覽器繼續(xù)全部使用老的緩存。
- 引用manifest的html必須與manifest文件同源,在同一個(gè)域下。
- FALLBACK中的資源必須和manifest文件同源。
- 當(dāng)一個(gè)資源被緩存后,該瀏覽器直接請(qǐng)求這個(gè)絕對(duì)路徑也會(huì)訪問(wèn)緩存中的資源。
- 站點(diǎn)中的其他頁(yè)面即使沒(méi)有設(shè)置manifest屬性,請(qǐng)求的資源如果在緩存中也從緩存中訪問(wèn)。
- 當(dāng)manifest文件發(fā)生改變時(shí),資源請(qǐng)求本身也會(huì)觸發(fā)更新。
自動(dòng)化工具
manifest文件中的cache部分不能使用通配符,必須手動(dòng)指定,這實(shí)在太讓人不可理解,文件一多,就成了體力活了,這里介紹的 grunt-manifest能自動(dòng)生成manifest文件的目的。
如下的命令可以安裝grunt-manifest,并加入到依賴文件。
npm install grunt-manifest --save-dev
如下的代碼,可以在grunt中載入grunt-manifest,然后便可使用。
grunt.loadNpmTasks('grunt-manifest');
使用grunt-manifest的一個(gè)典型的配置文件如下所示:
grunt.initConfig({
...
//離線緩存生成配置
manifest: {
generate: {
options: {
basePath: '../',
cache: [
'suimobile/dist/js/suimobileApp.js'//js文件
//樣式文件
,'suimobile/css/mobile-app-sui.css'
,'suimobile/js/lib/suimobile/sm.css'
,'suimobile/font/fontawesome/font-awesome.css'
,'suimobile/font/iconfont/iconfont.css'
],
// network: ['*'],
// fallback: ['/ /offline.html'],
exclude: ['js/jquery.min.js'],
// preferOnline: true,
// headcomment: " <%= pkg.name %> v<%= pkg.version %>",
verbose: true,
timestamp: true,//添加時(shí)間戳,每次執(zhí)行腳本時(shí)加入最新的時(shí)間戳
hash: true,//添加hash code,作用和上面一樣
// master: ['index.html'],
process: function(path) {
return path.substring('build/'.length);
}
},
src: [
'build/some_files/*.html',
'build/js/*.min.js',
'build/css/*.css'
],
dest: '<%= folder.base %>/<%= folder.dist %>/index.manifest'//最終生成的離線配置文件路徑
}
}
});
其中options定義生成manifest的一些自定義參數(shù),src是要生成的文件,dest是輸出文件。
options下有很多參數(shù),主要參數(shù)如下:
- basePath 設(shè)置出入文件的根目錄
- cache 手動(dòng)添加緩存文件
- network 手動(dòng)添加網(wǎng)絡(luò)文件
- fallback 手動(dòng)添加后備文件
- exclude 設(shè)置不添加到cache的文件
- verbose 是否添加版權(quán)信息
- timestamp是否添加時(shí)間戳