前端工程化

前端开发

  • 模块化(js 的模块化、css 的模块化、资源的模块化)
  • 组件化(复用现有的 UI 结构、样式、行为)
  • 规范化(目录结构的划分、编码规范化、接口规范化、文档规范化、 Git 分支管理)
  • 自动化(自动化构建、自动部署、自动化测试)

前端工程化指的是:在企业级的前端项目开发中,把前端开发所需的工具、技术、流程、经验等进行规范化、标准化

前端工程化的解决方案

webpack的基本使用

主要功能:它提供了友好的前端模块化开发支持,以及代码压缩混淆、处理浏览器端JavaScript 的兼容性、性能优化等强大的功能

好处:让程序员把工作的重心放到具体功能的实现上,提高了前端开发效率和项目的可维护性。注意:目前 Vue,React 等前端项目,基本上都是基于 webpack 进行工程化开发的。

安装 webpack

项目终端安装

npm install webpack@5.42.1 webpack-cli@4.7.2 -D

-D--save-dev 的缩写,表示开发时依赖,只在项目开发阶段用到。 -S--save 的缩写,表示运行时依赖,即项目打包发布运行时要用到。

配置 webpack

  1. 在项目根目录中,创建 webpack.config.js 的 webpack 配置文件,并初始化的基本配置:

    module.exports = {
      // mode 用于指定构建模式,可选值有 development 和 production
      mode: 'development',
    }
    
  2. package.json 文件的 scripts 节点下,新增 dev 脚本:

    "scripts" :{
      // 配置好后就能通过 npm run dev 命令执行打包过程
      "dev": "webpack"
    }
    
  3. 在终端中运行 npm run dev 命令,即可启动 webpack 进行项目的打包构建

mode 的可选值

webpack.config.jsmode 节点的可选值有两个

  1. development
    • 开发环境
    • 不会对打包生成的文件进行代码压缩和性能优化
    • 打包速度快,适合在开发阶段使用
  2. production
    • 生产环境
    • 会对打包生成的文件进行代码压缩和性能优化
    • 打包速度很慢,仅适合在项目发布阶段使用

webpack.config.js 文件的作用

webpack.config.js 是 webpack 的配置文件。webpack 在真正开始打包构建之前,会先读取这个配置文件,从而基于给定的配置,对项目进行打包

webpack 中的默认约定

在 webpack 4.x 和 5.x 版本中,默认约定:

  • 默认打包入口文件为 src/index.js
  • 默认输出文件路径为 dist/main.js

自定义打包的入口与出口

在 webpack.config.js 配置文件中,通过 entry 节点指定打包的入口。通过 output 节点指定打包的出口。

const path = require('path')
module.exports = {
    // 打包文件的入口文件路径
  entry: path.join(__dirname, './src/index.js'),
  output: {
       // 输出文件的存放路径
    path: path.join(__dirname, './dist'),
       // 输出文件的名称
    filename: 'bundle.js',
  },
}

webpack 插件

webpack-dev-server

webpack-dev-server 让 webpack 能监听项目源码的变化,从而自动打包构建。

安装

npm install webpack-dev-server@3.11.2 -D

配置

  1. 修改 package.json -> scriptsdev 命令:

    "scripts": {
      "dev": "webpack serve"
    }
    
  2. 运行 npm run dev 命令,重新打包项目

  3. 浏览器访问 http://localhost:8080 地址,查看打包效果

打包生成的文件存放

  • 配置了 webpack-dev-server 之后,打包生成的文件存放到了内存中
  • 不再根据 output 节点指定的路径,存放到实际的物理磁盘上
  • 提高了实时打包输出的性能,因为内存比物理磁盘速度快很多

生成到内存中的文件的访问

webpack-dev-server 生成的文件默认放在项目根目录中,是虚拟不可见的。

  • / 后跟上要访问的文件名称,即可访问内存中的文件
  • 127.0.0.1/bundle.js 表示访问 webpack-dev-server 生成到内存中的 bundle.js 文件

html-webpack-plugin

html-webpack-plugin 是 webpack 中的 HTML 插件,可以通过此插件自定制 index.html 页面的内容。

安装

npm install html-webpack-plugin@5.3.2 -D

配置

在 webpack.config.js 进行配置:

const HtmlPlugin = require('html-webpack-plugin')

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

module.exports => {
  mode: 'development',
  plugins: [htmlPlugin]
}

html-webpack-plugin 生成的文件

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

devServer 节点

在 webpack.config.js 配置文件中,可以通过 devServer 节点对 webpack-dev-server 插件进行更多的配置

devServer: {
  open: true, // 初次打包完成后,自动打开浏览器
  host: '127.0.0.1', // 访问地址
  port: 80 // 访问端口号
}

webpack 中的 loader (加载器)

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

loader 加载器的作用

协助 webpack 打包处理特定的文件模块。比如:

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

loader 的调用过程

image-20220814223621387

打包 css 文件

  1. 运行 npm i style-loader@3.0.0 css-loader@5.2.6 -D 命令,安装 loader

  2. 在 webpack.config.js 文件的 module->rules 数组添加规则:

    module: {
      rules: [{ test: /\.css$/, use: ['style-loader', 'css-loader'] }]
    }
    
    • test 表示匹配的文件类型,use 表示对应调用的 loader
    • use 数组的 loader 顺序是固定的
    • loader 调用顺序是从后往前

打包 less 文件

  1. 运行 npm i less-loader@10.0.1 less@4.1.1 -D 命令

  2. 在 webpack.config.js 文件的 module->rules 数组添加规则

    module: {
      rules: [{
          test: /\.less$/,
          use: ['style-loader', 'css-loader', 'less-loader'] }]
    }
    

打包 js 文件的高级语法

  1. 运行 npm i babel-loader@8.2.2 @babel/core@7.14.6 @babel/plugin-proposal-decorators@7.14.5 -D 安装 babel

  2. 在 webpack.config.js 文件的 module->rules 数组添加规则:

    module: {
      rules: [{ 
          test: /\.js$/,
          use: 'babel-loader', 
          exclude: /node_modules/ 
      }]
    }
    
  3. 配置 babel:在项目根目录下,创建名为 babel.config.js 的配置文件,定义 Babel 的配置项:

    module.exports = {
      // 声明 babel 可用的插件
      plugins: [['@babel/plugin-proposal-decorators', { legacy: true }]],
    }
    

打包发布

项目开发完成之后,需要使用webpack 对项目进行打包发布

  1. 开发环境下,打包生成的文件存放于内存中,无法获取到最终打包生成的文件
  2. 开发环境下,打包生成的文件不会进行代码压缩和性能优化
  3. 为了让项目能够在生产环境中高性能的运行,因此需要对项目进行打包发布。

配置 webpack 的打包发布

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

"scripts": {
  "dev": "webpack serve",
  "build": "webpack --mode production"
}

--model 指定 webpack 的运行模式,会覆盖 webpack.config.js 中的 model 选项

把 js 文件统一生成到文件夹

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

ouput: {
  path: path.join(__dirname, 'dist'),
  // 将 bundle.js 文件存放到 dist 目录的 js 子目录中
  filename: 'js/bundle.js',
}

把图片统一生成到 image 目录

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

{
  test: /\.jpg|png|gif$/,
  use: {
    loader: 'url-loader',
    options: {
      limit: 23333,
      // 指明生成的图片存到 dist 目录下的 image 子目录中
      outputPath: 'image'
    }
  }
}

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

  1. 安装 clean-webpack-plugin 插件

    npm install clean-webpack-plugin@3.0.0 -D
    
  2. 在 webpack.config.js 文件中进行配置:

    const { CleanWebpackPlugin } = require('clean-webpack-plugin')
    
    // plugins 节点挂载 CleanWebpackPlugin 实例对象
    plugins: [htmlPlugin, new CleanWebpackPlugin()]
    

企业级项目打包发布

企业级项目打包发布的流程更复杂:

  • 生成打包报告,根据报告分析具体的优化方案
  • Tree-Shaking
  • 为第三方库启用 CDN 加载
  • 配置组件的按需加载
  • 开启路由懒加载
  • 自定制首页内容

打包后双击 index.html 查看效果

项目 npm run build 打包之后,默认情况下在本地双击 dist/index.html 是无法看到项目效果的,如果想要看到效果需要进行配置。 vue.config.js文件将 publicPath 改为 './' 即可,默认为 '/'

module.exports = {
  publicPath: './',
}

Source Map

Source Map 就是一个信息文件,里面储存着位置信息,它存储着压缩混淆后的代码,所对应的转换前的位置。当我们运行打包生成的代码出错时,就能通过报错信息定位到源码的出错位置

webpack.config.js 中添加如下的配置

// webpack.config.js 文件
module.exports = {
  mode: 'development',
    // 开发环境 eval-source-map
    // 生产环境 nosources-source-map
  devtool: 'eval-source-map',
}

开发环境下:

  • devtool 设置为 eval-source-map
  • 显示源码报错的行数
  • 可以精准定位到具体的错误行

生产环境下:

  • 关闭 Source Map 或把 devtool 设置为 nosources-source-map
  • 只会显示源码中报错的行数,不会暴露源码
  • 防止源码泄露,提高网站安全性