从零配置Webpack

210 阅读6分钟

前言

webpack是作为前端工程化中很常用的一个工具,自己也一直在使用它,本文将从头梳理一下webpack的基本概念,以及配置方法,作为一次总结,也是一次分享。10月10日webpack已经发布了最新版5.0。

本质上,webpack 是一个现代 JavaScript 应用程序的静态模块打包器(module bundler)。当 webpack 处理应用程序时,它会递归地构建一个依赖关系图(dependency graph),其中包含应用程序需要的每个模块,然后将所有这些模块打包成一个或多个 bundle。

安装及使用

要安装最新版本或特定版本,请运行以下命令之一:

npm install --save-dev webpack
npm install --save-dev webpack@<version>

如果你使用 webpack 4+ 版本,你还需要安装 CLI。

npm install --save-dev webpack-cli

创建一个目录,初始化 npm,然后 在本地安装 webpack,接着安装 webpack-cli(此工具用于在命令行中运行 webpack):

mkdir webpack-demo && cd webpack-demo
npm init -y
npm install webpack webpack-cli --save-dev

基本概念

  • 入口(entry)

入口起点(entry point)指示 webpack 应该使用哪个模块,来作为构建其内部依赖图的开始。进入入口起点后,webpack 会找出有哪些模块和库是入口起点(直接和间接)依赖的。

每个依赖项随即被处理,最后输出到称之为 bundles 的文件中,可以通过在 webpack 配置中配置 entry 属性,来指定一个入口起点(或多个入口起点)。默认值为 ./src。

简单例子:

webpack.config.js

module.exports = {
  entry: './src/index.js' //入口文件名
};
  • 输出(output)

output 属性告诉 webpack 在哪里输出它所创建的 bundles,以及如何命名这些文件,默认值为 ./dist。基本上,整个应用程序结构,都会被编译到你指定的输出路径的文件夹中。可以通过在配置中指定一个 output 字段,来配置这些处理过程:

webpack.config.js

const path = require('path');

module.exports = {
  entry: './src/index.js',
  output: {
    path: path.resolve(__dirname, 'dist'),  //打包目录
    filename: 'js/[name].[chunkhash:8].bundle.js',
        //输出文件名
        // 如果不加哈希值,浏览器会有缓存,可能你部署了,但是用户看到的还是老页面
        // 8是hash的长度,如果不设置,webpack会设置默认值为20。
    /**
     * Node.js 中,__dirname 总是指向被执行 js 文件的绝对路径,
     * 所以当你在 /d1/d2/myscript.js 文件中写了 __dirname, 它的值就是 /d1/d2 。
     * path.resolve
     * 1.path.resolve()方法可以将路径或者路径片段解析成绝对路径
     * 2.传入路径从右至左解析,遇到第一个绝对路径是完成解析,例如path.resolve('/foo', '/bar', 'baz') 将返回 /bar/baz
     * 3.如果传入的绝对路径不存在,那么当前目录将被使用
     * 4.当传入的参数没有/时,将被传入解析到当前根目录
     * 5.零长度的路径将被忽略
     * 6.如果没有传入参数,将返回当前根目录
     **/
  }
};
  • loader

loader 让 webpack 能够去处理那些非 JavaScript 文件(webpack 自身只理解 JavaScript)。loader 可以将所有类型的文件转换为 webpack 能够处理的有效模块,然后你就可以利用 webpack 的打包能力,对它们进行处理。

本质上,webpack loader 将所有类型的文件,转换为应用程序的依赖图(和最终的 bundle)可以直接引用的模块。

loader的加载顺序是从右往左,从下往上,要注意.

test 属性,用于标识出应该被对应的 loader 进行转换的某个或某些文件。
use 属性,表示进行转换时,应该使用哪个 loader。

webpack.config.js

const path = require('path');

const config = {
  output: {
    filename: 'main.js'
  },
  module: {
    rules: [
      { test: /\.txt$/, use: 'raw-loader' } //test:被对应的 loader 进行转换的某个或某些文件。use:转换时,要用哪个 loader。
    ]
  }
};

module.exports = config;
  • 插件(plugins)

插件可以用于执行范围更广的任务。插件的范围包括,从打包优化和压缩,一直到重新定义环境中的变量。插件接口功能极其强大,可以用来处理各种各样的任务。

想要使用一个插件,只需要 require() 它,然后把它添加到 plugins 数组中。多数插件可以通过选项(option)自定义。也可以在一个配置文件中因为不同目的而多次使用同一个插件,这时需要通过使用 new 操作符来创建它的一个实例。

webpack.config.js

const HtmlWebpackPlugin = require('html-webpack-plugin'); // 通过 npm 安装
const webpack = require('webpack'); // 用于访问内置插件

const config = {
  module: {
    rules: [
      { test: /\.txt$/, use: 'raw-loader' }
    ]
  },
  plugins: [
    new HtmlWebpackPlugin({template: './src/index.html'})
  ]
};

module.exports = config;
  • 模式(mode) 通过选择 developmentproduction 之中的一个,也就是开发模式和生产模式,我们给不同的模块,配置不同的打包方式。
module.exports = {
  mode: 'production'
};

常用loader和plugin

  1. babel

babel-loader,一个预处理插件,它加载 ES2015+ 代码,然后使用 Babel 转译为 ES5。

npm install --save-dev babel-loader @babel/preset-react @babel/preset-env @babel/core babel-plugin-import
  • babel-loader:使用Babel和webpack来转译JavaScript文件。
  • @babel/preset-react:转译react的JSX
  • @babel/preset-env:转译ES2015+的语法
  • @babel/core:babel的核心模块
  • babel-plugin-import:按需加载所需要的babel解析
  1. webpack-merge

通过“通用”配置,我们不必在环境特定(environment-specific)的配置中重复代码。简单来说就是生产环境不同,我们要给的配置也有所不同,但是可以共用一个共有的配置。

npm install --save-dev webpack-merge
  1. HtmlWebpackPlugin 用于生成一个基本的html模板
npm install --save-dev html-webpack-plugin
  1. clean-webpack-plugin 每次构建时,webpack会生成一个dist目录,但是当我们修改后,继续构建,dist目录内的内容会增加,很麻烦。我们可以通过这个插件,在每次构建时删除旧的dist,生成最新的dist目录 npm install --save-dev clean-webpack-plugin
  2. webpack-dev-server 官方提供的热部署
npm install webpack-dev-server --save-dev
  1. source-map source-map可以展示我们代码的错误位置,因为我们的代码都是被webpack打包过的,只有机器看得懂,我们人类无法正常识别。所以需要他。但是这个配置生产环境并不需要,所以将它配置在开发环境即可。只需要在 【webpack.dev.config.js】 中增加一个 devtool 属性即可!
  2. css-loader和style-loader 这两个通常是搭配使用,css-loader会把CSS文件进行解析,style-loader 是通过一个JS脚本创建一个style标签,里面包含一些样式。
npm install --save-dev style-loader css-loader 
  1. less-loader css预处理工具,目前流行的css预处理器有sasssytlusless,选择哪个安装对应额loader即可。
npm install --save-dev less less-loader
  1. url-loader和file-loader 【file-loader】的作用是,把你的文件打包起来,和js文件放在一起,这样用户访问我们的网页的时候,其实也需要访问我们的url,既增加了服务器的压力,也增加了用户升级流量的压力,需要去下载这个文件。 【url-loader】 如果页面图片较多,发很多http请求,会降低页面性能。这个问题可以通过url-loader解决。url-loader会将引入的图片编码,生成dataURl并将其打包到文件中,最终只需要引入这个dataURL就能访问图片了。 url-loader和file-loader两兄弟的搭配可以有效的减少不必要的url请求,因为有的图片你要去请求url获取,如果小的话完全可以用base64替代。如果图片很大的话就用file-loader,这样可以减少编码的压力。
npm install file-loader url-loader --save-dev
  1. mini-css-extract-plugin

可以将css和html分开打包,减少html文件的大小

npm install --save-dev mini-css-extract-plugin