如何解决 PWA 中 Service Worker 请求 API 跨域的问题

如何解决 PWA 中 Service Worker 请求 API 跨域的问题

前言

随着 PWA 技术的不断发展，越来越多的 Web 应用程序借助 Service Worker 技术实现离线缓存、消息推送、网络代理等高级应用功能。但是，在实际的应用过程中，我们经常会面对 Service Worker 请求 API 跨域的问题，这让我们的实现过程变得更加复杂和困难。本文就结合实际应用场景，讲解如何解决 PWA 中 Service Worker 请求 API 跨域的问题。

解决方案

前端请求跨域一般有以下几种方式：

  • JSONP 跨域请求
  • CORS 跨域资源共享
  • 代理服务器转发
  • postMessage 跨域通信
  1. JSONP 跨域请求

JSONP 是一种利用 script 标签实现跨域请求的方式。由于 script 标签的 src 属性是不受同源策略限制的，所以可以利用这一点来实现跨域请求，同时还需要一个回调函数作为参数将请求结果传递回去。

下面是一个简单的示例：

// 注册 service worker，并在 install 事件中注册 fetch 事件监听器 self.addEventListener('install', function(event) { event.waitUntil( caches.open('my-cache').then(function(cache) { return cache.addAll([ '/', '/index.html', '/app.js' ]); }) ); });

// 监听 fetch 事件，并通过 JSONP 方式请求数据 self.addEventListener('fetch', function(event) { var url = event.request.url; if (url.indexOf('https://api.example.com/data') !== -1) { event.respondWith( fetch('https://api.example.com/data?callback=getData', { mode: 'no-cors' }).then(function(response) { return response.text(); }) .then(function(text) { var regex = /^getData((.*))$/; var matches = regex.exec(text); if (matches.length > 1) { return new Response(matches[1], { headers: { 'Content-Type': 'application/json' } }); } else { return new Response('', { status: 500, statusText: 'JSONP call failed' }); } }) ); } else { event.respondWith( caches.match(event.request).then(function(response) { return response || fetch(event.request); }) ); } });

需要注意，由于 JSONP 的缺陷比较明显，即只能通过 get 请求方式来请求数据，并且并不支持 error 或者超时等错误处理，所以在实际应用中，尽量要避免采用这种方式。

  1. CORS 跨域资源共享

CORS 是一种标准的跨域请求方式，通过在服务端设置 Access-Control-Allow-Origin 响应头，让浏览器知道当前的请求可以被哪些域名所访问。

下面是一个简单的示例：

// 注册 service worker，并在 install 事件中注册 fetch 事件监听器 self.addEventListener('install', function(event) { event.waitUntil( caches.open('my-cache').then(function(cache) { return cache.addAll([ '/', '/index.html', '/app.js' ]); }) ); });

// 监听 fetch 事件，并通过 CORS 方式请求数据 self.addEventListener('fetch', function(event) { var url = event.request.url; if (url.indexOf('https://api.example.com/data') !== -1) { event.respondWith( fetch(event.request, { mode: 'cors' }) .then(function(response) { return response; }) .catch(function(error) { return new Response(JSON.stringify({ error: error.message }), { status: 500, statusText: error.message }); }) ); } else { event.respondWith( caches.match(event.request).then(function(response) { return response || fetch(event.request); }) ); } });

需要注意，CORS 方式除了服务端要设置相关的 Access-Control-Allow-Origin 响应头之外，还需要浏览器支持。传统的服务端处理方式是在服务端定义的请求头里指定相关的 CORS 请求头，但 PWA 应用中 Service Worker 是无法修改客户端请求头的，所以需要在客户端发送请求时启用 mode 属性设置为 'cors'。

  1. 代理服务器转发

代理服务器主要是通过在服务端对请求进行转发，从而绕过浏览器同源限制的问题。由于 Service Worker 监听的是浏览器客户端请求事件 fetch，所以需要在客户端中对代理请求做相应的处理。

下面是一个简单的示例：

// 注册 service worker，并在 install 事件中注册 fetch 事件监听器 self.addEventListener('install', function(event) { event.waitUntil( caches.open('my-cache').then(function(cache) { return cache.addAll([ '/', '/index.html', '/app.js' ]); }) ); });

// 监听 fetch 事件，并通过代理服务器转发请求数据 self.addEventListener('fetch', function(event) { var url = event.request.url; if (url.indexOf('https://api.example.com/data') !== -1) { event.respondWith( fetch('/api/data') .then(function(response) { return response; }) .catch(function(error) { return new Response(JSON.stringify({ error: error.message }), { status: 500, statusText: error.message }); }) ); } else { event.respondWith( caches.match(event.request).then(function(response) { return response || fetch(event.request); }) ); } });

需要注意，代理服务器转发的请求绕过了浏览器的同源策略，具备一定的安全风险。同时，由于代理服务器一般都会代理大量的请求，如果协议或者服务器地址等修改，可能需要修改大量的代码，且在运维方面也需要做好相应的规划和管理。

  1. postMessage 跨域通信

postMessage 是 HTML5 标准定义的一种跨域通信方式，可以在父子页面、同源 iframe 之间进行通信。Service Worker 监听 fetch 事件时，可以通过 postMessage 启动一个 iframe 静默后台请求 API 返回数据，同时在 onmessage 回调函数中将请求结果传递回去。

下面是一个简单的示例：

// 注册 service worker，并在 install 事件中注册 fetch 事件监听器 self.addEventListener('install', function(event) { event.waitUntil( caches.open('my-cache').then(function(cache) { return cache.addAll([ '/', '/index.html', '/app.js' ]); }) ); });

// 监听 fetch 事件，并通过 postMessage 方式请求数据 self.addEventListener('fetch', function(event) { var url = event.request.url; if (url.indexOf('https://api.example.com/data') !== -1) { event.respondWith( new Promise(function(resolve, reject) { var messageChannel = new MessageChannel(); messageChannel.port1.onmessage = function(event) { var result = JSON.parse(event.data); if (result && result.status === 'success') { resolve(new Response(result.data, { headers: { 'Content-Type': 'application/json' } })); } else { reject(new Response('', { status: 500, statusText: 'postMessage call failed' })); } }; navigator.serviceWorker.controller.postMessage({ api: 'https://api.example.com/data', method: 'get' }, [messageChannel.port2]); }) ); } else { event.respondWith( caches.match(event.request).then(function(response) { return response || fetch(event.request); }) ); } });

需要注意，postMessage 方式需要 Service Worker 安全域名 和页面域名相同，且在 API 请求的时候需要通过静默后台 iframe 请求。同时，在浏览器发送 postMessage 时，需要自行选择兼容性最好的 API 进行操作，这里推荐使用 BroadcastChannel。

总结

以上就是 PWA 中 Service Worker 请求 API 跨域问题的解决方案。在实际应用中，我们需要根据具体的业务场景和安全规范选用合适的方式，从而在保证功能实现的同时也要提高安全性。

引用资料

  • JSONP is still good: How to easily solve Service Workers' CORS limitations
  • Service Worker and CORS
  • Understanding Service Workers in PWA – Part 3

参考代码

  • JSONP 示例代码
  • CORS 示例代码
  • 代理服务器转发 示例代码
  • postMessage 示例代码

来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/64c3367683d39b488172e25f

阅读全文

猜你喜欢

  • GraphQL：用 Connection 优化节点查询

    前言 GraphQL 是一种由 Facebook 开发的数据查询和操作语言，它提供了一种更高效、更灵活的方式来获取和操作数据。GraphQL 的一个重要特性就是可以精确地指定需要查询的数据，避免了传统...

    2 个月前
  • Server-sent Events 的浏览器支持情况及解决方法

    什么是 Server-sent Events？ Server-sent Events（简称 SSE）是一种基于 HTTP 的服务器推送技术，它可以让服务器向客户端发送事件流，客户端通过监听这个事件流来...

    2 个月前
  • ECMAScript 2020（ES11）中的新特性：BigInt 转换

    在 ECMAScript 2020（ES11）中，新增了一种数据类型：BigInt。它是一种可以表示任意大整数的数据类型，可以用来解决 JavaScript 中整数运算的精度问题。

    2 个月前
  • CSS Reset 在 IE6、IE7 等老浏览器中的应用

    什么是 CSS Reset CSS Reset 是一种通过重置浏览器默认样式的方式，消除不同浏览器之间的差异，从而实现更加一致的样式效果的技术手段。在前端开发中，使用 CSS Reset 可以让我们更...

    2 个月前
  • ES6 中的类继承和原型链之间的关系解析

    在 ES6 中，引入了 class 关键字，使得 JavaScript 也具备了面向对象编程的能力。在类继承和原型链之间，有着密切的关系。本文将详细解析 ES6 中的类继承和原型链之间的关系，并提供一...

    2 个月前
  • 如何使用 Redux 处理 React 应用中的表单数据

    前言 在开发 React 应用时，表单数据的处理是非常常见的需求。然而，由于 React 的单向数据流和组件化特性，传统的表单处理方式可能会变得非常繁琐。而 Redux 作为一种状态管理工具，可以帮助...

    2 个月前
  • Redis 处理高并发的策略

    前言 随着互联网的发展，高并发已经成为了一个不可避免的问题。而 Redis 作为一款高性能的 NoSQL 数据库，也成为了处理高并发的重要工具之一。本文将会介绍 Redis 处理高并发的策略，并且会提...

    2 个月前
  • 响应式设计中的图片适配问题解决方案

    在响应式设计中，图片适配是一个比较棘手的问题。如果不加以处理，可能会导致图片在不同设备上显示不佳，影响用户体验。本文将介绍响应式设计中的图片适配问题，并提供解决方案。

    2 个月前
  • 解析 TypeScript 中 encapsulation（封装）的实现方式

    解析 TypeScript 中 encapsulation（封装）的实现方式 在 TypeScript 中，封装（encapsulation）是一种重要的面向对象编程的特性。

    2 个月前
  • PM2 崩溃处理：如何避免由于 PM2 进程奔溃导致应用崩溃？

    在前端开发中，我们经常使用 PM2 进行进程管理和部署。但是，当 PM2 进程崩溃时，应用也会跟着崩溃。如何避免这种情况的发生？本文将介绍 PM2 崩溃处理的方法和技巧，帮助您更好地管理和部署应用。

    2 个月前
  • 在 Node.js 中运行 HTTPS 服务器的方法

    Node.js 是一个非常流行的 JavaScript 运行时环境，它可以让我们通过 JavaScript 编写服务器端应用程序。在开发 Web 应用程序时，安全性是非常重要的。

    2 个月前
  • 详解 ECMAScript 2018 中的三个新操作符及其用法

    ECMAScript 2018 (简称 ES2018) 是 JavaScript 语言的最新标准，其中包含了许多新特性和语法糖。本文将详细介绍其中的三个新操作符及其用法，分别是：扩展运算符、剩余运算符...

    2 个月前
  • 解决 Enzyme 测试 React Native 组件时动画无法渲染的问题

    在开发 React Native 应用时，我们经常需要使用 Enzyme 来测试组件。然而，当我们测试涉及到动画的组件时，我们可能会遇到一些问题：动画无法渲染，导致测试失败。

    2 个月前
  • 使用 React Router 打造复杂而强大的 SPA 应用

    随着 Web 技术的不断发展，单页应用（Single Page Application，SPA）已经成为了现代 Web 应用的主流。SPA 通过异步加载数据和动态更新页面，提供了更快速、更流畅的用户体...

    2 个月前
  • AngularJS 中如何使用 ng-repeat 中的 filter 来过滤数据

    在 AngularJS 中，ng-repeat 指令是用于循环遍历数组或对象并生成 HTML 元素的常用指令。而 ng-repeat 指令中的 filter 属性则是用于过滤数据的功能。

    2 个月前
  • 如何在 Chai 中验证 Promise.all

    如何在 Chai 中验证 Promise.all 在前端开发中，Promise.all 是一个非常常用的功能，它可以让我们在多个异步操作完成后再执行一些操作，这个功能在实际开发中非常实用。

    2 个月前
  • Mongoose 实现数据批量更新的方式详解

    前言 在前端开发中，经常会涉及到对数据库中的数据进行批量更新的操作。而 Mongoose 是一款 Node.js 平台下的 MongoDB 对象模型工具，它提供了一种方便的方式来操作 MongoDB ...

    2 个月前
  • 在使用 lit-element 的时候，如何解决麻烦的 Shadow DOM 的变量传递问题

    前言 在使用 Web Components 的时候，我们通常会使用 Shadow DOM 来实现封装和样式隔离。然而，Shadow DOM 的封闭性也带来了一些挑战，其中之一就是变量传递问题。

    2 个月前
  • Tailwind CSS 如何实现动态换肤？

    随着互联网的发展，越来越多的网站和应用开始支持动态换肤功能。动态换肤不仅可以提升用户体验，还可以让用户在不同的环境下选择适合自己的主题，增加用户黏性和满意度。本文将介绍如何使用 Tailwind CS...

    2 个月前
  • 如何在 Less 中使用字符串操作函数？

    在前端开发中，样式表是不可或缺的一部分。而 Less 是一种动态样式语言，它是 CSS 的一种扩展。在 Less 中，我们可以使用字符串操作函数来处理字符串，这些函数可以帮助我们更加方便地操作字符串，...

    2 个月前

相关推荐

    暂无文章