配置 webpack

配置 webpack

1.webpack 基本使用

webpack 是前端项目工程化的具体解决方案。

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

创建项目

1.初始化包管理配置文件 package.json

npm init -y

新建 src ->index.html 首页 -> index.js 脚本文件

2.安装jQuery

npm install jquery -S

-S是 --save的简写         //开发和部署上线都会用到
-D是 --save-dev 的简写     //开发阶段会被用到
//可在npm 中查找带什么

//index.js
// 使用ES6 导入语法jQuery
import $ from "jquery"
$(function() {})

3.在项目中安装 webpack

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

• 注意：切换 npm 的下包镜像源

1 //查看当前的下包镜像源
2 npm config get registry
3 //将下包镜像源切换为淘宝镜像源
4 npm config set registry=https://registry.npm.taobao.org/
5 //检查镜像是否下载成功
6 npm config get registry

4.在项目中配置 webpack

① 在项目根目录中，创建名为 webpack.config.js 的 webpack 配置文件，并初始化如下的基本配置：

//开发的不同阶段  mode:'development' 开发阶段  production 发布上线
//使用node.js 中的导出语法，向外导出一个webpack 的配置对象
module.exports = {
    mode: 'development'
}

② 在 package.json 的 scripts 节点下，新增 dev 脚本如下：

 "scripts": {
        "dev": "webpack"
    }

• “dev” 名字任意取；双引号；不能加注释。

③ 在终端中运行 npm run dev 命令，启动 webpack 进行项目的打包构建 。

5.在index.html 中运行，引入dist 中的main.js ,即解决兼容性问题。

    <script src="../dist/main.js"></script>

//项目开发完上线时 生成的 main.js 压缩 时间长，体积小
module.exports = {
    mode: 'production'
}

npm run dev

4.1 mode 的可选值 mode 节点的可选值有两个，分别是：

① development

• 开发环境
• 不会对打包生成的文件进行代码压缩和性能优化
• 打包速度快，适合在开发阶段使用

② production

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

4.2 webpack.config.js 文件的作用

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

• 注意：由于 webpack 是基于 node.js 开发出来的打包工具，因此在它的配置文件中，支持使用 node.js 相关 的语法和模块进行 webpack 的个性化配置 。

4.3 webpack 中的默认约定

在 webpack 4.x 和 5.x 的版本中，有如下的默认约定：

① 默认的打包入口文件为 src -> index.js

② 默认的输出文件路径为 dist -> main.js

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

4.4 自定义打包的入口与出口

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

const path = require('path');
//使用node.js 中的导出语法，向外导出一个webpack 的配置对象
module.exports = {
    mode: 'development',
    //enery:'指定要处理哪个文件'
    entry: path.join(__dirname, './src/index.js'),
    //指定生成的文件要存放到哪里
    output: {
        //存放到目录
        path: path.join(__dirname, 'dist'),
        //生成的文件名
        filename: 'main.js'
    }
}

• 当index.js 文件改变代码时，不生效，要重新运行npm run dev看到最新效果。

  npm run dev

2.webpack 中的插件

自动生成 无需再npm run dev

① 安装

npm install webpack-dev-server@3.11.2 -D

出错解决： 删除 node_modules,然后重新npm install

②配置 webpack-dev-serve

• 修改 package.json -> scripts 中的 dev 命令如下：

"scripts": {
        "dev": "webpack serve"
    }

• 再次运行 npm run dev 命令，重新进行项目的打包

• 在浏览器中访问 http://localhost:8080 地址，查看自动打包效果

• http://localhost:8080/src/

• <script src="/main.js"></script>
  

  注意： npm run dev 生成的文件放到了内存里 在根目录中

③ 安装 html-webpack-plugin 此插件 (保证一打开页面运行)

npm install html-webpack-plugin@5.3.2 -D

​ 配置 html-webpack-plugin

//1.导入html-webpack-plugin 这个插件，得到插件的构造函数
const HtmlPlugin = require('html-webpack-plugin')
    //2.new 构造函数,创建插件的实例对象
const htmlPlugin = new HtmlPlugin({
    //指定要复制的哪个页面
    template: './src/index.html',
    //指定复制出来的文件名和存放路径
    filename: './index.html'
})

module.exports = {
    //插件的数组，将来webpack 在运行时，会加载并调用这些插件
    plugins: [htmlPlugin]
}

无需导入js脚本，html-webpack-plugin此插件 复制页面到根目录，在复制的页面中自动注入js脚本

http://localhost:8080/

devServer 节点 在module.exports 中

devServer: {
        open: true, //首次打包完成后，自动打开浏览器
        host: '127.0.0.1', //指定运行的地址
        //在http 协议中，如果端口号是80 ，则可以被忽略
        port: 80
    }

• 只要修改包配置文件，需要再次运行 npm run dev 命令 ，才能生效。

3.webpack 中的 loader

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

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

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

① 打包处理css文件

// 导入样式(在 webpack 中，一切皆模块，都可以通过 ES6 导入语法进行导入和使用)
import '../CSS/index.css'

打包处理 css 文件, 安装处理 css 文件的 loader

npm i style-loader@3.0.0 css-loader@5.2.6 -D

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

 module: { //所有第三方文件模块的匹配规则
        rules: [   //文件后缀名的匹配规则
            //定义了不同模块对应的 loader
            { test: /\.css$/, use: ['style-loader', 'css-loader'] }
            //，test 表示匹配的文件类型， use 表示对应要调用的 loader
        ]
    }

• use 数组中指定的 loader 顺序是固定的 .
• 多个 loader 的调用顺序是：从后往前调用 .

② 打包处理less文件

import '../CSS/index.less'

npm i less-loader@10.0.1 less@4.1.1 -D

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

③ 打包处理样式表中与 url 路径相关的文件

// 导入图片，得到图片文件
import logo from '../img/logo.jpg'
//给img 标签的src 动态赋值
$('.box').attr('src',logo)

npm i url-loader@4.1.1 file-loader@6.2.0 -D

 module: {
        rules: [
            { test: /\.jpg|png|gif$/, use:'url-loader?limit=22229' }
            //其中 ? 之后的是 loader 的参数项：limit 用来指定图片的大小，单位是字节（byte）,只有 ≤ limit 大小的图片，才会被转为 base64 格式的图片
        ]
    }

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

npm i babel-loader@8.2.2 @babel/core@7.14.6 @babel/plugin-proposal-decorators@7.14.5 -D

4.打包发布

1.为什么要打包发布

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

① 开发环境下，打包生成的文件存放于内存中，无法获取到最终打包生成的文件

② 开发环境下，打包生成的文件不会进行代码压缩和性能优化

2.配置 webpack 的打包发布

"scripts": {
        "dev": "webpack serve",  //开发阶段 文件在内存
        "build": "webpack --mode production"  //发布阶段 文件在物理磁盘
    }

npm run build

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

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

output: {
        //存放目录
        path: path.join(__dirname, 'dist'),
        //文件名
        filename: 'js/main.js'

    },

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

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

// 1.安装清理idist 目录的webpack 插件
npm install --save-dev clean-webpack-plugin

//2.按需导入插件，得到插件的构造函数之后，创建插件的实例对象
const { CleanWebpackPlugin } = require('clean-webpack-plugin');//左侧{} 结构赋值 
const cleaPlugin = new CleanWebpackPlugin(); 

//3.把创建的 cleaPlugin 插件的实例对象，挂载到 plugins 节点中
plugins: [htmlPlugin,cleaPlugin]

4.Source Map

Source Map 的作用：精准定位到错误行并显示对应的源码。

module.exports = {
    mode: 'development',
    //在开发调试阶段 eval-source-map 仅在开发模式下使用，可以保证运行时 报错的行数 与源代码的行数 保持一致
    devtool: 'eval-source-map'
    }

//在实际发布时候，改变devtool值，或直接关闭SourceMap
devtool: 'nosources-source-map'