webpack

155 阅读8分钟

webpack

webpack中的默认约定

  1. 默认的打包入口文件为 src -> index.js
  2. 默认的输出文件路径为 dist -> main.js

注意: 可以在webpack.config.js中修改打包的默认约定

自定义打包的入口与出口

在webpack.config.js配置文件中,通过entry节点指定打包的入口。通过output节点指定打包的出口 示例代码如下:

const path = require('path')
module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  entry: path.join(__dirname, './src/index.js'), //打包入口文件的路径
  output: {
    path: path.join(__dirname, './dist'), // 输出文件的存放路径
    filename: 'bundle.js', //输出文件的名称
  },
}

webpack中的插件

通过安装和配置第三方的插件,可以扩展webpack的能力,从而让webpack用起来更方便。最常用的wenpack插件有如下两个

1. webpack-dev-server

  • 类似于node.js阶段用到的nodemon工具
  • 每当修改了源代码,webpack会自动进行项目的打包和构建

安装使用步骤:

  1. 安装:
npm install webpack-dev-server@3.11.0 -D
  1. 修改 package.json -> script 中的 命令如下:
  "scripts": {
    "dev":"webpack scrve"
  },

打包生成的文件哪儿去了

  1. 不配置webpack-dev-server 的情况下, webpack打包生成的文件,会放在实际的物理磁盘上
  • 严格遵守开发者在webpack.config.js中指定配置
  • 根据output节点指定路径进行存放
  1. 配置了webpack-dev-server之后,打包生成的文件存放到了内存中
  • 不再根据output节点指定的路径,存放到物理磁盘上
  • 提高了实时打包输出的性能,因为内存比物理磁盘速度快很多

生成到内存中的文件该如何访问?

webpack-dev-server 生成到内存中的文件,默认放到了项目根目录中,而且是虚拟的、不可见的

devServer 节点

在webpack.config.js配置文件中,可以通过devServer节点对webpack-dev-server插件进行更多配置, 示例代码如下:

module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  devServer: {
    open: true, // 初次打包完成后,自动打开浏览器
    host: '127.0.0.1', // 实时打包所使用的主机地址
    port: 80, //实时打包所使用的端口号码
  },
}

2. html-webpack-plugin

webpack中的HTML插件(类似于一个模板引擎插件)可以通过此插件自定制index.html页面的内容

安装:

npm install html-webpack-plugin@4.5.0 -D

使用:

const HtmlPlugin = require('html-webpack-plugin')
const htmlPlugin = new HtmlPlugin({
  template: './src/index.html', //指定原文件存放路径
  filename: './index.html', //指定生成文件存放路径
})

module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  plugins: [htmlPlugin], //通过plugins节点,使htmlPlugin插件生效
}

解惑:

  1. 通过html-webpack-plugin插件复制到项目根目录中的index.html页面,也被放到了内存中
  2. html-webpack-plugin插件在生成index.html页面的底部,自动注入了打包的bundle.js 文件

loader

在实际开发中,webpack默认只能打包处理以 .js 后缀名结尾的模块。其他非 .js 后缀名结尾的模块,webpack默认处理不了,需要调用loader加载器才可以正常打包,否则会报错!

loader加载器的作用: 协助webpack打包处理待定的文件模块。比如:

  • css-loader 可以打包处理.css相关的文件
  • less-loader 可以打包处理 .less相关的文件
  • babel-loader 可以打包处理webpack无法处理的高级JS语法

image.png

css Loader

  1. 安装 css loader
npm i style-loader@2.0.0 css-loader@5.0.1 -D
  1. 配置 在webpack.config.js的module->rules数组中,添加loader规则如下:
module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  module: {
    // 所有第三方文件模块的匹配规则
    rules: [
      // 文件后缀名的匹配规则
      { test: /\.css$/, use: ['style-loader', 'css-loader'] },
    ],
  },
}

其中,test表示匹配的文件类型,use表示对应要调用的loader, loader的顺序是固定的; 多个loader的调用顺序是从后向前进行调用的

less Loader

  1. 安装
npm i less-loader@7.1.0 less@3.12.2 -D
  1. 配置 在webpack.config.js的module -> rules 数组中,添加loader规则如下:
module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  module: {
    // 所有第三方文件模块的匹配规则
    rules: [
      // 文件后缀名的匹配规则
      { test: /\.css$/, use: ['style-loader', 'css-loader'] },
      { test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] },
    ],
  },
}

less 是内置依赖项,不用声明在use数组中,less-loader中会调用less

url路径相关的loader

如果在less文件中使用了例如 background:url('./css/avatar.png'); 项目会报错,为了处理产生的错误我们需要对应处理路径的loader

  1. 安装:
npm i url-loader@4.1.1 file-loader@6.2.0 -D
  1. 配置1(第一种方式)

在webpack.config.js的module -> rules 数组中,添加loader规则如下:

module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  module: {
    // 所有第三方文件模块的匹配规则
    rules: [
      // 文件后缀名的匹配规则
      { test: /\.jpg|png|gif|webp$/, use: ['url-loader?limit=22229'] },
    ],
  },
}

其中?之后的是loader的参数项

  • limit用来指定图片大小,单位是字节(byte)
  • 只有<=limit大小的图片,才会被转为base64格式的图片
  1. 配置2(第二种方式)

带参数的loader还可以通过对象的方式进行配置

module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  module: {
    // 所有第三方文件模块的匹配规则
    rules: [
      // 文件后缀名的匹配规则
      { //配置的第二种方式
        test: /\.jpg|png|gif|webp$/,
        use: {
          loader: 'url-loader',
          options: {
            limit: 22223,
          },
        },
      },
    ],
  },
}
 

打包处理js文件中的高级语法

webpack只能打包处理一部分高级的JavaScript语法。对于那些webpack无法处理的高级js语法,需要借助于 babel-loader进行打包处理。例如webpack无法处理下面的JavaScript代码:

class Person{
    static info='person info'
}
console.log(Person.info)

babel-loader 相关的包

  1. 安装 运行如下的命令安装对应的依赖包:
npm i babel-loader@8.2.1 @babel/core@7.12.3 @babel/plugin-proposal-class-properties@7.12.1 -D
  1. 配置 在webpack.config.js的module-rules数组中,添加loader规则如下:
  module: {
    // 所有第三方文件模块的匹配规则
    rules: [
      {
        test: /\.js$/,
        exclude: /node_modules/, //表示babel-loader 只需要处理开发者编写的js文件,不需要处理node_modules下的js文件
        use: {
          loader: 'babel-loader',
          options: {
            // 声明一个babel插件,此插件用来转化class中的高级语法
            plugins: ['@babel/plugin-proposal-class-properties'],
          },
        },
      },
    ],
  },

为什么要打包发布

项目开发完成之后,使用webpack对项目进行打包发布的主要原因有以下两点

  1. 开发环境下,打包生成的文件存放于内存中,无法获取到最终打包生成的文件
  2. 开发环境下,打包生成的文件不会进行代码压缩和性能优化

配置webpack的打包发布

在package.json文件的script节点下,新增build命令如下:

  "scripts": {
    "dev": "webpack serve", // 开发环境中,运行dev命令
    "build":"webpack --mode production" // 项目发布时,运行build命令
  },

--model是一个参数项,用来指定webpack的运行模式。production代表生产环境,会对打包生成的文件进行代码压缩和性能优化。

注意: 通过 --model指定的参数项,会覆盖webpack.config.js中的model选项

把JavaScript文件统一生成到js目录中

在webpack.config.js配置文件的output节点中,进行如下配置:

module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  output: {
    path: path.join(__dirname, './dist'), // 输出文件的存放路径
    filename: 'js/bundle.js', //输出文件的名称前面加一层js文件夹
  },
}

把图片文件统一生成到image目录中

修改webpack.config.js中的url-loader配置项,新增outputPath选项即可指定图片文件的输出路径:

module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  module: {
    // 所有第三方文件模块的匹配规则
    rules: [
      {
        //配置的第二种方式
        test: /\.jpg|png|gif|webp$/,
        use: {
          loader: 'url-loader',
          options: {
            // 被转为base64的图片不会存放到image文件夹下
            limit: 22223,
            // 明确指定把打包生成的图片文件,存储到dist目录下的image文件夹中
            outputPath: 'image',
          },
        },
      },
    ],
  },
}

自动清理dist目录下的旧文件

为了在每次打包发布时自动清理dist目录中的旧文件,可以安装配置 clean-webpack-plugin插件:

  1. 安装
npm install clean-webpack-plugin@3.0.0 -D
  1. 按需导入
const {CleanWebpackPlugin} = require('clean-webpack-plugin')
const cleanPlugin = new CleanWebpackPlugin()
  1. 挂载
module.exports = {
    plugins:[htmlPlugin,cleanPlugin]
}

Source Map

生产环境遇到的问题

前端项目在投入生产环境之前,都需要对JavaScript源代码进行压缩混淆,从而减小文件的体积,提高文件的加载效率。此时就不可避免的产生了另一个问题:

对压缩混淆之后的代码除错(debug) 是一件极其困难的事情

  • 变量被替换成没有任何语义 的名称
  • 空行和注释被剔除

什么是Source Map

Source Map 就是一个信息文件,里面存储着位置信息。也就是说,Source Map 文件中存储着代码压缩混淆前后的对应关系。

有了它,出错的时候,除错工具将直接显示原始代码,而不是转换后的代码, 能够极大的方便后期的调试

开发环境下的Source Map

在开发环境下,webpack默认启用了Source Map功能。当程序运行除错时,可以直接在控制台提示错误行的位置,并定位到具体源代码:

默认Source Map的问题

开发环境下默认生成的Source Map,记录的是生成后的代码的位置。会导致运行时报错的行数与源代码的行数不一致的问题。示意图如下:

报错的位置 image.png

实际代码的位置 image.png

解决默认Source Map 的问题(开发环境用 eval-source-map)

开发环境下,推荐在webpack.config.js 中添加如下的配置,即可保证运行时报错的行数源代码的行数 保持一致:

module.exports = {
  mode: 'development', // mode 用来指定构建模式。可选值有 development 和 production
  devtool: 'eval-source-map', //运行时报错的行数与源代码的行数保持一致
}

image.png

webpack 生产环境下的Source Map

在生产环境下,如果省略了devtool选项,则最终生成的文件中不包含Source Map. 这能够防止原始代码通过Source Map 的形式暴露给别有所图之人

image.png 但是如果这样的话就太不利于调试了

只定位行数不暴露源代码(生产环境使用:nosources-source-map)

在生产环境下,如果只想定位报错的具体行数,且不想暴露源代码。此时可以将devtool 的值设置为 nosources-source-map。 实际效果如图展示:

image.png

定位行数且暴露源码 (了解)

在生产环境下,如果想在定位报错行数的同时,展示具体报错的源码。此时可以将devtool的值设置为source-map。实际效果如图所示:

image.png