2020/02/08 (2022/01/24)

ルーティングライブラリ、React Router(v5)入門

開発関連技術

TypeScript, React

前回は React の基礎的なことをまとめましたが、今回は React アプリのルーティング設定をするうえでよく使われている React Router についてまとめました。

※この記事は元々 Qiita からの転載です。
現在は Qiita でなく Zenn の方で更新しています。

※2021/08/22追記 TypeScript ベースで、全体的に大幅加筆修正を行いました。
※2022/01/24追記あくまでライブラリの記事であるとわかりやすくするために、記事タイトルを変更しました（旧：React入門～React Router(v5)編～）

React Router とは？#

インストール#

React Router は Web とネイティブともに対応しています。
今回は Web アプリに導入するので、react-router-dom とその型定義を追加。

yarn add react-router-dom @types/react-router-dom

react-router も必要になりますが、react-router-dom の依存関係にあるので、一緒に追加されます。

今回の使用バージョンは以下のとおりです。

React：17.0.2
react-router-dom：5.2.0
react-router：5.2.0
@types/react-router-dom：5.1.8

※2022/01/24追加
2021/11に6系がリリースされましたが、当記事では5系を扱っていることに注意です。
5系と6系とでは、破壊的な変更も行われています。

基本的な使い方#

これ以降のコードは公式ドキュメントをコードを引用、もしくは元にしています。

import { VFC } from 'react';
import {
  BrowserRouter,
  Switch,
  Route,
  Link
} from 'react-router-dom';

const Home: VFC = () => {
  return <h2>Home</h2>;
}

const About: VFC = () => {
  return <h2>About</h2>;
}

const Users: VFC = () => {
  return <h2>Users</h2>;
}

const App: VFC = () => {
  return (
    <BrowserRouter>
      <div>
        <nav>
          <ul>
            <li>
              <Link to='/'>Home</Link>
            </li>
            <li>
              <Link to='/about'>About</Link>
            </li>
            <li>
              <Link to='/users'>Users</Link>
            </li>
          </ul>
        </nav>

        <Switch>
          <Route path='/about'>
            <About />
          </Route>
          <Route path='/users'>
            <Users />
          </Route>
          <Route path='/'>
            <Home />
          </Route>
        </Switch>
      </div>
    </BrowserRouter>
  );
}

export default App;

ルーティングに必要なものを import#

使用するコンポーネントを import します。

import {
  BrowserRouter,
  Switch,
  Route,
  Link
} from 'react-router-dom';

ルート階層で、コンポーネント全体をプロバイダーコンポーネントで囲う#

React Router が提供しているプロバイダーコンポーネントは複数存在しています。

BrowserRouter：HTML の History API（pushState、replaceState、popstate イベント）を使用して UI を URL と同期させるルーター
HashRouter：URL のハッシュ部分（window.location.hash）を使用して UI を URL と同期させるルーター
StaticRouter：location を変更しないルーター
MemoryRouter：URL の履歴をメモリに保持するルーター（アドレスバーの読み取りまたは書き込みは行わない）

この中で、今回はBrowserRouterを使っていきます。
現在の一般的な SPA 開発では、このBrowserRouterを使われることが多いようです。

const App: VFC = () => {
  return (
    <BrowserRouter>
    .
    .
    .
    </BrowserRouter>
  )
}

プロバイダーコンポーネントとはなんぞや？という方は、このコンポーネントの子コンポーネント全体に特定の値や機能を提供するものと、まずは思ってもらえればいいかなと。
（context の話が出てくることになりますが、ここでは書きません）

上記のプロバイダーコンポーネントでは、ルーティングに関する機能を提供してくれます。
ルート階層で囲っておくことで、その下層のコンポーネントでルーティングに関する機能が使えるようになるわけです。

ルーティングの定義#

Switchコンポーネントで囲い、その中にRouteコンポーネントでそれぞれのルートを定義。
このSwitchコンポーネントは、現在の URL と一致する Route を上から順に探し、最初に一致するルートの内容を返すようになっています。

注意点として、通常では前方一致で比較します。
例として path が/aboutの場合、/about/aなどでも一致とみなされます。
精度を変えたい場合は、ルート照合の精度指定参照。

const Home: VFC = () => {
  return <h2>Home</h2>;
}

const About: VFC = () => {
  return <h2>About</h2>;
}

const Users: VFC = () => {
  return <h2>Users</h2>;
}
.
.
.
<Switch>
  <Route path='/about'>
    <About />
  </Route>
  <Route path='/users'>
    <Users />
  </Route>
  <Route path='/'>
    <Home />
  </Route>
</Switch>

なお、Route の path は一度に複数定義も可能です。
以下の場合は、/about、/profile両方で About コンポーネントをレンダリングします。

<Route path={['/about', '/profile']}>
  <About />
</Route>

リンクの作成#

Linkコンポーネントでリンクを作成。to でリンク先情報を指定。
後に a タグへ変換されることになりますが、通常の a タグと違い、クライアントサイドで遷移が動作します。
通常の a タグを使うと React Router の管理外となり、アプリ全体が再読み込みされて履歴が消えてしまうので注意。
内部リンクは Link コンポーネント、外部リンクは a タグと使い分けるイメージです。

なお、この例では同じコンポーネント内に共存していますが、LinkコンポーネントはSwitchやRouteコンポーネントを使用しているコンポーネント内でしか使用できないということはありません。
ルーティングプロバイダーコンポーネントの配下であれば、どこでも使用できます。

<nav>
  <ul>
    <li>
      <Link to='/'>Home</Link>
    </li>
    <li>
      <Link to='/about'>About</Link>
    </li>
    <li>
      <Link to='/users'>Users</Link>
    </li>
  </ul>
</nav>

ちなみに、リンク URL と現在の URL が一致した時に、スタイルを追加できる NavLink コンポーネントという拡張バージョンがあったりもします。

React Router: Declarative Routing for React

Learn once, Route Anywhere

https://v5.reactrouter.com

これで基本的なルーティングが作成できました。

Hooks API#

React Router が提供しているフックは以下の4種類です。

useHistory
useLocation
useParams
useRouteMatch

useHistory#

React Router: Declarative Routing for React

Learn once, Route Anywhere

https://v5.reactrouter.com

React Router が提供する history オブジェクトを返すフック。

履歴の数である length
最後に実行されたアクションである action（PUSH・REPLACE・POP）
location オブジェクトとブラウザ履歴に関する関数などを持っているものです。

この history オブジェクトは HTML の History API と完全一致ではありませんが、おおよそ似たようなブラウザ履歴に関する処理ができるようになっています。

// 履歴の追加
history.push('/about')

// 履歴の追加 + ユーザ定義データの受け渡し
history.push('/about', { someState: 'foo' });

// 履歴の書き換え
history.replace('/about');

// 履歴の書き換え + ユーザ定義データの受け渡し
history.replace('/about', { someState: 'foo' });

// 履歴を2つ（引数の値分）進める
history.go(2);

// 履歴を1つ戻る
history.goBack();

// 履歴を1つ進める
history.goForward();

// 上記の履歴変更の前に記述しておくと、遷移前にアラートを出す
history.block('このページを離れますか？');

特定の処理後に遷移させたい（例：ログアウト処理後にログイン画面へリダイレクト）時や、特定の要素をクリックしたときに遷移させたい時などに活用できます。

ボタンを押した時に遷移させる例.

import { VFC } from 'react';
import { useHistory } from 'react-router-dom';

const Home: VFC = () => {
  const history = useHistory();

  const handleClick = () => {
    history.push('/about');
  };

  return (
    <>
      <h2>Home</h2>
      <button type="button" onClick={handleClick}>
        Go about
      </button>
    </>
  );
};

export default Home;

history オブジェクトの中身（history.push で /about に遷移した後の例）

あくまで処理の中でブラウザ履歴の操作をしているので、場合によっては、ユーザから見てクリックするまで挙動がわからない。遷移なのに別タブで開くことができない。となってしまう可能性があります。
特定の要素をクリックで遷移させたい時は、Linkコンポーネントの使用も検討してみましょう。

useLocation#

React Router: Declarative Routing for React

Learn once, Route Anywhere

https://v5.reactrouter.com

React Router が提供する location オブジェクトを返すフック。

location オブジェクトは以下の情報を持っています。

pathname：URL
search：クエリパラメータ
hash：URL ハッシュ
state：ユーザ定義のデータ

これらの情報はLinkコンポーネントや、history オブジェクトで履歴操作時に渡すことができます。
その情報を遷移先のコンポーネント側で使いたい場合に活用します。

import {
  BrowserRouter,
  Switch,
  Route,
  Link,
} from 'react-router-dom';

const to = {
  pathname: '/users',
  search: '?class=A',
  hash: '#user-hash',
  state: { test: 'test-state' }
};
.
.
.
<Link to={to}>Users</Link>
.
.
.
<Switch>
  <Route path='/users'>
    <Users />
  </Route>
</Switch>

import { VFC } from 'react';
import { useLocation } from 'react-router-dom';

const Users: VFC = () => {
  const location = useLocation();
  return (
    <>
      <h2>Users</h2>
      <p>pathname：{location.pathname}</p>
      <p>search：{location.search}</p>
      <p>hash：{location.hash}</p>
      <p>state：{(location.state as { test: string }).test}</p>
    </>
  );
}

export default Users

location オブジェクトの中身

動作

ちなみにクエリパラメータを取り出して扱いたい場合は、query-stringというライブラリを使うと便利です。

GitHub - sindresorhus/query-string: Parse and stringify URL query strings

Parse and stringify URL query strings. Contribute to sindresorhus/query-string development by creating an account on GitHub.

https://github.com

location オブジェクトのクエリパラメータに対して、以下のようにすると{ class: 'A' }のようにオブジェクト形式に変換してくれるため、扱いやすくなります。

import queryString from 'query-string';
.
.
.
queryString.parse(location.search)

クエリパラメータを頻繁に扱う場合は、あらかじめuseLocationとquery-stringを組み合わせたカスタムフックを作っておく手もありです。

useParams#

React Router: Declarative Routing for React

Learn once, Route Anywhere

https://v5.reactrouter.com

React Router が提供する match オブジェクトの中から、パスパラメータ部分のみ返すフック。
遷移元から受け取ったパスパラメータを保持しているため、その情報を遷移先のコンポーネント側で使いたい場合に活用します。

パスパラメータを受け付けるようにするには、Route コンポーネントの path で:aboutIdのように:をつけて定義。
この状態で、リンク時にパスパラメータを指定するようにすれば、遷移先の方で取り出せます。

import { VFC } from 'react';
import {
  BrowserRouter,
  Switch,
  Route,
  Link,
  useParams
} from 'react-router-dom';
.
.
.
<Link to='/about/1'>About</Link>
.
.
.
<Switch>
  <Route path='/about/:aboutId'>
    <About />
  </Route>
</Switch>

const About: VFC = () => {
  // { aboutId: '1' } からの、分割代入 + ショートハンド
  const { aboutId } = useParams<{aboutId: string}>();
  return <h2>About：{aboutId}</h2>
}

動作

ちなみにパスパラメータ定義に?をつけると任意パラメータにもできたりします。

<Route path='/about/:aboutId?'>
  <About />
</Route>

const About: VFC = () => {
  const { aboutId } = useParams<{aboutId?: string}>();
  return <h2>About：{aboutId ?? 'none' }</h2>
}

useRouteMatch#

React Router: Declarative Routing for React

Learn once, Route Anywhere

https://v5.reactrouter.com

React Router が提供する match オブジェクトを返すフック。

match オブジェクトは以下の情報を持っています。

path：ルートパス
url：URL
isExact：URL がルートパスと一致するか
params：パスパラメータのオブジェクト

Route コンポーネントが現在の URL を照合するのと同じ方法で、照合するようになっているようです。

活用例の1つとして、ネストしたルーティングを実現できます。

import { VFC } from 'react';
import {
  BrowserRouter,
  Switch,
  Route,
  Link,
  useRouteMatch
} from 'react-router-dom';

const Home: VFC = () => {
  return <h2>Home</h2>;
}

const Topics: VFC = () => {
  const match = useRouteMatch();

  return (
    <div>
      <h2>Topics</h2>

      <ul>
        <li>
          <Link to={`${match.url}/components`}>Components</Link>
        </li>
        <li>
          <Link to={`${match.url}/props-v-state`}>
            Props v. State
          </Link>
        </li>
      </ul>

      <Switch>
        <Route path={`${match.path}/components`}>
          <h3>Components</h3>
        </Route>
        <Route path={`${match.path}/props-v-state`}>
          <h3>props-v-state</h3>
        </Route>
      </Switch>
    </div>
  );
}

const App: VFC = () => {
  return (
    <BrowserRouter>
      <div>
        <ul>
          <li>
            <Link to='/'>Home</Link>
          </li>
          <li>
            <Link to='/topics'>Topics</Link>
          </li>
        </ul>

        <Switch>
          <Route path='/topics'>
            <Topics />
          </Route>
          <Route path='/'>
            <Home />
          </Route>
        </Switch>
      </div>
    </BrowserRouter>
  );
}

export default App;

match オブジェクトの中身

動作

その他の使い方#

ルート定義方法の種類#

Switch コンポーネント + Route コンポーネントで囲う形で子要素として渡す#

現在推奨されるスタンダードなやり方。
Switchコンポーネントを使用しているため、配下の Route を上から順に照合していって、最初に一致したものがレンダリングされます。

<Switch>
  <Route path='/about'>
    <About />
  </Route>
  <Route path='/users'>
    <Users />
  </Route>
  <Route path='/'>
    <Home />
  </Route>
</Switch>

この他にも指定方法はありますが、それらは主に Hooks API が導入される前のバージョンで使われていた方法で、以下のようなものがあります。
これらをSwitchコンポーネントと併用しない場合は、一致するルート全てがレンダリングされることになるため、扱いには注意が必要です。

Route コンポーネントの component に渡す#

<Route path='/about' component={About} />
<Route path='/users' component={Users} />
<Route path='/home' component={Home} />

この方法の特徴として、React Router は React.createElement を使用して、指定されたコンポーネントから新しい React 要素を作成します。
レンダリングごとに新しいコンポーネントを作成する形になるようです。
そのため、既存コンポーネントを更新するだけでなく、既存コンポーネントをアンマウント → 新しいコンポーネントをマウントのような挙動になるとのこと。

また、この方法では、渡すコンポーネントに props を指定できません。
その代わりに、RouteComponentProps型のオブジェクトが props へ渡されるようになっています。

このRouteComponentPropsには以下のものが含まれています。

history オブジェクト
location オブジェクト
match オブジェクト
staticContext

通常これらは Hooks API で取得できるものです。

component、render、children が同時に定義されていた場合、component は2番目の優先度となります。

Route コンポーネントの render に渡す#

<Route path="/about" render={() => <About />} />
<Route path="/users" render={() => <Users />} />
<Route path="/home" render={() => <Home />} />

ルートが一致したときに呼び出される関数として定義するやり方。
この render の引数には、RouteComponentProps型のオブジェクトが渡されるようになっているので、それを利用した処理が可能です。

component、render、children が同時に定義されていた場合、render は3番目の優先度となります。

Route コンポーネントの children に渡す#

<Route path="/about" children={() => <About />} />
<Route path="/users" children={() => <Users />} />
<Route path="/home" children={() => <Home />} />

render の時と似ていますね。
挙動としても render と似ていますが、children に渡している関数は、ルートが一致したかどうかに関係なく呼び出されます。
ルートが一致した時のみ、同様に引数へRouteComponentProps型のオブジェクトが渡されるようになっているため、ルートが一致するかどうかで UI を動的に切り替えるようなことも可能とのこと。

component、render、children が同時に定義されていた場合、children は1番目の優先度となります。

リンク定義方法の種類#

URL 形式#

URL のみのシンプルなパターン。

<Link to='/about'>About</Link>

オブジェクト形式#

location オブジェクト形式のパターン。

<Link
  to={{
    pathname: '/about',
    search: '?class=A',
    hash: '#user-hash',
    state: { test: 'test-state' }
  }}
>
  About
</Link>

関数形式#

現在の location 情報を引数として、location オブジェクト形式か URL 形式を返すパターン。

// オブジェクト形式
<Link to={location => ({ ...location, pathname: '/about' })} >About</Link>

// URL 形式
<Link to={location => `${location.pathname}?sort=name`} >About</Link>

ルート照合の精度指定#

デフォルトは前方一致です。

完全一致#

exact をつけます。

<Route path='/about' exact>
  ...
</Route>

末尾スラッシュ有無確認#

path の末尾にスラッシュをつける + strict をつけます。
/abount/に対して/aboutは一致とみなされません。

<Route path='/about/' strict>
  ...
</Route>

大文字・小文字確認#

sensitive をつけます。
大文字小文字を厳密に照合するようになります。

<Route path='/about' sensitive>
  ...
</Route>

ルート定義していない URL にアクセスされた場合のルート定義#

Routeコンポーネントの path で*を指定すると全受けにできるのを利用します。
Switchコンポーネントの仕様上、上から Route を照合していくので、最後に追加しておきます。

<Switch>
  <Route path='/about'>
    <About />
  </Route>
  <Route path='/users'>
    <Users />
  </Route>
  <Route path='*'>
    <Error />
  </Route>
</Switch>

アプリ内リダイレクト#

history.replace#

useHistoryの項でも書いた通り、history.replaceで履歴の書き換えができるので、これで対応できます。
ロジックの中でリダイレクトさせたい時など。

Redirect コンポーネント#

to にリダイレクト先情報（URL 形式、location オブジェクト形式）を指定することで、そちらにリダイレクトさせられます。
何らかのフラグ変数によって、リダイレクトさせるか切り分ける時など。

以下はauthenticated変数によって遷移する先を変化させている例です。

<Switch>
  <Route path='/mypage'>
    {authenticated ? <MyPage /> : <Redirect to="/" />}
  </Route>
  <Route path='/login'>
    {authenticated ? <Redirect to="/mypage" /> : <Login />}
  </Route>
</Switch>

ログインしている時にログイン画面へアクセスすると、マイページ画面にリダイレクト。
ログインしていない時にマイページ画面へアクセスすると、ログイン画面にリダイレクト。
といった感じ。

毎回、分岐を書くのがめんどくさければ、認証ルート用と非認証用ルートで Route コンポーネントの薄いラッパーを作るのもありです。
公式の example - Redirects(Auth) が参考になります。

React Router: Declarative Routing for React

Learn once, Route Anywhere

https://v5.reactrouter.com

また、以下のような書き方もできます。
こちらの場合は from を使用していて、from の URL にアクセスされたら、to の location にリダイレクトします。

<Switch>
  <Redirect from='/test' to='/other' />
  <Route path='/other'>
    <Other />
  </Route>
  .
  .
  .
</Switch>

フレンドリーフォワーディング#

ログイン時にしかアクセスできない画面に、未ログイン状態でアクセスしたとします。
大体の Web アプリはログイン画面にリダイレクトして、ログインを要求されるでしょう。
そうやってログインした後、ログイン後のアプリトップ画面でなく、元々アクセスしようとしていた画面に遷移してくれると嬉しいよね。というやつのことです。

クエリパラメータに URL を保持しておいて、ログイン後にその URL へリダイレクトさせる。
というのを割と見かける気がしますが、以下の例では location オブジェクトの state を活用してみています。

まず以下のような認証ルート用のラッパーコンポーネントを用意。

type Props = ComponentPropsWithRef<typeof Route>;

const AuthRoute: VFC<Props> = ({ children, ...rest }) => {
  // 認証情報を取得
  const { authenticated } = useAuth();

  return (
    <Route
      {...rest}
      render={({ location }) =>
        authenticated ? (
          children
        ) : (
          <Redirect
            to={{
              pathname: '/login',
              state: { from: location }
            }}
          />
        )
      }
    />
  );
}

認証していれば、子要素のコンポーネントを返す。
認証しなければ、ログイン画面へリダイレクトする。
というものです。
リダイレクト時に、その時の location 情報（元々アクセスしようとしていた画面情報）を state にセットしておきます。

あとは Login コンポーネント側でそれを取得しておいて、ログイン後にその Location 情報でリダイレクトさせれば OK です。

import { Location } from 'history';
.
.
.
const Login: VFC = () => {
  const history = useHistory();
  const location = useLocation();
  const { login } = useAuth();

  const { from } = (location.state as { from: Location }) || { from: { pathname: '/' } };

  const handleLogin = () => {
    login(); // ログイン処理
    history.replace(from);
  };

  return (
    <div>
      <form>
        {/* フォーム要素 */}
        .
        .
        .
        <button type="submit" onClick={handleLogin}>ログイン</button>
      </form>
    </div>
  );
}

これも先ほど触れた公式の example - Redirects(Auth) が参考になります。

※2021/08/21追記
全体加筆修正・更新にあたり、現在は Hooks API を使うことが一般的になっているため、HOC 式の項は削除しました。
HOC 式が気になるという方は、公式ドキュメント withRouter をご参照ください。

React Router: Declarative Routing for React

Learn once, Route Anywhere

https://v5.reactrouter.com

React Router とは？#

インストール#

基本的な使い方#

ルーティングに必要なものを import#

ルート階層で、コンポーネント全体をプロバイダーコンポーネントで囲う#

ルーティングの定義#

リンクの作成#

Hooks API#

useHistory#

useLocation#

useParams#

useRouteMatch#

その他の使い方#

ルート定義方法の種類#

Switch コンポーネント + Route コンポーネントで囲う形で子要素として渡す#

Route コンポーネントの component に渡す#

Route コンポーネントの render に渡す#

Route コンポーネントの children に渡す#

リンク定義方法の種類#

URL 形式#

オブジェクト形式#

関数形式#

ルート照合の精度指定#

完全一致#

末尾スラッシュ有無確認#

大文字・小文字確認#

ルート定義していない URL にアクセスされた場合のルート定義#

アプリ内リダイレクト#

history.replace#

Redirect コンポーネント#

フレンドリーフォワーディング#

参考リンクまとめ#