Webpack学习－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 +=
            "\n babel-loader@8 requires Babel 7.x (the package '@babel/core'). " +
            "If you'd 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代码解析成astbabel-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");

module.exports = makeLoader();
module.exports.custom = makeLoader;

function makeLoader(callback) {
  const overrides = callback ? callback(babel) : undefined;

  return function(source, inputSourceMap) {
    // 上面介绍过的api可以得知这是个异步Loader,做的是异步装换的工作
    const callback = this.async();

    loader
      .call(this, source, inputSourceMap, overrides)
      .then(args => callback(null, ...args), err => callback(err));
  };
}

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=>待转换的codeinputSourceMap=>上一个loader处理后的sourceMap,有的话overrides=>自定义加载器整块源码可以分成几部分

• let loaderOptions = loaderUtils.getOptions(this) || {};获取options并且获取当前处理转换的文件的路径this.resourcePath。
• 判断是否自定义加载器转换这里会进行一系列对options.customize进行判断options.customize一个相对路径loader函数参数overrides为空时起效执行let override = require(loaderOptions.customize);有了override之后后续逻辑如转换、获取optionoverride都会进行介入处理。
• 将函数传入参数和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了。