前端PWA应用的相关知识和基础Demo

一、什么是PWA应用？

1、Service Worker

Service Worker是一个独立于网页线程的脚本，无权访问页面的DOM结构，充当了网站和浏览器之间的代理服务器，每个PWA应用都只能注册一个Service Worker，其在PWA中主要用来实现离线访问、缓存资源、推送通知等功能，当然除此之外，它还具有很多其他功能，在这我们就不展开讲述了。

在网络正常时，当PWA应用请求Service Worker范围内的资源时，Service Worker会拦截该请求，并充当网络代理，然后它可以决定是从缓存中获取数据还是从服务器中获取数据。如果是从服务器中获取数据，Service Worker会缓存请求的数据，等到离线访问时，返回缓存的数据，使得PWA应用可以在离线状态下运行，并且可以利用缓存提升应用的加载速度。

由于Service Worker权利太大，能够直接截取并返回用户的请求，处于安全性考虑，目前仅支持在HTTPS或本地环境的安全环境下使用。

Service Worker的浏览器兼容性如下图：

$前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第2张$

如何为PWA注册Service Worker？

在Service Worker控制页面之前，必须在PWA应用中注册Service Worker服务。这意味着，在用户第一次访问PWA应用时，页面还并未受到Service Worker的控制，也就无法实现离线访问等功能。

注册Service Worker时，我们只需先判断浏览器是是否支持相关的API，如果支持则直接通过navigator.serviceWorker.register(url)进行注册即可，参数url表示具体Service Worker逻辑代码文件的路径。

// 这是页面中唯一与Service Worker有关的代码
if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/service-worker.js')
   .then(registration => {
     console.log('Service Worker 注册成功！', registration);
   })
   .catch(error => {
     console.log('Service Worker 注册失败：', error);
  });
}

如果想要查看Service Worker是否已经注册并正常运行，以Chrome浏览器为例，我们可以通过F12开发者工具中的Application，然后选中左侧的Service Workers ，如果右侧展示的信息中的Status中显示activity则表示已经注册并正常运行。

$前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第3张$

如果想要在移动端页面检查是否已经注册并正常运行，也只能通过连接电脑调试的方法来查看，具体可查看该文档：tools-and-debug。

Service Worker的作用范围怎么确定？

Service Worker在注册时引入的具体逻辑文件所在文件夹决定了其作用范围，例如：

navigator.serviceWorker.register("example.com/my-pwa/serviceworker.js");

则该Service Worker的作用范围在my-pwa文件夹下的任何文件，如： example.com/my-pwa/index.html等等。

为了实现Service Worker在PWA应用中的作用最大化，推荐将具体逻辑文件设置在PWA应用程序的根目录下，因为这样可以拦截到PWA应用中的所有请求。

Service Worker的生命周期分为哪些阶段？

Service Worker 的生命周期从注册 Service Worker 开始，也就是前文所说的register()方法，调用该方法时，就会发生注册行为。该生命周期阶段并没有对应的事件，然后我们可以通过register()方法的.then()来判断是否注册成功。

① Registration（注册）

if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/service-worker.js')
   .then(registration => {
     console.log('Service Worker 注册成功！', registration);
   })
   .catch(error => {
     console.log('Service Worker 注册失败：', error);
  });
}

然后浏览器开始下载并安装 Service Worker 文件，安装成功后，则会触发install事件，在整个生命周期中，install事件仅会触发这一次。开发者通常会在此事件中进行初始化，缓存一些静态资源，以备离线时访问。

② Installation（安装）

// 安装阶段
self.addEventListener('install', function(event) {
  event.waitUntil(
    // 向缓存中存储基本数据
    caches.open('cache-name').then(function(cache) {
      return cache.addAll([
        '/path/to/resource1',
        '/path/to/resource2',
        // ...
      ]);
    })
  );
});

在Service Worker中，我们需要通过全局对象self才能监听各个生命周期事件。在waitUntil()方法执行结束之前，Service Worker不会结束安装状态，必须等待其内部代码执行结束之后，才会进入到下一个生命周期。caches对象是限制在Service Worker 生命周期内使用的特殊对象，用于实现数据的缓存。

③ Activation（激活）

当Service Worker安装完成后，并不会立即进入激活状态，为了不影响当前正在访问的页面，此时Service Worker 并没有控制当前页面。所以要等到当前页面关闭，且再次加载该页面时，Service Worker才会进入激活状态，触发activate事件，开始控制网页的请求和缓存。在此阶段，开发者通常会进行清理旧的缓存、处理更新逻辑等操作，因为浏览器的缓存空间是有限的。

// Service Worker激活成功后 
self.addEventListener('activate', function(event) {
  event.waitUntil(
    // 对缓存中的数据进行处理
    caches.keys().then(function(cacheNames) {
      return Promise.all(
        // 只保留符合要求的数据 删除不需要的旧数据
        cacheNames.filter(function(cacheName) {
          return cacheName !== 'cache-name';
        }).map(function(cacheName) {
          return caches.delete(cacheName);
        })
      );
    })
  );
});

在waitUntil()方法执行结束之前，Service Worker不会进入下个状态，然后可以通过caches对象，对缓存的数据进行操作。

还有要注意的一点是，Service Worker 进入激活状态后，它会一直保持激活状态，除非被手动注销或者被新的 Service Worker 脚本取代。

④ Update（更新）

浏览器会周期性的检测当前应用的Service Worker是否有更新，当检测到Server Worker 脚本文件发生更新时，会在后台下载新的脚本，并触发更新流程。更新流程与安装流程类似，需要经历下载、安装、激活三个阶段。下载完成之后，会立即进行安装，但是安装完成之后，默认并不会立即激活，而且进入等待状态。因为同一时间只能有一个版本的 Service Worker处于Activation状态。只有当旧版本的Service Worker控制的所有页面都被关闭，然后用户再重新访问这些页面时，新的Service Worker才会被激活并接管旧版本所有页面的控制权。

我们也可以通过skipWaiting()方法来强制激活等待中 Service Worker，使其取代旧版 Service Worker，获得页面的控制权。该方法只有在存在等待状态的 Service Worker时，调用才会有意义，所以通常都在install事件中执行调用。

// 新版Service Worker的install事件
self.addEventListener("install", (event) => {
  // 安装好后 调用skipWaiting() 使其立即激活
  // skipWaiting() 返回一个 promise，但完全可以忽略它
  self.skipWaiting();
  // 然后执行 service worker 安装所需的缓存数据等其他操作
  e.waitUntil(
    (async () => {
      const cache = await caches.open(cacheName);
      await cache.addAll(contentToCache);
    })(),
  );
});

⑤ Termination（终止）

当Service Worker被手动注销，或被新版本Service Worker取代后，就会进入终止阶段，它将不再控制页面的请求，并释放相应的资源。即使不被注销或者取代，Service Worker也不会无限期的存活，各大浏览器的处理逻辑不同，但在激活一段时间后，Service Worker就会被终止。终止之后，需要重新注册，才能继续运行。

if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/service-worker.js')
   .then(registration => {
     console.log('Service Worker 注册成功！', registration);
     // 手动注销Service Worker
     registration.unregister().then(function (boolean) {
        if(boolean) {
          console.log('Service Worker 注销成功！')
        }
      });
   })
   .catch(error => {
     console.log('Service Worker 注册失败：', error);
  });
}

⑥ Fetch（请求）

Service Worker 还提供了一个fetch事件，每当Service Worker控制的页面中，发出fetch请求或者html、css、js等资源请求时，都会触发该事件，我们可以在此阶段拦截请求并结合缓存使用自定义响应来响应请求。注意：ajax请求不会触发该事件。

通常当请求的资源存在缓存时，我们都会从缓存中获取资源而不是从服务器获取。如果缓存中没有，那我们会使用另一个请求从服务器获取资源，并将资源存储在缓存中，以便下次请求或离线请求时使用。

self.addEventListener("fetch", (e) => {
  e.respondWith(
    (async () => {
      // 从缓存中获取资源
      const r = await caches.match(e.request);
      console.log(`Service Worker正在请求资源: ${e.request.url}`);
      if (r) {
        // 如果缓存中存在资源 则直接返回缓存中的资源
        return r;
      }
      // 如果缓存中没有 则去服务器请求资源
      const response = await fetch(e.request);
      const cache = await caches.open(cacheName);
      console.log(`Service Worker 缓存新资源: ${e.request.url}`);
      // 将请求的资源存储到缓存中 
      cache.put(e.request, response.clone());
      // 将请求结果缓存
      return response;
    })(),
  );
});

该fetch事件的事件对象event中包含了一个respondWith()方法，该方法可以阻止浏览器默认的fetch请求操作，并允许自定义请求的response，更多信息请查看：FetchEvent.respondWith()。

2、Web App Manifest

Web App Manifest（Web应用清单），是一个遵守W3C规范的JSON文件，用来定义PWA安装的客户端在设备上应该如何显示和运行，例如应用的名称、图标、启动方式等等，该文件是实现PWA所必需的。通过该文件，用户可将PWA应用安装到用户的主屏幕上，使其更像一个原生应用的客户端。

该文件中可定义的应用信息很多，其中比较常用的有以下几条：

① name

该字段定义PWA应用的全名，是Web App Manifes中必须的一个基本字段。该名称一般会显示为应用商店的应用名称，也会在应用启动时显示在标题栏中。

"name": "学科网PWA示例"

② short_name

该字段定义PWA应用的简称，尽量控制在12个字符以内，当应用程序被安装在桌面上时，由于空间有限，通常就会显示该简称，但具体展示name还是short_name可能因设备、浏览器或操作系统而有所不同，例如：在macos系统中，统一展示name字段。

"short_name": "PWA示例"

③ icons

该字段定义了应用程序安装在桌面上的图标，属性值为一个数组，数组元素为一个对象，对象中包含src、sizes、type三个属性，分别代表图标地址、图标的尺寸和图标的MIME类型。

src：指定了图标文件的位置，字段值可以是相对于manifest文件的相对URL，或者是一个绝对的网络URL。
sizes：指明了图标的尺寸，以宽×高的形式指定了图标的宽高，单位默认为px，目前设备适配性最好的图标尺寸为512×512。
type：指明了图标的MIME媒体类型，帮助浏览器在选择合适的图标文件，例如：image/png、image/jpeg等等。
该字段属性值数组至少需要定义一个图标元素，也可以定义多个不同格式的图标元素，从而为用户提供最佳的图标效果。每个浏览器都会根据其需要和所安装的操作系统选择其中最接近其所需的规范的某个图标。图标选择规则很多，主要有尺寸匹配、类型匹配、设备类型匹配等规则。
```
"icons": [
   {
      "src": "icons/512.png",
      "type": "image/png",
      "sizes": "512x512"
   },
   {
      "src": "icons/1024.png",
      "type": "image/png",
      "sizes": "1024x1024"
   }
]
```
④ start_url
该字段定义PWA应用的起始URL，用户点击图标打开程序时，将会加载这个URL所对应的页面，可以是相对于manifest文件的相对路径，也可以是一个绝对路径。推荐使用绝对路径，如果PWA应用的主页是网站的根目录，那么将该字段设置为/即可。如果没有设置该字段，则默认将安装PWA应用时的URL作为该字段的值。
```
"start_url": "./index.html"
```
⑤ display
该字段定义了PWA应用的打开方式，字段值有以下四种：
- standalone（推荐）：应用将以独立窗口打开，类似于原生应用程序，没有导航栏等浏览器功能。
  $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第4张$
  - fullscreen：应用将以全屏模式打开，隐藏浏览器的地址栏和工具栏。由于电脑操作系统的限制，该字段值表现效果与standalone一致。
  - minimal-ui：应用将独立窗口打开，但保留了一部分浏览器的导航功能，如后退、刷新功能等。
    $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第5张$
    - browser：应用将以常规浏览器网页的形式打开，类似于设置了一个网页的快捷方式。但是由于电脑操作系统的限制，该字段值表现效果与standalone一致。
```
"display": "standalone"
```
      ⑥ id
      该字段用于作为PWA应用的唯一标识，如果未设置，则默认以start_url的值为字段值。
```
"id": "xkw-pwa"
```
      ⑦ background_color
      该字段定义了PWA应用窗口打开后且样式表加载完成之前的窗口背景色，字段值支持关键字（red、green等）、十六进制色值（#FFFFFF、#CCCCC等）和RGB色值（rgb(255,255,255)等），但不建议使用rgba()等带有透明度的颜色，因为各个浏览器的展示效果可能大相径庭。但是目前iOS 和 iPadOS 上的 Safari 以及部分桌面浏览器目前会忽略此字段。
```
"background_color": "#000000",
```
      ⑧ theme_color
      该字段定义了PWA应用的窗口主题色，将会影响窗口工具栏、头部标题栏等区域的颜色，段值支持关键字（red、green等）、十六进制色值（#FFFFFF、#CCCCC等）和RGB色值（255,255,255等）。但是该属性会被标签设置的主题色所覆盖。
```
"theme_color": "#3880FF"
```
      ⑨ 其他属性
      。。。
      3、Push Notification
      Push 和 Notification是两个独立的API，Push用来接收服务器推送的信息，Notification 用来向用户推送信息。两者都需要在 Service Worker 内调用运行。
      具体可查看：Push Notification
      三、如何开发一个PWA应用Demo？
      1、创建一个demo文件夹，用来存储相关文件
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第6张$
      2、创建manifest.json文件，设置PWA应用信息
```
{
  "name": "猪猪侠的PWA示例", 
  "short_name": "PWA示例",
  "start_url": "/index.html",
  "display": "standalone",
  "background_color": "red",
  "theme_color": "#ccc",
  "icons": [
    {
      "src": "/icons/android-chrome-192x192.png",
      "sizes": "192x192",
      "type": "image/png"
    },
    {
      "src": "/icons/android-chrome-512x512.png",
      "sizes": "512x512",
      "type": "image/png"
    }
  ]
}
```
      3、创建icons文件夹，存储PWA应用图标文件
      存储以下两个图标文件：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第7张$
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第8张$
      4、创建main.css文件，设置页面样式
```
h3 {
  color: red;
}
```
      5、创建sw.js文件，设置Service Worker相关逻辑
      这里我们只需要直接书写Service Worker的处理逻辑即可：
```
// 缓存的key值，用于区别新旧版本缓存
var cacheStorageKey = 'minimal-pwa-2'
// 设置初始需要缓存的文件
var cacheList = [
  '/',
  'index.html',
  'main.css',
  '/icons/android-chrome-512x512.png'
]
// 监听安装事件 并在此阶段 缓存基本资源
self.addEventListener('install', e => {
  e.waitUntil(
    caches.open(cacheStorageKey)
      .then(
        // 缓存基本资源
        cache => cache.addAll(cacheList)
      )
      .then(() =>
        // 当脚本更新时 使新版Service Worker强制进入activate状态
        self.skipWaiting()
      )
  )
})
// 监听fetch请求事件
self.addEventListener('fetch', function (e) {
  // 拦截相关请求
  e.respondWith(
    // 如果缓存中已经有请求的数据就终止请求 直接返回缓存数据
    caches.match(e.request).then(async function (response) {
      if (response != null) {
        return response
      }
      // 否则就重新向服务端请求
      const res = await fetch(e.request)
      // 这块需要结合具体业务具体分析 我这里的示例逻辑是无脑全部缓存
      // 请求成功后将请求的资源缓存起来 后续请求直接走缓存
      const cache = await caches.open(cacheStorageKey)
      cache.put(e.request, res.clone())
      // 将请求的资源返回给页面。
      return res;
    })
  )
})
// 监听激活事件
self.addEventListener('activate', function (e) {
  e.waitUntil(
    //获取所有cache名称
    caches.keys().then(cacheNames => {
      return Promise.all(
        // 获取缓存中所有不属于当前版本cachekey下的内容
        cacheNames.filter(cacheNames => {
          return cacheNames !== cacheStorageKey
        }).map(cacheNames => {
          // 删除不属于当前版本的cache缓存数据
          return caches.delete(cacheNames)
        })
      )
    }).then(() => {
      // 无须刷新页面 即可使新版server worker接管当前页面
      return self.clients.claim()
    })
  )
})
```
      6、创建主文件index.html，设置页面DOM，并引用各类资源
```
  
  Hello PWA
  
  
  


  Hello 猪猪侠的PWA


  // 检测浏览器是否支持SW
  if ('serviceWorker' in navigator) {
    // 为当前页面注册Service Worker
    navigator.serviceWorker.register('./sw.js')
      .then(function (registartion) {
        console.log('当前浏览器支持sw:', registartion.scope);
        console.log('Service Worker注册成功', registartion);
      })
  }
```
      7、部署到服务器上(https) 或在本地环境使用
      以本地环境为例，使用VSCode作为辅助工具：
      ① 在VSCode中，右键选中index.html文件，选中Open with live Server选项，运行页面：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第9张$
      ② F12控制台，查看Service Worker是否注册成功：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第10张$
      ③ 然后点击Application，选中左侧Service Workers，查看sw脚本是否正常运行：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第11张$
      ④ 点击左侧Cache Storage，选中我们定义的cacheStorageKey-当前域名地址，查看初始资源(sw.js文件中定义的cacheList数组中的资源)是否被缓存：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第12张$
      ⑤ 点击Network，选中All，刷新页面，查看请求资源情况：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第13张$
      ⑥ 经过上次刷新，所有相关资源已被缓存，再次刷新页面，所有资源都将经过Service Worker之后，从缓存中获取：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第14张$
      ⑦ 通过选中NetWork中的Offline选项切断网络，查看在无网络时，页面是否能利用缓存正常显示：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第15张$
      ⑧ 点击右上角的下载按钮，安装PWA应用到设备上：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第16张$
      ⑨ 以macos系统为例，PWA应用安装后，会自动打开，并桌面端入口安装到应用启动台中，查看打开后的页面：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第17张$
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第18张$
      ⑩ F12控制台，重复②~⑦的操作，验证在桌面端打开时，Service Worker 能否正常运行。
      ⑪ 下载安装的PWA应用，需要通过右上角的功能区，进行卸载：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第19张$
      ⑫ 如果我们本地修改了项目文件的内容，直接刷新或者关闭页面再打开，是看不到更新的内容的，因为都是直接从缓存中获取相关数据，而且关闭页面或浏览器后Service Worker脚本依旧在后台执行，再次打开访问时，依旧是从缓存中获取数据。想要页面显示最新的内容需要先注销掉旧的的脚本，然后让新脚本取代旧脚本即可，在浏览器开发工具的Application中我们可以直接注销Service Worker脚本，然后再刷新页面即可：
      $前端PWA应用的相关知识和基础Demo,在这里插入图片描述,词库加载错误:未能找到文件“C:\Users\Administrator\Desktop\火车头9.8破解版\Configuration\Dict_Stopwords.txt”。,服务,服务器,网络,第20张$
      ⑬ 其他操作。。。
      四、相关资料
      PWA谷歌文档
      PWA的MDN文档
      Service Worker
      Service Worker 生命周期
      Web App Manifes
      参考博客