本文介紹如何以 React-router 與 Webpack 快速起一個 React 專案,從初始化、打包設定一路做到路由與元件,最後說明部署方式。
先建一個空資料夾,初始化 package.json 並填寫基本資訊。
$ npm init
接著安裝依賴,我的 package.json 中 devDependencies 大致如下:
"devDependencies": {
"babel": "^5.5.6",
"babel-core": "^5.5.6",
"babel-loader": "^5.1.4",
"history": "^1.13.1",
"react": "^0.13.3",
"react-hot-loader": "^1.2.7",
"react-router": "^0.13.3",
"webpack": "^1.12.6",
"webpack-dev-server": "^1.12.1"
}
$ npm install
接著建立幾個必要檔案與目錄:
$ mkdir js css && touch index.html webpack.config.js
Webpack 是一款模組處理器,它會把你的所有程式碼打包成靜態檔案,放進開發中的 App 裡。
var webpack = require('webpack');
module.exports = {
entry: [
'webpack/hot/only-dev-server',
"./js/app.js"
],
output: {
path: __dirname + '/build',
filename: "bundle.js"
},
module: {
loaders: [
{ test: /\.js?$/, loaders: ['react-hot', 'babel'], exclude: /node_modules/ },
{ test: /\.js$/, exclude: /node_modules/, loader: 'babel-loader'},
{ test: /\.css$/, loader: "style!css" }
]
},
plugins: [
new webpack.NoErrorsPlugin()
]
};
這份設定主要有四個部分:
entry:指定打包的入口檔案,每一組鍵值對就是一個入口。
output:設定打包結果,path 定義輸出資料夾,filename 定義打包後的名稱,其中 [name] 會被 entry 的鍵取代;範例中便會產生 /build/bundle.js。
module:定義模組的處理邏輯,這裡用 loaders 宣告一系列載入器與對應的正則表達式。當要載入的檔案符合 test 的正則時就會被處理。我們用了 react-hot 與 babel,其中 babel-loader 是為了能用 ES6 開發並轉譯成 JS。最後加上一條 css 規則,示範如何引入樣式檔;實務上也可以換成 sass-loader 等。
plugins:定義要使用的外掛,例如 CommonsChunkPlugin 在打包多個入口時會抽出共用部分產生 common.js;而 NoErrorsPlugin 則控制程式碼出錯時是否自動重新載入。
另外 loader 是 Webpack 強大的關鍵:上面定義了凡是 .js 結尾的檔案都交給 babel-loader 處理,而 .jsx 結尾的會先經 jsx-loader 再進 babel-loader。這些 loader 都需要另外用 npm 安裝。
接著在 package.json 加入 scripts 欄位:
"scripts": {
"start": "webpack-dev-server --hot --progress --colors",
"build": "webpack --progress --colors"
}
此時執行 npm start 會啟動一個 webpack server,可以瀏覽 localhost:8080/webpack-dev-server/;執行 npm run build 則會把檔案輸出到 build/ 下。
然後建立 index.html:
<!doctype html> <html lang="en"> <head> <meta charset="utf-8"> <title>New React App</title> </head> <body> <section id="react"></section> <script src="bundle.js"></script> </body> </html>
基本骨架完成後,建立 app.js 作為專案入口。
import React from 'react';
import Router from 'react-router';
import { DefaultRoute, Link, Route, RouteHandler } from 'react-router';
import LoginHandler from './components/Login.js';
let App = React.createClass({
render() {
return (
<div className="nav">
<Link to="app">Home</Link>
<Link to="login">Login</Link>
{/* this is the important part */}
<RouteHandler/>
</div>
);
}
});
let routes = (
<Route name="app" path="/" handler={App}>
<Route name="login" path="/login" handler={LoginHandler}/>
</Route>
);
Router.run(routes, function (Handler) {
React.render(<Handler/>, document.body);
});
檔案開頭把我們要用的 react 與 react-router 引入,同時引入 login.js 作為 Login 元件。接著用 React 建立一個類別——這個範例裡,它其實就是一個會出現在所有子頁面中的導覽列,我們用 Link 連到 app 與 login 兩個路由,而 React Router 會由 <RouteHandler/> 這個元件決定實際要渲染的內容。
在 App 中我們定義路由並指定對應的處理元件(即 React 元件):根路徑是 app,其他路徑都是 App 的子元件。範例裡加了一個登入頁,供使用者登入。
最後,React-router 會把定義好的一切掛載到 document.body,index.html 就此變身為我們的 React App。
在 /js 目錄下建立 Login.js:
import React from 'react';
let Login = React.createClass({
render() {
return(<div>Welcome to login</div>);
}
});
export default Login;
這是一個非常簡單的元件,內容就是顯示「Welcome to Login」。此時執行 npm start 並瀏覽 https://localhost:8080/webpack-dev-server/,你會看到導覽列上有 Home 與 Login 兩個連結,點 Login 就會顯示剛剛建立的內容。
如果一切順利,接下來你就可以自行擴充內容。若專案使用 Flux,在 js 資料夾下可以用任何你喜歡的結構組織。
上線的方式有很多種,而 Webpack 的打包結果非常好處理:把產生的資源檔放到 CDN,再把 index.html 放到主機上並更新腳本路徑即可。
這篇文章的程式碼基於 React 0.13 與 react-router 0.13,其中 Router.run、RouteHandler、DefaultRoute 等 API 在後續版本已全部改寫;Webpack 1 的 loader 設定寫法也與現在不同。若你要在今日的專案實作,概念(打包、loader、路由表、頁面元件)依然適用,但語法請對照 React Router 與 Webpack 的現行官方文件。