webpack基础——常用配置解析

系列:
webpack入门——了解及使用
webpack进阶——缓存与独立打包

文件目录:

-- /node_modules:依赖的各种模块
-- /src
– index.js
– print.js
– style.css
– package.json:配置npm相关设置
– webpack.config.js:配置webpack
package.json脚本(输入npm run xxx,xxx为脚本中对应命令,将会在命令行中执行相应操作):

"scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "build": "webpack",   // webpack打包
  "watch": "webpack --watch",  // webpack监听模式
  "start": "webpack-dev-server --open" // 自动刷新
}

webpack.config.js:
(这是一个我们已经配置好的webpack配置js,本文中的讲解都将基于该文件,会在本文件上多多少少做一些改变以供测试。)

const path = require('path');
const HtmlWebpackPlugin = require('html-webpack-plugin');
const CleanWebpackPlugin = require('clean-webpack-plugin');
const webpack = require('webpack');
 
module.exports = {
  entry: {
    app: './src/index.js',
    print: './src/print.js'
  },
  output: {
    filename: '[name].js',
    path: path.resolve(__dirname, 'dist')
  },
  module: {
    rules: [
      {
        test: /.css$/,
        use: ['style-loader', 'css-loader']
      }
    ]
  },
  devtool: 'inline-source-map',
  devServer: {
    hot: true,
    contentBase: path.resolve(__dirname, 'dist'),
    publicPath: '/'
  },
  plugins: [
    new webpack.optimize.CommonsChunkPlugin({
      name: "common",
      minChunks: Infinity,
    }),
    new webpack.HotModuleReplacementPlugin(),
    new CleanWebpackPlugin(['dist']),
    new HtmlWebpackPlugin({
      title: 'Output Management'
    })
  ]

HtmlWebpackPlugin

由webpack.config.js可知,webpack打包后生成的是若干个js文件,但是最终这些js文件都是应用在html中的。
假如打包后的文件只有app.js,那么完全可以手动创建一个html,并加入<script type="text/javascript" src="app.js">,html就可以应用该打包后的文件。
但是如果我们打包的文件不止一个,或者打包后的文件包含hash值,那么每次我们都需要添加script或者说每次都需要更改文件的hash值吗?当然可以,但是这样很麻烦,开发效率很低。
所以我们就引入了HtmlWebpackPlugin插件,这样就可以自动生成html模版并且自动添加script。

plugins: [
  new webpack.HashedModuleIdsPlugin(),
  new webpack.optimize.CommonsChunkPlugin({
    name: "common",
    minChunks: Infinity,
  }),
  new webpack.HotModuleReplacementPlugin(), 
  new CleanWebpackPlugin(['dist']),
  new HtmlWebpackPlugin({        // 已添加该插件
    title: 'Output Management'
  })
]

现在我们进行wepack打包:
生成目录:
-- /dist
– app.js
– common.js
– print.js
– index.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="UTF-8">
    <title>Output Management</title>
  </head>
  <body>
  <script type="text/javascript" src="common.js"></script><script type="text/javascript" src="app.js"></script><script type="text/javascript" src="print.js"></script></body>
</html>

更多配置:HTML Webpack Plugin

CleanWebpackPlugin

该插件的主要作用是清除前次打包文件。
没有hash时,这个插件体现不出来效果,我我们在以上的webpack配置中做点小的变动:

// 给输出文件名上加上hash
  output: {
    filename: '[name].[hash].js',
    path: path.resolve(__dirname, 'dist')
  }
  
// 注释掉CleanWebpackPlugin
  plugins: [
    new webpack.HashedModuleIdsPlugin(),
    new webpack.optimize.CommonsChunkPlugin({
      name: "common",
      minChunks: Infinity,
    }),
    new webpack.HotModuleReplacementPlugin(),
    // new CleanWebpackPlugin(['dist']),
    new HtmlWebpackPlugin({
      title: 'Output Management'
    })
  ]

然后再次打包,可以看见dist文件夹中:


现在我们只需要hash后的文件给html使用,但是这里却任然保留着很多上一次打包留下来的东西。
这个时候我们把CleanWebpackPlugin取注释,然后再次打包。

可以看见上次文件夹里的垃圾都没有了,只留下了现在需要的文件。
故CleanWebpackPlugin的效果是在打包前,删除指定的曾经打包的文件夹,然再新建并把最新打包好的内容放在dist文件夹里。
参数为文件夹字符串数组,更多配置:Clean Webpack Plugin

webpack-dev-server

webpack有一个功能叫做监听,使用方法:命令行中输入 webpack --watch。
这样启动webpack之后,每当我们在源文件中发生了改变,都会进行重新打包,这样提高了生产效率,虽然重新打包了,但是我们必须刷新页面才能看见更变。
这样是不友好的,如果能够自己刷新页面那就极好了,这也就是webpack-dev-server的作用,启动一个小型server达到实时刷新的效果。
使用方法:


sudo npm install webpack-dev-server --save-dev
## 然后启动的时候,就
webpack-dev-server --open
## 运行参数可以用以下查看
webpack-dev-server -help
## 常用的有 编译刷新的时候出现颜色和进程条
webpack-dev-server --progress --colors

我们将该脚本写入了package.json中,可以快捷启动 npm run start。

Hot Module Replace

热替换常常和webpack-dev-server同时使用,所谓热替换(HMR: Hot Module Replace)描述的是运行中的一个系统,我要更换其中部分内容,而仍然要保持不替换的内容继续工作,并在替换后,替换部分能够立即生效。
可能到这里大家还不是很明白热替换的具体作用,简单来说就是部分刷新。
假如我们仅仅只使用webpack-dev-server,然后在index.js 引入了 style.css。 那么我们修改一下style.css的样式,webpack-dev-server会监听到源文件发生了变化,然后重新进行webpack打包,然后再刷新页面,可能到这里已经满足了很多人的需求。但是我现在有了一个新的需求,我页面上有一个input,我在input中输入了一系列文字,现在我希望,我更改了样式,input中的文字仍然保持不变,只有修改的样式发生改变。我们知道webpack-dev-server在源文件发生改变后,会刷新整个页面,一旦刷新的整个页面,那么input中的文字必当消失。 这个时候就是体现热替换强大功能的时候了,使用了热替换,就可以仅仅只更改样式而保持input中的值不发生改变。


使用方法:

  • 在命令行中直接使用:
webpack-dev-server --hot
  • 将启动配置写入webpack.config.js中,首先在插件数组中添加该插件:
plugins: [
  new webpack.HashedModuleIdsPlugin(),
  new webpack.optimize.CommonsChunkPlugin({
    name: "common",
    minChunks: Infinity,
  }),
  new webpack.HotModuleReplacementPlugin(),  // 在实例webpack.config.js中已添加
  new CleanWebpackPlugin(['dist']),
  new HtmlWebpackPlugin({
    title: 'Output Management'
  })
]

这之后我们将进行webpack-dev-server的配置,

devServer: {
  hot: true,  // hot为true则代表启动了热替换服务
  contentBase: path.resolve(__dirname, 'dist'),
  publicPath: '/'
},

进行配置之后,我们直接启动npm run start脚本既可(webpack-dev-server --open)。
由本例我们知道了devServer是关于webpack-dev-server的配置,我们来看看常用参数:

  • port:8080(Number,访问端口),从localhost:8080访问服务器
  • hot:是否开启热替换模式
  • contentBase:简单来说就是提供静态资源文件的目录,如果我们没有使用HtmlWebpackPlugin的,而是手动的添加了index.html,那么这个时候index.html在哪个目录下,contentBase就需要写哪个目录。这里一定要写绝对路径。因为这个路径是基于本机的,如果写相对路径则是相对于本机的根路径的。
  • publicPath:开发模式中,打包的文件在该目录下,而不是在output中制定的文件夹下。并且路径是相对于当前目录的,以'/'开头。例如:publicPath: '/public/',则应该通localhost:8080/public/来访问打包的文件,例如我要访问common.js,那么就是localhost:8080/public/common.js。使用该路径时,通常都不会自己手写index.html,这样会造成访问混乱,直接使用HtmlWebpackPlugin生成HTML。
    更多配置:Webpack Dev Server

source map

首先我们先在本例的webpack配置上做出一些修改:
// devtool: 'inline-source-map' // 注释掉source-map
之后我们运行npm run start,这个时候我们的项目应该正常进入了开发模式中。进入print.js文件:

import _ from 'lodash';
 
export default function printMe() {
  console.log(_.join(['qq', 'bb'], ' '));
}

这个时候我们把console改成consol然后保存,在页面上触发这个printMe函数,发现控制台上:


我们知道错误明明出现在print.js中,但是由于是app.js引用了print.js,所以报错还是在app.js上,这样以后我们出现了错误很难定位出错的位置,导致难以调试,现在我们吧
// devtool: 'inline-source-map'解注,然后重新执行npm run start。再次触发printMe这个函数:


然后我们可以看见,清楚的定位了出错的是在print.js第四行,这就是source map的作用,用于错误定位。但是在生产环境中,我们一般都是经过调试好的文件,所以在生产环境中不需要这个source map。
相关信息查看:开发辅助调试工具(Devtool)

参考资料:
开发中 Server
Webpack dev server
webpack-dev-server 使用总结
Webpack使用教程三(webpack-dev-server)

本文将持续更新。。。。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,482评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,377评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,762评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,273评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,289评论 5 373
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,046评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,351评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,988评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,476评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,948评论 2 324
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,064评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,712评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,261评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,264评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,486评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,511评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,802评论 2 345

推荐阅读更多精彩内容

  • GitChat技术杂谈 前言 本文较长,为了节省你的阅读时间,在文前列写作思路如下: 什么是 webpack,它要...
    萧玄辞阅读 12,674评论 7 110
  • 无意中看到zhangwnag大佬分享的webpack教程感觉受益匪浅,特此分享以备自己日后查看,也希望更多的人看到...
    小小字符阅读 8,140评论 7 35
  • 在现在的前端开发中,前后端分离、模块化开发、版本控制、文件合并与压缩、mock数据等等一些原本后端的思想开始...
    Charlot阅读 5,431评论 1 32
  • 最近在学习 Webpack,网上大多数入门教程都是基于 Webpack 1.x 版本的,我学习 Webpack 的...
    My_Oh_My阅读 8,166评论 40 247
  • “人和鬼就差口气 人就是鬼,鬼就是人。”一座深宅老院,用高墙围住生命的气息,以为那就是人生该有的归宿。它锁住了青春...
    甜美系美少女阅读 5,031评论 1 7