React Router教程

React項(xiàng)目的可用的路由庫是 React-Router ,當(dāng)然這也是官方支持的葱轩。它也分為：

• react-router 核心組件
• react-router-dom 應(yīng)用于瀏覽器端的路由庫（單獨(dú)使用包含了react-router的核心部分）
• react-router-native 應(yīng)用于native端的路由

以下教程我們都以Web端為主酿箭，所以所有的教程內(nèi)容都是默認(rèn)關(guān)于react-router-dom的介紹。

進(jìn)行網(wǎng)站（將會(huì)運(yùn)行在瀏覽器環(huán)境中）構(gòu)建妇蛀，我們應(yīng)當(dāng)安裝 react-router-dom 评架。 react-router-dom 暴露出 react-router 中暴露的對象與方法纵诞，因此你只需要安裝并引用 react-router-dom 即可登刺。

官方文檔地址： https://reacttraining.com/react-router/web/guides/philosophy

Installation | 安裝

安裝：

yarn add react-router-dom
# 或者纸俭，不使用 yarn
npm install react-router-dom

路由的基本概念

現(xiàn)在的React Router版本中已不需要路由配置揍很，現(xiàn)在一切皆組件窒悔。

ReactRouter中提供了以下三大組件：

• Router是所有路由組件共用的底層接口組件蛉迹，它是路由規(guī)則制定的最外層的容器。

• Route路由規(guī)則匹配珍策，并顯示當(dāng)前的規(guī)則對應(yīng)的組件攘宙。

• Link路由跳轉(zhuǎn)的組件
  當(dāng)然每個(gè)組件下又會(huì)有幾種不同的子類組件實(shí)現(xiàn)拐迁。比如： Router組件就針對不同功能和平臺(tái)對應(yīng)用：

• <BrowserRouter> 瀏覽器的路由組件

• <HashRouter> URL格式為Hash路由組件

• <MemoryRouter> 內(nèi)存路由組件

• <NativeRouter> Native的路由組件

• <StaticRouter> 地址不改變的靜態(tài)路由組件
  三大組件使用的關(guān)系：

image.png

如果說我們的應(yīng)用程序是一座小城的話蹭劈，那么Route就是一座座帶有門牌號(hào)的建筑物，而Link就代表了到某個(gè)建筑物的路線线召。有了路線和目的地铺韧，那么就缺一位老司機(jī)了，沒錯(cuò)Router就是這個(gè)老司機(jī)缓淹。

第一個(gè)Demo

現(xiàn)在你可以復(fù)制任意的示例代碼，并粘貼到 'src/App.js'讯壶。如下：

import React, { Component } from 'react';
import { HashRouter as Router, Link, Route } from 'react-router-dom';
import './App.css';

const Home = () => (
  <div>
    <h2>Home</h2>
  </div>
)

const About = () => (
  <div>
    <h2>About</h2>
  </div>
)

const Product = () => (
  <div>
    <h2>Product</h2>
  </div>
)

class App extends Component {
  render() {
    return (
      <Router>
        <div className="App">
          <Link to="/">Home</Link>
          <Link to="/About">About</Link>
          <Link to="/Product">Product</Link>
          <hr/>
          <Route path="/" exact component={Home}></Route>
          <Route path="/about" component={About}></Route>
          <Route path="/product" component={Product}></Route>
        </div>
      </Router>
    );
  }
}

export default App;

Router組件

BrowserRouter組件

BrowserRouter主要使用在瀏覽器中料仗，也就是WEB應(yīng)用中。它利用HTML5 的history API來同步URL和UI的變化伏蚊。當(dāng)我們點(diǎn)擊了程序中的一個(gè)鏈接之后,BrowserRouter就會(huì)找出與這個(gè)URL匹配的Route立轧，并將他們對應(yīng)的組件渲染出來。BrowserRouter是用來管理我們的組件的，那么它當(dāng)然要被放在最頂級的位置氛改，而我們的應(yīng)用程序的組件就作為它的一個(gè)子組件而存在匀借。
。

import * as React from 'react';
import * as ReactDOM from 'react-dom';
import { BrowserRouter } from 'react-router-dom';

ReactDOM.render(
    <BrowserRouter>
        <App/>
    </BrowserRouter>,
    document.body);

BrowserRouter組件提供了四個(gè)屬性平窘。

• basename: 字符串類型，路由器的默認(rèn)根路徑
• forceRefresh: 布爾類型凳怨，在導(dǎo)航的過程中整個(gè)頁面是否刷新
• getUserConfirmation: 函數(shù)類型瑰艘，當(dāng)導(dǎo)航需要確認(rèn)時(shí)執(zhí)行的函數(shù)。默認(rèn)是：window.confirm
• keyLength: 數(shù)字類型location.key 的長度肤舞。默認(rèn)是 6

basename 屬性

當(dāng)前位置的基準(zhǔn) URL紫新。如果你的頁面部署在服務(wù)器的二級（子）目錄，你需要將 basename 設(shè)置到此子目錄李剖。正確的 URL 格式是前面有一個(gè)前導(dǎo)斜杠芒率，但不能有尾部斜杠。

例如：有時(shí)候我們的應(yīng)用只是整個(gè)系統(tǒng)中的一個(gè)模塊篙顺，應(yīng)用中的URL總是以 http://localhost/admin/ 開頭偶芍。這種情況下我們總不能每次定義Link和Route的時(shí)候都帶上admin吧？react-router已經(jīng)考慮到了這種情況德玫，所以為我們提供了一個(gè)basename屬性匪蟀。為BrowserRouter設(shè)置了basename之后，Link中就可以省略掉admin了宰僧，而最后渲染出來的URL又會(huì)自動(dòng)帶上admin材彪。

<BrowserRouter basename="/admin"/>
    ...
    <Link to="/home"/> // 被渲染為 <a href="/admin/home">
    ...
</BrowserRouter>

getUserConfirmation: func

當(dāng)導(dǎo)航需要確認(rèn)時(shí)執(zhí)行的函數(shù)。默認(rèn)使用 window.confirm琴儿。

// 使用默認(rèn)的確認(rèn)函數(shù)
const getConfirmation = (message, callback) => {
  const allowTransition = window.confirm(message)
  callback(allowTransition)
}

forceRefresh: bool

當(dāng)設(shè)置為 true 時(shí)段化，在導(dǎo)航的過程中整個(gè)頁面將會(huì)刷新。 只有當(dāng)瀏覽器不支持 HTML5 的 history API 時(shí)造成，才設(shè)置為 true显熏。

const supportsHistory = 'pushState' in window.history
<BrowserRouter forceRefresh={!supportsHistory}/>

keyLength: number

location.key 的長度。默認(rèn)是 6谜疤。

<BrowserRouter keyLength={12}/>

<meta charset="utf-8">

children: node

渲染單一子組件（元素）佃延。

HashRouter

HashRouter 使用 URL 的 hash (例如：window.location.hash) 來保持 UI 和 URL 的同步。

注意： 使用hash 的方式記錄導(dǎo)航歷史不支持 location.key 和location.state夷磕。在以前的版本中履肃，我們?yōu)檫@種行為提供了 shim，但是仍有一些問題我們無法解坐桩。任何依賴此行為的代碼或插件都將無法正常使用尺棋。由于該技術(shù)僅用于支持傳統(tǒng)的瀏覽器，因此在用于瀏覽器時(shí)可以使用<BrowserHistory>代替。

跟BrowserRouter類似膘螟，它也有：basename成福、getUserConfirmation、children屬性荆残，而且是一樣的奴艾。

hashType: string

<meta charset="utf-8">

window.location.hash 使用的 hash 類型。有如下幾種：

• "slash" - 后面跟一個(gè)斜杠内斯，例如 #/ 和 #/sunshine/lollipops
• "noslash" - 后面沒有斜杠蕴潦，例如 # 和 #sunshine/lollipops
• "hashbang" - Google 風(fēng)格的 "ajax crawlable"镐牺，例如 #!/ 和 #!/sunshine/lollipops

默認(rèn)為 "slash"惋戏。

<meta charset="utf-8">

MemoryRouter

主要用在ReactNative這種非瀏覽器的環(huán)境中，因此直接將URL的history保存在了內(nèi)存中痴腌。 StaticRouter 主要用于服務(wù)端渲染真朗。

Link組件

Link就像是一個(gè)個(gè)的路牌此疹，為我們指明組件的位置。Link使用聲明式的方式為應(yīng)用程序提供導(dǎo)航功能遮婶，定義的Link最終會(huì)被渲染成一個(gè)a標(biāo)簽蝗碎。Link使用to這個(gè)屬性來指明目標(biāo)組件的路徑，可以直接使用一個(gè)字符串旗扑，也可以傳入一個(gè)對象衍菱。

import { Link } from 'react-router-dom'
// 字符串參數(shù)
<Link to="/query">查詢</Link>

// 對象參數(shù)
<Link to={{
  pathname: '/query',
  search: '?key=name',
  hash: '#hash',
  state: { fromDashboard: true }
}}>查詢</Link>

<meta charset="utf-8">

屬性： to

需要跳轉(zhuǎn)到的路徑(pathname)或地址（location）。

屬性：replace: bool

當(dāng)設(shè)置為 true 時(shí)肩豁，點(diǎn)擊鏈接后將使用新地址替換掉訪問歷史記錄里面的原地址脊串。

當(dāng)設(shè)置為 false 時(shí)，點(diǎn)擊鏈接后將在原有訪問歷史記錄的基礎(chǔ)上添加一個(gè)新的紀(jì)錄清钥。

默認(rèn)為 false琼锋。

<Link to="/courses" replace />

<meta charset="utf-8">

<article class="_2rhmJa">

NavLink組件

NavLink是一個(gè)特殊版本的Link，可以使用activeClassName來設(shè)置Link被選中時(shí)被附加的class祟昭，使用activeStyle來配置被選中時(shí)應(yīng)用的樣式缕坎。此外，還有一個(gè)exact屬性,此屬性要求location完全匹配才會(huì)附加class和style篡悟。這里說的匹配是指地址欄中的URl和這個(gè)Link的to指定的location相匹配谜叹。

// 選中后被添加class selected
<NavLink to={'/'} exact activeClassName='selected'>Home</NavLink>
// 選中后被附加樣式 color:red
<NavLink to={'/gallery'} activeStyle={{color:red}}>Gallery</NavLink>

activeClassName默認(rèn)值為 active

屬性

• to 可以是字符串或者對象，同Link組件
• exact 布爾類型搬葬，完全匹配時(shí)才會(huì)被附件class和style
• activeStyle Object類型
• activeClassName 字符串類型
• strict: bool類型荷腊，當(dāng)值為 true 時(shí)，在確定位置是否與當(dāng)前 URL 匹配時(shí)急凰，將考慮位置 pathname 后的斜線女仰。

Route組件

Route應(yīng)該是react-route中最重要的組件了，它的作用是當(dāng)location與Route的path匹配時(shí)渲染Route中的Component。如果有多個(gè)Route匹配疾忍，那么這些Route的Component都會(huì)被渲染乔外。

與Link類似，Route也有一個(gè)exact屬性一罩，作用也是要求location與Route的path絕對匹配杨幼。

// 當(dāng)location形如 http://location/時(shí)，Home就會(huì)被渲染聂渊。
// 因?yàn)?"/" 會(huì)匹配所有的URL推汽，所以這里設(shè)置一個(gè)exact來強(qiáng)制絕對匹配。
<Route exact path="/" component={Home}/>
<Route path="/about" component={About}/>

Route的三種渲染方式

1. component: 這是最常用也最容易理解的方式歧沪，給什么就渲染什么。
2. render: render的類型是function莲组，Route會(huì)渲染這個(gè)function的返回值诊胞。因此它的作用就是附加一些額外的邏輯。

<Route path="/home" render={() => {
    console.log('額外的邏輯');
    return (<div>Home</div>);
    }/>

1. children: 這是最特殊的渲染方式锹杈。

一撵孤、它同render類似,是一個(gè)function。不同的地方在于它會(huì)被傳入一個(gè)match參數(shù)來告訴你這個(gè)Route的path和location匹配上沒有竭望。
二邪码、第二個(gè)特殊的地方在于，即使path沒有匹配上咬清，我們也可以將它渲染出來闭专。秘訣就在于前面一點(diǎn)提到的match參數(shù)。我們可以根據(jù)這個(gè)參數(shù)來決定在匹配的時(shí)候渲染什么旧烧，不匹配的時(shí)候又渲染什么影钉。

// 在匹配時(shí)，容器的calss是light掘剪，<Home />會(huì)被渲染
// 在不匹配時(shí)平委，容器的calss是dark，<About />會(huì)被渲染
<Route path='/home' children={({ match }) => (
    <div className={match ? 'light' : 'dark'}>
      {match ? <Home/>:<About>}
    </div>
  )}/>

所有路由中指定的組件將被傳入以下三個(gè) props 夺谁。

• match.
• location.
• history.

這里主要說下match.params.透過這個(gè)屬性廉赔，我們可以拿到從location中解析出來的參數(shù)。當(dāng)然匾鸥，如果想要接收參數(shù)蜡塌，我們的Route的path也要使用特殊的寫法。

如下示例勿负，三個(gè)Link是一個(gè)文章列表中三個(gè)鏈接岗照，分別指向三篇id不同的文章。而Route用于渲染文章詳情頁。注意path='/p/:id' 攒至，location中的對應(yīng)的段會(huì)被解析為id=1 這樣的鍵值厚者。最終這個(gè)鍵值會(huì)作為param的鍵值存在。Route中的組件可以使用this.props.match.params.id來獲取迫吐，示例中使用了結(jié)構(gòu)賦值库菲。

<Link to='/p/1' />
<Link to='/p/2' />
<Link to='/p/3' />
......
<Route path='/p/:id' render={(match)=<h3>當(dāng)前文章ID:{match.params.id}</h3>)} />

location

Location 是指你當(dāng)前的位置，下一步打算去的位置志膀，或是你之前所在的位置熙宇，形式大概就像這樣：

{
  key: 'ac3df4', // 在使用 hashHistory 時(shí)，沒有 key
  pathname: '/somewhere'
  search: '?some=search-string',
  hash: '#howdy',
  state: {
    [userDefined]: true
  }
}

你使用以下幾種方式來獲取 location 對象：

• 在 Route component 中溉浙，以 this.props.location 的方式獲取烫止，
• 在 Route render 中，以 ({ location }) => () 的方式獲取戳稽，
• 在 Route children 中馆蠕，以 ({ location }) => () 的方式獲取，
• 在 withRouter 中惊奇，以 this.props.location 的方式獲取互躬。

你也可以在 history.location 中獲取 location 對象，但是別那么寫颂郎，因?yàn)?history 是可變的吼渡。更多信息請參見 history 文檔。

location 對象不會(huì)發(fā)生改變乓序，因此你可以在生命周期的鉤子函數(shù)中使用 location 對象來查看當(dāng)前頁面的位置是否發(fā)生改變寺酪，這種技巧在獲取遠(yuǎn)程數(shù)據(jù)以及使用動(dòng)畫時(shí)非常有用。

componentWillReceiveProps(nextProps) {
  if (nextProps.location !== this.props.location) {
    // 已經(jīng)跳轉(zhuǎn)了替劈！
  }
}

通常情況下房维，你只需要給一個(gè)字符串當(dāng)做 location ，但是抬纸，當(dāng)你需要添加一些 location 的狀態(tài)時(shí)咙俩，你可以對象的形式使用 location 。并且當(dāng)你需要多個(gè) UI 湿故，而這些 UI 取決于歷史時(shí)阿趁，例如彈出框（modal），使用location 對象會(huì)有很大幫助坛猪。

// 通常你只需要這樣使用 location
<Link to="/somewhere"/>

// 但是你同樣可以這么用
const location = {
  pathname: '/somewhere'
  state: { fromDashboard: true }
}

<Link to={location}/>
<Redirect to={location}/>
history.push(location)
history.replace(location)

最后脖阵，你可以把 location 傳入一下組件：

• [Route]
• [Switch]

這樣做可以讓組件不使用路由狀態(tài)（router state）中的真實(shí) location，因?yàn)槲覀冇袝r(shí)候需要組件去渲染一個(gè)其他的 location 而不是本身所處的真實(shí) location墅茉，比如使用動(dòng)畫或是等待跳轉(zhuǎn)時(shí)命黔。

history

本文檔中的「history」以及「history對象」請參照 history 包中的內(nèi)容呜呐。 History 是 React Router 的兩大重要依賴之一（除去 React 本身），在不同的 Javascript 環(huán)境中悍募，history 以多種形式實(shí)現(xiàn)了對于 session 歷史的管理蘑辑。

我們會(huì)經(jīng)常使用以下術(shù)語：

• 「browser history」 - history 在 DOM 上的實(shí)現(xiàn)，經(jīng)常使用于支持 HTML5 history API 的瀏覽器端坠宴。
• 「hash history」 - history 在 DOM 上的實(shí)現(xiàn)洋魂，經(jīng)常使用于舊版本瀏覽器端。
• 「memory history」 - 一種存儲(chǔ)于內(nèi)存的 history 實(shí)現(xiàn)喜鼓，經(jīng)常用于測試或是非 DOM 環(huán)境（例如 React Native）副砍。

history 對象通常會(huì)具有以下屬性和方法：

• length -（ number 類型）指的是 history 堆棧的數(shù)量。
• action -（ string 類型）指的是當(dāng)前的動(dòng)作（action）庄岖，例如 PUSH豁翎，REPLACE 以及 POP 。
• location -（ object類型）是指當(dāng)前的位置（location）隅忿，location 會(huì)具有如下屬性：
  • pathname -（ string 類型）URL路徑心剥。
  • search -（ string 類型）URL中的查詢字符串（query string）。
  • hash -（ string 類型）URL的 hash 分段硼控。
  • state -（ string 類型）是指 location 中的狀態(tài)，例如在 push(path, state) 時(shí)胳赌，state會(huì)描述什么時(shí)候 location 被放置到堆棧中等信息牢撼。這個(gè) state 只會(huì)出現(xiàn)在 browser history 和 memory history 的環(huán)境里。
• push(path, [state]) -（ function 類型）在 hisotry 堆棧頂加入一個(gè)新的條目疑苫。
• replace(path, [state]) -（ function 類型）替換在 history 堆棧中的當(dāng)前條目熏版。
• go(n) -（ function 類型）將 history 對戰(zhàn)中的指針向前移動(dòng) n 。
• goBack() -（ function 類型）等同于 go(-1) 捍掺。
• goForward() -（ function 類型）等同于 go(1) 撼短。
• block(prompt) -（ function 類型）阻止跳轉(zhuǎn)，（請參照 history 文檔）

match

match 對象包含了 <Route path> 如何與URL匹配的信息挺勿。match 對象包含以下屬性：

• params -（ object 類型）即路徑參數(shù)曲横，通過解析URL中動(dòng)態(tài)的部分獲得的鍵值對。
• isExact - 當(dāng)為 true 時(shí)不瓶，整個(gè)URL都需要匹配禾嫉。
• path -（ string 類型）用來做匹配的路徑格式。在需要嵌套 <Route> 的時(shí)候用到蚊丐。
• url -（ string 類型）URL匹配的部分熙参，在需要嵌套 <Link> 的時(shí)候會(huì)用到。

你可以在以下地方獲取 match 對象：

• 在 Route component 中麦备，以 this.props.match 方式孽椰。
• 在 Route render中昭娩，以 ({ match }) => () 方式。
• 在 Route children中黍匾，以 ({ match }) => () 方式

Redirect組件

當(dāng)這個(gè)組件被渲染是栏渺，location會(huì)被重寫為Redirect的to指定的新location。它的一個(gè)用途是登錄重定向膀捷，比如在用戶點(diǎn)了登錄并驗(yàn)證通過之后迈嘹，將頁面跳轉(zhuǎn)到個(gè)人主頁。

<Redirect to="/new"/>

Switch組件

渲染匹配地址(location)的第一個(gè) <Route>或者<Redirect>

這與只使用一堆<Route>有什么不同全庸？

<Switch>的獨(dú)特之處是獨(dú)它僅僅渲染一個(gè)路由秀仲。相反地，每一個(gè)包含匹配地址(location)的<Route>都會(huì)被渲染壶笼。思考下面的代碼：

<Route path="/about" component={About}/>
<Route path="/:user" component={User}/>
<Route component={NoMatch}/>

如果現(xiàn)在的URL是 /about 神僵，那么 <About>, <User>, 還有 <NoMatch> 都會(huì)被渲染，因?yàn)樗鼈兌寂c路徑(path)匹配覆劈。這種設(shè)計(jì)保礼，允許我們以多種方式將多個(gè) <Route> 組合到我們的應(yīng)用程序中，例如側(cè)欄(sidebars)责语，面包屑(breadcrumbs)炮障，bootstrap tabs等等。 然而坤候，偶爾我們只想選擇一個(gè)<Route> 來渲染胁赢。如果我們現(xiàn)在處于 /about，我們也不希望匹配 /:user （或者顯示我們的 "404" 頁面 ）白筹。以下是使用 Switch 的方法來實(shí)現(xiàn)：

import { Switch, Route } from 'react-router'

<Switch>
  <Route exact path="/" component={Home}/>
  <Route path="/about" component={About}/>
  <Route path="/:user" component={User}/>
  <Route component={NoMatch}/>
</Switch>

現(xiàn)在智末，如果我們處于 /about, <Switch> 將開始尋找匹配的 <Route>。 <Route path="/about"/> 將被匹配徒河， <Switch> 將停止尋找匹配并渲染<About>系馆。 同樣，如果我們處于 /michael 顽照， <User> 將被渲染由蘑。

這對于過渡動(dòng)畫也是起作用的，因?yàn)槠ヅ涞?<Route> 在與前一個(gè)相同的位置被渲染代兵。

<Fade>
  <Switch>
    {/* there will only ever be one child here */}
    {/* 這里只會(huì)有一個(gè)子節(jié)點(diǎn) */}
    <Route/>
    <Route/>
  </Switch>
</Fade>

<Fade>
  <Route/>
  <Route/>
  {/* there will always be two children here,
      one might render null though, making transitions
      a bit more cumbersome to work out */}
   {/* 這里總是有兩個(gè)子節(jié)點(diǎn),
      一個(gè)可能會(huì)渲染為null, 使計(jì)算過渡增加了一點(diǎn)麻煩 */}    
</Fade>

路由配置

import React from "react";
import { BrowserRouter as Router, Route, Link } from "react-router-dom";

// Some folks find value in a centralized route config.
// A route config is just data. React is great at mapping
// data into components, and <Route> is a component.

////////////////////////////////////////////////////////////
// first our route components
const Main = () => <h2>Main</h2>;

const Sandwiches = () => <h2>Sandwiches</h2>;

const Tacos = ({ routes }) => (
  <div>
    <h2>Tacos</h2>
    <ul>
      <li>
        <Link to="/tacos/bus">Bus</Link>
      </li>
      <li>
        <Link to="/tacos/cart">Cart</Link>
      </li>
    </ul>

    {routes.map((route, i) => <RouteWithSubRoutes key={i} {...route} />)}
  </div>
);

const Bus = () => <h3>Bus</h3>;
const Cart = () => <h3>Cart</h3>;

////////////////////////////////////////////////////////////
// then our route config
const routes = [
  {
    path: "/sandwiches",
    component: Sandwiches
  },
  {
    path: "/tacos",
    component: Tacos,
    routes: [
      {
        path: "/tacos/bus",
        component: Bus
      },
      {
        path: "/tacos/cart",
        component: Cart
      }
    ]
  }
];

// wrap <Route> and use this everywhere instead, then when
// sub routes are added to any route it'll work
const RouteWithSubRoutes = route => (
  <Route
    path={route.path}
    render={props => (
      // pass the sub-routes down to keep nesting
      <route.component {...props} routes={route.routes} />
    )}
  />
);

const RouteConfigExample = () => (
  <Router>
    <div>
      <ul>
        <li>
          <Link to="/tacos">Tacos</Link>
        </li>
        <li>
          <Link to="/sandwiches">Sandwiches</Link>
        </li>
      </ul>

      {routes.map((route, i) => <RouteWithSubRoutes key={i} {...route} />)}
    </div>
  </Router>
);

export default RouteConfigExample;