Webpack如何实现一个Loader?

loader界说: 用于对模块的源代码举行转换。loader 可以使你在 import 或"加载"模块时预处置文件 简朴使用 module.exports = { //... module: { rules: [ { test: /\.j...
loader界说: 用于对模块的源代码举行转换。loader 可以使你在 import 或"加载"模块时预处置文件

简朴使用

module.exports = {
  //...
  module: {
    rules: [
      {
        test: /\.js$/,
        use: [
          {
            // loader 是导出为一个a函数的 node 模块。该函数在 loader 转换资源的时刻挪用
            // 给定的函数将挪用 loader API,并通过 this 上下文接见
            loader: path.resolve('loader.js'),
            options: {/* ... */}
          }
        ]
      }
    ]
  }
};

回首了loader的界说及简朴使用后,我们再来剖析一下实现loader的思绪

  • 单一职责,一个loader只做一件事
  • 链式组合,链中的每个 loader 会将转换应用在已处置过的资源上
  • 模块化,是导出为一个函数的 node 模块
  • 参数合并,loader 可以通过 options 工具设置

基于上面剖析的几点,我们最先着手

// 这个就是一个最简朴loader,
// 若是我们的loader有依赖其它模块,也得以module的写法将在在顶部引入
import fs from 'fs';
export default function(source){
    return source
}

我们发现上面直接使用了return,是因为是同步类的loader且返回的内容唯一,若是你希望你的loader支持链式挪用,将效果返给下一个loader继续使用,这时刻就需要用webpack提供的api

这里我们简朴看一下this.callback的界说,一个可以同步或者异步挪用的可以返回多个效果的函数。预期的参数是

this.callback(
  err: Error | null,
  content: string | Buffer,
  sourceMap?: SourceMap,
  meta?: any
)
// loader-utils 它提供了许多有用的工具
// 最常用的一个就是获取传入 loader 的 options
import { getOptions } from 'loader-utils';
export default function(source, other) {
  const options = getOptions(this)    
  // do whatever you want
  // ...
  this.callback(null, source, other)
}

手写一个loader对没有研究过的听上去似乎有点难,事实上, 掌握上面所先容的内容及头脑,就可以最先写一个简朴的 Loader 了, 我们再来用简朴的代码绥一下loader到底是什么?

// 首先loader它是一个node模块,这很好明白
export const lessToCss = function(source, other) {
    // source 就是你即将要转换的文件源
    // TODO
    // 将转换好的文件源流转至一个管道
    this.callback(null, source, other)
}
让你的loader更好用

loader api中有几个好用的家伙这里就顺便带一下

  • this.cacheable() 从提高执行效率上,若何处置行使缓存是极其重要的, webpack 中this.cacheable就可以轻松将loader缓存了
  • this.async() 当一个loader无依赖时,我们应该异步的去返回效果
案例剖析

下方贴上less-loader的源码,代码很简练,连系上方我们所剖析的,也很容易明白

import processResult from './processResult';
const render = pify(less.render.bind(less));

function lessLoader(source) {
  const loaderContext = this;
  const options = getOptions(loaderContext);
  const done = loaderContext.async();
  const isSync = typeof done !== 'function';

  if (isSync) {
    throw new Error(
      'Synchronous compilation is not supported anymore. See https://github.com/webpack-contrib/less-loader/issues/84'
    );
  }
  processResult(loaderContext, render(source, options));
}


总结

  • loader是一个node模块
  • 编写loader时要遵照单一原则,每个loader只做一种"转义"事情
  • webpack为我们提供了厚实的loader api
  • webpack为我们还提供了工具函数集——loader-utils


思源资源网:分类流动

1.阿里云: 本站现在使用的是阿里云主机,平安/可靠/稳固。点击领取2000米代金券、领会最新阿里云产物的种种优惠流动点击进入

2.腾讯云: 提供云服务器、云数据库、云存储、视频与CDN、域名等服务。腾讯云各种产物的最新流动,优惠券领取点击进入

3.广告同盟: 整理了现在主流的广告同盟平台,若是你有流量,可以作为参考选择适合你的平台点击进入

链接: http://www.fly63.com/article/detial/2702

  • 发表于 2021-04-17 13:02
  • 阅读 ( 275 )
  • 分类:互联网

0 条评论

请先 登录 后评论
刘东升
刘东升

728 篇文章

你可能感兴趣的文章

相关问题