编写 webpack loader(一)

用过webpack的人都知道处理各种资源的时候要用到loader,比如babel-loader可以将ES6转化为ES5,less-loader可以编译less文件等。

但是loader到底是什么?自己如何去编写一个loader? 带着这两个问题,我去看了官方文档。这篇文章就是记录下自己的学习,如有不准确或不正确的地方,欢迎大家指正。

本文主要讲的是如何编写一个loader,所以不会详细讲loader的使用。


loader是什么?

关于loader到底是什么,官方有一段话:

Loaders are transformations that are applied on the source code of a module. They allow you to pre-process files as you import or “load” them. Thus, loaders are kind of like “tasks” in other build tools, and provide a powerful way to handle front-end build steps. Loaders can transform files from a different language (like TypeScript) to JavaScript, or inline images as data URLs. Loaders even allow you to do things like import CSS files directly from your JavaScript modules!

大概翻译一下:

Loaders就是对一个模块源码的转换。它们可以在引入或加载文件时对文件进行预处理。因此loaders有点像其他构建工具中的tasks(任务),可以提供一种有力的方式去处理前端构建步骤。Loaders可以将一种不同类型的语言(比如TypeScript)转换为JavaScript,或者将内嵌图片转换为 data URLs。甚至可以在JavaScript模块中直接引入CSS文件。

简单点说,loader就是用来对各种资源进行转换。


编写loader

重点来了,就是怎样去编写一个loader。

A loader is a node module that exports a function. This function is called when a resource should be transformed by this loader. The given function will have access to the Loader API using the thiscontext provided to it.

还是翻译一下:

loader就是一个node模块,它输出了一个函数。当某种资源需要用这个loader转换时,这个函数会被调用。并且,这个函数可以通过提供给它的this上下文访问Loader API

所以loader大概就是这样一个JavaScript文件:

module.exports  = function(src){
  //可以通过 this 访问Loader API
  //this是由webpack提供的,可以直接使用
}

在动手写之前,我们要知道一个重要的知识点:处理一个文件可以使用多个loader,loader的执行顺序是和本身的顺序是相反的,即最后一个loader最先执行,第一个loader最后执行。第一个执行的loader接收源文件内容作为参数,其他loader接收前一个执行的loader的返回值作为参数。最后执行的loader会返回此模块的JavaScript源码。这里可能不太容易理解,没关系,继续往下看。

下面我们来编写一个简单的loader,就叫reverse-txt-loader吧,功能就是对txt文件的内容反转。我们有个test.txt,内容为abcde。
在webpack中这样使用:



其中loader的路径以实际为准。可以看到,处理txt文件是只用了一个loader,所以reverse-txt-loader既是第一个也是最后一个loader,根据上面说的,此loader会接收原文件内容作为参数,会返回JavaScript源码。所以reverse-txt-loader.js是这样:

module.exports = function(src) {
  //src是原文件内容(abcde),下面对内容进行处理,这里是反转
  var result = src.split('').reverse().join(''); //edcba
  //返回JavaScript源码,必须是String或者Buffer
  return `module.exports = '${result}'`;
}

为什么会返回这样子的一个字符串呢?因为我们要使用某个文件时,比如test.txt,会这样 var text = require('./test.txt'),参考下nodejs就明白了。

上面也可以调用loader API返回:

module.exports = function(src) {
  //src是原文件内容(abcde),下面对内容进行处理,这里是反转
  var result = src.split('').reverse().join('');//edcba
  //返回JavaScript源码,必须是String或者Buffer
  this.callback(null, `module.exports = '${result}'`);
  return;
}

下面我们又有一个新需求,就是在反转前将首字符转为大写。当然,我们可以在一个loader里实现这两个功能,但更好的做法是分开写,一个loader实现一个特定的功能,有利于复用。所以,我们再写一个loader,就叫uppercase-first-loader吧。

因为需求是要先将首字符转换为大写,所以uppercase-first-loader应该先执行,根据我们之前说的loader的执行顺序,uppercase-first-loader应该位于reverse-txt-loader之后。
在webpack中是这样:


uppercase-first-loader.js代码是这样:

module.exports = function(src) {
  //因为是第一个loader,所以src是原文件内容(abcde),下面对内容进行处理,这里首字符大写
  if(!src) {
    return ''; 
  }
  var result = src.charAt(0).toUpperCase() + src.slice(1); //Abcde
  //返回结果给下一个loader
  return result;
}

reverse-txt-loader.js代码不变,但接收的参数不再是原文件内容了,而是uppercase-first-loader返回的内容。

现在我们已经知道了loader怎么写了,但目前的loader都是同步的,也没有传其他参数,这部分会单独再说。

因为表达能力有限,所以肯定有表达不清楚或不正确的地方,欢迎提出。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 215,294评论 6 497
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,780评论 3 391
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 161,001评论 0 351
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,593评论 1 289
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,687评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,679评论 1 294
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,667评论 3 415
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,426评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,872评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,180评论 2 331
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,346评论 1 345
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,019评论 5 340
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,658评论 3 323
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,268评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,495评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,275评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,207评论 2 352

推荐阅读更多精彩内容

  • 版权声明:本文为博主原创文章,未经博主允许不得转载。 webpack介绍和使用 一、webpack介绍 1、由来 ...
    it筱竹阅读 11,103评论 0 21
  • 一、概述 本文将简单介绍webpack的基本用途以及它的四个基本概念Entry(入口文件)、Loader(加载器)...
    荣儿飞阅读 752评论 0 1
  • Lua 5.1 参考手册 by Roberto Ierusalimschy, Luiz Henrique de F...
    苏黎九歌阅读 13,782评论 0 38
  • 一直想找个app好好写写家人,过去,生活,或者未来。希望自己能够顺利上岸吧!这样以后就有时间更新了。
    梦妮521521阅读 148评论 0 0
  • 从小学到初中都平淡的出奇的自己,从未感受过爱情初生的悸动,成绩卓越的兴奋。就像是万颗丛草不起眼的一颗。 高中...
    哈妮2222阅读 194评论 0 0