React Router 使用教程
作者： 阮一峰
日期： 2016年5月25日
真正学会 React 是一个漫长的过程。
你会发现，它不是一个库，也不是一个框架，而是一个庞大的体系。想要发挥它的威力，整个技术栈都要配合它改造。你要学习一整套解决方案，从后端到前端，都是全新的做法。
举例来说，React 不使用 HTML，而使用 JSX 。它打算抛弃 DOM，要求开发者不要使用任何 DOM 方法。它甚至还抛弃了 SQL ，自己发明了一套查询语言 GraphQL 。当然，这些你都可以不用，React 照样运行，但是就发挥不出它的最大威力。
这样说吧，你只要用了 React，就会发现合理的选择就是，采用它的整个技术栈。
本文介绍 React 体系的一个重要部分：路由库React-Router。它是官方维护的，事实上也是唯一可选的路由库。它通过管理 URL，实现组件的切换和状态的变化，开发复杂的应用几乎肯定会用到。
本文针对初学者，尽量写得简洁易懂。预备知识是 React 的基本用法，可以参考我写的《React 入门实例教程》。
另外，我没有准备示例库，因为官方的示例库非常棒，由浅入深，分成14步，每一步都有详细的代码解释。我强烈建议你先跟着做一遍，然后再看下面的API讲解。
（[说明] 本文写作时，React-router 是 2.x 版，本文的内容只适合这个版本，与最新的 4.x 版不兼容。目前，官方同时维护 2.x 和 4.x 两个版本，所以前者依然可以用在项目中。2017年3月）
一、基本用法
React Router 安装命令如下。
$ npm install -S react-router
使用时，路由器Router就是React的一个组件。
1 import { Router } from 'react-router'; 2render(<Router/>, document.getElementById('app'));
Router组件本身只是一个容器，真正的路由要通过Route组件定义。
1 import { Router, Route, hashHistory } from 'react-router'; 2 3render(( 4 <Router history={hashHistory}> 5 <Route path="/" component={App}/> 6 </Router> 7), document.getElementById('app'));
上面代码中，用户访问根路由/（比如http://www.example.com/），组件APP就会加载到document.getElementById('app')。
你可能还注意到，Router组件有一个参数history，它的值hashHistory表示，路由的切换由URL的hash变化决定，即URL的#部分发生变化。举例来说，用户访问http://www.example.com/，实际会看到的是http://www.example.com/#/。
Route组件定义了URL路径与组件的对应关系。你可以同时使用多个Route组件。
1 <Router history={hashHistory}> 2 <Route path="/" component={App}/> 3 <Route path="/repos" component={Repos}/> 4 <Route path="/about" component={About}/> 5</Router>
上面代码中，用户访问/repos（比如http://localhost:8080/#/repos）时，加载Repos组件；访问/about（http://localhost:8080/#/about）时，加载About组件。
二、嵌套路由
Route组件还可以嵌套。
1 <Router history={hashHistory}> 2 <Route path="/" component={App}> 3 <Route path="/repos" component={Repos}/> 4 <Route path="/about" component={About}/> 5 </Route> 6</Router>
上面代码中，用户访问/repos时，会先加载App组件，然后在它的内部再加载Repos组件。
1 <App> 2 <Repos/> 3</App>
App组件要写成下面的样子。
1 export default React.createClass({ 2 render() { 3 return <div> 4 {this.props.children} 5 </div> 6 } 7})
上面代码中，App组件的this.props.children属性就是子组件。
子路由也可以不写在Router组件里面，单独传入Router组件的routes属性。
1 let routes = <Route path="/" component={App}> 2 <Route path="/repos" component={Repos}/> 3 <Route path="/about" component={About}/> 4</Route>; 5 6<Router routes={routes} history={browserHistory}/>
三、 path 属性
Route组件的path属性指定路由的匹配规则。这个属性是可以省略的，这样的话，不管路径是否匹配，总是会加载指定组件。
请看下面的例子。
1 <Route path="inbox" component={Inbox}> 2 <Route path="messages/:id" component={Message} /> 3</Route>
上面代码中，当用户访问/inbox/messages/:id时，会加载下面的组件。
1 <Inbox> 2 <Message/> 3</Inbox>
如果省略外层Route的path参数，写成下面的样子。
1 <Route component={Inbox}> 2 <Route path="inbox/messages/:id" component={Message} /> 3</Route>
现在用户访问/inbox/messages/:id时，组件加载还是原来的样子。
1 <Inbox> 2 <Message/> 3</Inbox>
四、通配符
path属性可以使用通配符。
1 <Route path="/hello/:name"> 2// 匹配 /hello/michael 3// 匹配 /hello/ryan 4 5<Route path="/hello(/:name)"> 6// 匹配 /hello 7// 匹配 /hello/michael 8// 匹配 /hello/ryan 9 10<Route path="/files/*.*"> 11// 匹配 /files/hello.jpg 12// 匹配 /files/hello.html 13 14<Route path="/files/*"> 15// 匹配 /files/ 16// 匹配 /files/a 17// 匹配 /files/a/b 18 19<Route path="/**/*.jpg"> 20// 匹配 /files/hello.jpg 21// 匹配 /files/path/to/file.jpg
通配符的规则如下。
（1）
:paramName
:paramName匹配URL的一个部分，直到遇到下一个/、?、#为止。这个路径参数可以通过this.props.params.paramName取出。（2）
()
()表示URL的这个部分是可选的。（3）
*
*匹配任意字符，直到模式里面的下一个字符为止。匹配方式是非贪婪模式。（4）
**
**匹配任意字符，直到下一个/、?、#为止。匹配方式是贪婪模式。
path属性也可以使用相对路径（不以/开头），匹配时就会相对于父组件的路径，可以参考上一节的例子。嵌套路由如果想摆脱这个规则，可以使用绝对路由。
路由匹配规则是从上到下执行，一旦发现匹配，就不再其余的规则了。
1 <Route path="/comments" ... /> 2<Route path="/comments" ... />
上面代码中，路径/comments同时匹配两个规则，第二个规则不会生效。
设置路径参数时，需要特别小心这一点。
1 <Router> 2 <Route path="/:userName/:id" component={UserPage}/> 3 <Route path="/about/me" component={About}/> 4</Router>
上面代码中，用户访问/about/me时，不会触发第二个路由规则，因为它会匹配/:userName/:id这个规则。因此，带参数的路径一般要写在路由规则的底部。
此外，URL的查询字符串/foo?bar=baz，可以用this.props.location.query.bar获取。
五、IndexRoute 组件
下面的例子，你会不会觉得有一点问题？
1 <Router> 2 <Route path="/" component={App}> 3 <Route path="accounts" component={Accounts}/> 4 <Route path="statements" component={Statements}/> 5 </Route> 6</Router>
上面代码中，访问根路径/，不会加载任何子组件。也就是说，App组件的this.props.children，这时是undefined。
因此，通常会采用{this.props.children || <Home/>}这样的写法。这时，Home明明是Accounts和Statements的同级组件，却没有写在Route中。
IndexRoute就是解决这个问题，显式指定Home是根路由的子组件，即指定默认情况下加载的子组件。你可以把IndexRoute想象成某个路径的index.html。
1 <Router> 2 <Route path="/" component={App}> 3 <IndexRoute component={Home}/> 4 <Route path="accounts" component={Accounts}/> 5 <Route path="statements" component={Statements}/> 6 </Route> 7</Router>
现在，用户访问/的时候，加载的组件结构如下。
1 <App> 2 <Home/> 3</App>
这种组件结构就很清晰了：App只包含下级组件的共有元素，本身的展示内容则由Home组件定义。这样有利于代码分离，也有利于使用React Router提供的各种API。
注意，IndexRoute组件没有路径参数path。
六、Redirect 组件
<Redirect>组件用于路由的跳转，即用户访问一个路由，会自动跳转到另一个路由。
1 <Route path="inbox" component={Inbox}> 2 {/* 从 /inbox/messages/:id 跳转到 /messages/:id */} 3 ＜Redirect from="messages/:id" to="/messages/:id" /> 4</Route>
现在访问/inbox/messages/5，会自动跳转到/messages/5。
七、IndexRedirect 组件
IndexRedirect组件用于访问根路由的时候，将用户重定向到某个子组件。
1 <Route path="/" component={App}> 2 ＜IndexRedirect to="/welcome" /> 3 <Route path="welcome" component={Welcome} /> 4 <Route path="about" component={About} /> 5</Route>
上面代码中，用户访问根路径时，将自动重定向到子组件welcome。
八、Link
Link组件用于取代<a>元素，生成一个链接，允许用户点击后跳转到另一个路由。它基本上就是<a>元素的React 版本，可以接收Router的状态。
1 render() { 2 return <div> 3 <ul role="nav"> 4 <li><Link to="/about">About</Link></li> 5 <li><Link to="/repos">Repos</Link></li> 6 </ul> 7 </div> 8}
如果希望当前的路由与其他路由有不同样式，这时可以使用Link组件的activeStyle属性。
1 <Link to="/about" activeStyle={{color: 'red'}}>About</Link> 2<Link to="/repos" activeStyle={{color: 'red'}}>Repos</Link>
上面代码中，当前页面的链接会红色显示。
另一种做法是，使用activeClassName指定当前路由的Class。
1 <Link to="/about" activeClassName="active">About</Link> 2<Link to="/repos" activeClassName="active">Repos</Link>
上面代码中，当前页面的链接的class会包含active。
在Router组件之外，导航到路由页面，可以使用浏览器的History API，像下面这样写。
1 import { browserHistory } from 'react-router'; 2browserHistory.push('/some/path');
九、IndexLink
如果链接到根路由/，不要使用Link组件，而要使用IndexLink组件。
这是因为对于根路由来说，activeStyle和activeClassName会失效，或者说总是生效，因为/会匹配任何子路由。而IndexLink组件会使用路径的精确匹配。
1 <IndexLink to="/" activeClassName="active"> 2 Home 3</IndexLink>
上面代码中，根路由只会在精确匹配时，才具有activeClassName。
另一种方法是使用Link组件的onlyActiveOnIndex属性，也能达到同样效果。
1 <Link to="/" activeClassName="active" onlyActiveOnIndex={true}> 2 Home 3</Link>
实际上，IndexLink就是对Link组件的onlyActiveOnIndex属性的包装。
十、histroy 属性
Router组件的history属性，用来监听浏览器地址栏的变化，并将URL解析成一个地址对象，供 React Router 匹配。
history属性，一共可以设置三种值。
- browserHistory
- hashHistory
- createMemoryHistory
如果设为hashHistory，路由将通过URL的hash部分（#）切换，URL的形式类似example.com/#/some/path。
1 import { hashHistory } from 'react-router' 2 3render( 4 <Router history={hashHistory} routes={routes} />, 5 document.getElementById('app') 6)
如果设为browserHistory，浏览器的路由就不再通过Hash完成了，而显示正常的路径example.com/some/path，背后调用的是浏览器的History API。
1 import { browserHistory } from 'react-router' 2 3render( 4 <Router history={browserHistory} routes={routes} />, 5 document.getElementById('app') 6)
但是，这种情况需要对服务器改造。否则用户直接向服务器请求某个子路由，会显示网页找不到的404错误。
如果开发服务器使用的是webpack-dev-server，加上--history-api-fallback参数就可以了。
$ webpack-dev-server --inline --content-base . --history-api-fallback
createMemoryHistory主要用于服务器渲染。它创建一个内存中的history对象，不与浏览器URL互动。
const history = createMemoryHistory(location)
十一、表单处理
Link组件用于正常的用户点击跳转，但是有时还需要表单跳转、点击按钮跳转等操作。这些情况怎么跟React Router对接呢？
下面是一个表单。
1 <form onSubmit={this.handleSubmit}> 2 <input type="text" placeholder="userName"/> 3 <input type="text" placeholder="repo"/> 4 <button type="submit">Go</button> 5</form>
第一种方法是使用browserHistory.push
1 import { browserHistory } from 'react-router' 2 3// ... 4 handleSubmit(event) { 5 event.preventDefault() 6 const userName = event.target.elements[0].value 7 const repo = event.target.elements[1].value 8 const path = `/repos/${userName}/${repo}` 9 browserHistory.push(path) 10 },
第二种方法是使用context对象。
1 export default React.createClass({ 2 3 // ask for `router` from context 4 contextTypes: { 5 router: React.PropTypes.object 6 }, 7 8 handleSubmit(event) { 9 // ... 10 this.context.router.push(path) 11 }, 12})
十二、路由的钩子
每个路由都有Enter和Leave钩子，用户进入或离开该路由时触发。
1 <Route path="about" component={About} /> 2＜Route path="inbox" component={Inbox}> 3 ＜Redirect from="messages/:id" to="/messages/:id" /> 4</Route>
上面的代码中，如果用户离开/messages/:id，进入/about时，会依次触发以下的钩子。
/messages/:id的onLeave/inbox的onLeave/about的onEnter
下面是一个例子，使用onEnter钩子替代<Redirect>组件。
1 <Route path="inbox" component={Inbox}> 2 <Route 3 path="messages/:id" 4 onEnter={ 5 ({params}, replace) => replace(`/messages/${params.id}`) 6 } 7 /> 8</Route>
onEnter钩子还可以用来做认证。
1 const requireAuth = (nextState, replace) => { 2 if (!auth.isAdmin()) { 3 // Redirect to Home page if not an Admin 4 replace({ pathname: '/' }) 5 } 6} 7export const AdminRoutes = () => { 8 return ( 9 <Route path="/admin" component={Admin} onEnter={requireAuth} /> 10 ) 11}
下面是一个高级应用，当用户离开一个路径的时候，跳出一个提示框，要求用户确认是否离开。
1 const Home = withRouter( 2 React.createClass({ 3 componentDidMount() { 4 this.props.router.setRouteLeaveHook( 5 this.props.route, 6 this.routerWillLeave 7 ) 8 }, 9 10 routerWillLeave(nextLocation) { 11 // 返回 false 会继续停留当前页面， 12 // 否则，返回一个字符串，会显示给用户，让其自己决定 13 if (!this.state.isSaved) 14 return '确认要离开？'; 15 }, 16 }) 17)
上面代码中，setRouteLeaveHook方法为Leave钩子指定routerWillLeave函数。该方法如果返回false，将阻止路由的切换，否则就返回一个字符串，提示用户决定是否要切换。
（完）
文档信息
- 版权声明：自由转载-非商用-非衍生-保持署名（创意共享3.0许可证）
- 发表日期： 2016年5月25日
本文转自 http://www.ruanyifeng.com/blog/2016/05/react_router.html，如有侵权，请联系删除。