React Router教程

React項目的可用的路由庫是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)站（將會運(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)然每個組件下又會有幾種不同的子類組件實(shí)現(xiàn)蔗牡。比如： Router組件就針對不同功能和平臺對應(yīng)用：

• <BrowserRouter>瀏覽器的路由組件
• <HashRouter> URL格式為Hash路由組件
  *<MemoryRouter> 內(nèi)存路由組件
• <NativeRouter>Native的路由組件
  *<StaticRouter> 地址不改變的靜態(tài)路由組件

三大組件使用的關(guān)系：

image.png

如果說我們的應(yīng)用程序是一座小城的話，那么Route就是一座座帶有門牌號的建筑物嗅剖，而Link就代表了到某個建筑物的路線辩越。有了路線和目的地，那么就缺一位老司機(jī)了信粮，沒錯Router就是這個老司機(jī)区匣。

第一個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)擊了程序中的一個鏈接之后,BrowserRouter就會找出與這個URL匹配的Route姑丑，并將他們對應(yīng)的組件渲染出來。BrowserRouter是用來管理我們的組件的辞友，那么它當(dāng)然要被放在最頂級的位置栅哀，而我們的應(yīng)用程序的組件就作為它的一個子組件而存在。

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組件提供了四個屬性称龙。

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

basename 屬性

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

例如：有時候我們的應(yīng)用只是整個系統(tǒng)中的一個模塊侈询，應(yīng)用中的URL總是以 http://localhost/admin/ 開頭。這種情況下我們總不能每次定義Link和Route的時候都帶上admin吧糯耍？react-router已經(jīng)考慮到了這種情況扔字，所以為我們提供了一個basename屬性。為BrowserRouter設(shè)置了basename之后温技，Link中就可以省略掉admin了啦租，而最后渲染出來的URL又會自動帶上admin。

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

getUserConfirmation: func

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

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

<BrowserRouter getUserConfirmation={getConfirmation}/>

forceRefresh: bool

當(dāng)設(shè)置為 true 時焊刹，在導(dǎo)航的過程中整個頁面將會刷新系任。 只有當(dāng)瀏覽器不支持 HTML5 的 history API 時，才設(shè)置為 true虐块。

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

keyLength: number

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

<BrowserRouter keyLength={12}/>

children: node

渲染單一子組件（元素）贺奠。

HashRouter

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

注意： 使用 hash 的方式記錄導(dǎo)航歷史不支持location.key和location.state。在以前的版本中儡率，我們?yōu)檫@種行為提供了 shim挂据，但是仍有一些問題我們無法解。任何依賴此行為的代碼或插件都將無法正常使用儿普。由于該技術(shù)僅用于支持傳統(tǒng)的瀏覽器崎逃，因此在用于瀏覽器時可以使用 <BrowserHistory> 代替。
跟BrowserRouter類似眉孩，它也有：basename个绍、getUserConfirmation、children屬性浪汪，而且是一樣的巴柿。

hashType: string

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

• "slash" - 后面跟一個斜杠死遭，例如 #/ 和 #/sunshine/lollipops
• "noslash" - 后面沒有斜杠广恢，例如 # 和 #sunshine/lollipops
• "hashbang" - Google 風(fēng)格的 "ajax crawlable"，例如 #!/ 和 #!/sunshine/lollipops

默認(rèn)為 "slash"呀潭。

MemoryRouter

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

Link組件

Link就像是一個個的路牌篷牌，為我們指明組件的位置睡蟋。Link使用聲明式的方式為應(yīng)用程序提供導(dǎo)航功能，定義的Link最終會被渲染成一個a標(biāo)簽枷颊。Link使用to這個屬性來指明目標(biāo)組件的路徑戳杀，可以直接使用一個字符串，也可以傳入一個對象夭苗。

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>

屬性： to

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

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

默認(rèn)為false。

<Link to="/courses" replace />

NavLink組件

NavLink是一個特殊版本的Link界赔，可以使用activeClassName來設(shè)置Link被選中時被附加的class丢习，使用activeStyle來配置被選中時應(yīng)用的樣式。此外淮悼，還有一個exact屬性,此屬性要求location完全匹配才會附加class和style咐低。這里說的匹配是指地址欄中的URl和這個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 布爾類型见擦，完全匹配時才會被附件class和style
• activeStyle Object類型
• activeClassName 字符串類型
• strict: bool類型，當(dāng)值為 true 時羹令，在確定位置是否與當(dāng)前 URL 匹配時鲤屡，將考慮位置 pathname 后的斜線。

Route組件

Route應(yīng)該是react-route中最重要的組件了福侈，它的作用是當(dāng)location與Route的path匹配時渲染Route中的Component执俩。如果有多個Route匹配，那么這些Route的Component都會被渲染癌刽。

與Link類似役首，Route也有一個exact屬性，作用也是要求location與Route的path絕對匹配显拜。

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

Route的三種渲染方式

1.component: 這是最常用也最容易理解的方式，給什么就渲染什么。
2.render: render的類型是function档址，Route會渲染這個function的返回值盹兢。因此它的作用就是附加一些額外的邏輯。

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

1.children: 這是最特殊的渲染方式守伸。

一绎秒、它同render類似,是一個function。不同的地方在于它會被傳入一個match參數(shù)來告訴你這個Route的path和location匹配上沒有尼摹。
二见芹、第二個特殊的地方在于，即使path沒有匹配上蠢涝，我們也可以將它渲染出來玄呛。秘訣就在于前面一點(diǎn)提到的match參數(shù)。我們可以根據(jù)這個參數(shù)來決定在匹配的時候渲染什么和二，不匹配的時候又渲染什么徘铝。

// 在不匹配時，容器的calss是dark惯吕，<About />會被渲染
<Route path='/home' children={({ match }) => (
    <div className={match ? 'light' : 'dark'}>
      {match ? <Home/>:<About>}
    </div>
  )}/>

所有路由中指定的組件將被傳入以下三個 props 惕它。

• match.
• location.
• history.
  這里主要說下match.params.透過這個屬性，我們可以拿到從location中解析出來的參數(shù)混埠。當(dāng)然，如果想要接收參數(shù)诗轻，我們的Route的path也要使用特殊的寫法钳宪。

如下示例，三個Link是一個文章列表中三個鏈接扳炬，分別指向三篇id不同的文章吏颖。而Route用于渲染文章詳情頁。注意path='/p/:id' 恨樟，location中的對應(yīng)的段會被解析為id=1 這樣的鍵值半醉。最終這個鍵值會作為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 時，沒有 key
  pathname: '/somewhere'
  search: '?some=search-string',
  hash: '#howdy',
  state: {
    [userDefined]: true
  }
}

<meta charset="utf-8">

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

• 在 Route component 中绳泉，以 this.props.location 的方式獲取逊抡，
• 在 Route render 中，以 ({ location }) => () 的方式獲取零酪，
• 在 Route children 中冒嫡，以 ({ location }) => () 的方式獲取拇勃，
• 在 withRouter 中，以 this.props.location 的方式獲取孝凌。

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

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

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

通常情況下，你只需要給一個字符串當(dāng)做 location 穆碎，但是牙勘，當(dāng)你需要添加一些 location 的狀態(tài)時，你可以對象的形式使用 location 所禀。并且當(dāng)你需要多個 UI 方面，而這些 UI 取決于歷史時，例如彈出框（modal）色徘，使用location 對象會有很大幫助恭金。

// 通常你只需要這樣使用 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候需要組件去渲染一個其他的 location 而不是本身所處的真實(shí) location横腿，比如使用動畫或是等待跳轉(zhuǎn)時。

history

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

我們會經(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」 - 一種存儲于內(nèi)存的 history 實(shí)現(xiàn)，經(jīng)常用于測試或是非 DOM 環(huán)境（例如 React Native）诊县。

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

• length -（ number 類型）指的是 history 堆棧的數(shù)量榜苫。
• action -（ string 類型）指的是當(dāng)前的動作（action），例如 PUSH翎冲，REPLACE 以及POP 垂睬。
• location -（ object類型）是指當(dāng)前的位置（location），location 會具有如下屬性：
• pathname -（ string 類型）URL路徑。
• search -（ string 類型）URL中的查詢字符串（query string）驹饺。
• hash -（ string 類型）URL的 hash 分段钳枕。
• state -（ string 類型）是指 location 中的狀態(tài)，例如在push(path, state) 時赏壹，state會描述什么時候 location 被放置到堆棧中等信息鱼炒。這個 state 只會出現(xiàn)在 browser history 和 memory history 的環(huán)境里。

• push(path, [state]) -（ function 類型）在 hisotry 堆棧頂加入一個新的條目蝌借。
• replace(path, [state]) -（ function 類型）替換在 history 堆棧中的當(dāng)前條目昔瞧。
• go(n) -（ function 類型）將 history 對戰(zhàn)中的指針向前移動 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中動態(tài)的部分獲得的鍵值對。

• isExact - 當(dāng)為 true 時瞧哟，整個URL都需要匹配混巧。
  *path -（ string 類型）用來做匹配的路徑格式。在需要嵌套 <Route>的時候用到勤揩。
  *url -（ string 類型）URL匹配的部分咧党，在需要嵌套<Link>的時候會用到。
  你可以在以下地方獲取 match 對象：

• 在 Route component 中陨亡，以this.props.match 方式傍衡。

• 在 Route render中，以 ({ match }) => () 方式数苫。

• 在 Route children中聪舒，以({ match }) => () 方式

Redirect組件

當(dāng)這個組件被渲染是辨液，location會被重寫為Redirect的to指定的新location虐急。它的一個用途是登錄重定向，比如在用戶點(diǎn)了登錄并驗(yàn)證通過之后滔迈，將頁面跳轉(zhuǎn)到個人主頁止吁。

<Redirect to="/new"/>

Switch組件

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

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

<Switch>的獨(dú)特之處是獨(dú)它僅僅渲染一個路由燎悍。相反地敬惦，每一個包含匹配地址(location)的<Route>都會被渲染槽唾。思考下面的代碼：

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

如果現(xiàn)在的URL是 /about 荷鼠，那么 <About>,<User>, 還有 <NoMatch> 都會被渲染，因?yàn)樗鼈兌寂c路徑(path)匹配点待。這種設(shè)計，允許我們以多種方式將多個<Route>組合到我們的應(yīng)用程序中畴椰，例如側(cè)欄(sidebars)臊诊，面包屑(breadcrumbs)，bootstrap tabs等等斜脂。 然而抓艳，偶爾我們只想選擇一個<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>將被渲染。

這對于過渡動畫也是起作用的犁钟，因?yàn)槠ヅ涞?code><Route> 在與前一個相同的位置被渲染棱诱。

Fade>
  <Switch>
    {/* there will only ever be one child here */}
    {/* 這里只會有一個子節(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 */}
   {/* 這里總是有兩個子節(jié)點(diǎn),
      一個可能會渲染為null, 使計算過渡增加了一點(diǎn)麻煩 */}    
</Fade>

路由配置

<meta charset="utf-8">

<article class="_2rhmJa">

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;

</article>

作者：IT老馬
鏈接：http://www.reibang.com/p/6583b7258e78
來源：簡書
著作權(quán)歸作者所有。商業(yè)轉(zhuǎn)載請聯(lián)系作者獲得授權(quán)涝动，非商業(yè)轉(zhuǎn)載請注明出處迈勋。