webpack使用文档

webpack使用文档

当前 Web 开发面临的困境

• 文件依赖关系错综复杂
• 静态资源请求效率低
• 模块化支持不友好
• 浏览器对高级 Javascript 特性兼容程度较低
• etc…

webpack 概述

webpack是一个流行的前端项目构建工具(打包工具)，可以解决当前web开发中所面临的困境。
webpack提供了友好的模块化支持，以及代码压缩混淆、处理js兼容问题、性能优化等强大的功能，从而让程序员把工作的重心放到具体的功能实现上，提高了开发效率和项目的可维护性。

目前绝大多数企业中的前端项目，都是基于webpack进行打包构建的。

webpack的基本使用

1.创建列表隔行变色项目

① 新建项目空白目录，并运行 npm init -y 命令，初始化包管理配置文件 package.json

② 新建 src 源代码目录

③ 新建src -> index.html 首页

④ 初始化首页基本的结构

⑤ 运行 npm install jquery -s 命令，安装 jQuery

⑥ 通过模块化的形式，实现列表隔行变色效果

2.在项目中安装和配置 webpack

① 运行 npm install webpack webpack-cli -D 命令，安装 webpack 相关的包

② 在项目根目录中，创建名为 webpack.config.js 的 webpack配置文件

③ 在 webpack 的配置文件中，初始化如下基本配置:

module.exports ={
	mode : 'development' // mode用来指定构建模式
}

④ 在 package.json 配置文件中的 scripts 节点下，新增dev脚本如下:

"scripts" : {
	"dev" : "webpack" // script节点下的脚本，可以通过 npm run 执行
}

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

3.配置打包的入口与出口

webpack 的4.x版本中默认约定:

• 打包的入口文件为 src -> index.js

  

• 打包的输出文件为 dist -> main.js

  

如果要修改打包的入口与出口，可以在webpack.config.js中新增如下配置信息:

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

4.配置webpack的自动打包功能

① 运行 npm install webpack-dev-server -D 命令，安装支持项目自动打包的工具

② 修改package.json -> scripts 中的dev命令如下:

"scripts" : {
	"dev" : "webpack-dev-server" // script 节点下的脚本，可以通过npm run 执行
}

③ 将src -> index.html中，script脚本的引用路径，修改为"/bundle.js"

④ 运行 npm run dev 命令，重新进行打包

到这一步你可能会报错，可能是 webpack 与 webpack-dev-server 的版本不兼容所导致的，你需要在 package.json 文件中配置以下信息

"webpack": "^5.3.2",
"webpack-cli": "^3.3.12",
"webpack-dev-server": "^3.11.0"

把你的 node_modules 和 package-lock.json 删除，然后运行 npm install

即可正常运行 npm run dev

解决思路：

可以去你的 node_modules 中找到 webpack-dev-server 目录

搜索你的错误信息，找到如下信息，看看兼容 webpack-cli 的什么版本，就改成什么版本，重新安装即可

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

5.配置html-webpack-plugin生成预览页面

① 运行 npm install html-webpack-plugin -D 命令，安装生成预览页面的插件

②修改 webpack.config.js 文件头部区域，添加如下配置信息:

// 导入生成预览页面的插件，得到一个构造函数
const HtmlwebpackPlugin = require ('html-webpack-plugin')
const htmlPlugin = new HtmlwebpackPlugin ({ //创建插件的实例对象
    template: './src/index.html', //指定要用到的模板文件
	filename: 'index.html' //指定生成的文件的名称，该文件存在于内存中，在目录中不显示
})

③ 修改 webpack.config.js 文件中向外暴露的配置对象，新增如下配置节点:

module.exports = {
	plugins: [ htmlPlugin ] // plugins 数组是 webpack 打包期间会用到的一些插件列表
}

6.配置自动打包相关的参数

// package.json中的配置
// --open 打包完成后自动打开浏览器页面
// --host 配置工P地址
// --port 配置端口
"scripts" : {
	"dev" : "webpack-dev-server --open --host 127.0.0.1 --port 8888"
},

webpack 中的加载器

1.通过 loader 打包非 js 模块

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

loader加载器可以协助webpack 打包处理特定的文件模块，比如:

• less-loader 可以打包处理 .less 相关的文件
• sass-loader 可以打包处理 .scss 相关的文件
• url-loader 可以打包处理 css 中与 url 路径相关的文件

2.loader 的调用过程

webpack 中加载器的基本使用

1.打包处理 css 文件

① 运行 npm i style-loader css-loader -D 命令，安装处理 css 文件的 loader

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

//所有第三方文件模块的匹配规则
module: {
    rules: [
    	{ test: /\.css$/, use: ['style-loader', 'css-loader'] }
    ]
}

其中, test 表示匹配的文件类型，use 表示对应要调用的 loader

2.打包处理 less 文件

① 运行 npm i less-loader less -D 命令

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

//所有第三方文件模块的匹配规则
module: {
    rules: [
    	{ test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader/'] }
    ]
}

3.打包处理 scss 文件

① 运行 npm i sass-loader node-sass -D 命令

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

//所有第三方文件模块的匹配规则
module: {
    rules: [
        { test: /\.scss$/,use: ['style-loader','css-loader','sass-loader'] }
    ] 
}

4.配置postCSS自动添加css的兼容前缀

① 运行 npm i postcss-loader autoprefixer -D 命令

② 在项目根目录中创建 postcss 的配置文件 postcss.config.js ，并初始化如下配置;

const autoprefixer = require ('autoprefixer') // 导入自动添加前缀的插件
module.exports = {
	plugins: [ autoprefixer ] //挂载插件
}

在 webpack.config.js 的module -> rules 数组中，修改css的 loader规则如下:

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

5.打包样式表中的图片和字体文件

① 运行 npm i url-loader file-loader -D 命令

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

module: {
    rules: [
    	{
            test: /\.jpg|png|gif|bmp|ttf|eot|svg|woff|woff2$/ ,
        	use: 'url-loader?limit=16940'
        }
    ]
}

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

limit 用来指定图片的大小，单位是字节（byte），只要小余 limit 大小的图片，才会被转为 base64 图片

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

① 安装babel 转换器相关的包: npm i babel-loader @babel/core @babel/runtime -D

② 安装babel语法插件相关的包: npm i @babel/preset-env @babel/plugin-transform-runtime @babel/plugin-proposal-class-properties -D

③ 在项目根目录中，创建 babel 配置文件 babel.config.js 并初始化基本配置如下:

module.exports = {
    presets: [ "@babel/preset-env" ],
    plugins: [ '@babel/plugin-transform-runtime','@babel/plugin-proposal-class-properties' ]
}

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

// exclude 为排除项，表示 babel-loader不需要处理 node_modules 中的 js 文件
{ test: /\.js$/, use: "babel-loader",exclude: /node_modules/ }

Vue单文件组件

传统组件的问题和解决方案

1.问题

1. 全局定义的组件必须保证组件的名称不重复
2. 字符串模板缺乏语法高亮，在HTML有多行的时候，需要用到丑陋的 \
3. 不支持CSS意味着当HTML和JavaScript组件化时，CSS明显被遗漏
4. 没有构建步骤限制，只能使用HTML和ES5 JavaScript,而不能使用预处理器(如:Babel)

2.解决方案

针对传统组件的问题，Vue提供了一个解决方案 —— 使用 Vue 单文件组件。

Vue单文件组件的基本用法

单文件组件的组成结构

• template组件的模板区域
• script业务逻辑区域
• style样式区域

<template>
	<!--这里用于定义vue组件的模板内容-->
</template>

<script>
    // 这里用于定义vue组件的业务逻辑
    export default {
    	data(){ return {} },//私有数据
        methods: {} // 处理函数
    	// ...其它业务逻辑
    }
</script>

<style scoped>
	/* 这里用于定义组件的样式 */
</style>

webpack 中配置 vue 组件的加载器

① 运行 npm i vue-loader vue-template-compiler -D 命令

② 在 webpack.config.js 配置文件中，添加 vue-loader 的配置项如下:

const VueLoaderPlugin = require('vue-loader/lib/plugin')
module.exports = {
	module: {
		rules: [
			// ..．其它规则
			{ test: /\.vue$/ , loader: 'vue-loader'}
        ]
	},
	plugins: [
		// ..．其它插件
    	new VueLoaderPlugin() //请确保引入这个插件!
    ]
}

在 webpack 项目中使用 vue

① 运行 npm i vue -S 安装 vue

② 在src -> index.js 入口文件中，通过 import Vue from 'vue' 来导入 vue 构造函数

③ 创建 vue 的实例对象，并指定要控制的el区域

④ 通过 render 函数渲染 App 根组件

// 1．导入vue构造函数
import Vue from 'vue'
// 2．导入App根组件
import App from './components/App.vue'
const vm = new Vue({
	// 3．指定vm实例要控制的页面区域
    el: "#app",
	// 4．通过render函数,把指定的组件渲染到 el 区域中
    render: h => h(App)
})

项目中使用 vue

① 运行 npm i vue -S 安装 vue

② 在src -> index.js 入口文件中，通过 import Vue from 'vue' 来导入 vue 构造函数

③ 创建 vue 的实例对象，并指定要控制的el区域

④ 通过 render 函数渲染 App 根组件

// 1．导入vue构造函数
import Vue from 'vue'
// 2．导入App根组件
import App from './components/App.vue'
const vm = new Vue({
	// 3．指定vm实例要控制的页面区域
    el: "#app",
	// 4．通过render函数,把指定的组件渲染到 el 区域中
    render: h => h(App)
})