詳解polyfills如何按需載入及場景範例詳解

2023-02-06 06:01:00

前言

青銅時代

最使前端頭痛的問題，莫過於瀏覽器相容性，無論是js，還是css都要考慮瀏覽器相容性問題，在webpack出來之前，這無非是一個非常頭疼的問題，查到一個相容性問題，查詢很多資料，解決一下，再出來一個問題又要花很長時間解決一下，這無疑要花費很長時間，這無疑浪費了寶貴的摸魚時間。

火槍時代

webpack出來之後，效率提高几倍，但是有一個問題就是設定複雜，可能有的朋友包括我在內，到現在也沒弄懂 @babel/preset-env,@babel/polyfills, @babel/plugin-transform-runtime的區別，以及如何設定才是最優解

webpack新增babel-loader

首先安裝@babel/core,@babel/cli,babel-loader包

index.js 內容

const fn = () => {
  console.log('ws');
}
const array = [1, 2, 3, 4];
array.includes(1);

package.json 編譯·

  "scripts": {
    "build": "babel src --out-dir build"
  },

然後進行編譯

const fn = () => {
  console.log('ws');
};
const array = [1, 2, 3, 4];
array.includes(1);

發現和我程式碼幾乎一樣，沒有啥改變

在加入plugins測試之前我們需要知道一些前置知識，babel將ECMAScript 2015+ 版本的程式碼分為了兩種情況處理：

語法層： let、const、class、箭頭函數等，這些需要在構建時進行轉譯，是指在語法層面上的轉譯
api方法層：Promise、includes、map等，這些是在全域性或者Object、Array等的原型上新增的方法，它們可以由相應es5的方式重新定義

babel對這兩種情況的轉譯是不一樣的，我們需要給出相應的設定。

@babel/preset-env

@babel/preset-env 是把語法轉化為當前瀏覽器能夠理解的程式碼, 注意只是語法層面哦

安裝@babel/preset-env還需要在babel.config.js中進行一下設定

module.exports = {
  presets: ["@babel/preset-env"]
}

然後我們看一下列印結果

"use strict";
var fn = function fn() {
  console.log('ws');
};
var array = [1, 2, 3, 4];
array.includes(1);

箭頭函數已經進行了轉化，因為箭頭函數是語法層面的

@babel/polyfill

@babel/polyfill是把api轉化為當前瀏覽器能夠理解的程式碼,此處是轉化的api

庫的使用需要在index.js中引入@babel/polyfill

import "@babel/polyfill";
const fn = () => {
  console.log('ws');
}
const array = [1, 2, 3, 4];
array.includes(1);

編譯後發現我們的程式碼沒啥變化，但是確把@babel/polyfill都引了過來，要知道@babel/polyfill是非常大的，包括所有的api，這無疑會使打包體積變大很多

"use strict";
require("@babel/polyfill");
var fn = function fn() {
  console.log('ws');
};
var array = [1, 2, 3, 4];
array.includes(1);

這就不是我們想要的，我們只想要array.includes方法呀，我們需要按需載入，而不是載入這麼多程式碼

別慌，接下來就會講到

設定 useBuiltIns

為了解決polyfill按需載入的問題, @babel/preset-env整合了polyfill,並且可以通過設定useBuildIns的方式實現按需載入

corejs 也要同時設定，2 的版本可以處理全域性物件，但實體方法並不處理，所以這裡用 3 的版本。

npm install core-js@3

usage 會根據設定的瀏覽器相容，以及你程式碼中用到的 API 來進行 polyfill，實現了按需新增。

module.exports = {
  presets: [
    [
      "@babel/preset-env",
      {
        useBuiltIns: 'usage',
        corejs: 3,
      }
    ]
  ]
}

此時再檢視我們的打包結果

"use strict";
require("core-js/modules/es.array.includes.js");
var fn = function fn() {
  console.log('ws');
};
var array = [1, 2, 3, 4];
array.includes(1);

只引入了array.includes，good

加入 @babel/plugin-transform-runtime

改造上面的例子在index.js再加一些

......
class Person {
  constructor(name) {
    this.name = name;
  }
  say() {
    console.log(this.name);
  }
}

只轉換一個 Person 類，我們看看轉換後的檔案長啥樣

"use strict";
require("core-js/modules/es.symbol.to-primitive.js");
require("core-js/modules/es.date.to-primitive.js");
require("core-js/modules/es.symbol.js");
require("core-js/modules/es.symbol.description.js");
require("core-js/modules/es.object.to-string.js");
require("core-js/modules/es.number.constructor.js");
require("core-js/modules/es.object.define-property.js");
require("core-js/modules/es.symbol.iterator.js");
require("core-js/modules/es.array.iterator.js");
require("core-js/modules/es.string.iterator.js");
require("core-js/modules/web.dom-collections.iterator.js");
function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
require("core-js/modules/es.array.includes.js");
function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
var fn = function fn() {
  console.log('ws');
};
var array = [1, 2, 3, 4];
array.includes(1);
var Person = /*#__PURE__*/function () {
  function Person(name) {
    _classCallCheck(this, Person);
    this.name = name;
  }
  _createClass(Person, [{
    key: "say",
    value: function say() {
      console.log(this.name);
    }
  }]);
  return Person;
}();

除了require的部分，還多了好多自定義的函數。同學們想一想，現在只有一個index檔案需要轉換，然而實際專案開發中會有大量的需要轉換的檔案，如果每一個轉換後的檔案中都存在相同的函數，那豈不是浪費了，怎麼才能把重複的函數去掉呢？

plugin-transform-runtime 閃亮登場。

上面出現的_classCallCheck，_defineProperties，_createClass三個函數叫做輔助函數，是在編譯階段輔助 Babel 的函數。

當使用了plugin-transform-runtime外掛後，就可以將babel轉譯時新增到檔案中的內聯輔助函數統一隔離到babel-runtime提供的helper模組中，編譯時，直接從helper模組載入，不在每個檔案中重複的定義輔助函數，從而減少包的尺寸，下面我們看下效果：

// webpack.config.js
module.exports = {
  presets: [
    [
      "@babel/env",
      {
        useBuiltIns: "usage",
        corejs: { version: 3, proposals: true }
      }
    ]
  ],
  plugins: ["@babel/plugin-transform-runtime"]
};

"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
require("core-js/modules/es.array.includes.js");
var fn = function fn() {
  console.log('ws');
};
var array = [1, 2, 3, 4];
array.includes(1);
var Person = /*#__PURE__*/function () {
  function Person(name) {
    (0, _classCallCheck2.default)(this, Person);
    this.name = name;
  }
  (0, _createClass2.default)(Person, [{
    key: "say",
    value: function say() {
      console.log(this.name);
    }
  }]);
  return Person;
}();

完美的解決了程式碼冗餘的問題。你們以為這就結束了嗎，還沒有。仔細看到這裡的同學應該注意到了雖然上面使用 useBuiltIns 設定項實現了poilyfill的按需參照，可是他還存在全域性變數汙染的情況，就好比這句程式碼，重寫了array的prototype方法，造成了全域性汙染。

require("core-js/modules/es.array.includes.js");

最後再改造一次babel的組態檔

module.exports = {
  presets: [
    "@babel/preset-env",
  ],
  plugins: [["@babel/plugin-transform-runtime", {
    corejs: 3
  }]]
}

去掉了 @babel/preset-env 的相關引數，而給 plugin-transform-runtime 新增了corejs引數，最終轉換後的檔案不會再出現polyfill的require的方法了。而是從引入了core-js-stable從而解決轉譯api層出現的全域性變數汙染

"use strict";
var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/classCallCheck"));
var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/createClass"));
var _includes = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/includes"));
var fn = function fn() {
  console.log('ws');
};
var array = [1, 2, 3, 4];
(0, _includes.default)(array).call(array, 1);
var Person = /*#__PURE__*/function () {
  function Person(name) {
    (0, _classCallCheck2.default)(this, Person);
    this.name = name;
  }
  (0, _createClass2.default)(Person, [{
    key: "say",
    value: function say() {
      console.log(this.name);
    }
  }]);
  return Person;
}();

綜上所述，plugin-transform-runtime 外掛藉助babel-runtime實現了下面兩個重要的功能