详解webpack-dev-server的使用

53

webpack-dev-server

webpack-dev-server是一个小型的Node.js Express服务器,它使用webpack-dev-middleware来服务于webpack的包,除此自外,它还有一个通过Sock.js来连接到服务器的微型运行时.

我们来看一下下面的配置文件(webpack.config.js)

var path = require("path");
module.exports = {
    entry:{
    app:["./app/main.js"]
    },
    output:{
    path:path.resolve(__dirname,"build"),
    publicPath:"/assets/",
    filename:"bundle.js"
}
}

这里你将你的源文件放在app文件夹下,并通过webpack将其打包到build文件夹下的bundle.js中.

注意:webpack-dev-server是一个独立的NPM包,你可以通过npm install webpack-dev-server来安装它.

基本目录

webpack-dev-server默认会以当前目录为基本目录,除非你制定它.

webpack-dev-server --content-base build/

上述命令是在命令行中执行的,它将build目录作为根目录.有一点需要注意的是:webpack-dev-server生成的包并没有放在你的真实目录中,而是放在了内存中.

我们在基本目录下新建一个index.html文件,然后在浏览器中输入http://localhost:8080访问.

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Document</title>
</head>
<body>
  <script src="assets/bundle.js"></script>
</body>
</html>

自动刷新

webpack-dev-server支持两种模式来自动刷新页面.

  • iframe模式(页面放在iframe中,当发生改变时重载)

  • inline模式(将webpack-dev-sever的客户端入口添加到包(bundle)中)

两种模式都支持热模块替换(Hot Module Replacement).热模块替换的好处是只替换更新的部分,而不是页面重载.

iframe模式

使用这种模式不需要额外的配置,只需要以下面这种URL格式访问即可

http://«host»:«port»/webpack-dev-server/«path»

例如:http://localhost:8080/webpack...

inline模式

inline模式下我们访问的URL不用发生变化,启用这种模式分两种情况:

1 当以命令行启动webpack-dev-server时,需要做两点:

  • 在命令行中添加--inline命令

  • webpack.config.js中添加devServer:{inline:true}

2 当以Node.js API启动webpack-dev-server时,我们也需要做两点:

  • 由于webpack-dev-server的配置中无inline选项,我们需要添加webpack-dev-server/client?http://«path»:«port»/到webpack配置的entry入口点中.

  • <script src="http://localhost:8080/webpack-dev-server.js"></script>添加到html文件中

    var config = require("./webpack.config.js");
    var webpack = require('webpack');
    var WebpackDevServer = require('webpack-dev-server');

config.entry.app.unshift("webpack-dev-server/client?http://localhost:8080/");

var compiler = webpack(config);
var server = new WebpackDevServer(compiler, {
    contentBase:'build/',
    publicPath: "/assets/"
});
server.listen(8080);

Node中运行上面的代码即可。

注意:webpack配置中的devSever配置项只对在命令行模式有效。

(Hot Module Replacement)热模块替换

在命令行中运行inline模式,并启用热模块替换

这里只需要多增加 --hot指令就OK了.如下所示.

webpack-dev-server --content-base build --inline --hot

注意:命令行模式下,webpack.config.js中一定要配置output.publicPath来指定编译后的包(bundle)的访问位置.

在Nodejs API中运行inline模式,并启用热模块替换

这里需要做以下三点:

  • webpack.config.jsentry选项中添加:webpack/hot/dev-server

  • webpack.config.jsplugins选项中添加:new webpack.HotModuleReplacementPlugin()

  • webpack-dev-server的配置中添加:hot:true

webpack-dev-server中的配置选项

var WebpackDevServer = require("webpack-dev-server");
var webpack = require("webpack");

var compiler = webpack({
  // configuration
});
var server = new WebpackDevServer(compiler, {
  // webpack-dev-server options

  contentBase: "/path/to/directory",
  // Can also be an array, or: contentBase: "http://localhost/",

  hot: true,
  // Enable special support for Hot Module Replacement
  // Page is no longer updated, but a "webpackHotUpdate" message is send to the content
  // Use "webpack/hot/dev-server" as additional module in your entry point
  // Note: this does _not_ add the `HotModuleReplacementPlugin` like the CLI option does. 

  // Set this as true if you want to access dev server from arbitrary url.
  // This is handy if you are using a html5 router.
  historyApiFallback: false,

  // Set this if you want to enable gzip compression for assets
  compress: true,

  // Set this if you want webpack-dev-server to delegate a single path to an arbitrary server.
  // Use "**" to proxy all paths to the specified server.
  // This is useful if you want to get rid of 'http://localhost:8080/' in script[src],
  // and has many other use cases (see https://github.com/webpack/webpack-dev-server/pull/127 ).
  proxy: {
    "**": "http://localhost:9090"
  },

  setup: function(app) {
    // Here you can access the Express app object and add your own custom middleware to it.
    // For example, to define custom handlers for some paths:
    // app.get('/some/path', function(req, res) {
    //   res.json({ custom: 'response' });
    // });
  },

  // pass [static options](http://expressjs.com/en/4x/api.html#express.static) to inner express server
  staticOptions: {
  },

  // webpack-dev-middleware options
  quiet: false,
  noInfo: false,
  lazy: true,
  filename: "bundle.js",
  watchOptions: {
    aggregateTimeout: 300,
    poll: 1000
  },
  // It's a required option.
  publicPath: "/assets/",
  headers: { "X-Custom-Header": "yes" },
  stats: { colors: true }
});
server.listen(8080, "localhost", function() {});
// server.close();

参考:http://webpack.github.io/docs...

你可能感兴趣的

15 条评论
sugang · 2016年12月15日

翻页的蛮好

回复

guoyujun · 2017年02月10日

您好,我想问下“在Nodejs API中运行inline模式”是什么意思,另外为什么我执行webpack-dev-server命令和执行webpack-dev-server --inline --hot命令页面都可以实现实时刷新呢

回复

0

运行webpack-dev-server有两种方式,方式一是通过cmd,方式二是借助Nodejs平台。你提到的两种命令确实都可以实时刷新,后者只刷新改变的部分

yuhualingfeng 作者 · 2017年02月14日
yozosann · 2017年02月20日

webpack-dev-server --content-base build/ 成功执行后 输入8080无法进入,,, http://«host»:«port»/webpack-dev-server/«path» 也是无法进入,,, 直接点index是可以看见页面的。。哪里有问题呢

回复

0

你的这段命令是将build文件夹作为服务目录,检查下index是否在build下,不在肯定是不能浏览到的

yuhualingfeng 作者 · 2017年02月22日
0

@yuhualingfeng 我没有改任何东西重启电脑就行了, 今天也遇见了一样的情况,重启一下又行了,请问您知道原因吗

yozosann · 2017年02月23日
0

我觉得应该是你的端口被其他进程占用了,比如mysql的默认端口就是8080

前端小白 · 2017年12月16日
monkey · 2017年03月28日

webpack-dev-server的配置详解推荐http://www.cnblogs.com/xfshen...

回复

old_bin · 2017年07月13日

想问下,即便是热替换,实际上每次更改,页面也会刷新么?

回复

0

热替换页面是不会刷新的,希望能够帮到你,谢谢

yuhualingfeng 作者 · 2017年09月15日
ccwu · 2017年08月11日

'当以命令行启动webpack-dev-server时,需要做"两"点'
应该是二选一吧?

回复

zhoushx3 · 2017年08月29日

2 当以Node.js API启动webpack-dev-server时,我们也需要做两点:.....

楼主的做法相对麻烦,参考webpack-dev-server的执行文件bin/webpack-dev-server就知道执行addDevServerEntrypoints(webpackConf, devServerOpt)是更加便捷的做法。

回复

lc941015 · 2017年12月04日

请您翻译的时候尊重一下源文档,二选一不是全配,搞死我了

回复

向东是大海 · 2018年03月17日

你好,请问怎么知道webpack-dev-server是否在运行?我访问8080端口被拒绝访问,改成8078还是被拒绝访问。

回复

0

如果程序正常的话,运行成功之后会直接打开浏览器并打开网页,无需手动打开浏览器和网址。(我这正常的话就是如此,不知道还有没有其他情况)

全都怪我 · 2018年04月25日
载入中...