html5 离线缓存

版本：HTML5

HTML5 规范还定义了当用户的网络被断开后如何让它们继续与网页程序和文档进行交互。通过提供一个 manifest 文件来定义哪些文件需要被缓存，哪些需要在离线的时候有折衷方案替代。当用户访问这个页面，支持的浏览器将会猎取一个 manifest 版本。它将下载并缓存所有的涉及到的文件，并且当 manifest 相对于用户上次的浏览的版本有变化，它将会再次下载并缓存所有的文件。

大部分的网页，必须联网才能访问，这其实也是web的特色，但对于现在的移动互联网时代，设备终端位置不再固定，依赖无线信号，网络的可靠性变得降低，比如坐在火车上，过了一个隧道（15分钟），便无法访问网站，这对于web的用户体验是大打折扣的。

html5便引入了cache manifest（离线缓存）文件来解决这个问题。那么什么是cache manifest呢？

什么是Cache Manifest

首先manifest是一个后缀名为minifest的文件，在文件中定义那些需要缓存的文件，支持manifest的浏览器，会将按照manifest文件的规则，像文件保存在本地，从而在没有网络链接的情况下，也能访问页面。

当我们第一次正确配置app cache后，当我们再次访问该应用时，浏览器会首先检查manifest文件是否有变动，如果有变动就会把相应的变得跟新下来，同时改变浏览器里面的app cache，如果没有变动，就会直接把app cache的资源返回，基本流程如下所示。

Manifest的特点

• 离线浏览: 用户可以在离线状态下浏览网站内容。
• 更快的速度: 因为数据被存储在本地，所以速度会更快.
• 减轻服务器的负载: 浏览器只会下载在服务器上发生改变的资源。

浏览器支持

如何使用

html新增了一个manifest属性，可以用来指定当前页面的manifest文件。创建一个和html同名的manifest文件，比如页面为index.html，那么可以建一个index.manifest的文件，然后给index.html的html标签添加如下属性即可：

index.maifest 要存在于web服务器中，路径可以随意置顶，但是要确保能找到此文件。对于java的tomcat来说，需要在web.xml添加一个属性来支持此文件的类型。如下所示

 manifest  
  text/cache-manifest 

Manifest文件

接下来详细说说manifest的细节，一个典型的manifest文件代码结构像下面这样：

CACHE MANIFEST
# This manifest was generated by grunt-manifest HTML5 Cache Manifest Generator
# Time: Mon Nov 14 2016 16:52:07 GMT+0800 (中国标准时间)

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为可选项。
而第一行CACHE MANIFEST为固定格式，必须写在前面。
以#号开头的是注释，一般会在第二行写个版本号，用来在缓存的文件更新时，更改manifest的作用，可以是版本号，时间戳或者md5码等等。

1. CACHE:（必须）标识出哪些文件需要缓存，可以是相对路径也可以是绝对路径。
2. NETWORK:（可选）这一部分是要绕过缓存直接读取的文件，可以使用通配符＊。
   下面的代码 “login.asp” 永远不会被缓存，且离线时是不可用的：

NETWORK:login.asp

可以使用星号来指示所有其他资源/文件都需要因特网连接：

1. FALLBACK:（可选）
   指定了一个后备页面，当资源无法访问时，浏览器会使用该页面。该段落的每条记录都列出两个 URI—第一个表示资源，第二个表示后备页面。两个 URI 都必须使用相对路径并且与清单文件同源。可以使用通配符。
   下面的例子中，如果无法建立因特网连接，则用 “404.html” 替代 /html5/ 目录中的所有文件。

FALLBACK:/html5/ /404.html

下面的例子中，则用 “404.html” 替代所有文件。

如何更新缓存

如下三种方式，可以更新缓存：

• 更新manifest文件：给manifest添加或删除文件，都可更新缓存，如果我们更改了js，而没有新增或删除，前面例子中注释中的版本号，可以很好的用来更新manifest文件
• 通过javascript操作：html5中引入了js操作离线缓存的方法，下面的js可以手动更新本地缓存。

window.applicationCache.update();

• 清除浏览器缓存：如果用户清除了浏览器缓存（手动或用其他一些工具）都会重新下载文件。

对于浏览器来说，manifest的加载是要晚于其他资源的，这就导致check manifest的过程是滞后的。发现manifest改变，所有浏览器的实现都是紧随着做静默更新资源，以保证下次pv，应用到更新。

由更新机制来说，首次更新manifest时，因为页面加载已经开始甚至已经完成，缓存更新尚未完成，浏览器仍然会使用过期的资源；浏览器是当Application Cache有更新时，该次不会使用新资源，第二次才会使用。这个时候update事件中执行window.reload事件。

这里，我们来看看更新manifest会走的一些流程：

缓存立即执行

我们的产品已经更新了用户却要第二次进来才能够看到，这样用户体验也太差了吧，有什么方式能够解决呢？好在html5给javascript提供了相关的API。

applicationCache.onupdateready = function()
{
        applicationCache.swapCache();
        location.reload();
};

注意事项

• 浏览器对缓存数据的容量限制可能不太一样（某些浏览器设置的限制是每个站点 5MB）。
• 如果manifest文件，或者内部列举的某一个文件不能正常下载，整个更新过程都将失败，浏览器继续全部使用老的缓存。
• 引用manifest的html必须与manifest文件同源，在同一个域下。
• FALLBACK中的资源必须和manifest文件同源。
• 当一个资源被缓存后，该浏览器直接请求这个绝对路径也会访问缓存中的资源。
• 站点中的其他页面即使没有设置manifest属性，请求的资源如果在缓存中也从缓存中访问。
• 当manifest文件发生改变时，资源请求本身也会触发更新。

自动化工具

manifest文件中的cache部分不能使用通配符，必须手动指定，这实在太让人不可理解，文件一多，就成了体力活了，这里介绍的 grunt-manifest能自动生成manifest文件的目的。
如下的命令可以安装grunt-manifest，并加入到依赖文件。

npm install grunt-manifest --save-dev

如下的代码，可以在grunt中载入grunt-manifest，然后便可使用。

grunt.loadNpmTasks('grunt-manifest');

使用grunt-manifest的一个典型的配置文件如下所示：

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: "  v",
                    verbose: true,
                    timestamp: true,//添加时间戳，每次执行脚本时加入最新的时间戳
                    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: '//index.manifest'//最终生成的离线配置文件路径
            }
        }
    });

其中options定义生成manifest的一些自定义参数，src是要生成的文件，dest是输出文件。
options下有很多参数，主要参数如下：

• basePath 设置出入文件的根目录
• cache 手动添加缓存文件
• network 手动添加网络文件
• fallback 手动添加后备文件
• exclude 设置不添加到cache的文件
• verbose 是否添加版权信息
• timestamp是否添加时间戳

鹏仔微信 15129739599 鹏仔QQ344225443 鹏仔前端 pjxi.com 共享博客 sharedbk.com