Polyfill Example

--- theme: vue-pro --- ## 引言对于前端开发者来说，`caniuse`网站是一个非常有用的工具，它可以帮助我们查询JavaScript API在不同浏览器版本中的兼容性情况。以`fetch`为例，我们可以在网站上查到其兼容性如下图所示： ![image.png](https://p1-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/efb20e69eff0498d8dcfc784a9752bba~tplv-k3u1fbpfcp-watermark.image?) ```js fetch('http://domain/service', { method: 'GET' }) .then(response => response.json()) .then(json => console.log(json)) .catch(error => console.error('error:', error)); ``` 但是人工保证 API 的兼容性是不可靠的，下面我分享一个真实发生的案例来分享本文的主题`自动化兼容性检查和解决方案` ### 线上事故最近发生了一起线上事故，让我深感惋惜。事情是这样的，小飞是刚毕业不久的前端应届生，7月份本该是他转正的日子。然而，不久前，由于他的一个小问题，导致线上APP H5页面出现了白屏，造成了部分业务损失。小飞同学主要负责借贷业务，这类业务涉及C端用户，而且涉及金钱，所以问题的严重性不言而喻。最终，这次事故导致他的转正申请未能通过，实在是遗憾。 ### 事故原因后来，小飞问我，该如何尽量避免这种白屏问题。他提到，在回归测试阶段，测试同学告诉他没有问题，结果线上用户才反馈白屏问题。我的第一反应是询问他是否有JS报错导致的问题。事实上，这确实是问题的根源。由于低端机型不支持某个API，导致页面报错，从而出现白屏问题。那么，有没有办法在CICD流程中或者在代码开发中就能扫描到这种问题呢？除了监控系统之外是否还有其他方式？实际上是有的。之前我写过一篇文章[我给项目加了性能守卫插件，同事叫我晚上别睡的太死](https://juejin.cn/post/7253331974051823675)，提到了如何利用`eslint-plugin-compat插件`来实现这种机制，从而避免类似线上生产事故的发生。使用这个插件，我们可以在代码开发阶段就发现可能的兼容性问题，让开发者及时修复，避免将问题带入线上环境。 ## 自动化兼容性检查 ### 使用eslint-plugin-compat插件 eslint-plugin-compat是一个强大的工具，可以帮助我们检查代码中使用的特性在不同浏览器中的兼容性。以下是使用eslint-plugin-compat进行自动化兼容性检查的步骤： ### 安装插件： ```bash npm install eslint-plugin-compat --save-dev ``` ### 配置ESLint：在项目的.eslintrc.js配置文件中添加插件： ```javascript module.exports = { // ... plugins: [ // ... 'compat' ], // ... }; ``` ### 设置browserslist：通过使用`browserslist`配置，你可以确保你的项目在目标浏览器中都能够正常运行，并在开发阶段自动引入相应的polyfill或进行兼容性警告，从而节省调试时间，提高开发效率，并构建跨浏览器友好的Web应用。无论是在现代浏览器中使用最新的特性，还是在旧版浏览器中提供兼容性支持，`browserslist`都能帮助你轻松管理和配置项目的兼容性需求。示例`.browserslistrc`配置如下： ```js # Browsers that have more than 5% global usage > 5% # Last 2 versions of major browsers (including Chrome, Firefox, Safari, and Edge) last 2 major versions # Specific browser versions IE 11 iOS >= 11 not dead # Browsers used in specific countries and_chr 78 and_ff 68 # Browsers used in specific environments maintained node versions not IE 11 # Development and production environment specific targets development last 1 chrome version last 1 firefox version production > 0.2% ``` | 配置选项 | 描述 | |-------------------------------|-----------------------------------------------------| | `> 5%` | 全球使用率超过5%的浏览器 | | `last 2 major versions` | 最近两个主要版本的浏览器 | | `IE 11` | 仅包括Internet Explorer 11 | | `iOS >= 11` | iOS系统版本大于等于11的浏览器 | | `not dead` | 排除已经被认为是不再使用的浏览器 | | `and_chr 78` | 特定版本的Chrome浏览器 | | `and_ff 68` | 特定版本的Firefox浏览器 | | `maintained node versions` | 当前被维护的Node.js版本 | | `not IE 11` | 排除Internet Explorer 11 | | `development` | 开发环境配置，指定兼容性需求 | | `production` | 生产环境配置，指定兼容性需求 | | `last 1 chrome version` | 最近一个版本的Chrome浏览器 | | `last 1 firefox version` | 最近一个版本的Firefox浏览器 | | `> 0.2%` | 全球使用率超过0.2%的浏览器 | ### 测试效果：假设我们有以下的代码示例`main.js`： ```javascript // main.js const button = document.getElementById('my-button'); button.addEventListener('click', () => { console.log('Button clicked!'); }); ``` 运行eslint命令来检查代码的兼容性： ```bash eslint main.js ``` 如果浏览器版本支持addEventListener，则不会报错。否则，会提示相应的兼容性警告。 ## 使用eslint-plugin-builtin-compat插件 > `eslint-plugin-builtin-compat`是另一个用于检查浏览器兼容性的插件，它提供了一些额外的特性。 ### 安装插件： ```bash npm install eslint-plugin-builtin-compat --save-dev ``` ### 配置ESLint：在项目的.eslintrc.js配置文件中添加插件： ```javascript module.exports = { // ... plugins: [ // ... 'builtin-compat' ], // ... }; ``` ### 配置检查脚本：在package.json中添加检查脚本： ```json { "scripts": { // ... "compat-check": "eslint --no-eslintrc --ext .js main.js" } } ``` 运行检查脚本： ```bash npm run compat-check ``` ## git提交校验为了确保代码在提交前已经通过了兼容性检查，我们可以使用husky工具来在commit前执行校验。 ### 安装husky： ```bash npm install husky --save-dev ``` ### 配置husky：在package.json中添加pre-commit钩子，以在提交前执行兼容性检查： ```json { "husky": { "hooks": { "pre-commit": "npm run compat-check" } } } ``` ## CICD校验 > 除了在git进行校验，我们也可以在cicd流程进行校验，一旦不通过，就不通过`MR` ```js { "scripts": { "lint": "eslint . --ext .js" } } ``` ```js stage('Linting') { steps { sh 'npm run lint' } } ``` ## 三、使用polyfill解决兼容性问题在某些情况下，即使经过兼容性检查，仍然可能存在一些浏览器不支持的新特性。这时候，我们可以使用polyfill来为这些浏览器提供缺失的功能。 ### 手动polyfill ### 安装第三方库： > 在项目中安装需要的polyfill库，比如core-js或者polyfill.io。 > ```bash npm install core-js --save ``` ### 写兼容性代码： > 在需要兼容性支持的地方，引入相应的polyfill库，并编写对应的代码。 ```javascript // main.js import 'core-js/features/promise'; const button = document.getElementById('my-button'); button.addEventListener('click', () => { // 使用新特性Promise new Promise((resolve) => { setTimeout(() => { resolve('Button clicked!'); }, 1000); }).then((message) => { console.log(message); }); }); ``` ### 自动polyfill > 使用Babel来自动根据目标浏览器版本转换代码，并使用babel-runtime来抽离公共模块。 ### 安装相关库： ```bash npm install @babel/preset-env @babel/plugin-transform-runtime --save-dev ``` ### 配置Babel： > 在项目的.babelrc文件中配置Babel： ```json { "presets": [ ["@babel/preset-env", { "useBuiltIns": "usage", "corejs": 3 }] ], "plugins": ["@babel/plugin-transform-runtime"] } ``` ### 按需引入polyfill： > 根据实际使用的新特性，Babel会自动根据目标浏览器版本引入必要的polyfill。 ```javascript // main.js const button = document.getElementById('my-button'); button.addEventListener('click', () => { // 使用新特性Promise new Promise((resolve) => { setTimeout(() => { resolve('Button clicked!'); }, 1000); }).then((message) => { console.log(message); }); }); ``` ### 动态polyfill服务： > 可以使用polyfill.io等服务来动态为不支持的浏览器提供polyfill，以减少页面加载的数据量。 ```html Polyfill Example ``` ## 再谈Babel > Babel 是一个 JavaScript 编译器,为什么这么说，因为babel不会处理`Web API`啊，我当时也认为babel自动帮我们做polyfill，结果忽略了`Web API`,`babel只会处理ECMAScript标准中的特性` Babel 是一个工具链，主要用于将采用 ECMAScript 2015+ 语法编写的代码转换为向后兼容的 JavaScript 语法，以便能够运行在当前和旧版本的浏览器或其他环境中。 - 语法转换 - 通过 Polyfill 方式在目标环境中添加缺失的特性（通过引入第三方 polyfill 模块，例如core-js） - 源码转换（codemods） ### 遇到的问题在chrome61环境中报错ResizeObserver is not a function。经确认ResizeObserver特性最低支持chrome64，于是将babel编译的目标版本设置为chrome 61，但改报错仍未解决，经过一番查找，原因如下： > Babel only polyfills ECMAScript features. > > What is ECMAScript? It is the core of the JavaScript that you can use in the browser. Browsers implements ECMAScript, and on top of it there are lots of expansions (Dom objects, service workers, Ajax, ...). ResizeObserver is one of those expansions. > > How can you know if a feature is part of ECMAScript or not? > I'd suggest searching for that function on MDN, and look at the Specifications section ([ArrayBuffer example](https://link.segmentfault.com/?enc=hwAZFhouC84GoNQJqedTLQ%3D%3D.B%2FukU0t13rDGhYx85XSfqQyqBx0GxrcumIBk%2FQZPN9npKmrMMa68Pix69QGL1BOsarwOd53yDP2WbZ7ALPRHSDN1lOGPv8pEZE4utNVfV2sqLcafpfvwebE%2FzW5ZZNjVguiDrYOi2wP74EOkE%2FujuA%3D%3D)). [参考出处](https://link.segmentfault.com/?enc=nekab1vPr%2FOgrgZVtgDr4w%3D%3D.ToHPG%2FHOj1LO1V8VLr3CICmz7lh%2BjP2ODwF6NuoggfhOEMzdrHfIDg4RZ9fz2mlW) 于是手动引入`resize-observer-pollyfill`问题就解决了