詳解webpack-dev-server使用方法
記錄下webpack-dev-server
的用法.
首先,我們來看看基本的webpack.config.js
的寫法
module.exports = { entry: './src/js/index.js', output: { path: './dist/js', filename: 'bundle.js' } }
配置文件提供一個入口和一個出口,webpack
根據(jù)這個來進行js的打包和編譯
工作。雖然webpack
提供了webpack --watch
的命令來動態(tài)監(jiān)聽文件的改變并實時打包,輸出新bundle.js
文件,這樣文件多了之后打包速度會很慢,此外這樣的打包的方式不能做到hot replace
,即每次webpack
編譯之后,你還需要手動刷新瀏覽器。
webpack-dev-server
其中部分功能就能克服上面的2個問題。webpack-dev-server
主要是啟動了一個使用express
的Http服務器
。它的作用主要是用來伺服資源文件。此外這個Http服務器
和client
使用了websocket
通訊協(xié)議,原始文件作出改動后,webpack-dev-server
會實時的編譯,但是最后的編譯的文件并沒有輸出到目標文件夾,即上面配置的:
output: { path: './dist/js', filename: 'bundle.js' }
注意:你啟動webpack-dev-server后,你在目標文件夾中是看不到編譯后的文件的,實時編譯后的文件都保存到了內(nèi)存當中。因此很多同學使用webpack-dev-server進行開發(fā)的時候都看不到編譯后的文件
下面來結合webpack
的文檔和webpack-dev-server
里部分源碼來說明下如何使用:
啟動
啟動webpack-dev-server
有2種方式:
- 通過
cmd line
- 通過
Node.js API
配置
我主要講解下cmd line
的形式,Node.js API
形式大家去看下官方文檔。可通過npm script
進行啟動。我的目錄結構是:
app |__dist | |__styles | |__js | |__bundle.js | |__index.html |__src | |__styles | |__js | |__index.js |__node_modules |__package.json |__webpack.config.js
content-base
設定webpack-dev-server
伺服的directory
。如果不進行設定的話,默認是在當前目錄下。
webpack-dev-server --content-base ./dist
這個時候還要注意的一點就是在webpack.config.js
文件里面,如果配置了output
的publicPath
這個字段的值的話,在index.html
文件里面也應該做出調(diào)整。因為webpack-dev-server
伺服的文件是相對publicPath
這個路徑的。因此,如果你的webpack.config.js
配置成這樣的:
module.exports = { entry: './src/js/index.js', output: { path: './dist/js', filename: 'bundle.js', publicPath: '/assets/' } }
那么,在index.html
文件當中引入的路徑也發(fā)生相應的變化:
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Demo</title> </head> <body> <script src="assets/bundle.js"></script> </body> </html>
如果在webpack.config.js
里面沒有配置output
的publicPath
的話,那么index.html
最后引入的文件js文件
路徑應該是下面這樣的。
<!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8"> <title>Demo</title> </head> <body> <script src="bundle.js"></script> </body> </html>
Automatic Refresh
webpack-dev-server
支持2種自動刷新的方式:
- Iframe mode
- inline mode
這2種模式配置的方式和訪問的路徑稍微有點區(qū)別,最主要的區(qū)別還是Iframe mode
是在網(wǎng)頁中嵌入了一個iframe
,將我們自己的應用注入到這個iframe
當中去,因此每次你修改的文件后,都是這個iframe
進行了reload
。
通過查看webpack-dev-server
的源碼,lib
路徑下的Server.js
文件,第38-48行,分別新建幾個流,這幾個流保存了client
文件夾下的相關文件:
// Prepare live html page var livePage = this.livePage = new StreamCache(); fs.createReadStream(path.join(__dirname, "..", "client", "live.html")).pipe(livePage); // Prepare the live js file var liveJs = new StreamCache(); fs.createReadStream(path.join(__dirname, "..", "client", "live.bundle.js")).pipe(liveJs); // Prepare the inlined js file var inlinedJs = new StreamCache(); fs.createReadStream(path.join(__dirname, "..", "client", "index.bundle.js")).pipe(inlinedJs);
// Init express server var app = this.app = new express(); // middleware for serving webpack bundle this.middleware = webpackDevMiddleware(compiler, options); app.get("/__webpack_dev_server__/live.bundle.js", function(req, res) { res.setHeader("Content-Type", "application/javascript"); liveJs.pipe(res); }); app.get("/webpack-dev-server.js", function(req, res) { res.setHeader("Content-Type", "application/javascript"); inlinedJs.pipe(res); }); app.get("/webpack-dev-server/*", function(req, res) { res.setHeader("Content-Type", "text/html"); this.livePage.pipe(res); }.bind(this));
當使用Iframe mode
時,請求/webpack-dev-server/index.html
路徑時,會返回client/index.html
文件,這個文件的內(nèi)容就是:
<!DOCTYPE html><html> <head> <meta http-equiv="X-UA-Compatible" content="IE=edge"/> <meta charset="utf-8"/> <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1.0, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0"/> <script type="text/javascript" charset="utf-8" src="/__webpack_dev_server__/live.bundle.js"> </script> </head> <body></body> </html>
這個頁面會請求live.bundle.js
,其中里面會新建一個Iframe
,你的應用就被注入到了這個Iframe
當中。同時live.bundle.js
中含有socket.io
的client
代碼,這樣它就能和webpack-dev-server
建立的http server
進行websocket
通訊了。并根據(jù)返回的信息完成相應的動作。
而Inline-mode
,是webpack-dev-server
會在你的webpack.config.js
的入口配置文件中再添加一個入口,
module.exports = { entry: { app: [ 'webpack-dev-server/client?http://localhost:8080/', './src/js/index.js' ] }, output: { path: './dist/js', filename: 'bundle.js' } }
這樣就完成了將inlinedJS
打包進bundle.js
里的功能,同時inlinedJS
里面也包含了socket.io
的client
代碼,可以和webpack-dev-server
進行websocket
通訊。
當然你也可以直接在你index.html
引入這部分代碼:
<script src="http://localhost:8080/webpack-dev-server.js"></script>
不過Iframe mode
和Inline mode
最后達到的效果都是一樣的,都是監(jiān)聽文件的變化,然后再將編譯后的文件推送到前端,完成頁面的reload
的。
Iframe mode
Iframe mode
下cmd line
不需要添加其他的內(nèi)容,瀏覽器訪問的路徑是:localhost:8080/webpack-dev-server/index.html。
這個時候這個頁面的header部分
會出現(xiàn)整個reload消息
的狀態(tài)。當時改變源文件的時候,即可以完成自動編譯打包,頁面自動刷新的功能。
Inline mode
使用inline mode
的時候,cmd line
需要寫成:
webpack-dev-server --inline --content-base ./dist
這個時候訪問的路徑是:localhost:8080/index.html
也能完成自動編譯打包,頁面自動刷新的功能。但是沒有的header
部分的reload
消息的顯示,不過在控制臺中會顯示reload
的狀態(tài)。
Hot Module Replacement
開啟Hot Module Replacemen
t功能,在cmd line
里面添加--hot
webpack-dev-server --hot --inline --content-base ./dist
其他配置選項
- --quiet 控制臺中不輸出打包的信息
- --compress 開啟gzip壓縮
- --progress 顯示打包的進度
還有一切其他的配置信息可以查閱官方文檔:
這是我的package.json
的文件:
{ "name": "reptile", "version": "1.0.0", "description": "", "main": "index.js", "scripts": { "dev": "webpack-dev-server --devtool eval-source-map --progress --colors --hot --inline --content-base ./dist", "build": "webpack --progress --colors" }, "author": "", "license": "ISC", "devDependencies": { "babel-core": "^6.13.2", "babel-loader": "^6.2.5", "babel-preset-es2015": "^6.13.2", "babel-preset-react": "^6.11.1", "css-loader": "^0.23.1", "react": "^15.3.1", "react-dom": "^15.3.1", "style-loader": "^0.13.1", "webpack": "^1.13.2", "webpack-dev-server": "^1.14.1" } }
首先命令行:輸入 npm install
所有依賴。然后輸入npm run dev
。在瀏覽器中打開localhost:8080/index.html,然后就可以愉快的開發(fā)咯。
本地搭建API Server
如果你在本地還啟動了一個api server
,port
為3000,這個server
主要和你的前端應用進行數(shù)據(jù)交互。這個時候很顯然會出現(xiàn)跨域的問題,那么這個時候,你前端應用的入口文件應當是用你自己啟動的api server
提供的。
var express = require('express'); var app = express(); app.get('/', function(req, res) { res.send('xxx/xxx/index.html'); //這個地方填寫dist/index.html的路徑 })
此外webpack.config.js
:
module.exports = { entry: './src/js/index.js', output: { path: './dist/js', filename: 'bundle.js', publicPath: 'localhost:8080/dist' }, devServer: { '/get': { targer: 'localhost:3000', secure: false } } }
將publicPath
字段的內(nèi)容配置為絕對路徑。同時index.html
文件中對js
引用的路徑也改為絕對路徑
<script src="localhost:8080/dist/bundle.js"></script>
如果對web-dev-server
還有其他問題的話,請留言告知。
另外2篇關于webpack
的文章:
webpack1.x分包及異步加載套路
webpack2分包及異步加載套路
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關文章
httpclient模擬登陸具體實現(xiàn)(使用js設置cookie)
最簡單的方法就是通過得到的cookie定制一個httpclient,感興趣的朋友可以了解下本文2013-12-12深入淺析JavaScript系列(13):This? Yes,this!
在這篇文章里,我們將討論跟執(zhí)行上下文直接相關的更多細節(jié)。討論的主題就是this關鍵字。實踐證明,這個主題很難,在不同執(zhí)行上下文中this的確定經(jīng)常會發(fā)生問題2016-01-01