菜单

Service Worker初体验

2019年2月26日 - 金沙前端

在大家早先写码从前

从这个种类地址拿到chaches
polyfill。

这个polyfill支持CacheStorate.match,Cache.add和Cache.addAll,而现在Chrome
M40实现的Cache
API还没有辅助那些点子。

将dist/serviceworker-cache-polyfill.js放到你的网站中,在service
worker中通过importScripts加载进来。被service
worker加载的剧本文件会被电动缓存。

JavaScript

importScripts(‘serviceworker-cache-polyfill.js’);

1
importScripts(‘serviceworker-cache-polyfill.js’);

需要HTTPS

在开发阶段,你能够通过localhost使用service
worker,然则如果上线,就须要您的server辅助HTTPS。

您能够由此service
worker胁制连接,伪造和过滤响应,分外逆天。尽管你能够约束本身不干坏事,也会有人想干坏事。所以为了防患旁人使坏,你不得不在HTTPS的网页上注册service
workers,那样大家才能够免备加载service
worker的时候不被歹徒篡改。(因为service
worker权限不小,所以要常备不懈它自身被坏人篡改利用——译者注)

Github
Pages恰恰是HTTPS的,所以它是一个美好的天然实验田。

如果您想要让你的server扶助HTTPS,你要求为您的server得到2个TLS证书。差其他server安装方法差别,阅读扶助文书档案并透过Mozilla’s
SSL config
generator刺探最佳实践。

fetch事件

在页面发起http请求时,service
worker能够通过fetch事件拦截请求,并且付诸本身的响应。
w3c提供了一个新的fetch
api,用于代替XMLHttpRequest,与XMLHttpRequest最大差别有两点:

1.
fetch()方法重回的是Promise对象,通过then方法开始展览连接调用,裁减嵌套。ES6的Promise在改为专业之后,会愈来愈便利开发职员。

2. 提供了Request、Response对象,假诺做过后端开发,对Request、Response应该比较熟识。前端要发起呼吁能够经过url发起,也能够行使Request对象发起,而且Request能够复用。然而Response用在哪里啊?在service
worker出现在此之前,前端确实不会协调给协调发音信,不过有了service
worker,就足以在阻止请求之后据悉须要发回本身的响应,对页面而言,这几个普通的伸手结果并无差别,那是Response的一处接纳。

上边是在中,作者采纳fetch
api通过fliker的当众api获取图片的事例,注释中详细分解了每一步的效用:

JavaScript

/* 由于是get请求,间接把参数作为query string传递了 */ var URL =
”;
function fetch德姆o() { // fetch(url,
option)援救八个参数,option中得以设置header、body、method音讯fetch(U智跑L).then(function(response) { // 通过promise
对象获得对应内容,并且将响应内容根据json格式转成对象,json()方法调用之后回到的照样是promise对象
// 也能够把内容转化成arraybuffer、blob对象 return response.json();
}).then(function(json) { // 渲染页面 insertPhotos(json); }); }
fetch德姆o();

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
/* 由于是get请求,直接把参数作为query string传递了 */
var URL = ‘https://api.flickr.com/services/rest/?method=flickr.photos.search&api_key=your_api_key&format=json&nojsoncallback=1&tags=penguins’;
 
function fetchDemo() {
  // fetch(url, option)支持两个参数,option中可以设置header、body、method信息
  fetch(URL).then(function(response) {
    // 通过promise 对象获得相应内容,并且将响应内容按照json格式转成对象,json()方法调用之后返回的依然是promise对象
    // 也可以把内容转化成arraybuffer、blob对象
    return response.json();
  }).then(function(json) {
    // 渲染页面
    insertPhotos(json);
  });
}
 
fetchDemo();

fetch
api与XMLHttpRequest相比较,越发简洁,并且提供的机能更周到,能源获得方式比ajax更优雅。包容性方面:chrome
42上马协理,对于旧浏览器,能够透过合法维护的polyfill帮助。

连不上网?United Kingdom卫报的秉性离线页面是这般做的

2015/11/20 · HTML5 · Service
Worker,
离线页面

本文由 伯乐在线 –
Erucy
翻译,weavewillg
校稿。未经许可,禁止转发!
英文出处:Oliver
Ash。欢迎加入翻译组。

大家是何等行使 service worker 来为 theguardian.com
创设3个自定义的离线页面。

图片 1

theguardian.com 的离线页面。插图:奥利弗 Ash

你正在朝着公司途中的大巴里,在小弟大上打开了
Guardian
应用。大巴被隧道包围着,不过那些利用能够健康运行,即使没有网络连接,你也能赢得完整的效益,除了出示的内容大概有点旧。要是你品味在网站上也这么干,可惜它完全无法加载:

图片 2

安卓版 Chrome 的离线页面

Chrome 中的这一个彩蛋,很六人都不清楚》

Chrome
在离线页面上有个藏匿的游戏(桌面版上按空格键,手提式有线电话机版上点击这只恐龙),这多少能减轻一点您的愤懑。不过大家能够做得更好。

Service
workers
允许网站作者拦截本人站点的有所互连网请求,那也就表示大家得以提供全面的离线体验,就像是原生应用相同。在
Guardian
网站,大家近期上线了1个自定义的离线体验效果。当用户离线的时候,他们相会到三个富含
Guardian
标识的页面,下面带有1个简易的离线提示,还有1个填字游戏,他们能够在等待网络连接的时候玩玩这些找点乐子。那篇博客解释了我们是怎么营造它的,不过在上马以前,你能够先自身试试看。

(4)cache html

地点第(3)步把图纸、js、css缓存起来了,可是一旦把页面html也缓存了,例如把首页缓存了,就会有1个难堪的题材——ServiceWorker是在页面注册的,可是今后赢得页面的时候是从缓存取的,每一回都以一模一样的,所以就造成不可能立异ServiceWorker,如变成sw-5.js,不过PWA又必要我们能缓存页面html。这怎么办呢?谷歌的开发者文档它只是提到会存在那么些题材,但并没有评释怎么化解这一个标题。那么些的标题标消除就供给大家要有1个编写制定能精晓html更新了,从而把缓存里的html给替换掉。

Manifest更新缓存的体制是去看Manifest的文件内容有没有爆发变化,尽管产生变化了,则会去立异缓存,ServiceWorker也是基于sw.js的文本内容有没有产生变化,我们得以借鉴那么些考虑,假若请求的是html并从缓存里取出来后,再发个请求获取多个文本看html更新时间是还是不是产生变化,即便爆发变化了则印证发生变动了,进而把缓存给删了。所以能够在服务端通过操纵这几个文件从而去革新客户端的缓存。如下代码:

JavaScript

this.add伊芙ntListener(“fetch”, function(event) { event.respondWith(
caches.match(event.request).then(response => { // cache hit if
(response) { //假使取的是html,则看发个请求看html是或不是更新了 if
(response.headers.get(“Content-Type”).indexOf(“text/html”) >= 0) {
console.log(“update html”); let url = new U奥迪Q7L(event.request.url);
util.updateHtmlPage(url, event.request.clone(), event.clientId); }
return response; } return util.fetchPut(event.request.clone()); }) );
});

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
this.addEventListener("fetch", function(event) {
 
    event.respondWith(
        caches.match(event.request).then(response => {
            // cache hit
            if (response) {
                //如果取的是html,则看发个请求看html是否更新了
                if (response.headers.get("Content-Type").indexOf("text/html") >= 0) {
                    console.log("update html");
                    let url = new URL(event.request.url);
                    util.updateHtmlPage(url, event.request.clone(), event.clientId);
                }
                return response;
            }
 
            return util.fetchPut(event.request.clone());
        })
    );
});

经过响应头header的content-type是不是为text/html,假若是的话就去发个请求获取贰个文书,遵照那个文件的情节决定是还是不是须求删除缓存,那么些立异的函数util.updateHtmlPage是这么达成的:

JavaScript

let pageUpdateTime = { }; let util = { updateHtmlPage: function (url,
htmlRequest) { let pageName = util.getPageName(url); let jsonRequest =
new Request(“/html/service-worker/cache-json/” + pageName + “.sw.json”);
fetch(jsonRequest).then(response => { response.json().then(content
=> { if (pageUpdateTime[pageName] !== content.updateTime) {
console.log(“update page html”); // 倘若有革新则另行赢得html
util.fetchPut(htmlRequest); pageUpdateTime[pageName] =
content.updateTime; } }); }); }, delCache: function (url) {
caches.open(CACHE_NAME).then(cache => { console.log(“delete cache “

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
let pageUpdateTime = {
 
};
let util = {
    updateHtmlPage: function (url, htmlRequest) {
        let pageName = util.getPageName(url);
        let jsonRequest = new Request("/html/service-worker/cache-json/" + pageName + ".sw.json");
        fetch(jsonRequest).then(response => {
            response.json().then(content => {
                if (pageUpdateTime[pageName] !== content.updateTime) {
                    console.log("update page html");
                    // 如果有更新则重新获取html
                    util.fetchPut(htmlRequest);
                    pageUpdateTime[pageName] = content.updateTime;
                }
            });
        });
    },
    delCache: function (url) {
        caches.open(CACHE_NAME).then(cache => {
            console.log("delete cache " + url);
            cache.delete(url, {ignoreVary: true});
        });
    }
};

代码先去获取叁个json文件,3个页面会对应七个json文件,那个json的始末是那样的:

JavaScript

{“updateTime”:”10/2/2017, 3:23:57 PM”,”resources”: {img: [], css:
[]}}

1
{"updateTime":"10/2/2017, 3:23:57 PM","resources": {img: [], css: []}}

里头根本有多个updateTime的字段,假设地点内部存款和储蓄器没有这一个页面包车型地铁updateTime的多少只怕是和新颖updateTime不一致,则再度去得到html,然后嵌入缓存里。接着须求公告页面线程数据产生变化了,你刷新下页面吗。这样就绝不等用户刷新页面才能卓有效率了。所以当刷新完页面后用postMessage通告页面:

JavaScript

let util = { postMessage: async function (msg) { const allClients =
await clients.matchAll(); allClients.forEach(client =>
client.postMessage(msg)); } }; util.fetchPut(htmlRequest, false,
function() { util.postMessage({type: 1, desc: “html found updated”, url:
url.href}); });

1
2
3
4
5
6
7
8
9
let util = {
    postMessage: async function (msg) {
        const allClients = await clients.matchAll();
        allClients.forEach(client => client.postMessage(msg));
    }
};
util.fetchPut(htmlRequest, false, function() {
    util.postMessage({type: 1, desc: "html found updated", url: url.href});
});

并分明type: 1就象征那是1个立异html的消息,然后在页面监听message事件:

JavaScript

if(“serviceWorker” in navigator) {
navigator.serviceWorker.addEventListener(“message”, function(event) {
let msg = event.data; if (msg.type === 1 && window.location.href ===
msg.url) { console.log(“recv from service worker”, event.data);
window.location.reload(); } }); }

1
2
3
4
5
6
7
8
9
if("serviceWorker" in navigator) {
    navigator.serviceWorker.addEventListener("message", function(event) {
        let msg = event.data;
        if (msg.type === 1 && window.location.href === msg.url) {
            console.log("recv from service worker", event.data);
            window.location.reload();
        }  
    });
}

接下来当大家须要更新html的时候就更新json文件,那样用户就能来看最新的页面了。大概是当用户重新起动浏览器的时候会造成ServiceWorker的周转内部存款和储蓄器都被清空了,即存款和储蓄页面更新时间的变量被清空了,这么些时候也会再一次请求页面。

须求小心的是,要把那个json文件的http
cache时间设置成0,那样浏览器就不会缓存了,如下nginx的安插:

JavaScript

location ~* .sw.json$ { expires 0; }

1
2
3
location ~* .sw.json$ {
    expires 0;
}

因为这一个文件是亟需实时获取的,不可能被缓存,firefox私下认可会缓存,Chrome不会,加上http缓存时间为0,firefox也不会缓存了。

还有一种更新是用户更新的,例如用户公布了评价,须要在页面公告service
worker把html缓存删了重新取得,那是三个扭转的新闻通告:

JavaScript

if (“serviceWorker” in navigator) {
document.querySelector(“.comment-form”).addEventListener(“submit”,
function() { navigator.serviceWorker.controller.postMessage({ type: 1,
desc: “remove html cache”, url: window.location.href} ); } }); }

1
2
3
4
5
6
7
8
9
10
if ("serviceWorker" in navigator) {
    document.querySelector(".comment-form").addEventListener("submit", function() {
            navigator.serviceWorker.controller.postMessage({
                type: 1,
                desc: "remove html cache",
                url: window.location.href}
            );
        }
    });
}

Service Worker也监听message事件:

JavaScript

const messageProcess = { // 删除html index 1: function (url) {
util.delCache(url); } }; let util = { delCache: function (url) {
caches.open(CACHE_NAME).then(cache => { console.log(“delete cache “

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
const messageProcess = {
    // 删除html index
    1: function (url) {
        util.delCache(url);
    }
};
 
let util = {
    delCache: function (url) {
        caches.open(CACHE_NAME).then(cache => {
            console.log("delete cache " + url);
            cache.delete(url, {ignoreVary: true});
        });
    }
};
 
this.addEventListener("message", function(event) {
    let msg = event.data;
    console.log(msg);
    if (typeof messageProcess[msg.type] === "function") {
        messageProcess[msg.type](msg.url);
    }
});

依据分歧的新闻类型调差其余回调函数,假设是1的话正是删除cache。用户公布完评论后会触发刷新页面,刷新的时候缓存已经被删了就会另行去伏乞了。

这么就消除了实时更新的难点。

哪些缓存和重回Request

你曾经设置了service worker,你今后得以回去您缓存的呼吁了。

当service
worker被设置成功还要用户浏览了另1个页面大概刷新了最近的页面,service
worker将上马接到到fetch事件。下边是贰个例证:

JavaScript

self.addEventListener(‘fetch’, function(event) { event.respondWith(
caches.match(event.request) .then(function(response) { // Cache hit –
return response if (response) { return response; } return
fetch(event.request); } ) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
self.addEventListener(‘fetch’, function(event) {
  event.respondWith(
    caches.match(event.request)
      .then(function(response) {
        // Cache hit – return response
        if (response) {
          return response;
        }
 
        return fetch(event.request);
      }
    )
  );
});

下边包车型大巴代码里大家定义了fetch事件,在event.respondWith里,大家传入了一个由caches.match发生的promise.caches.match
查找request中被service worker缓存命中的response。

一旦大家有1个命中的response,大家重返被缓存的值,不然大家回来二个实时从互联网请求fetch的结果。那是二个格外简单的例子,使用全数在install步骤下被缓存的财富。

借使我们想要增量地缓存新的伸手,大家得以经过处理fetch请求的response并且增进它们到缓存中来兑现,例如:

JavaScript

self.addEventListener(‘fetch’, function(event) { event.respondWith(
caches.match(event.request) .then(function(response) { // Cache hit –
return response if (response) { return response; } // IMPORTANT: Clone
the request. A request is a stream and // can only be consumed once.
Since we are consuming this // once by cache and once by the browser for
fetch, we need // to clone the response var fetchRequest =
event.request.clone(); return fetch(fetchRequest).then(
function(response) { // Check if we received a valid response
if(!response || response.status !== 200 || response.type !== ‘basic’) {
return response; } // IMPORTANT: Clone the response. A response is a
stream // and because we want the browser to consume the response // as
well as the cache consuming the response, we need // to clone it so we
have 2 stream. var responseToCache = response.clone();
caches.open(CACHE_NAME) .then(function(cache) {
cache.put(event.request, responseToCache); }); return response; } ); })
); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
self.addEventListener(‘fetch’, function(event) {
  event.respondWith(
    caches.match(event.request)
      .then(function(response) {
        // Cache hit – return response
        if (response) {
          return response;
        }
 
        // IMPORTANT: Clone the request. A request is a stream and
        // can only be consumed once. Since we are consuming this
        // once by cache and once by the browser for fetch, we need
        // to clone the response
        var fetchRequest = event.request.clone();
 
        return fetch(fetchRequest).then(
          function(response) {
            // Check if we received a valid response
            if(!response || response.status !== 200 || response.type !== ‘basic’) {
              return response;
            }
 
            // IMPORTANT: Clone the response. A response is a stream
            // and because we want the browser to consume the response
            // as well as the cache consuming the response, we need
            // to clone it so we have 2 stream.
            var responseToCache = response.clone();
 
            caches.open(CACHE_NAME)
              .then(function(cache) {
                cache.put(event.request, responseToCache);
              });
 
            return response;
          }
        );
      })
    );
});

代码里大家所做政工包蕴:

  1. 丰硕3个callback到fetch请求的 .then 方法中
  2. 若果大家得到了三个response,大家开始展览如下的自我批评:
    1. 保障response是有效的
    2. 反省response的情状是或不是是200
    3. 确定保障response的档次是basic,那代表请求作者是同源的,非同源(即跨域)的伸手也无法被缓存。
  3. 比方大家由此了自作者批评,clone其一请求。这么做的因由是一旦response是3个Stream,那么它的body只好被读取3次,所以大家得将它克隆出来,一份发给浏览器,一份发给缓存。

难点1. 运作时刻

service
worker并不是直接在后台运行的。在页面关闭后,浏览器可以继承维持service
worker运维,也得以关闭service
worker,那取决于与浏览器自个儿的行事。所以不用定义一些全局变量,例如上面包车型客车代码(来自):

JavaScript

var hitCounter = 0; this.addEventListener(‘fetch’, function(event) {
hitCounter++; event.respondWith( new Response(‘Hit number ‘ +
hitCounter) ); });

1
2
3
4
5
6
7
8
var hitCounter = 0;
 
this.addEventListener(‘fetch’, function(event) {
  hitCounter++;
  event.respondWith(
    new Response(‘Hit number ‘ + hitCounter)
  );
});

重返的结果或许是不曾规律的:1,2,1,2,1,1,2….,原因是hitCounter并不曾间接存在,假如浏览器关闭了它,下次起首的时候hitCounter就赋值为0了
诸如此类的事务导致调节和测试代码困难,当您更新三个service
worker以往,唯有在开辟新页面现在才大概使用新的service
worker,在调节和测试进度中时常等上一两分钟才会选择新的,相比较抓狂。

试试看

您须求一个支撑 Service
Worker 和 fetch
API 的浏览器。停止到本文编写时只有Chrome(手提式有线电电话机版和桌面版)同时辅助那三种 API(译者注:Opera
近来也支撑这三头),不过 Firefox
非常的慢就要协助了(在每一天更新的本子中早就支撑了),除去 Safari
之外的富有浏览器也都在尝试。其余,service worker 只好登记在使用了
HTTPS 的网站上,theguardian.com
已经开头逐年搬迁到 HTTPS,所以我们只可以在网站的 HTTPS
部分提供离线体验。就当下以来,我们选取了 开发者博客 作为大家用来测试的地点。所以只要您是在大家网站的 开发者博客 部分阅读这篇小说的话,很幸运。

当您采纳支持的浏览器访问我们的 开发者博客 中的页面包车型客车时候,一切就准备妥贴了。断开你的网络连接,然后刷新一下页面。假如你本人没条件尝试的话,可以看一下那段 示范录像(译者注:需梯子)。

(3)fetch资源后cache起来

正如代码,监听fetch事件做些处理:

JavaScript

this.addEventListener(“fetch”, function(event) { event.respondWith(
caches.match(event.request).then(response => { // cache hit if
(response) { return response; } return
util.fetchPut(event.request.clone()); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
this.addEventListener("fetch", function(event) {
    event.respondWith(
        caches.match(event.request).then(response => {
            // cache hit
            if (response) {
                return response;
            }
            return util.fetchPut(event.request.clone());
        })
    );
});

先调caches.match看一下缓存里面是不是有了,倘诺有直接重回缓存里的response,不然的话不奇怪请求能源并把它内置cache里面。放在缓存里财富的key值是Request对象,在match的时候,须求请求的url和header都无差距才是相同的能源,能够设定第二个参数ignoreVary:

JavaScript

caches.match(event.request, {ignoreVary: true})

1
caches.match(event.request, {ignoreVary: true})

代表一旦请求url相同就认为是同一个能源。

地点代码的util.fetchPut是那般达成的:

JavaScript

let util = { fetchPut: function (request, callback) { return
fetch(request).then(response => { // 跨域的财富直接return if
(!response || response.status !== 200 || response.type !== “basic”) {
return response; } util.putCache(request, response.clone()); typeof
callback === “function” && callback(); return response; }); }, putCache:
function (request, resource) { // 后台不要缓存,preview链接也不要缓存 if
(request.method === “GET” && request.url.indexOf(“wp-admin”) < 0 &&
request.url.indexOf(“preview_id”) < 0) {
caches.open(CACHE_NAME).then(cache => { cache.put(request,
resource); }); } } };

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
let util = {
    fetchPut: function (request, callback) {
        return fetch(request).then(response => {
            // 跨域的资源直接return
            if (!response || response.status !== 200 || response.type !== "basic") {
                return response;
            }
            util.putCache(request, response.clone());
            typeof callback === "function" && callback();
            return response;
        });
    },
    putCache: function (request, resource) {
        // 后台不要缓存,preview链接也不要缓存
        if (request.method === "GET" && request.url.indexOf("wp-admin") < 0
              && request.url.indexOf("preview_id") < 0) {
            caches.open(CACHE_NAME).then(cache => {
                cache.put(request, resource);
            });
        }
    }
};

要求小心的是跨域的能源无法缓存,response.status会再次回到0,假若跨域的财富支撑CO本田CR-VS,那么能够把request的mod改成cors。即使请求退步了,如404或许是过期等等的,那么也直接重回response让主页面处理,不然的话表达加载成功,把这一个response克隆叁个放手cache里面,然后再重返response给主页面线程。注意能舒缓存里的能源一般只可以是GET,通过POST获取的是不能够缓存的,所以要做个判断(当然你也能够手动把request对象的method改成get),还有把部分私人住房不期望缓存的能源也做个判断。

如此只要用户打开过二回页面,ServiceWorker就设置好了,他刷新页面大概打开第①个页面包车型客车时候就能够把请求的财富一一做缓存,包涵图片、CSS、JS等,只要缓存里有了不管用户在线或然离线都能够健康访问。那样我们本来会有2个难题,这一个缓存空间到底有多大?上一篇大家关系Manifest也算是地点存款和储蓄,PC端的Chrome是5Mb,其实这些说法在新本子的Chrome已经不可信赖赖了,在Chrome
61本子能够阅览地点存款和储蓄的上空和动用状态:

图片 3

在那之中Cache Storage是指ServiceWorker和Manifest占用的半空中大小和,上海体育地方能够见到总的空间尺寸是20GB,大概是unlimited,所以基本上不用顾虑缓存会不够用。

使用Service Worker

今后大家有了polyfill,并且解决了HTTPS,让大家看看毕竟怎么用service
worker。

生命周期

先来看一下二个service worker的运维周期

图片 4
上航海用教室是service
worker生命周期,出处

图中能够看到,2个service worker要经历以下进度:

  1.  安装

2.
 激活,激活成功未来,打开chrome://inspect/#service-workers能够查阅到当前运转的service
worker

图片 5

  1. 监听fetch和message事件,下边两种事件会进展简短描述

  2. 销毁,是不是销毁由浏览器决定,就算二个service
    worker长时间不应用依然机器内部存款和储蓄器有数,则恐怕会销毁这几个worker

有关作者:Erucy

图片 6

现已的SharePoint喵星程序猿(权且还挂着微软MVP的名头),以往的Azure/.Net/MongoDB/Cordova/前端程序猿,偶尔写随笔
个人主页 ·
笔者的作品 ·
46 ·
  

图片 7

5. 接纳Web App Manifest添加桌面入口

留意那里说的是别的二个Manifest,这些Manifest是3个json文件,用来放网站icon名称等消息以便在桌面添加三个图标,以及成立一种打开这些网页就如打开App一样的意义。上边一向说的Manifest是被丢掉的Application
Cache的Manifest。

以此Maifest.json文件能够这样写:

JavaScript

{ “short_name”: “人人FED”, “name”: “人人网FED,专注于前者技术”,
“icons”: [ { “src”: “/html/app-manifest/logo_48.png”, “type”:
“image/png”, “sizes”: “48×48” }, { “src”:
“/html/app-manifest/logo_96.png”, “type”: “image/png”, “sizes”: “96×96”
}, { “src”: “/html/app-manifest/logo_192.png”, “type”: “image/png”,
“sizes”: “192×192” }, { “src”: “/html/app-manifest/logo_512.png”,
“type”: “image/png”, “sizes”: “512×512” } ], “start_url”:
“/?launcher=true”, “display”: “standalone”, “background_color”:
“#287fc5”, “theme_color”: “#fff” }

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
  "short_name": "人人FED",
  "name": "人人网FED,专注于前端技术",
  "icons": [
    {
      "src": "/html/app-manifest/logo_48.png",
      "type": "image/png",
      "sizes": "48×48"
    },
    {
      "src": "/html/app-manifest/logo_96.png",
      "type": "image/png",
      "sizes": "96×96"
    },
    {
      "src": "/html/app-manifest/logo_192.png",
      "type": "image/png",
      "sizes": "192×192"
    },
    {
      "src": "/html/app-manifest/logo_512.png",
      "type": "image/png",
      "sizes": "512×512"
    }
  ],
  "start_url": "/?launcher=true",
  "display": "standalone",
  "background_color": "#287fc5",
  "theme_color": "#fff"
}

icon必要预备三种口径,最大要求512px *
512px的,那样Chrome会自动去接纳合适的图纸。要是把display改成standalone,从转变的图标打开就会像打开二个App一样,没有浏览器地址栏那么些东西了。start_url钦点打开之后的输入链接。

然后添加2个link标签指向那几个manifest文件:

JavaScript

<link rel=”manifest” href=”/html/app-manifest/manifest.json”>

1
<link rel="manifest" href="/html/app-manifest/manifest.json">

如此组合Service Worker缓存:
图片 8把start_url指向的页面用瑟维斯Worker缓存起来,那样当用户用Chrome浏览器打开那一个网页的时候,Chrome就会在底部弹一个唤起,询问用户是不是把那几个网页添加到桌面,就算点“添加”就会转移三个桌面图标,从这么些图标点进去仿佛打开3个App一样。感受如下:

图片 9

相比难堪的是Manifest近期唯有Chrome帮助,并且不得不在安卓系统上利用,IOS的浏览器不能添加几个桌面图标,因为IOS没有开放那种API,不过自己的Safari却又是能够的。

综上,本文介绍了怎么用Service Worker结合Manifest做二个PWA离线Web
APP,主倘诺用ServiceWorker控制缓存,由于是写JS,比较灵活,还足以与页面举办通信,其余通过请求页面包车型客车立异时间来判定是不是要求立异html缓存。ServiceWorker的包容性不是特地好,可是前景比较光明,浏览器都在准备帮忙。现阶段能够组成offline
cache的Manifest做离线应用。

连带阅读:

  1. 怎么要把网站升级到HTTPS
  2. 如何把网站升级到http/2
  3. 自家是怎么样让网站用上HTML5
    Manifest

1 赞 1 收藏
评论

图片 10

处理边界和填坑

这一节内容相比新,有好多待定细节。希望这一节十分的快就不必要讲了(因为标准会处理那个难点——译者注),不过今后,这个内容照旧应该被提一下。

Service Worker初体验

2016/01/06 · JavaScript
· Service Worker

初稿出处: AlloyTeam   

在二零一六年,W3C发布了service worker的草案,service
worker提供了不少新的力量,使得web app拥有与native
app相同的离线体验、音讯推送体验。
service worker是一段脚本,与web
worker一样,也是在后台运营。作为四个单身的线程,运转条件与日常脚本分歧,所以不能够直接加入web交互行为。native
app可以做到离线使用、音讯推送、后台自动更新,service
worker的出现是还好为了使得web app也得以享有类似的力量。

 

service worker可以:

  1. 后台音信传递
  2. 网络代理,转载呼吁,伪造响应
  3. 离线缓存
  4. 消息推送
  5.  … …

正文以财富缓存为例,说圣元下service worker是怎么办事的。

做事原理

透过一段简单的
JavaScript,大家得以提示浏览器在用户访问页面包车型大巴时候马上登记我们协调的
service worker。近日支撑 service worker
的浏览器很少,所以为了防止不当,大家须求动用性子检测。

JavaScript

if (navigator.serviceWorker) {
navigator.serviceWorker.register(‘/service-worker.js’); }

1
2
3
if (navigator.serviceWorker) {
    navigator.serviceWorker.register(‘/service-worker.js’);
}

Service worker
安装事件的一有的,大家得以采取 新的缓存
API 来缓存大家网站中的种种内容,比如
HTML、CSS 和
JavaScript:

JavaScript

var staticCacheName = ‘static’; var version = 1; function updateCache()
{ return caches.open(staticCacheName + version) .then(function (cache) {
return cache.addAll([ ‘/offline-page.html’, ‘/assets/css/main.css’,
‘/assets/js/main.js’ ]); }); }; self.addEventListener(‘install’,
function (event) { event.waitUntil(updateCache()); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
var staticCacheName = ‘static’;
var version = 1;
 
function updateCache() {
    return caches.open(staticCacheName + version)
        .then(function (cache) {
            return cache.addAll([
                ‘/offline-page.html’,
                ‘/assets/css/main.css’,
                ‘/assets/js/main.js’
            ]);
        });
};
 
self.addEventListener(‘install’, function (event) {
    event.waitUntil(updateCache());
});

当安装实现后,service worker
能够监听和操纵 fetch
事件,让我们得以完全控制之后网站中发生的拥有网络请求。

JavaScript

self.addEventListener(‘fetch’, function (event) {
event.respondWith(fetch(event.request)); });

1
2
3
self.addEventListener(‘fetch’, function (event) {
    event.respondWith(fetch(event.request));
});

在那边大家有很灵活的上空能够发挥,比如下边这一个关键,能够因此代码来生成我们和好的伸手响应:

JavaScript

self.addEventListener(‘fetch’, function (event) { var response = new
Response(‘<h1>Hello, World!</h1>’, { headers: {
‘Content-Type’: ‘text/html’ } }); event.respondWith(response); });

1
2
3
4
5
self.addEventListener(‘fetch’, function (event) {
    var response = new Response(‘&lt;h1&gt;Hello, World!&lt;/h1&gt;’,
        { headers: { ‘Content-Type’: ‘text/html’ } });
    event.respondWith(response);
});

再有这么些,要是在缓存中找到了请求相应的缓存,我们得以一直从缓存中回到它,要是没找到的话,再通过网络得到响应内容:

JavaScript

self.addEventListener(‘fetch’, function (event) { event.respondWith(
caches.match(event.request) .then(function (response) { return response
|| fetch(event.request); }) ); });

1
2
3
4
5
6
7
8
self.addEventListener(‘fetch’, function (event) {
    event.respondWith(
        caches.match(event.request)
            .then(function (response) {
                return response || fetch(event.request);
            })
    );
});

那正是说大家怎样使用那么些效用来提供离线体验吧?

第壹,在 service worker
安装进度中,大家要求把离线页面须要的 HTML 和能源文件通过 service worker
缓存下来。在缓存中,我们加载了温馨付出的 填字游戏 的
React应用 页面。之后,大家会堵住全体访问
theguardian.com
网络请求,包罗网页、以及页面中的财富文件。处理那一个请求的逻辑大概如下:

  1. 当大家检查和测试到传播请求是指向大家的 HTML
    页面时,大家总是会想要提供最新的内容,所以大家会尝试把这一个请求通过网络发送给服务器。

    1. 当大家从服务器获得了响应,就足以平素回到那几个响应。
    2. 一旦互联网请求抛出了老大(比如因为用户掉线了),大家捕获那一个丰富,然后接纳缓存的离线
      HTML 页面作为响应内容。
  2. 要不,当大家检查和测试到请求的不是 HTML
    的话,大家会从缓存中找找响应的呼吁内容。

    1. 假定找到了缓存内容,大家能够直接重回缓存的剧情。
    2. 要否则,大家会尝试把这几个请求通过互连网发送给服务器。

在代码中,大家使用了 新的缓存
API(它是 Service Worker API 的一有的)以及
fetch
成效(用于转移网络请求),如下所示:

JavaScript

var doesRequestAcceptHtml = function (request) { return
request.headers.get(‘Accept’) .split(‘,’) .some(function (type) { return
type === ‘text/html’; }); }; self.addEventListener(‘fetch’, function
(event) { var request = event.request; if
(doesRequestAcceptHtml(request)) { // HTML pages fallback to offline
page event.respondWith( fetch(request) .catch(function () { return
caches.match(‘/offline-page.html’); }) ); } else { // Default fetch
behaviour // Cache first for all other requests event.respondWith(
caches.match(request) .then(function (response) { return response ||
fetch(request); }) ); } });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
var doesRequestAcceptHtml = function (request) {
    return request.headers.get(‘Accept’)
        .split(‘,’)
        .some(function (type) { return type === ‘text/html’; });
};
 
self.addEventListener(‘fetch’, function (event) {
    var request = event.request;
    if (doesRequestAcceptHtml(request)) {
        // HTML pages fallback to offline page
        event.respondWith(
            fetch(request)
                .catch(function () {
                    return caches.match(‘/offline-page.html’);
                })
        );
    } else {
        // Default fetch behaviour
        // Cache first for all other requests
        event.respondWith(
            caches.match(request)
                .then(function (response) {
                    return response || fetch(request);
                })
        );
    }
});

就只需求那样多!theguardian.com
上的 负有代码都以在 GitHub
上开源 的,所以你能够去那儿查看我们的
service worker
的完整版本,大概直接从生产条件上访问

我们有富厚的说辞为那些新的浏览器技术欢呼喝彩,因为它可以用来让您的网站像今日的原生应用相同,拥有完美的离线体验。以往当
theguardian.com 完全迁移到 HTTPS
之后,离线页面包车型客车最首要性会显然扩大,大家得以提供越发完美的离线体验。设想一下您在上下班途中网络很差的时候访问
theguardian.com,你汇合到专门为你订制的天性化内容,它们是在您前面访问网站时由浏览器缓存下来的。它在设置进程中也不会发出其余困难,你所供给的只是访问那几个网站而已,不像原生应用,还亟需用户有二个运用商店的账号才能安装。Serviceworker
同样能够补助大家进步网站的加载速度,因为网站的框架能够被保险地缓存下来,就像原生应用相同。

一经您对 service worker
很感兴趣,想要通晓越来越多内容的话,开发者 马特Gaunt(Chrome的忠贞协助者)写了一篇越发详细地 介绍 Service
Worker的文章。

打赏帮助作者翻译越多好小说,感谢!

打赏译者

(2)Service Worker安装和激活

注册完之后,ServiceWorker就会议及展览开设置,这几个时候会触发install事件,在install事件之中能够缓存一些财富,如下sw-3.js:

JavaScript

const CACHE_NAME = “fed-cache”; this.add伊芙ntListener(“install”,
function(event) { this.skipWaiting(); console.log(“install service
worker”); // 制造和开辟二个缓存库 caches.open(CACHE_NAME); // 首页 let
cacheResources = [“];
event.waitUntil( // 请求财富并添加到缓存里面去
caches.open(CACHE_NAME).then(cache => {
cache.addAll(cacheResources); }) ); });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
const CACHE_NAME = "fed-cache";
this.addEventListener("install", function(event) {
    this.skipWaiting();
    console.log("install service worker");
    // 创建和打开一个缓存库
    caches.open(CACHE_NAME);
    // 首页
    let cacheResources = ["https://fed.renren.com/?launcher=true"];
    event.waitUntil(
        // 请求资源并添加到缓存里面去
        caches.open(CACHE_NAME).then(cache => {
            cache.addAll(cacheResources);
        })
    );
});

通过地点的操作,成立和添加了1个缓存库叫fed-cache,如下Chrome控制台所示:

图片 11

ServiceWorker的API基本上都以重返Promise对象防止堵塞,所以要用Promise的写法。下边在安装ServiceWorker的时候就把首页的乞请给缓存起来了。在ServiceWorker的周转条件之中它有三个caches的全局对象,那个是缓存的输入,还有三个常用的clients的大局对象,3个client对应2个标签页。

在ServiceWorker里面能够利用fetch等API,它和DOM是与世隔膜的,没有windows/document对象,非常的小概直接操作DOM,不大概直接和页面交互,在ServiceWorker里面不能够获知当前页面打开了、当前页面包车型地铁url是什么,因为贰个ServiceWorker管理当前开拓的多少个标签页,能够因此clients知道全体页面包车型客车url。还有可以通过postMessage的点子和主页面相互传送新闻和数量,进而做些控制。

install完现在,就会触发Service Worker的active事件:

JavaScript

this.addEventListener(“active”, function(event) { console.log(“service
worker is active”); });

1
2
3
this.addEventListener("active", function(event) {
    console.log("service worker is active");
});

ServiceWorker激活之后就可见监听fetch事件了,大家盼望每得到2个能源就把它缓存起来,就不用像上一篇涉嫌的Manifest要求先生成三个列表。

您只怕会问,当作者刷新页面包车型地铁时候不是又再次登记安装和激活了三个ServiceWorker?固然又调了3回注册,但并不会重新挂号,它发现”sw-3.js”那个已经注册了,就不会再登记了,进而不会触发install和active事件,因为日前ServiceWorker已经是active状态了。当须求创新ServiceWorker时,如变成”sw-4.js”,可能改变sw-3.js的公文内容,就会再度注册,新的ServiceWorker会先install然后进入waiting状态,等到重启浏览器时,老的ServiceWorker就会被轮换掉,新的ServiceWorker进入active状态,要是不想等到再次起动浏览器能够像上边一样在install里面调skipWaiting:

JavaScript

this.skipWaiting();

1
this.skipWaiting();

拍卖响应式图片

img的srcset属性大概<picture>标签会根据情况从浏览器或者网络上选择最合适尺寸的图片。

在service worker中,你想要在install步骤缓存二个图纸,你有以下三种选用:

  1. 安装具有的<picture>元素或者将被请求的srcset属性。
  2. 安装单一的low-res版本图片
  3. 安装单一的high-res版本图片

正如好的方案是2或3,因为假使把拥有的图片都给下载下来存着有点浪费内部存款和储蓄器。

假设你将low-res版本在install的时候缓存了,然后在页面加载的时候你想要尝试从网络上下载high-res的版本,可是若是high-res版本下载退步以来,就依然用low-res版本。那几个想法很好也值得去做,但是有三个题材:

比方大家有上边二种图片:

Screen Density Width Height
1x 400 400
2x 800 800

HTML代码如下:

JavaScript

<img src=”image-src.png” srcset=”image-src.png 1x, image-2x.png 2x”
/>

1
<img src="image-src.png" srcset="image-src.png 1x, image-2x.png 2x" />

假使大家在2个2x的展现格局下,浏览器会下载image-2x.png,假诺我们离线,你能够读取在此以前缓存并回到image-src.png替代,假设在此以前它已经被缓存过。就算如此,由于今日的方式是2x,浏览器会把400X400的图形展现成200X200,要制止这几个难题即将在图片的体裁上安装宽高。

JavaScript

<img src=”image-src.png” srcset=”image-src.png 1x, image-2x.png 2x”
style=”width:400px; height: 400px;” />

1
2
<img src="image-src.png" srcset="image-src.png 1x, image-2x.png 2x"
style="width:400px; height: 400px;" />

图片 12

<picture>标签情况更复杂一些,难度取决于你是如何创建和使用的,但是可以通过与srcset类似的思路去解决。

行使service workder缓存文件

上面介绍三个行使service worker缓存离线文件的事例
防微杜渐index.js,用于注册service-worker

JavaScript

if (navigator.serviceWorker) {
navigator.serviceWorker.register(‘service-worker.js’).then(function(registration)
{ console.log(‘service worker 注册成功’); }).catch(function (err) {
console.log(‘servcie worker 注册退步’) }); }

1
2
3
4
5
6
7
if (navigator.serviceWorker) {
    navigator.serviceWorker.register(‘service-worker.js’).then(function(registration) {
        console.log(‘service worker 注册成功’);
    }).catch(function (err) {
        console.log(‘servcie worker 注册失败’)
    });
}

在上述代码中,注册了service-worker.js作为当前路线下的service
worker。由于service
worker的权柄很高,全体的代码都亟需是安全可信的,所以只有https站点才足以动用service
worker,当然localhost是3个特例。
登记甘休,以后起来写service-worker.js代码。
依据后边的生命周期图,在1个新的service
worker被登记之后,首先会触发install事件,在service-workder.js中,能够由此监听install事件举办部分伊始化学工业作,大概如何也不做。
因为我们是要缓存离线文件,所以能够在install事件中初露缓存,不过只是将文件加到caches缓存中,真正想让浏览器采纳缓存文件要求在fetch事件中梗阻

JavaScript

var cacheFiles = [ ‘about.js’, ‘blog.js’ ];
self.addEventListener(‘install’, function (evt) { evt.waitUntil(
caches.open(‘my-test-cahce-v1’).then(function (cache) { return
cache.addAll(cacheFiles); }) ); });

1
2
3
4
5
6
7
8
9
10
11
var cacheFiles = [
    ‘about.js’,
    ‘blog.js’
];
self.addEventListener(‘install’, function (evt) {
    evt.waitUntil(
        caches.open(‘my-test-cahce-v1’).then(function (cache) {
            return cache.addAll(cacheFiles);
        })
    );
});

第叁定义了亟待缓存的公文数组cacheFile,然后在install事件中,缓存这个文件。
evt是贰个InstallEvent对象,继承自Extendable伊夫nt,当中的waitUntil()方法接收1个promise对象,直到那个promise对象成功resolve之后,才会连续运维service-worker.js。
caches是七个CacheStorage对象,使用open()方法打开一个缓存,缓存通过名称实行区分。
取得cache实例之后,调用addAll()方法缓存文件。

如此那般就将文件添加到caches缓存中了,想让浏览器选取缓存,还亟需拦截fetch事件

JavaScript

// 缓存图片 self.add伊夫ntListener(‘fetch’, function (evt) {
evt.respondWith( caches.match(evt.request).then(function(response) { if
(response) { return response; } var request = evt.request.clone();
return fetch(request).then(function (response) { if (!response &&
response.status !== 200 &&
!response.headers.get(‘Content-type’).match(/image/)) { return response;
} var responseClone = response.clone();
caches.open(‘my-test-cache-v1’).then(function (cache) {
cache.put(evt.request, responseClone); }); return response; }); }) ) });

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
// 缓存图片
self.addEventListener(‘fetch’, function (evt) {
    evt.respondWith(
        caches.match(evt.request).then(function(response) {
            if (response) {
                return response;
            }
            var request = evt.request.clone();
            return fetch(request).then(function (response) {
                if (!response && response.status !== 200 && !response.headers.get(‘Content-type’).match(/image/)) {
                    return response;
                }
                var responseClone = response.clone();
                caches.open(‘my-test-cache-v1’).then(function (cache) {
                    cache.put(evt.request, responseClone);
                });
                return response;
            });
        })
    )
});

透过监听fetch事件,service worker能够回到本人的响应。

第贰检缓存中是或不是早已缓存了那几个请求,借使有,就径直重临响应,就减少了一回网络请求。否则由service
workder发起请求,那时的service workder起到了1个中间代理的成效。

service worker请求的历程通过fetch
api达成,获得response对象未来举办过滤,查看是还是不是是图片文件,借使不是,就径直重返请求,不会缓存。

假定是图片,要先复制一份response,原因是request只怕response对象属于stream,只好使用贰次,之后一份存入缓存,另一份发送给页面。
那便是service worker的强硬之处:拦截请求,伪造响应。fetch
api在那里也起到了非常大的功力。

 

service
worker的换代很简短,只要service-worker.js的文件内容有更新,就会利用新的台本。然而有好几要小心:旧缓存文件的解除、新文件的缓存要在activate事件中展开,因为大概旧的页面还在选拔在此以前的缓存文件,清除之后会失去效能。

 

在首先使用service worker的长河中,也碰着了部分难点,上边是中间五个

打赏扶助作者翻译越多好小说,多谢!

图片 13

1 赞 收藏
评论

(1)注册二个Service Worker

Service Worker对象是在window.navigator里面,如下代码:

JavaScript

window.addEventListener(“load”, function() { console.log(“Will the
service worker register?”); navigator.serviceWorker.register(‘/sw-3.js’)
.then(function(reg){ console.log(“Yes, it did.”); }).catch(function(err)
{ console.log(“No it didn’t. This happened: “, err) }); });

1
2
3
4
5
6
7
8
9
window.addEventListener("load", function() {
    console.log("Will the service worker register?");
    navigator.serviceWorker.register(‘/sw-3.js’)
    .then(function(reg){
        console.log("Yes, it did.");
    }).catch(function(err) {
        console.log("No it didn’t. This happened: ", err)
    });
});

在页面load完之后注册,注册的时候传三个js文件给它,那几个js文件正是ServiceWorker的运转条件,若是不可能打响注册的话就会抛卓殊,如Safari
TP固然有那几个指标,可是会抛非常不可能采用,就足以在catch里面处理。那里有个难点是怎么需求在load事件运转呢?因为您要格外运行3个线程,运维以往你只怕还会让它去加载能源,那个都以亟需占用CPU和带宽的,咱们相应保障页面能健康加载完,然后再起步大家的后台线程,不能与正规的页面加载产生竞争,这些在低端移动装备意义比较大。

再有少数急需专注的是ServiceWorker和Cookie一样是有Path路径的定义的,假使您设定1个cookie要是叫time的path=/page/A,在/page/B那些页面是不能取获得这么些cookie的,就算设置cookie的path为根目录/,则怀有页面都能赢获得。类似地,假使注册的时候利用的js路径为/page/sw.js,那么那个ServiceWorker只可以管理/page路径下的页面和财富,而不能处理/api路径下的,所以一般把瑟维斯Worker注册到五星级目录,如上边代码的”/sw-3.js”,那样这一个ServiceWorker就能接管页面包车型客车保有财富了。

相关文章

发表评论

电子邮件地址不会被公开。 必填项已用*标注

网站地图xml地图