Loader學習，簡析babel-loader

什麼是Loader?

繼上兩篇文章webpack工作原理介紹（上篇、下篇）,我們了解到Loader：模塊轉換器，也就是將模塊的內容按照需求裝換成新內容，而且每個Loader的職責都是單一，只會完成一種轉換，所以我們一般對源文件的處理，也是由多個Loader以鏈式順序執行的方式來進行多次裝換，然後得到我們要的結果。

那麼這樣Loader只需要關心輸入和輸出，Loader其實是一個Node.js模塊，該模塊導出的是一個函數（意味著，所有node.js的api我們都可以使用），如下：

module.exports = function (source) {
// 對source做一系列的轉換
return source;
}


下面我們介紹一下webpack提供了哪些供Loader調用的api，對Loader有個比較深刻的理解，然後來分析babel-loader的源碼，看看我們常用的loader是怎麼編寫出來的。

獲得Loader的options

const loaderUtils = require(loader-utils);
module.exports = function(source) {
// 獲取用戶為當前Loader傳入的options
console.log(loaderUtils.getOptions(this));
return source;
}


返回其他結果

如上，我們返回的是轉換後的內容，但是有些情況下，我們不僅僅需要返迴轉換後的內容，還需要返回一些其他的內容，如sourceMap或是AST語法樹，那麼這時候我們可以使用webpack提供的APIthis.callback，當使用this.callback了，那麼我們就必須需要在Loader函數返回undefined,以此來讓webpack知道返回的結果在this.callback中，API詳細參數如下：

this.callback(
// 無法裝換原內容時的Error
err: Error || null,
// 裝換後的的內容，如上述的source
content: string | Buffer,
// 用於通過裝換後的內容得出原內容的Source Map，方便調試
// 我們了解到，SourceMap我們只是會在開發環境去使用，於是就會變成可控制的，
// webpack也提供了this.sourceMap去告訴是否需要使用sourceMap，
// 當然也可以使用loader的option來做判斷，如css-loader
sourceMap?: SourceMap,
// 如果本次轉換同時生成ast語法樹，也可以將這個ast返回，方便後續loader需要復用該ast，這樣可以提高性能
abstractSyntaxTree? AST
);


同步與非同步

看看非同步Loader在this.asyncAPI下如何實現，

module.exports = async function (source) {
const callback = this.async();
const { err, content, sourceMap, AST } = await Func();
callback(err, content, sourceMap, AST); // 如上訴`this.callback`參數一樣
}


處理二進位數據

像file-loader這樣的Loader，處理的是二進位數據，那麼就需要告訴webpack給loader傳入二進位格式的數據，代碼可以如下：

module.exports = function(source) {
if (source instanceof Buffer) {
// 一系列操作
return source; //當然我本身也可以返回二進位數據提供給下一個loader
}
}
moudle.exports.raw = true; //不設置，就會拿到字元串


通過moudle.exports.raw = true;告知webpack，自己本身需要二進位數據。

緩存加速

優化的最佳點，可以使用this.cacheable(Boolen)，緩存loader轉換後的內容，當處理文件或依賴文件沒有發生變化時，使用緩存的轉換內容，以此提速！

其他API

說到學習，當然越系統越好了，api多介紹 ，除了上面常用的api之外，還存在以下常用的api。

• this.context: 當前處理轉換的文件所在的目錄
• this.resource: 當前處理轉換的文件完整請求路徑，包括querystring
• this.resourcePath: 當前處理轉換的文件的路徑
• this.resourceQuery: 當前處理文件的querystring
• this.target: webpack配置的target
• this.loadMoudle: 處理文件時，需要依賴其他文件的處理結果時，可以使用this.loadMoudle(request: string, callback: function(err, source, sourceMap, module))去獲取到依賴文件的處理結果。
• this.resolve: 獲取指定文件的完整路徑，this.resolve(context: string, request: string, callback: function(err, result: string))
• this.addDependency: 為當前處理文件添加依賴文件，以便依賴文件發生變化時重新調用Loader轉換該文件,this.addDependency(file: string)
• this.addContextDependency: 為當前處理文件添加依賴文件目錄，以便依賴文件目錄里文件發生變化時重新調用Loader轉換該文件，this.addContextDependency(dir: string)
• this.clearDependencies: 清除當前正在處理的文件的所有依賴
• this.emitFile: 輸出一個文件，使用的方法為this.emitFile(name: string, content: Buffer | string, sourceMap: {...})

babel-loader源碼簡析

源碼第一行如下：

let babel;
try {
babel = require("@babel/core");
} catch (err) {
if (err.code === "MODULE_NOT_FOUND") {
err.message +=
"
babel-loader@8 requires Babel 7.x (the package @babel/core). " +
"If youd like to use Babel 6.x (babel-core), you should install babel-loader@7.";
}
throw err;
}


babel-loader依賴了@babel/core,這就是安裝babel-loader需要同時安裝@babel/core（通常會再安裝babel-preset-env、babel-plugin-transform-runtime、babel-runtime）的原因。我們接下去看，src/index.js整個文件是不是按照我們前面所講編寫Loader的方法來組織代碼的。

//引入package.json
const pkg = require("../package.json");
/*
根據babel-loader是否配置cacheDirectory屬性來告訴
babel-loader是否緩存loader的執行結果，如果true，
便會使用cache方法去實現，`cache.js`文件有著read、write、filename（文件命名方法）
以及如何處理緩存的handleCache方法（有則讀，無則寫再讀），有興趣可以去看看。
*/
const cache = require("./cache");
/*
transfrom.js用來轉換內容，內部調用了babel.transform方法進行轉換，這裡簡單介紹一下babel的原理：
babylon將es6/es7代碼解析成ast，babel-traverse對ast進行轉譯，得到新的ast，新的ast通過
babel-generator轉換成es5，核心方法在@babel/core/lib/transformation/index.js中的`runSync`
方法，有興趣可以去了解一下。
*/
const transform = require("./transform");
const injectCaller = require("./injectCaller");
const path = require("path");
// 獲取Loader參數options
const loaderUtils = require("loader-utils");

async function loader(source, inputSourceMap, overrides) {
....
}


可以看到確實和我們Loader編寫方式是一樣的，通過module.exports = makeLoader();導出一個函數，makeLoader()是一個高階函數，又返回了一個函數，通過const callback = this.async();可以知道，這是一個非同步的loader，不難看出最重要的實現都在這一步函數loader裡面了，那麼到底在loader函數裡面究竟做了些什麼呢？我們來看看，在閱讀源碼前，最好先看看babel-loader的README，先做個基本了解.

上面代碼可以看出loader(source, inputSourceMap, overrides)函數入參有三個，分別是source=>待轉換的code，inputSourceMap=>上一個loader處理後的sourceMap,有的話，overrides=>自定義載入器，整塊源碼可以分成幾部分， let loaderOptions = loaderUtils.getOptions(this) || {};，獲取options，並且獲取當前處理轉換的文件的路徑this.resourcePath。 判斷是否自定義載入器轉換，這裡會進行一系列對options.customize進行判斷，options.customize一個相對路徑，loader函數參數overrides為空時起效，執行let override = require(loaderOptions.customize);，有了override之後，後續邏輯（如轉換、獲取option）override都會進行介入處理。 將函數傳入參數和LoaderOptions歸併，得到programmaticOptions。 調用babel.loadPartialConfig可以拿到babel配置並賦值給config變數,其實就是為了允許系統輕鬆操作和驗證用戶的配置，此功能解決了插件和預設 生成cacheIdentifier 判斷options.cacheDirectory是否需要緩存Loader轉換內容，如為true，調用cache.js的module.export Cache方法（上面已做介紹） config.babelrc不為空，則有.babelrc文件，依賴.babelrc文件變化，使用this.addDependency(config.babelrc); metadataSubscribers 訂閱元數據，主要作用是訂閱一些編譯過程中的一些元數據，訂閱以後這些元數據將會被添加 到webpack的上下文中。通常我們是用不上的，估計在某些babel-plugin中可能會使用到。 * 最後將處理後的結果返回

小結

每一個Loader其實返回值就是一個Function，而且就是把帶轉換內容傳入，得到轉換後的內容，做的事情就是這樣，這篇文章先對Loader的基本概念進行介紹，並且了解webpack為Loader的編寫提供一些常用的API,最後通過簡析babel-loader的源碼，我覺得應該差不多知道如何去寫一個簡單的Loader了。

推薦閱讀：