1.Webpack手写loader和plugin
2.Webpack进阶less-loader、css-loader、style-loader源码解析
3.Loader学习,简析babel-loader
4.webpack5loader和plugin原理解析
5.手写loader并不难
6.vue-loader源码分析学习
Webpack手写loader和plugin
深入理解Webpack内部工作原理,让我们通过手写loader和plugin来揭示它们的运作机制。首先,特种设备溯源码让我们构建一个简单的less-loader,它会处理less文件并以style标签的形式插入到页面。
在Webpack中,loader是按链式方式工作,从上一个loader传递资源给下一个。开发loader时,关键点是定义一个导出的函数,接受文件资源和SourceMap,对其进行处理后返回,注意避免使用箭头函数,因为需要通过this访问内部属性和方法。
在项目中,我们创建一个loader文件夹,编写自定义的style-loader。loader处理完毕后,输出的内容会以JS字符串形式返回,包含在webpack生成的模块中。
对于异步操作,loader可以使用async/await或回调函数。记得在处理过程中考虑是否返回源代码的Source Map,这对于调试至关重要,但仅在开发环境中启用。
加载本地loader时,需要在webpack配置中指定正确路径,通过resolveLoader属性进行解析。避免与第三方loader重名,以防止覆盖。
在配置loader时,参数传递是常见的,通过options属性。Webpack的query属性在处理字符串和对象参数时表现不稳定,推荐使用loader-utils包进行参数处理。
接下来,我们分析官方less-loader的源码,它同样调用less.render进行资源处理,易语言摄像监控源码并通过callback返回处理结果和Source Map。
在loader中,我们可能需要引用外部资源,通过this.addDependency来声明依赖,确保缓存失效和观察模式下的更新。
为了优化性能,对于耗时计算的loader,可以启用缓存。但有时需要禁用,比如不想缓存某些特定操作的结果。
接下来转向plugin部分。Plugin是监听Webpack生命周期事件并在适当时机修改输出的组件。我们创建一个简单的插件,通过apply函数注册事件并访问compiler对象。
通过实例化插件和传递参数,可以在构建时初始化插件的行为。掌握compiler和compilation的区别,有助于理解插件在Webpack中的作用。
最后,我们实现一个FileListPlugin,它会在打包目录中生成一个文件列表,展示了构建的所有输出文件。这个插件演示了如何利用webpack输出对象和compilation进行操作。
Webpack进阶less-loader、css-loader、style-loader源码解析
Webpack进阶学习中,Loader的运用是关键环节。在深入理解Loader基础后,本文将解析less-loader、css-loader和style-loader的内部工作原理。
less-loader是专为处理Less样式文件设计的,它将Less代码转换为浏览器能识别的CSS。以less文件为例,其工作原理是调用less库的功能,将扩展了CSS特性的Less代码转化为CSS,如变量、Mixin和函数等。
css-loader的功能则更为复杂,它不仅处理@import和url语句,还支持css-modules,师资建设管理系统源码将样式文件内容合并并作为JavaScript模块输出。以多个样式文件(如a.css、b.css和c.css)为例,css-loader会将它们合并成一个JavaScript模块,输出包含所有样式内容的字符串。
style-loader的作用在于将css-loader转化后的CSS样式代码插入到DOM中。理论上,我们可能期望直接在JavaScript中插入CSS代码,但css-loader返回的是模块化的代码,不能直接放入style标签。style-loader的实现通过一种巧妙的方式,将这些模块代码适当地包装,确保样式能正确插入到文档中。
style-loader的设计思路独特,其内部逻辑涉及Loader调用链、执行顺序和模块化输出等多个层面,理解style-loader的运作机制,对于深化对Webpack和Loader的理解至关重要。深入研究这些Loader的源码,无疑能提升你对Webpack进阶应用的掌握程度。
Loader学习,简析babel-loader
Loader是什么?
在阅读了webpack工作原理的两篇文章后,我们了解到Loader是模块转换器,它将模块内容转换成新的形式。每个Loader只负责单一的任务,因此多个Loader会按照链式顺序执行,以达到最终的转换效果。
Loader本质上是一个Node.js模块,它导出一个函数,这意味着我们可以使用所有Node.js的API。下面将介绍webpack提供的供Loader调用的API,帮助大家对Loader有更深入的理解,并分析babel-loader的源码,看看我们常用的Loader是如何编写的。
除了返回转换后的内容,有些情况下还需要返回sourceMap或AST语法树等额外内容。这时,我们可以使用webpack提供的API this.callback。使用this.callback时,Loader函数必须返回undefined,淘宝客源码特卖商城以便webpack知道返回的结果在this.callback中。
异步Loader在this.async() API下如何实现,以及像file-loader这样的Loader如何处理二进制数据,这些都是Loader开发中需要了解的内容。
缓存是优化Loader性能的关键。使用this.cacheable(Boolean)可以缓存Loader转换后的内容,当文件或依赖文件没有发生变化时,使用缓存的转换内容,从而提高效率。
除了常用的API,还有其他一些常用的API,例如:module.exports.raw = true,告知webpack需要二进制数据。
babel-loader源码简析:babel-loader依赖@babel/core,因此需要同时安装@babel/core、babel-preset-env、babel-plugin-transform-runtime、babel-runtime。源码的第一行是module.exports = makeLoader(),这是一个高阶函数,返回了一个函数。loader函数中最重要的实现部分是异步Loader,它通过const callback = this.async()实现。
loader函数入参有三个:source(待转换的code),inputSourceMap(上一个loader处理后的sourceMap),overrides(自定义加载器)。loader函数会获取options,并获取当前处理转换的文件的路径this.resourcePath。如果存在自定义加载器,则执行let override = require(loaderOptions.customize)。然后将函数传入参数和LoaderOptions归并,得到programmaticOptions。调用babel.loadPartialConfig可以拿到babel配置并赋值给config变量,解决插件和预设生成cacheIdentifier等问题。
最后,将处理后的结果返回。每个Loader返回值都是一个Function,将带转换内容传入,得到转换后的内容。本文介绍了Loader的lineage14.1源码下载基本概念,了解了webpack为Loader提供的常用API,并通过简析babel-loader的源码,让大家对Loader的编写有了更深入的了解。
webpack5loader和plugin原理解析
大家好,今天为大家解析下loader和plugin一、区别loader是文件加载器,能够加载资源文件,并对这些文件进行一些处理,诸如编译、压缩等,最终一起打包到指定的文件中
plugin赋予了Webpack各种灵活的功能,例如打包优化、资源管理、环境变量注入等,目的是解决loader无法实现的其他事从整个运行时机上来看,如下图所示:
可以看到,两者在运行时机上的区别:
loader运行在打包文件之前plugins在整个编译周期都起作用在Webpack运行的生命周期中会广播出许多事件,Plugin可以监听这些事件,在合适的时机通过Webpack提供的API改变输出结果
对于loader,实质是一个转换器,将A文件进行编译形成B文件,操作的是文件,比如将A.scss或A.less转变为B.css,单纯的文件转换过程
下面我们来看看loader和plugin实现的原理
Loader原理loader概念帮助webpack将不同类型的文件转换为webpack可识别的模块。
loader执行顺序分类
pre:前置loader
normal:普通loader
inline:内联loader
post:后置loader
执行顺序
4类loader的执行优级为:pre>normal>inline>post。
相同优先级的loader执行顺序为:从右到左,从下到上。
例如:
//此时loader执行顺序:loader3-loader2-loader1module:{ rules:[{ test:/\.js$/,loader:"loader1",},{ test:/\.js$/,loader:"loader2",},{ test:/\.js$/,loader:"loader3",},],},//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},使用loader的方式
配置方式:在webpack.config.js文件中指定loader。(pre、normal、postloader)
内联方式:在每个import语句中显式指定loader。(inlineloader)
开发一个loader1.最简单的loader//loaders/loader1.jsmodule.exports=functionloader1(content){ console.log("hellofirstloader");returncontent;};它接受要处理的源码作为参数,输出转换后的js代码。
2.loader接受的参数content源文件的内容
mapSourceMap数据
meta数据,可以是任何内容
loader分类1.同步loadermodule.exports=function(content,map,meta){ returncontent;};this.callback方法则更灵活,因为它允许传递多个参数,而不仅仅是content。
module.exports=function(content,map,meta){ //传递map,让source-map不中断//传递meta,让下一个loader接收到其他参数this.callback(null,content,map,meta);return;//当调用callback()函数时,总是返回undefined};2.异步loadermodule.exports=function(content,map,meta){ constcallback=this.async();//进行异步操作setTimeout(()=>{ callback(null,result,map,meta);},);};由于同步计算过于耗时,在Node.js这样的单线程环境下进行此操作并不是好的方案,我们建议尽可能地使你的loader异步化。但如果计算量很小,同步loader也是可以的。
3.RawLoader默认情况下,资源文件会被转化为UTF-8字符串,然后传给loader。通过设置raw为true,loader可以接收原始的Buffer。
module.exports=function(content){ //content是一个Buffer数据returncontent;};module.exports.raw=true;//开启RawLoader4.PitchingLoadermodule.exports=function(content){ returncontent;};module.exports.pitch=function(remainingRequest,precedingRequest,data){ console.log("dosomethings");};webpack会先从左到右执行loader链中的每个loader上的pitch方法(如果有),然后再从右到左执行loader链中的每个loader上的普通loader方法。
在这个过程中如果任何pitch有返回值,则loader链被阻断。webpack会跳过后面所有的的pitch和loader,直接进入上一个loader。
loaderAPI方法名含义用法this.async异步回调loader。返回this.callbackconstcallback=this.async()this.callback可以同步或者异步调用的并返回多个结果的函数this.callback(err,content,sourceMap?,meta?)this.getOptions(schema)获取loader的optionsthis.getOptions(schema)this.emitFile产生一个文件this.emitFile(name,content,sourceMap)this.utils.contextify返回一个相对路径this.utils.contextify(context,request)this.utils.absolutify返回一个绝对路径this.utils.absolutify(context,request)更多文档,请查阅webpack官方loaderapi文档
手写clean-log-loader作用:用来清理js代码中的console.log
//loaders/clean-log-loader.jsmodule.exports=functioncleanLogLoader(content){ //将console.log替换为空returncontent.replace(/console\.log\(.*\);?/g,"");};手写banner-loader作用:给js代码添加文本注释
loaders/banner-loader/index.js
constschema=require("./schema.json");module.exports=function(content){ //获取loader的options,同时对options内容进行校验//schema是options的校验规则(符合JSONschema规则)constoptions=this.getOptions(schema);constprefix=`/**Author:${ options.author}*/`;return`${ prefix}\n${ content}`;};loaders/banner-loader/schema.json
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},0手写babel-loader作用:编译js代码,将ES6+语法编译成ES5-语法。
下载依赖
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},1loaders/babel-loader/index.js
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},2loaders/banner-loader/schema.json
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},3手写file-loader作用:将文件原封不动输出出去
下载包
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},4loaders/file-loader.js
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},5loader配置
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},6手写style-loader作用:动态创建style标签,插入js中的样式代码,使样式生效。
loaders/style-loader.js
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},7Plugin原理Plugin的作用通过插件我们可以扩展webpack,加入自定义的构建行为,使webpack可以执行更广泛的任务,拥有更强的构建能力。
Plugin工作原理webpack就像一条生产线,要经过一系列处理流程后才能将源文件转换成输出结果。这条生产线上的每个处理流程的职责都是单一的,多个流程之间有存在依赖关系,只有完成当前处理后才能交给下一个流程去处理。插件就像是一个插入到生产线中的一个功能,在特定的时机对生产线上的资源做处理。webpack通过Tapable来组织这条复杂的生产线。webpack在运行过程中会广播事件,插件只需要监听它所关心的事件,就能加入到这条生产线中,去改变生产线的运作。webpack的事件流机制保证了插件的有序性,使得整个系统扩展性很好。——「深入浅出Webpack」
站在代码逻辑的角度就是:webpack在编译代码过程中,会触发一系列Tapable钩子事件,插件所做的,就是找到相应的钩子,往上面挂上自己的任务,也就是注册事件,这样,当webpack构建的时候,插件注册的事件就会随着钩子的触发而执行了。
Webpack内部的钩子什么是钩子钩子的本质就是:事件。为了方便我们直接介入和控制编译过程,webpack把编译过程中触发的各类关键事件封装成事件接口暴露了出来。这些接口被很形象地称做:hooks(钩子)。开发插件,离不开这些钩子。
TapableTapable为webpack提供了统一的插件接口(钩子)类型定义,它是webpack的核心功能库。webpack中目前有十种hooks,在Tapable源码中可以看到,他们是:
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},8Tapable还统一暴露了三个方法给插件,用于注入不同类型的自定义构建行为:
tap:可以注册同步钩子和异步钩子。
tapAsync:回调方式注册异步钩子。
tapPromise:Promise方式注册异步钩子。
Plugin构建对象Compilercompiler对象中保存着完整的Webpack环境配置,每次启动webpack构建时它都是一个独一无二,仅仅会创建一次的对象。
这个对象会在首次启动Webpack时创建,我们可以通过compiler对象上访问到Webapck的主环境配置,比如loader、plugin等等配置信息。
它有以下主要属性:
compiler.options可以访问本次启动webpack时候所有的配置文件,包括但不限于loaders、entry、output、plugin等等完整配置信息。
compiler.inputFileSystem和compiler.outputFileSystem可以进行文件操作,相当于Nodejs中fs。
compiler.hooks可以注册tapable的不同种类Hook,从而可以在compiler生命周期中植入不同的逻辑。
compilerhooks文档
Compilationcompilation对象代表一次资源的构建,compilation实例能够访问所有的模块和它们的依赖。
一个compilation对象会对构建依赖图中所有模块,进行编译。在编译阶段,模块会被加载(load)、封存(seal)、优化(optimize)、分块(chunk)、哈希(hash)和重新创建(restore)。
它有以下主要属性:
compilation.modules可以访问所有模块,打包的每一个文件都是一个模块。
compilation.chunkschunk即是多个modules组成而来的一个代码块。入口文件引入的资源组成一个chunk,通过代码分割的模块又是另外的chunk。
compilation.assets可以访问本次打包生成所有文件的结果。
compilation.hooks可以注册tapable的不同种类Hook,用于在compilation编译模块阶段进行逻辑添加以及修改。
compilationhooks文档
生命周期简图开发一个插件最简单的插件plugins/test-plugin.js
//此时loader执行顺序:loader1-loader2-loader3module:{ rules:[{ enforce:"pre",test:/\.js$/,loader:"loader1",},{ //没有enforce就是normaltest:/\.js$/,loader:"loader2",},{ enforce:"post",test:/\.js$/,loader:"loader3",},],},9注册hook//loaders/loader1.jsmodule.exports=functionloader1(content){ console.log("hellofirstloader");returncontent;};0启动调试通过调试查看compiler和compilation对象数据情况。
package.json配置指令
//loaders/loader1.jsmodule.exports=functionloader1(content){ console.log("hellofirstloader");returncontent;};1运行指令
//loaders/loader1.jsmodule.exports=functionloader1(content){ console.log("hellofirstloader");returncontent;};2此时控制台输出以下内容:
PSC:\Users\\Desktop\source>//loaders/loader1.jsmodule.exports=functionloader1(content){ console.log("hellofirstloader");returncontent;};2>source@1.0.0debug>node--inspect-brk./node_modules/webpack-cli/bin/cli.jsDebuggerlisteningonws://.0.0.1:/ea-7b--a7-fccForhelp,see:/post/开发思路:
我们需要借助html-webpack-plugin来实现
在html-webpack-plugin输出index.html前将内联runtime注入进去
删除多余的runtime文件
如何操作html-webpack-plugin?官方文档
实现:
//loaders/loader1.jsmodule.exports=functionloader1(content){ console.log("hellofirstloader");returncontent;};7手写loader并不难
理解并掌握webpack的loader配置并非难事。loader在webpack中扮演关键角色,用于处理模块源代码,例如将不同语言转换为JavaScript,或在JavaScript中引入CSS文件。loader支持链式传递,按照相反顺序执行,且遵循单一原则,即每个loader只负责特定任务。配置loader时,确保遵循最佳实践,如使用绝对路径,并配置指向自定义loader的路径。
loader本质上是一个函数,负责生成预期的JavaScript输出。它们应保持无状态,确保不同模块之间独立运行。遵循这些原则,合理配置loader,即可实现模块预处理。通过`use`属性指向自定义loader,如`use: ['loader/loader.js']`,实现链式调用。
在`loader.js`文件中,处理传入的代码并返回有效输出至关重要。若返回值非Buffer或String,则可能导致构建失败。例如,`use`属性配置确保正确使用loader路径。
loader运行原理相对简单,但实际应用时,需关注代码处理细节。了解loader的不同模式(如`pre`、`normal`、`inline`、`post`)有助于优化配置。通过调整`use`属性,可以控制不同loader之间的执行顺序和优先级。
loader通常由两部分组成:pitch和normal。pitch部分在执行前先运行,若返回值则跳过后续loader。通过添加`pitch`方法,可实现自定义逻辑。loader还支持异步处理,使用`this.async()`和`this.callback`来处理复杂的场景。
探索更多loader特性,如通过`loader-utils`获取配置参数,以及API文档,能进一步提升loader应用能力。理解loader的工作机制,结合实际需求进行定制,是编写高效loader的关键。
vue-loader源码分析学习
Vue-loader源码深入解析
Webpack配置中的loader调用和执行位置是在NormalModule的_doBuild方法中,当module需要转换为source时,会用到loader-runner包。本文将逐步分析loader的核心代码。
首先,loader的入口点涉及到source的处理,它包含了整个.vue文件的代码。VueLoaderPlugin的作用在于检查版本差异并加载相应的文件,以适应Webpack 5的更新。
接着,代码中的一大块内容是关于module.rules的处理,这些规则与配置文件中定义的类似,如test、include、exclude和resolve。RuleSetCompiler是一个处理rule集合的处理器,它负责收集和转换规则字段,生成带有condition和effects的集合。
loader会监听compiler的compilation和loader hooks,确保插件在vue-loader之前执行。之后,会遍历配置的规则,对不符合特定条件的规则进行报错处理,并处理vue-loader相关的规则,添加自定义字段。
在cloneRule方法中,关键步骤是调用ruleSetCompiler.compileRule,这个方法会执行hook并处理每个rule,将规则的特定字段转换成最终的条件和效果。整个过程确保了规则的正确匹配和处理。
总结来说,rulePlugin扩展配置文件中的rule,而ruleSetCompiler负责管理和执行这些规则,生成最终的处理逻辑。在处理过程中,巧妙地利用闭包缓存和query判断,确保了对vue资源的精确匹配和处理。
最后,VueLoaderPlugin还针对template、js和ts文件的处理进行了特殊规则设置,确保render function与其他用户代码得到相同的处理,同时通过pitcher处理vue块请求和资源顺序调整。