webpack 是一个流行的前端项目构建工具(打包工具),可以解决当前 web 开发中所面临的困境。
webpack 提供了友好的模块化支持,以及代码压缩混淆、处理 js 兼容问题、性能优化等强大的功能,从而让程序员把工作的重心放到具体的功能实现上,提高了开发效率和项目的可维护性。
目前绝大多数企业中的前端项目,都是基于 webpack 进行打包构建的。
下面我们新建一个目录结构,演示webpack的配置:
- 新建项目空白目录,并运行 npm init –y 命令,初始化包管理配置文件 package.json
- 新建 src 源代码目录
- 新建 src -> index.html 首页
- 初始化首页基本的结构
- 新建 src -> index.js
- 执行
npm init -y
命令初始化npm
├── src # 静态文件夹
├── index.html
├── index.js
├── package.json
配置webpack
对于大多数项目,我们建议本地安装。这可以使我们在引入破坏式变更(breaking change)的依赖时,更容易分别升级项目
- 要安装最新版本:
npm install --save-dev webpack
- 还需要安装 CLI,此工具用于在命令行中运行 webpack:
npm install --save-dev webpack-cli
- 在根目录中创建webpack.config.js
module.exports = { mode: 'development', // mode 用来指定构建模式 };
- 在 package.json 配置文件中的 scripts 节点下,新增 dev 脚本如下:
"scripts": { "dev": "webpack" // script 节点下的脚本,可以通过 npm run 执行 }
- 在终端中运行 npm run dev 命令,启动 webpack 进行项目打包。
- 项目根目录会生成dist文件夹,里面有main.js文件,就是编译后的index.js.在html里导入main.js替换掉index.js.
配置打包的入口与出口
webpack 的 4.x 版本中默认约定:
- 打包的入口文件为 src -> index.js
- 打包的输出文件为 dist -> main.js
如果要修改打包的入口与出口,可以在 webpack.config.js 中新增如下配置信息:
const path = require('path') // 导入 node.js 中专门操作路径的模块
module.exports = {
mode: 'development', // mode 用来指定构建模式
entry: path.join(__dirname, './src/index.js'), // 打包入口文件的路径
output: {
path: path.join(__dirname, './dist'), // 输出文件的存放路径
filename: 'bundle.js' // 输出文件的名称
}
}
在终端中运行 npm run dev 命令,启动 webpack 进行项目打包。
成dist文件夹里会生成bundle.js文件,就是编译后的index.js.
配置 webpack 的自动打包功能
上面的配置还需要手动打包,不太方面,下面配置自动打包。
- 安装支持项目自动打包的工具
npm install webpack-dev-server -D
- 修改 package.json -> scripts 中的 dev 命令如下:
"scripts": { "dev": "webpack-dev-server" // script 节点下的脚本,可以通过 npm run 执行 }
- 将 src -> index.html 中,script 脚本的引用路径,修改为 "/buldle.js"
- 运行 npm run dev 命令,重新进行打包
- 在浏览器中访问 http://localhost:8080 地址,查看自动打包效果
==注意==:
- webpack-dev-server 会启动一个实时打包的 http 服务器
- webpack-dev-server 打包生成的输出文件,默认放到了项目根目录中,而且是虚拟的、看不见的
现在,不论你修改了index.html文件还是index.js文件,系统都会自动打包实时更新。
配置html-webpack-plugin生成预览页面
经过上面的配置,虽然可以自动打包,但是第一次打包的时候,我们还要再浏览器手动输入地址打开页面,也不太方便,并且html文件还需要引入js文件,如果能自动导入就更好了,所以我们继续配置。
- 安装生成预览页面的插件
npm install html-webpack-plugin -D
- 修改webpack.config.js文件:
==此时不需要在html里引入js文件了,webpack会自动引入。所以删掉index.html里的script标签。==const HtmlWebpackPlugin = require('html-webpack-plugin') const htmlWebpackPlugin = new HtmlWebpackPlugin({ // 创建插件的实例对象 template: './src/index.html', // 指定要用到的模板文件 filename: 'index.html' //指定生成的文件名,该文件存在于内存中,在目录里不显示 }) const path = require('path') // 导入 node.js 中专门操作路径的模块 module.exports = { mode: 'development', // mode 用来指定构建模式 entry: path.join(__dirname, './src/index.js'), // 打包入口文件的路径 output: { path: path.join(__dirname, './dist'), // 输出文件的存放路径 filename: 'bundle.js' // 输出文件的名称 }, plugins: [htmlWebpackPlugin] // plugins 数组是 webpack 打包期间会用到的一些插件列表 }
- 修改package.json:
"dev": "webpack-dev-server --open" // --open会自动在浏览器打开文件
重新运行npm run dev 浏览器会自动打开页面
webpack-配置自动打包相关的参数
- 在package.json里添加:
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
+ "dev": "webpack-dev-server --open --host 127.0.0.1 --port 8888"
// --open 打包后自动打开
// --host 配置地址
// --port 配置端口
},
- 重启npm run dev命令
这样就会在浏览器自动打开127.0.0.1:8888。
webpack加载器
webpack加载器-打包处理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.config.js
module.exports={ presets:['@babel/preset-env'], plugins:['@babel/plugin-transform-runtime','@babel/plugin-proposal-class-properties'] }
- 修改webpack.config.js文件:
const path = require('path') const HtmlWebpackPlugin = require('html-webpack-plugin') const htmlWebpackPlugin = new HtmlWebpackPlugin({ template: './src/index.html', filename: 'index.html' }) module.exports = { mode: 'development', entry: path.join(__dirname, 'src/index.js'), output: { path: path.join(__dirname, 'dist'), filename: 'bundle.js' }, plugins: [htmlWebpackPlugin], + module: { + rules: [ + { + test: /\.js$/, + use: 'babel-loader', + exclude: /node_module/ + } + ] + } }
- 重启npm run dev
这样我们就可以欢快的面向未来编程写高级js语法了
打包处理 css 文件
- 安装处理 css 文件的 loader
npm i style-loader css-loader -D
- 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
{ test: /\.css$/, use: ['style-loader', 'css-loader'] }
其中,test 表示匹配的文件类型, use 表示对应要调用的 loader
注意:
- use 数组中指定的 loader 顺序是固定的
- 多个 loader 的调用顺序是:从后往前调用
打包处理 less 文件
- 安装处理 less 文件的 loader
npm i less-loader less -D
- 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
{ test: /\.less$/, use: ['style-loader', 'css-loader', 'less-loader'] }
配置 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 规则如下:
{ test:/\.css$/, use: ['style-loader', 'css-loader', 'postcss-loader'] }
打包样式表中的图片和字体文件
- 安装
npm i url-loader file-loader -D
- 在 webpack.config.js 的 module -> rules 数组中,添加 loader 规则如下:
其中 ? 之后的是 loader 的参数项。{ test: /\.jpg|png|gif|bmp|ttf|eot|svg|woff|woff2$/, use: 'url-loader?limit=16940' }
limit 用来指定图片的大小,单位是字节(byte),只有小于 limit 大小的图片,才会被转为 base64 图片
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)
})
webpack 打包发布
上线之前需要通过webpack将应用进行整体打包,可以通过 package.json 文件配置打包命令:
// 在package.json文件中配置 webpack 打包命令
// 该命令默认加载项目根目录中的 webpack.config.js 配置文件
"scripts": {
// 用于打包的命令
"build": "webpack -p",
// 用于开发调试的命令
"dev": "webpack-dev-server --open --host 127.0.0.1 --port 3000",
},