web前端高级webpack - webpack常用知识汇总及手写loader和plugin

484 阅读6分钟

这是我参与8月更文挑战的第20天,活动详情查看:8月更文挑战

webpack常用的loader和plugins

  • Loader
  • css-loader:加载 CSS,支持模块化、压缩、文件导入等特性
  • style-loader:把 CSS 代码注入到 JavaScript 中,通过 DOM 操作去加载 CSS
  • postcss-loader:扩展 CSS 语法,使用下一代 CSS,可以配合 autoprefixer 插件自动补齐 CSS3 前缀 -** babel-loader**:把 ES6 转换成 ES5
  • file-loader:把文件输出到一个文件夹中,在代码中通过相对 URL 去引用输出的文件 (处理图片和字体)
  • url-loader:与 file-loader 类似,区别是用户可以设置一个阈值,大于阈值会交给 file-loader 处理,小于阈值时返回文件base64 形式编码 (处理图片和字体)
  • vue-loader:加载 Vue.js 单文件组件
  • mini-css-extract-plugin提供的loader: 使用 link 标签引入 外联的css文件
  • Plugin
  • html-webpack-plugin: 设置渲染页面的模板
  • terser-webpack-plugin: 支持压缩 ES6 (Webpack4)
  • mini-css-extract-plugin:分离样式文件,CSS 提取为独立文件,支持按需加载
  • clean-webpack-plugin:目录清理
  • define-plugin:定义环境变量
  • DllPlugin:此插件用于在单独的 webpack 配置中创建一个 dll-only-bundle。 此插件会生成一个名为 manifest.json 的文件,这个文件是用于让 DllReferencePlugin 能够映射到相应的依赖上

Loader和Plugin的区别?

  • Loader 本质就是一个函数,在该函数中对接收到的内容进行转换,返回转换后的结果。 因为 Webpack 只认识 JavaScript,所以 Loader 就成了翻译官,对其他类型的资源进行转译的预处理工作。Loader 在 module.rules 中配置,作为模块的解析规则,类型为数组。每一项都是一个 Object,内部包含了 test(类型文件)、loader、options (参数)等属性。
  • Plugin 就是插件,基于事件流框架 Tapable,插件可以扩展 Webpack 的功能,在 Webpack 运行的生命周期中会广播出许多事件,Plugin 可以监听这些事件,在合适的时机通过 Webpack 提供的 API 改变输出结果。Plugin 在 plugins 中单独配置,类型为数组,每一项是一个 Plugin 的实例,参数都通过构造函数传入

Webpack的构建流程。

流程可以大致划分为 以下7个阶段

  • 初始化参数:从配置文件和 Shell 语句中读取与合并参数,得出最终的参数
  • 开始编译:用上一步得到的参数初始化 Compiler 对象,加载所有配置的插件,执行对象的 run 方法开始执行编译
  • 确定入口:根据配置中的 entry 找出所有的入口文件
  • 编译模块:从入口文件出发,调用所有配置的 Loader 对模块进行翻译,再找出该模块依赖的模块,再递归本步骤直到所有入口依赖的文件都经过了本步骤的处理
  • 完成模块编译:在经过第4步使用 Loader 翻译完所有模块后,得到了每个模块被翻译后的最终内容以及它们之间的依赖关系
  • 输出资源:根据入口和模块之间的依赖关系,组装成一个个包含多个模块的 Chunk,再把每个 Chunk 转换成一个单独的文件>加入到输出列表,这步是可以修改输出内容的最后机会
  • 输出完成:在确定好输出内容后,根据配置确定输出的路径和文件名,把文件内容写入到文件系统

Webpack 的热更新原理

Webpack 的热更新又称热替换(Hot Module Replacement),缩写为 HMR。 这个机制可以做到不用刷新浏览器而将新变更的模块替换掉旧的模块。 HMR的核心就是客户端从服务端拉取更新后的文件,准确的说是 chunk diff (chunk 需要更新的部分),实际上 WDS 与浏览器之间维护了一个 Websocket,当本地资源发生变化时,WDS 会向浏览器推送更新,并带上构建时的 hash,让客户端与上一次资源进行对比。客户端对比出差异后会向 WDS 发起 Ajax 请求来获取更改内容(文件列表、hash),这样客户端就可以再借助这些信息继续向 WDS 发起 jsonp 请求获取该chunk的增量更新。 后续的部分(拿到增量更新之后如何处理?哪些状态该保留?哪些又需要更新?)由 HotModulePlugin 来完成,提供了相关 API 以供开发者针对自身场景进行处理,像react-hot-loader 和 vue-loader 都是借助这些 API 实现 HMR。

Webpack构建的优化

  • 使用最新的 webpack 版本。我们会经常进行性能优化。 保持最新的 Node.js 也能够保证性能。除此之外,保证你的包管理工具 (例如 npm 或者 yarn ) 为最新也能保证性能。较新的版本能够建立更高效的模块树以及提高解析速度。
  • 将 loaders 应用于最少数的必要模块中。
  • 使用 DllPlugin 将更改不频繁的代码进行单独编译。这将改善引用程序的编译速度,即使它增加了构建过程的复杂性。
  • 减少编译的整体大小,以提高构建性能。尽量保持 chunks 小巧。 - 使用 更少/更小 的库。 - 在多页面应用程序中使用 CommonsChunksPlugin。 - 在多页面应用程序中以 async 模式使用 CommonsChunksPlugin 。 - 移除不使用的代码。 - 只编译你当前正在开发部分的代码。
  • 使用 cache-loader 启用持久化缓存。使用 package.json 中的 "postinstall" 清除缓存目录。
  • 基础包分离:使用 html-webpack-externals-plugin,将基础包通过 CDN 引入,不打入 bundle 中使用 SplitChunksPlugin 进行(公共脚本、基础包、页面公共文件)分离(Webpack4内置) ,替代了 CommonsChunkPlugin 插件
  • 多进程/多实例构建:HappyPack(不维护了)、thread-loader

webpack优化2

  • 压缩js与css。 webpack默认会自动压缩js,但是一旦配置了css压缩后,js将不再自动压缩,需手动配置。插件:css-minimizer-webpack-plugin 和 terser-webpack-plugin
    optimization:{
    	minimizer:[
    		new CssMinimizerPlugin(),
    		new TerserPlugin()
     	]
    }
    
  • exclude:使用exclude排除不需要解析的文件,可以提升编译速度,一般是node_modules目录
  • noParse:不用检查该包是否包含其他依赖包,一般用于已经明确要引入的包中不包含其他依赖,如jquery,lodash。
  • resolve.alias:定义别名,使用绝对路径可以提升文件的查找速度,进而提升webpack的编译速度
  • resolve.extensions:在导入文件时省略文件后缀['.vue','.js']
  • resolve.modules:到指定的目录中查找,缩小查找范围进而提升编译速度
  • webpack.ProvidePlugin:可以在模块中不用import导入库也可以配置后直接使用,如jquery可以在如下配置后省略import步骤
let webpack = require('webpack');
plugins:[
	new webpack.ProvidePlugin({
		$:'jquery'
	})
]
  • webpack.IgnorePlugin:忽略某些包中不必要的文件,如moment库,用来操作时间并支持多国语言,但有时候我们可能只会用到中文和英语,所以就可以把其它语言文件忽略
  • externals:{vue:"Vue" //Vue是我们通过cdn引入的全局变量,vue则是我们通过import xx from ww中的ww}:外部扩展,可以通过cdn的方式引入一些包,但在模块中还可以正常通过import使用这个包
  • splitChunks:分包
optimization:{
	splitChunks:{
		cacheGroups:{
			jq:{
				filename:'jq.js',test:/jquery/
	}}}}
  • DllPlugin+DllReferencePlugin:两者结合可以把一些不修改或不经常修改的文件单独打包。DllPlugin使用在独立的配置文件中用于打包文件,DLLReferencePlugin使用在主配置文件中用于配置打包后的包文件
//独立的配置文件
output: {
 	path: path.join(__dirname, "dist"),
 	filename: "MyDll.[name].js",
 	library: "[name]_[fullhash]"
 },
 plugins: [
 	new webpack.DllPlugin({
 		path: path.join(__dirname, "dist", "[name]-manifest.json"),
 		name: "[name]_[fullhash]"
 	})
 ]
//主配置文件
plugins: [
 	new webpack.DllReferencePlugin({
 		context: path.join(__dirname, "..", "dll"),
 		manifest: require("../dll/dist/alpha-manifest.json") // eslint-disable-line
 	}),
 	new webpack.DllReferencePlugin({
 		scope: "beta",
 		manifest: require("../dll/dist/beta-manifest.json"), // eslint-disable-line
 		extensions: [".js", ".jsx"]
 	})
 ]

手写loader

const parser =  require('@babel/parser') ;// 可以把js源码转成 ast语法树
		const traverse = require('@babel/traverse').default // 可以递归遍历 ast节点
		const generator = require('@babel/generator').default; // 把修改好的ast语法树 再转成源码字符串
		const types = require('@babel/types') // 操作节点的增删改
		module.exports = function(source){
		  const ast = parser.parse(source,{sourceType:'module'})
		  // console.log(ast.program.body);
		  traverse(ast,{
		    CallExpression(path){
		      // console.log(path)
		      if(types.isMemberExpression(path.node.callee) && types.isIdentifier(path.node.callee.object,{name:'console'})){
		        path.remove()
		      }  
		    }
		  })
		  const output = generator(ast,{},source);
		  return output.code
		}

手写plugin

class Myplugin{
		 // 可以再打包的时候产生一个新的文件
		  constructor(options){
		    // new 这个插件是传进来的参数
		    this.options = options
		  }
		  apply(compiler){
	      const hooks = compiler.hooks;
		  if(hooks){
		      hooks.emit.tap('myplugin',function(complication,callback){
		        var str = '文件列表是:\n';
		        for(let k in complication.assets){
		          str += `文件名:${k},,,大小是 ${ complication.assets[k].size()} \n\n`
		        }
		        complication.assets['myfile.md'] = {
		          source(){
		            return str
		          },
		          size(){
		            return str.length
		          }
		        }
		        callback&&callback()
		      })
		    }else{
			      compiler.plugin('emit',function(complication,callback){
			        var str = '文件列表是:\n';
			        for(let k in complication.assets){
			          str += `文件名:${k},,,大小是 ${ complication.assets[k].size()} \n\n`
			        }
			        complication.assets['myfile.md'] = {
			          source(){
			            return str
			          },
			          size(){
			            return str.length
			          }
			        }
			        callback&&callback()
			      })
			    }
		  }
	}
	module.exports = Myplugin