Webpack Loader源碼導讀之babel-loader

時間 2019-11-06

標籤 webpack loader 源碼導讀 babel 简体版

原文原文鏈接

webpack應該是當下最主流的前端構建工具之一，可是因爲webpack自己糟糕的文檔，使得使用者可能是會用但不知其因此然，出現問題時難以入手；爲此，我想根據自身的理解，詳細講解一些經常使用loader、plugin源碼，深刻各個loader及其配置所帶來的影響；本系列將以babel-loader開篇，但只講述babel-loader所作的事情，對於babel部份的內容，將在將來開篇詳談。node

先看下源碼src目錄下的總體結構webpack

|src
|——utils
|  |——exists.js  
|  |——read.js
|  |——relative.js
|——fs-cache.js
|——index.js
|——resolve-rc.js
複製代碼

配置說明

首先，咱們進入index.js，找到module.exports = function(source, inputSourceMap)，這裏就是babel-loader的入口了。每一個webpack loader返回的都是一個function，這個function有兩個參數，第一個是待處理的代碼，第二個參數是上一loader處理後的sourcemap，若是有的話。進入loader之後，首先是獲取文件名，再經過loaderUtils.getOptions獲取loader的配置，即query部份，其中babel-loader支持的配置有：git

babelrc 配置文件.babelrc的位置，值false時不使用配置文件，配置爲具體路徑且文件存在時直接使用該文件，不然按默認處理(從當前文件位置開始向上查找 .babelrc、.babelrc.js或使用package.json中的babel配置，具體見resolve-rc.js)
cacheDirectory 是否緩存目錄，默認false;設置爲true時使用默認緩存目錄node_modules/.cache/babel-loader或者系統默認臨時文件目錄os.tmpdir(); 也能夠設置具體的文件夾路徑
cacheIdentifier 緩存標識符；默認包括babel-core、babel-loader的版本號，.babelrc的內容以及BABEL_ENV(沒有時會取NODE_ENV)的值
sourceMap 是否輸出源碼，默認值與webpack配置devtool一致;配置此值時，將無視devtool的配置。
forceEnv Babel編譯的環境變量，默認不配置，環境變量先取BABEL_ENV再取NODE_ENV。當配置此值時，該值將覆蓋BABEL_ENV和NODE_ENV。
metadataSubscribers 訂閱元數據。這個配置在文檔中並無寫出來，可是是容許配置的。主要做用是訂閱一些編譯過程當中的一些元數據，訂閱之後這些元數據將會被添加到webpack的上下文中。一般咱們是用不上的，估計在某些babel-plugin中可能會使用到。數據大概是這樣的，記錄一些module導入導出的信息：

{
  "usedHelpers": [
    "createClass",
    "classCallCheck"
  ],
  "marked": [],
  "modules": {
    "imports": [],
    "exports": {
      "exported": [
        "Test"
      ],
      "specifiers": [
        {
          "kind": "local",
          "local": "Test",
          "exported": "default"
        }
      ]
    }
  }
}
複製代碼

cache詳解

真正的編譯過程都是在babel-core中執行的，babel-loader的主要做用時babel-core所需配置的一些初始化，以及編譯結果的緩存，如今咱們主要講下緩存。咱們先修改下babel-loader的配置:github

{
  test: /\.jsx?$/,
  loader: 'babel-loader',
  include: [path.resolve(process.cwd(), 'src')],
  exclude: [path.resolve(process.cwd(), 'node_modules')],
  query: {
    cacheDirectory: path.resolve(process.cwd(), 'tmp') // 配置緩存目錄到當前項目tmp下，方便等下查看緩存文件
  }
}
複製代碼

cacheIdentifier的默認值以下，若是咱們配置了此值，將覆蓋默認值而非合併，因此暫時先不設置該值。web

JSON.stringify({
  "babel-loader": pkg.version,
  "babel-core": babel.version,
  babelrc: babelrcPath ? read(fileSystem, babelrcPath) : null,
  env:
    loaderOptions.forceEnv ||
    process.env.BABEL_ENV ||
    process.env.NODE_ENV ||
    "development",
})
複製代碼

當咱們配置了cacheDirectory時，loader會先查找緩存文件是否存在，文件名是經過下列方法計算得出json

const filename = function(source, identifier, options) {
  const hash = crypto.createHash("SHA1");
  const contents = JSON.stringify({
    source: source,
    options: options,
    identifier: identifier,
  });

  hash.end(contents);

  return hash.read().toString("hex") + ".json.gz";
};
複製代碼

能夠看到，文件名是以源碼source、loader選項options以及loader標識符identifier三個值的json字符串通過SHA1編碼獲得的，因此當這三個值任意一個發生變化時，都會致使文件名發生變化。當緩存文件不存在，或者以上三個值發生變化致使緩存文件名變成一個不存在的文件時，會調用babel-core的transform方法進行編譯，編譯結果包含code、 map、metadata三個，其中map即與源碼的一些映射關係，這三個內容將保存在緩存文件中；緩存文件是一個通過壓縮的JSON內容長這樣：緩存

|tmp
|  |-- 9d08ce6a6158ff5416a96e2290c7243607f9f5c8.json.gz
|  |-- cceb4d9049dfb84308e4cdd7eeedbdadc98c7c09.json.gz
複製代碼

緩存的內容示例：bash

{
  "code": "'use strict';\n\nvar _test = require('./test');\n\nvar _test2 = _interopRequireDefault(_test);\n\nfunction _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }\n\nvar test = new _test2.default();\n\nconsole.log(test.toString());",
  "map": {
    "version": 3,
    "sources": [
      "src/index.js"
    ],
    "names": [
      "test",
      "console",
      "log",
      "toString"
    ],
    "mappings": ";;AAAA;;;;;;AAEA,IAAMA,OAAO,oBAAb;;AAEAC,QAAQC,GAAR,CAAYF,KAAKG,QAAL,EAAZ",
    "file": "index.js",
    "sourceRoot": "/Users/yzf/webpack-tuition/loaders/babel",
    "sourcesContent": [
      "import Test from './test';\n\nconst test = new Test();\n\nconsole.log(test.toString());\n"
    ]
  },
  "metadata": {
    "usedHelpers": [
      "interopRequireDefault"
    ],
    "marked": [],
    "modules": {
      "imports": [
        {
          "source": "./test",
          "imported": [
            "default"
          ],
          "specifiers": [
            {
              "kind": "named",
              "imported": "default",
              "local": "Test"
            }
          ]
        }
      ],
      "exports": {
        "exported": [],
        "specifiers": []
      }
    }
  }
}
複製代碼