webpack-dev-server是一个小型的node.js Express服务器,它使用webpack-dev-middleware中间件来为通过webpack打包生成的资源文件提供Web服务。它还有一个通过Socket.IO连接着webpack-dev-server服务器的小型运行时程序。webpack-dev-server发送关于编译状态的消息到客户端,客户端根据消息作出响应。

简单来说,webpack-dev-server就是一个小型的静态文件服务器。使用它,可以为webpack打包生成的资源文件提供Web服务。那么,它能给开发带来什么便利呢?

支持自动刷新的两种模式

webpack-dev-server有两种模式支持自动刷新——iframe模式和inline模式。在iframe模式下:页面嵌套在一个iframe下,在代码发生改动的时候,这个iframe会重新加载; 在inline模式下:一个小型的webpack-dev-server客户端会作为入口文件打包,这个客户端在后端代码改变的时候刷新页面。

  • 使用iframe模式无需额外配置,只需要在浏览器中输入http://localhost:8080/webpack-dev-server/index.html

  • 使用inline模式有两种方式:命令行方式和Node.js API

1) 命令行方式比较简单,只需要加入--inline即可。例如webpack-dev-server --inline

使用--inline会自动把webpack-dev-server客户端加到webpack的入口文件配置中。

注意:使用webpack-dev-server命令行的时候,会自动查找名为webpack.config.js的配置文件。如果你的配置文件名称不是webpack.config.js,需要命令行中指明配置文件。 例如,配置文件是webpack.config.dev.js,那么命令就应该是webpack-dev-server --inline --config webpack.config.dev.js

2) Node.js API的方式需要手动把webpack-dev-server/client?http://localhost:8080加到配置文件的入口文件配置中,因为webpack-dev-server没有inline:true这个配置项。 (注意:通常我们设置好webpack-dev-server服务自动刷新预览功能之后,发现手机预览不了,其实是由于webpack-pack-server服务安全机制导致的,只允许本机访问,我们可以把host设置为0.0.0.0就可以允许或者设置为本机地址。)

支持热替换

webpack-dev-srever持Hot Module Replacement,即模块热替换,在前端代码变动的时候无需整个刷新页面,只把变化的部分替换掉。使用HMR功能也有两种方式:命令行方式和Node.js API

1) 命令行方式同样比较简单,只需加入--inline --hot选项。--hot这个选项干了一件事情,它把webpack/hot/dev-server入口点加入到了webpack配置文件中。这时访问浏览器,你会看见控制台的log信息:

[HMR] Waiting for update signal from WDS...
[WDS] Hot Module Replacement enabled.

HMR前缀的信息由webpack/hot/only-dev-server模块产生,WDS前缀的信息由webpack-dev-server客户端产生。

2) Node.js API方式需要做三个配置:

  • webpack/hot/only-dev-server加入到webpack配置文件的entry项;

  • new webpack.HotModuleReplacementPlugin()加入到webpack配置文件的plugins项;

  • hot:true加入到webpack-dev-server的配置项里面。

注意:要使HMR功能生效,还需要做一件事情,就是要在应用热替换的模块或者根模块里面加入允许热替换的代码。否则,热替换不会生效,还是会重刷整个页面。下面是摘自webpackgithub上docs的原话:

A module can only be updated if you “accept” it. So you need to module.hot.accept the module in the parents or the parents of the parents… I. e. a Router is a good place or a subview.

具体代码是:

if (module.hot) {
   module.hot.accept();
}

也可以使用一些插件去完成这个工作,例如webpack-module-hot-accept插件。不过,webpack-dev-server HMR结合react-hot-loader使用的时候,react-hot-loader会去做这个工作。

综合上述两点,使用wepack-dev-server辅助开发,使得开发者在开发前端代码的过程中无需频繁手动刷新页面,使用HMR甚至不用等待页面刷新,确实可以给开发者带来很好的体验。

与后端服务器结合使用

但是,问题又来了。我要进行前后端联调的时候怎么办呢?毕竟webpack-dev-server只是一个静态文件服务器,不具备动态处理的能力。这个时候就需要将后端服务器与webpack-dev-server结合使用了。 webpack-dev-server只用来为webpack打包生成的资源文件提供服务,比如js文件、图片文件、css文件等;后端服务器除提供API接口外,还提供入口HTML。

要将webpack-dev-server与后端服务器结合使用,需要做三件事情。

1) 首页HTML文件是从后端服务器发出的,这时页面的根地址变成了后端服务器地址,怎么使得webpack产生的资源文件在请求资源的时候是向web-dev-server请求而不是后端服务器请求? 只需在webpack配置文件中的output.publicPath配置项写上绝对URL地址,例如output.publicPath = "http://localhost:8080/assets/"。 这时,webpack打包产生的资源文件里面的url地址都会是绝对地址,而不是相对地址。

2) 后端服务器产生的入口HTML文件要向webpack-dev-server请求资源文件,这个简单,只需在HTML文件中加入资源文件的绝对地址,例如:<script src="http://localhost:8080/assets/bundle.js">

3) 要使webpack-dev-server和它的运行时程序连接起来。这个简单,只需要使用inline模式即可。