欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Webpack学习-Loader

程序员文章站 2022-03-20 19:52:15
什么是Loader? 继上两篇文章webpack工作原理介绍( "上篇" 、 "下篇" ),我们了解到 ,而且每个Loader的职责都是单一,只会完成一种转换,所以我们一般对源文件的处理,也是由多个Loader以链式顺序执行的方式来进行多次装换,然后得到我们要的结果。 那么这样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-envbabel-plugin-transform-runtimebabel-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");

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-loaderreadme,先做个基本了解.

上面代码可以看出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之后,后续逻辑(如转换、获取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了,文章原文地址我的博客