漸進式Web應用(PWA)入門教程(下)

上篇文章咱們對漸進式Web應用(PWA)作了一些基本的介紹。css

漸進式Web應用(PWA)入門教程(上)html

在這一節中,咱們將介紹PWA的原理是什麼,它是如何開始工做的。前端

第一步:使用HTTPS

漸進式Web應用程序須要使用HTTPS鏈接。雖然使用HTTPS會讓您服務器的開銷變多,但使用HTTPS可讓您的網站變得更安全,HTTPS網站在Google上的排名也會更靠前。web

因爲Chrome瀏覽器會默認將localhost以及127.x.x.x地址視爲測試地址,因此在本示例中您並不須要開啓HTTPS。另外,出於調試目的,您能夠在啓動Chrome瀏覽器的時候使用如下參數來關閉其對網站HTTPS的檢查:編程

  • user-data-dir
  • unsafety-treat-insecure-origin-as-secure

第二步:建立一個應用程序清單(Manifest)

應用程序清單提供了和當前漸進式Web應用的相關信息,如:json

  • 應用程序名
  • 描述
  • 全部圖片(包括主屏幕圖標,啓動屏幕頁面和用的圖片或者網頁上用的圖片)

本質上講,程序清單是頁面上用到的圖標和主題等資源的元數據。segmentfault

程序清單是一個位於您應用根目錄的JSON文件。該JSON文件返回時必須添加Content-Type: application/manifest+json 或者 Content-Type: application/jsonHTTP頭信息。程序清單的文件名不限,在本文的示例代碼中爲manifest.json:數組

{
      "name"              : "PWA Website",
      "short_name"        : "PWA",
      "description"       : "An example PWA website",
      "start_url"         : "/",
      "display"           : "standalone",
      "orientation"       : "any",
      "background_color"  : "#ACE",
      "theme_color"       : "#ACE",
      "icons": [
        {
          "src"           : "/images/logo/logo072.png",
          "sizes"         : "72x72",
          "type"          : "image/png"
        },
        {
          "src"           : "/images/logo/logo152.png",
          "sizes"         : "152x152",
          "type"          : "image/png"
        },
        {
          "src"           : "/images/logo/logo192.png",
          "sizes"         : "192x192",
          "type"          : "image/png"
        },
        {
          "src"           : "/images/logo/logo256.png",
          "sizes"         : "256x256",
          "type"          : "image/png"
        },
        {
          "src"           : "/images/logo/logo512.png",
          "sizes"         : "512x512",
          "type"          : "image/png"
        }
      ]
    }

程序清單文件創建完以後,你須要在每一個頁面上引用該文件:瀏覽器

<link rel="manifest" href="/manifest.json">

如下屬性在程序清單中常用,介紹說明以下:緩存

  • name: 用戶看到的應用名稱
  • short_name: 應用短名稱。當顯示應用名稱的地方不夠時,將使用該名稱。
  • description: 應用描述。
  • start_url: 應用起始路徑,相對路徑,默認爲/。
  • scope: URL範圍。好比:若是您將「/app/」設置爲URL範圍時,這個應用就會一直在這個目錄中。
  • background_color: 歡迎頁面的背景顏色和瀏覽器的背景顏色(可選)
  • theme_color: 應用的主題顏色,通常都會和背景顏色同樣。這個設置決定了應用如何顯示。
  • orientation: 優先旋轉方向,可選的值有:any, natural, landscape, landscape-primary, landscape-- - secondary, portrait, portrait-primary, and portrait-secondary
  • display: 顯示方式——fullscreen(無Chrome),standalone(和原生應用同樣),minimal-ui(最小的一套UI控件集)或者browser(最古老的使用瀏覽器標籤顯示)
  • icons: 一個包含全部圖片的數組。該數組中每一個元素包含了圖片的URL,大小和類型。

第三步:建立一個 Service Worker

Service Worker 是一個可編程的服務器代理,它能夠攔截或者響應網絡請求。Service Worker 是位於應用程序根目錄的一個個的JavaScript文件。

您須要在頁面對應的JavaScript文件中註冊該ServiceWorker:

if ('serviceWorker' in navigator) {
      // register service worker
      navigator.serviceWorker.register('/service-worker.js');
    }

若是您不須要離線的相關功能,您能夠只建立一個 /service-worker.js文件,這樣用戶就能夠直接安裝您的Web應用了!

Service Worker這個概念可能比較難懂,它實際上是一個工做在其餘線程中的標準的Worker,它不能夠訪問頁面上的DOM元素,沒有頁面上的API,可是能夠攔截全部頁面上的網絡請求,包括頁面導航,請求資源,Ajax請求。

上面就是使用全站HTTPS的主要緣由了。假設您沒有在您的網站中使用HTTPS,一個第三方的腳本就能夠從其餘的域名注入他本身的ServiceWorker,而後篡改全部的請求——這無疑是很是危險的。

Service Worker 會響應三個事件:install,activate和fetch。

Install事件
該事件將在應用安裝完成後觸發。咱們通常在這裏使用Cache API緩存一些必要的文件。

首先,咱們須要提供以下配置

  1. 緩存名稱(CACHE)以及版本(version)。應用能夠有多個緩存存儲,可是在使用時只會使用其中一個緩存存儲。每當緩存存儲有變化時,新的版本號將會指定到緩存存儲中。新的緩存存儲將會做爲當前的緩存存儲,以前的緩存存儲將會被做廢。
  2. 一個離線的頁面地址(offlineURL):當用戶訪問了以前沒有訪問過的地址時,該頁面將會顯示。
  3. 一個包含了全部必須文件的數組,包括保障頁面正常功能的CSS和JavaScript。在本示例中,我還添加了主頁和logo。當有不一樣的URL指向同一個資源時,你也能夠將這些URL分別寫到這個數組中。offlineURL將會加入到這個數組中。
  4. 咱們也能夠將一些非必要的緩存文件(installFilesDesirable)。這些文件在安裝過程當中將會被下載,但若是下載失敗,不會觸發安裝失敗。

    // 配置文件
       const
         version = '1.0.0',
         CACHE = version + '::PWAsite',
         offlineURL = '/offline/',
         installFilesEssential = [
           '/',
           '/manifest.json',
           '/css/styles.css',
           '/js/main.js',
           '/js/offlinepage.js',
           '/images/logo/logo152.png'
         ].concat(offlineURL),
         installFilesDesirable = [
           '/favicon.ico',
           '/images/logo/logo016.png',
           '/images/hero/power-pv.jpg',
           '/images/hero/power-lo.jpg',
           '/images/hero/power-hi.jpg'
         ];

installStaticFiles() 方法使用基於Promise的方式使用Cache API將文件存儲到緩存中。

// 安裝靜態資源
    function installStaticFiles() {
      
      return caches.open(CACHE)
        .then(cache => {
      
          // 緩存可選文件
          cache.addAll(installFilesDesirable);
      
          // 緩存必須文件
          return cache.addAll(installFilesEssential);
      
        });
      
    }

最後,咱們添加一個install的事件監聽器。waitUntil方法保證了service worker不會安裝直到其相關的代碼被執行。這裏它會執行installStaticFiles()方法,而後self.skipWaiting()方法來激活service worker:

// 應用安裝
    self.addEventListener('install', event => {
      
      console.log('service worker: install');
      
      // 緩存主要文件
      event.waitUntil(
        installStaticFiles()
        .then(() => self.skipWaiting())
      );
      
    });

Activate 事件
這個事件會在service worker被激活時發生。你可能不須要這個事件,可是在示例代碼中,咱們在該事件發生時將老的緩存所有清理掉了:

// clear old caches
    function clearOldCaches() {
      
      return caches.keys()
        .then(keylist => {
      
          return Promise.all(
            keylist
              .filter(key => key !== CACHE)
              .map(key => caches.delete(key))
          );
      
        });
      
    }
      
    // application activated
    self.addEventListener('activate', event => {
      
      console.log('service worker: activate');
      
        // delete old caches
      event.waitUntil(
        clearOldCaches()
        .then(() => self.clients.claim())
        );
      
    });

注意self.clients.claim()執行時將會把當前service worker做爲被激活的worker。

Fetch 事件 該事件將會在網絡開始請求時發起。該事件處理函數中,咱們可使用respondWith()方法來劫持HTTP的GET請求而後返回:

  1. 從緩存中取到的資源文件
  2. 若是第一步失敗,資源文件將會從網絡中使用Fetch API來獲取(和service
    worker中的fetch事件無關)。獲取到的資源將會加入到緩存中。
  3. 若是第一步和第二步均失敗,將會從緩存中返回正確的資源文件。

    // application fetch network data
       self.addEventListener('fetch', event => {
         
         // abandon non-GET requests
         if (event.request.method !== 'GET') return;
         
         let url = event.request.url;
         
         event.respondWith(
         
           caches.open(CACHE)
             .then(cache => {
         
               return cache.match(event.request)
                 .then(response => {
         
                   if (response) {
                     // return cached file
                     console.log('cache fetch: ' + url);
                     return response;
                   }
         
                   // make network request
                   return fetch(event.request)
                     .then(newreq => {
         
                       console.log('network fetch: ' + url);
                       if (newreq.ok) cache.put(event.request, newreq.clone());
                       return newreq;
         
                     })
                     // app is offline
                     .catch(() => offlineAsset(url));
         
                 });
         
             })
         
         );
         
       });

offlineAsset(url)方法中使用了一些helper方法來返回正確的數據:

// 是否爲圖片地址?
    let iExt = ['png', 'jpg', 'jpeg', 'gif', 'webp', 'bmp'].map(f => '.' + f);
    function isImage(url) {
      
      return iExt.reduce((ret, ext) => ret || url.endsWith(ext), false);
      
    }
      
      
    // return 返回離線資源
    function offlineAsset(url) {
      
      if (isImage(url)) {
      
        // 返回圖片
        return new Response(
          '<svg role="img" viewBox="0 0 400 300" xmlns="http://www.w3.org/2000/svg"><title>offline</title><path d="M0 0h400v300H0z" fill="#eee" /><text x="200" y="150" text-anchor="middle" dominant-baseline="middle" font-family="sans-serif" font-size="50" fill="#ccc">offline</text></svg>',
          { headers: {
            'Content-Type': 'image/svg+xml',
            'Cache-Control': 'no-store'
          }}
        );
      
      }
      else {
      
        // return page
        return caches.match(offlineURL);
      
      }
      
    }

offlineAsset()方法檢查請求是否爲一個圖片,而後返回一個帶有「offline」文字的SVG文件。其餘請求將會返回 offlineURL 頁面。

Chrome開發者工具中的ServiceWorker部分提供了關於當前頁面worker的信息。其中會顯示worker中發生的錯誤,還能夠強制刷新,也可讓瀏覽器進入離線模式。

Cache Storage 部分例舉了當前全部已經緩存的資源。你能夠在緩存須要更新的時候點擊refresh按鈕。

第四步:建立可用的離線頁面

離線頁面能夠是靜態的HTML,通常用於提醒用戶當前請求的頁面暫時沒法使用。然而,咱們能夠提供一些能夠閱讀的頁面連接。

Cache API能夠在main.js中使用。然而,該API使用Promise,在不支持Promise的瀏覽器中會失敗,全部的JavaScript執行會所以受到影響。爲了不這種狀況,在訪問/js/offlinepage.js的時候咱們添加了一段代碼來檢查當前是否在離線環境中:

/js/offlinepage.js 中以版本號爲名稱保存了最近的緩存,獲取全部URL,刪除不是頁面的URL,將這些URL排序而後將全部緩存的URL展現在頁面上:

// cache name
    const
      CACHE = '::PWAsite',
      offlineURL = '/offline/',
      list = document.getElementById('cachedpagelist');
      
    // fetch all caches
    window.caches.keys()
      .then(cacheList => {
      
        // find caches by and order by most recent
        cacheList = cacheList
          .filter(cName => cName.includes(CACHE))
          .sort((a, b) => a - b);
      
        // open first cache
        caches.open(cacheList[0])
          .then(cache => {
      
            // fetch cached pages
            cache.keys()
              .then(reqList => {
      
                let frag = document.createDocumentFragment();
      
                reqList
                  .map(req => req.url)
                  .filter(req => (req.endsWith('/') || req.endsWith('.html')) && !req.endsWith(offlineURL))
                  .sort()
                  .forEach(req => {
                    let
                      li = document.createElement('li'),
                      a = li.appendChild(document.createElement('a'));
                      a.setAttribute('href', req);
                      a.textContent = a.pathname;
                      frag.appendChild(li);
                  });
      
                if (list) list.appendChild(frag);
      
              });
      
          })
      
      });

開發者工具

Chrome瀏覽器提供了一系列的工具來幫助您來調試Service Worker,日誌也會直接顯示在控制檯上。

您最好使用匿名模式來進行開發工做,這樣能夠排除緩存對開發的干擾。

最後,Chrome的Lighthouse擴展也能夠爲您的漸進式Web應用提供一些改進信息。

漸進式Web應用的要點

漸進式Web應用是一種新的技術,因此使用的時候必定要當心。也就是說,漸進式Web應用可讓您的網站在幾個小時內獲得改善,而且在不支持漸進式Web應用的瀏覽器上也不會影響網站的顯示。

可是咱們須要考慮如下幾點:

URL隱藏
當您的應用就是一個單URL的應用程序時(好比遊戲),我建議您隱藏地址欄。除此以外的狀況我並不建議您隱藏地址欄。在Manifest中,display: minimal-ui 或者 display: browser對於大多數狀況來講足夠用了。

緩存過大
你不能將您網站中的全部內容緩存下來。對於小一些的網站來講緩存全部內容並非一個問題,可是若是一個網站包含了上千個頁面呢?很明顯不是全部人對網站中的全部內容都感興趣。存儲是有限制的,若是您將全部訪問過的頁面都緩存下來的話,緩存大小會增加額很快。

你能夠這樣制定你的緩存策略:

  • 只緩存重要的頁面,好比主頁,聯繫人頁面和最近瀏覽文章的頁面。
  • 不要緩存任何圖片,視頻和大文件
  • 定時清理舊的緩存
  • 提供一個「離線閱讀」按鈕,這樣用戶就能夠選擇須要緩存哪些內容了。

緩存刷新
示例代碼中在發起請求以前會先查詢緩存。當用戶處於離線狀態時,這很好,可是若是用戶處於在線狀態,那他只會瀏覽到比較老舊的頁面。

各類資源好比圖片和視頻不會改變,因此通常都把這些靜態資源設置爲長期緩存。這些資源能夠直接緩存一年(31,536,000秒)。在HTTP Header中,就是:

Cache-Control: max-age=31536000

頁面,CSS和腳本文件可能變化的更頻繁一些,因此你能夠設置一個比較小的緩存超時時間(24小時),並確保在用戶網絡鏈接恢復時再次從服務器請求:

Cache-Control: must-revalidate, max-age=86400

你也能夠在每次網站發佈時,經過更名的方式強制瀏覽器從新請求資源。

小結

至此,相信你若是按照本文一步一步操做下來,你也能夠很快把本身的Web應用轉爲PWA。在轉爲了PWA後,若是有使用知足 PWA 模型的前端控件的需求,你能夠試試純前端表格控件SpreadJS,適用於 .NET、Java 和移動端等平臺的表格控件必定不會令你失望的。

原文連接:https://www.sitepoint.com/ret...

相關文章
相關標籤/搜索