认识webpack
什么是webpack
官方的解释:
从本质上来讲,webpack是一个现代的javascript应用的静态模块打包工具。
但是它是什么呢?用概念解释概念,还是不清楚
我们从两个点上来解释上面这句话:模块和打包
前端模块化
前端模块化
- 前面,我们用了大量的篇幅解释为什么前端需要模块化。
- 而且也提到了目前使用前端模块化的一些方案:AMD、CMD、CommonJS、ES6
- 在ES6之前,我们要想进行模块化开发,就必须借助于其他的工具,让我们可以进行模块化开发。
- 并且在通过在模块化开发完成了项目后,还需要处理模块间的各种依赖,并且将其进行整合打包。
- 而webpack其中一个核心就是让我们可能进行模块化开发,并且会帮助我们处理模块间的依赖关系。
- 而且不仅仅是javascript文件,我们的css,img(图片),json文件等等,在webpack中都可以被当做模块来使用
- 这就是webpack中模块化的概念。
打包如何理解
- 理解了webpack可以帮助我们进行模块化,并且处理模块间的各种复杂关系后,打包的概念就非常好理解了。
- 就是将webpack中的各种资源模块进行打包合并成一个或多个包(Bundle)。
- 并且在打包的过程中,还可以对资源进行处理,比如压缩图片,将scss(sass)转换成css,将ES6语法转换成ES5语法,将Typescript 转成javascript等等操作。
- 但是打包的操作似乎grunt/gulp也可以帮助我们完成,他们有什么不同呢?
和grunt/gulp的对比
webpack的安装
安装webpack首先需要安装
Node.js
,Node.js 自带了软件包管理工具npm
查看自己的
node
版本
node -v
全局安装webpack(这里我先指定版本号3.6.0,因为vue cli2 依赖该版本)
npm install webpack@3.6.0 -g
局部安装webpack(后续才需要)
--save-dev
是开发时依赖,项目打包后不需要继续使用的。
cd 对应目录
npm install webpack@3.6.0 --save-dev
为什么全局安装后,还需要局部安装呢?
- 在终端(cmd)直接执行webpack命令,使用的全局安装的webpack
- 当在
package.json
中定义了scripts 时,其中包含了webpack命令,那么使用的是局部webpack
webpack的起步
准备工作
首先我们创建如下文件和文件夹
文件和文件夹解析:
- dist文件夹:用于存放之后打包的文件
- src文件夹:用于存放我们写的源文件
- main.js:项目的入口文件。详情内容看下面详情
- mathUtils.js 定义了一些数学工具函数,可以在其他地方引用,并且使用。 详情内容看下面详情
- index.html : 浏览器打开展示的首页html
- package.json : 通过
npm init
生成的,npm包管理的文件(现在暂时没有用上,后面才会用上)可以先安装上
- mathUtils.js 中的代码:
function add(num1, num2) {
return num1 + num2
}
function mull(num1, num2) {
return num1 * num2
}
modules.exports = {
add,
mull
}
- main.js 中的代码:
const math = require('./mathUtils')
console.log('hello webpack');
console.log(math.add(10, 20));
console.log(math.mul(10, 20));
js文件的打包
现在的js文件中 使用了模块化的方式进行开发,他们可以直接使用吗? 不可以
- 因为如果直接在
index.html
引入这两个js文件,浏览器并不识别其中的模块化代码。- 另外,在真实的开发中当有许多这样的js文件时,我们一个个引用非常麻烦,并且后期不方便对它们进行管理。
我们该怎么办?使用webpack工具,对多个js文件进行打包。
- 我们知道,webpack就是一个模块化的打包工具,所以它支持我们代码中写模块化,可以对模块化的代码进行处理。(如何处理的,后面会讲解)
- 另外,如果在处理完所有模块之间的关系后,将多个js打包到一个js文件中,引入时就变得非常方便了。
OK,如何打包呢?使用webpack的指令即可
webpack ./src/main.js ./dist/bundle.js
使用打包后的文件
打包后的文件会在dist文件下,生成一个bundle.js文件
- 文件内容有些复杂,这里暂时先不看,后续再进行分析。
bundle.js
文件,是webpack处理了项目直接文件依赖后生成的一个js文件,我们只需要将这个js文件在index.html中引入即可
webpack的配置
我们考虑一下,如果每次使用webpack的命令都需要写上入口和出口作为参数,就非常麻烦,有没有一种方法可以将这两个参数写到配置中,在运行时,直接读取呢?
当然可以,就是创建一个
webpack.config.js
文件
注意:这是手写的,不要写错单词
entry
output
然后使用
npm init
进行初始化
然后按回车,最后输入 yes
就会生成一个
package.json
的文件
这里我改了name
问题不大
如果在package.json
里有别的依赖 就使用npm install
进行安装依赖的东西但是在这个项目里没有声明依赖所以就没有声明效果
局部安装webpack
目前,我们使用的webpack是全局的webpack,如果我们想使用局部来打包呢?
- 因为一个项目往往依赖特定的webpack版本,全局的版本可能很这个项目的webpack版本不一致,导出打包出现问题。
- 所以通常一个项目,都有自己局部的webpack。
第一步:项目中需要 安装自己局部的webpack
- 这里我们让局部安装 webpack3.6.0
- Vue CLI3中已经升级到webpack4,但是它将配置文件隐藏了起来,所以查看起来不是很方便。
npm install webpack@3.6.0 --save-dev
第二步,通过
node_modules/.bin/webpack
启动webpack打包
package.json中定义启动
但是,每次执行都敲这么长有没有感觉不方便呢
- 所以,我们可以在
package.json
的scripts
中定义自己的运行脚本。
{
"name": "meetwebpack",
"version": "1.0.0",
"description": " ",
"main": "webpack.config.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"build": "webpack"
},
"author": "",
"license": "ISC",
"devDependencies": {
"webpack": "^3.6.0"
}
}
package.json中的scripts的脚本在执行时,会按照一定的顺序寻找命令对应的位置。
- 首先,会寻找本地的node_modules/.bin路径中对应的命令。
- 如果没有找到,会去全局的环境变量中寻找。
如何执行我们的build指令呢?
在终端中输入
npm run build
loader的使用
loader使用过程:
步骤一:通过npm安装需要使用的loader
步骤二:在webpack.config.js中的modules关键字下进行配置
大部分loader我们都可以在webpack的官网中找到,并且学习对应的用法。
css文件处理–准备工作
项目开发过程中,我们必然需要添加很多的样式,而样式我们往往写到一个单独的文件中。
- 在src目录中,创建一个css文件,其中创建一个normal.css文件。
- 我们也可以重新组织文件的目录结构,将零散的js文件放在一个js文件夹中。
normal.css中的代码非常简单,就是将body设置为red
但是,这个时候normal.css中的样式会生效吗?
- 当然不会,因为我们压根就没有引用它。
- webpack也不可能找到它,因为我们只有一个入口,webpack会从入口开始查找其他依赖的文件。
在入口文件中引用:
然后我们重新打包,会出现如下错误
这个错误告诉我们:加载normal.css文件必须有对应的loader。
css文件处理-- css-loader
在webpack的官方中,我们可以找到如下关于样式的loader使用方法:
按照官方配置webpack.config.js文件
- 注意:配置中有一个style-loader,我们并不知道它是什么,所以可以暂时不进行配置。(后面会说)
让我们重新打包项目:
但是,运行index.html,你会发现样式并没有生效
- 原因:css-loader只负责加载css文件,但是并不负责将css具体样式嵌入到文档中。
- 这个时候,我们还需要一个
style-loader
帮助我们处理
css文件处理-- style-loader
我们来安装
style-loader
npm install style-loader --save-dev
注意:style-loader需要放在css-loader的前面。
疑惑:不对吧?按照我们的逻辑,在处理css文件过程中,应该是css-loader先加载css文件,再由style-loader来进行进一步的处理,为什么会将style-loader放在前面呢?
答案:这次因为webpack在读取使用的loader的过程中,是按照从右向左的顺序读取的。
目前,webpack.config.js的配置如下:
const path = require('path')
module.exports = {
// 入口:可以是字符串/数组/对象,这里我们入口只有一个,所以写一个字符串即可
entry: './src/main.js',
// 出口:通常是一个对象,里面至少包含两个重要属性, path 和filename
output: {
path: path.resolve(__dirname, 'dist'), //注意:path通常是一个绝对路径
filename: 'bundle.js'
},
module: {
rules: [{
test: /\.css$/,
// css-loader 只负责将css文件进行加载
// style-loader 负责将样式添加到DOM中
// 使用多个loader时,是从右往左
use: ['style-loader', 'css-loader']
}]
}
}
less文件处理- 准备工作
如果我们希望在项目中使用less、scss、stylus来写样式,webpack是否可以帮助我们处理呢?
- 我们这里以less为例,其他也是一样的。
我们还是先创建一个less文件,依然放在css文件夹中
less文件处理- less-loader
继续在官方中查找,我们会找到less-loader相关的使用说明
首先,还是需要安装对应的loader
- 注意:我们这里还安装了less,因为webpack会使用less对less文件进行编译
npm install --save-dev less-loader less
其次,修改对应的配置文件
- 添加一个rules选项,用于处理.less文件
图片文件处理-准备工作
首先,我们在项目中加入两张图片:
- 一张较小的图片(test.jpg - 小于10kb),一张较大的图片(test2.jpg - 大于10kb)
- 待会儿我们会针对这两张图片进行不同的处理
我们先考虑在css样式中引用图片的情况,所以我更改了css中的样式
如果我们直接打包就会出现下面的问题:
图片处理 - url- loader
上面的问题,还是因为没有加载对应的
loader
所导致的 ,接下来我我们先安装url- loader
npm install --save-dev url-loader
并且,修改webpack.config.js 的配置文件
limit 默认是 8192 (8kb)
再次打包,运行index.html ,就会发现我们的背景图片选出来了
- 在浏览器观察时,我们会发现背景图是通过base64显示出来的
- OK,这也是limit属性的作用,当图片小于10kb时,对图片进行base64编码
图片处理 - file-loader
那么问题来了,如果大于10kb呢? 我们将
background
的图片改成test2.jpg
这次因为大于10kb的图片,会通过file-loader进行处理,但是我们的项目并没有
file-loader
所以,我们需要安装file-loader
npm install --save-dev file-loader
再次打包,就会发现dist文件下多了一个图片文件
修改图片文件名称
我们发现webpack自动帮我们生成一次非常长的名字
- 这是一个32位hash值,目的是防止名字重复
- 但是真实开发中,我们可能对打包文件的图片名字有一定要求
- 比如,将所有的图片放在一个文件夹中,跟上图片原来的名称,同时也要防止重复
所以 ,我们可以在options中添加上如下的选项:
- img:文件要打包到的文件夹
- name:获取图片原来的名字,放在该位置
- hash:8 :为了防止图片名称冲突,依然使用hash,但是我们只保留8位
- ext:使用图片原来的扩展名
但是,我们发现图片并没有显示出来,这是因为图片使用的路径不正确
- 默认情况下,webpack会将生成的路径直接返回给使用者
- 但是,我们整个程序是打包在dist文件夹下的,所以这里我们需要在路径下再添加一个
dist/
ES6 语法的处理 - babel的使用
如果你仔细阅读webpack打包的js文件,发现写的ES6语法并没有转成ES5,那么就意味着可能一些对ES6还不支持的浏览器没有办法很好的运行我们的代码。
在前面我们说过,如果希望将ES6的语法转成ES5,那么就需要使用babel。
- 而在webpack中,我们直接使用babel对应的loader就可以了。
npm install --save-dev babel-loader@7 babel-core babel-preset-es2015
配置webpack.config.js文件
重新打包,查看bundle.js文件,发现其中的内容变成了ES5的语法
webpack中配置Vue
在后续项目中,我们会使用Vuejs进行开发,而且会以特殊的文件来组织vue的组件。
所以,下面我们来学习一下如何在我们的webpack环境中集成Vuejs
现在,我们希望在项目中使用Vuejs,那么必然需要对其有依赖,所以需要先进行安装
- 注:因为我们后续是在实际项目中也会使用vue的,所以并不是开发时依赖
npm install vue --save
那么现在,就可以按照我们之前学习的方式来使用Vue了
修改完成后,重新打包,运行程序:
- 打包过程没有任何错误(因为只是多打包了一个vue的js文件而已)
- 但是运行程序,没有出现想要的效果,而且浏览器中有报错
这个错误说的是我们使用的是runtime-only版本的Vue,什么意思呢?
- 这里我只说解决方案:
Vue不同版本构建
,后续我具体说runtime-only
和runtime-compiler
的区别。
所以我们修改webpack的配置,添加如下内容即可
el和template 区别
正常运行之后,我们来考虑另外一个问题:
- 如果我们希望将data中的数据显示在界面中,就必须是修改index.html
- 如果我们后面自定义了组件,也必须修改index.html来使用组件
- 但是html模板在之后的开发中,我并不希望手动的来频繁修改,是否可以做到呢?
定义template属性:
- 在前面的Vue实例中,我们定义了el属性,用于和index.html中的#app进行绑定,让Vue实例之后可以管理它其中的内容
- 这里,我们可以将div元素中的{{message}}内容删掉,只保留一个基本的id为div的元素
- 但是如果我依然希望在其中显示{{message}}的内容,应该怎么处理呢?
- 我们可以再定义一个template属性,代码如下:
重新打包,运行程序,显示一样的结果和HTML代码结构
那么,el和template模板的关系是什么呢?
- 在我们之前的学习中,我们知道el用于指定Vue要管理的DOM,可以帮助解析其中的指令、事件监听等等。
- 而如果Vue实例中同时指定了template,那么template模板的内容会替换掉挂载的对应el的模板。
这样做有什么好处呢?
- 这样做之后我们就不需要在以后的开发中再次操作index.html,只需要在template中写入对应的标签即可
但是,书写template模块非常麻烦怎么办呢?
- 没有关系,稍后我们会将template模板中的内容进行抽离。
- 会分成三部分书写:template、script、style,结构变得非常清晰。
Vue组件化开发引入
在学习组件化开发的时候,我说过以后的Vue开发过程中,我们都会采用组件化开发的思想。
- 那么,在当前项目中,如果我也想采用组件化的形式进行开发,应该怎么做呢?
查看下面的代码:
- 当然,我们也可以将下面的代码抽取到一个js文件中,并且导出。
我们新建一个vue 的文件夹,把代码放进去
运行后还会报错 ,所以安装相应的
loader
npm install --save-dev vue-loader vue-template-compiler
再进行配置
然后运行 依旧报错
这里是因为
vue-loader
版本太高 ,所以我们改成13.0.0
然后 执行npm install
把版本改过来
然后就可以运行了
扩展 加入子组件
我们继续在vue文件下创建一个
Cpn.vue
具体代码如下
<template>
<div>
<h2>cpn的标题</h2>
<p>{{name1}}</p>
</div>
</template>
<script>
export default {
name:"cpn",
data() {
return {
name1:'cpn组件的name'
}
}
}
</script>
<style scoped>
</style>
在App.vue中引入和使用
plugin的使用
plugin的使用过程:
- 步骤一:通过npm安装需要使用的plugins(某些webpack已经内置的插件不需要安装)
- 步骤二:在webpack.config.js中的plugins中配置插件。
添加版权
我们先来使用一个最简单的插件,为打包的文件添加版权声明
该插件名字叫BannerPlugin,属于webpack自带的插件。
-
按照下面的方式来修改webpack.config.js的文件:
-
重新打包程序:查看bundle.js文件的头部:
打包html
目前,我们的index.html文件是存放在项目的根目录下的。’
- 我们知道,在真实发布项目时,发布的是dist文件夹中的内容,但是dist文件夹中如果没有index.html文件,那么打包的js等文件也就没有意义了。
- 所以,我们需要将index.html文件打包到dist文件夹中,这个时候就可以使用
HtmlWebpackPlugin
插件
HtmlWebpackPlugin插件可以为我们做这些事情:
- 自动生成一个index.html文件(可以指定模板来生成)
- 将打包的js文件,自动通过script标签插入到body中
安装
HtmlWebpackPlugin
插件
npm install html-webpack-plugin --save-dev
这里有版本问题,我们使用3.2.0版本 原因尚不清楚
npm install html-webpack-plugin@3.2.0 -D
使用插件,修改
webpack.config.js
文件中plugins部分的内容如下:
- 这里的template表示根据什么模板来生成index.html
- 另外,我们需要删除之前在output中添加的publicPath属性
否则插入的script标签中的src可能会有问题
js压缩-在发布时候使用
在项目发布之前,我们必然需要对js等文件进行压缩处理
- 这里,我们就对打包的js文件进行压缩
- 我们使用一个第三方的插件uglifyjs-webpack-plugin,并且版本号指定1.1.1,和CLI2保持一致
npm install uglifyjs-webpack-plugin@1.1.1 --save-dev
-
修改webpack.config.js文件,使用插件:
-
查看打包后的bunlde.js文件,是已经被压缩过了。
搭建本地服务器
安装
npm install --save-dev webpack-dev-server@2.9.1
配置
webpack.config.js文件配置修改如下:
devserver也是作为webpack中的一个选项,选项本身可以设置如下属性:
- contentBase:为哪一个文件夹提供本地服务,默认是根文件夹,我们这里要填写
./dist
- port:端口号
- inline:页面实时刷新
- historyApiFallback:在SPA页面中,依赖HTML5的history模式
在
package.json
文件的scripts
的配置如下:
--open
参数表示直接打开浏览器
配置文件分离
1.首先创建一个
build
文件夹
2.在这个文件下面创建3个文件
- 把
webpack.config.js
文件分成三个部分 并且放入对应文件
4.使用
npm install webpack-merge --seve-dev
进行安装插件、
5.进行配置
6.在
package.json
指定配置文件位置--config ./build/prod.config.js
- 最后打包运行就行