Reactルーターチュートリアル–コード例を使用して、レンダリング、リダイレクト、切り替え、リンクなどを行う方法

Reactを使い始めたばかりの場合は、おそらくシングルページアプリケーションの概念全体に頭を悩ませているでしょう。

従来、ルーティングは次のよう/contactに機能します。たとえば、URLを入力するとします。ブラウザはサーバーにGETリクエストを送信し、サーバーは応答としてHTMLページを返します。

ただし、新しいシングルページアプリケーションパラダイムでは、すべてのURL要求はクライアント側のコードを使用して処理されます。

これをReactのコンテキストに適用すると、各ページがReactコンポーネントになります。React-RouterはURLと一致し、その特定のページのコンポーネントをロードします。

すべてが非常に高速かつシームレスに行われるため、ユーザーはブラウザーでアプリのようなネイティブエクスペリエンスを利用できます。ルート遷移の間に派手な空白ページはありません。

この記事では、React-Routerとそのコンポーネントを使用してシングルページアプリケーションを作成する方法を学習します。それでは、お気に入りのテキストエディタを開いて、始めましょう。

プロジェクトをセットアップする

次のコマンドを実行して、新しいReactプロジェクトを作成します。

yarn create react-app react-router-demo

依存関係をインストールするためにyarnを使用しますが、npmも使用できます。

次に、をインストールしましょうreact-router-dom

yarn add react-router-dom

コンポーネントのスタイル設定には、BulmaCSSフレームワークを使用します。それで、それも追加しましょう。

yarn add bulma

次に、ファイルをインポートbulma.min.cssし、index.jsファイルからすべての定型コードをクリーンアップしApp.jsます。

import "bulma/css/bulma.min.css";

プロジェクトを設定したので、いくつかのページコンポーネントを作成することから始めましょう。

ページコンポーネントの作成

すべてのページコンポーネントをパークするsrcフォルダー内にpagesディレクトリを作成します。

このデモでは、Home、About、Profileの3つのページを作成します。

ホームコンポーネントとバージョン情報コンポーネント内に以下を貼り付けます。

// pages/Home.js import React from "react"; const Home = () => ( 

This is the Home Page

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras gravida, risus at dapibus aliquet, elit quam scelerisque tortor, nec accumsan eros nulla interdum justo. Pellentesque dignissim, sapien et congue rutrum, lorem tortor dapibus turpis, sit amet vestibulum eros mi et odio.

); export default Home;
// pages/About.js import React from "react"; const About = () => ( 

This is the About Page

Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia curae; Duis consequat nulla ac ex consequat, in efficitur arcu congue. Nam fermentum commodo egestas.

); export default About;

プロフィールページは、この記事の後半で作成します。

ナビゲーションバーコンポーネントを作成する

アプリのナビゲーションバーを作成することから始めましょう。このコンポーネントは、からのコンポーネントを利用しますreact-router-dom

srcフォルダ内に「components」というディレクトリを作成します。

// components/Navbar.js import React, { useState } from "react"; import { NavLink } from "react-router-dom"; const Navbar = () => { const [isOpen, setOpen] = useState(false); return ( {/* ... */} ); }; export default Navbar;

isOpen状態変数は、モバイルやタブレットデバイス上のメニューをトリガするために使用されます。

それでは、ハンバーガーメニューを追加しましょう。

const Navbar = () => { const [isOpen, setOpen] = useState(false); return ( setOpen(!isOpen)} > {/* ... */} ); };

メニューにリンクを追加するには、コンポーネントbyを使用しますreact-router-dom

このNavLinkコンポーネントは、アプリケーション内を移動するための宣言型の方法を提供します。Linkリンクがアクティブな場合にアクティブなスタイルをリンクに適用できることを除いて、コンポーネントに似ています。

ナビゲートするルートを指定するには、topropを使用してパス名を渡します。

activeClassNameそれが現在アクティブかどう小道具は、リンクにアクティブなクラスを追加します。

 Home 

ブラウザでは、NavLinkコンポーネントは、小道具で渡されhref属性値を持つタグとしてレンダリングされますto

また、ここexactでは、URLと正確に一致するように小道具を指定する必要があります。

すべてのリンクを追加して、Navbarコンポーネントを完成させます。

import React, { useState } from "react"; import { NavLink } from "react-router-dom"; const Navbar = () => { const [isOpen, setOpen] = useState(false); return ( setOpen(!isOpen)} > Home   About   Profile Log in ); }; export default Navbar; 

If you notice here, I've added a Login button. We will come back to the Navbar component again when we discuss protected routes later on in the guide.

Rendering the pages

Now that the Navbar component is set up let's add that to the page and start with rendering the pages.

Since the navigation bar is a common component across all the pages, instead of calling the component in each page component, it will be a better approach to render the Navbar in a common layout.

// App.js function App() { return ( {/* Render the page here */} ); }

Now, add the page components inside of the container.

// App.js function App() { return ( ); }

If you check out the results now, you'll notice that both the Home and the About page component gets rendered onto the page. That's because we haven't added any routing logic yet.

You need to import the BrowserRouter component from React Router to add the ability to route the components. All you need to do is wrap all the page components inside of the BrowserRouter component. This will enable all the page components to have the routing logic. Perfect!

But again, nothing's going to change with the results – you are still going to see both the pages rendered. You need to render the page component only if the URL matches a particular path. That's where the Route component from React Router comes into play.

The Router component has a path prop that accepts the page's path, and the page component should be wrapped with the Router, as shown below.

So let's do the same for the Home component.

The exact prop above tells the Router component to match the path exactly. If you don't add the exact prop on the / path, it will match with all the routes starting with a / including /about.

If you go check out the results now, you'll still see both the components rendered. But, if you go to /about, you'll notice that only the About component gets rendered. You see this behavior because the router keeps matching the URL with the routes even after it had matched a route already.

We need to tell the router to stop matching further once it matches a route. This is done using the Switch component from React Router.

function App() { return ( ); }

There you go! You have successfully configured routing in your React app.

Protected Routes and Redirect

When working on Real-world applications, you will have some routes behind an authentication system. You are going to have routes or pages that can only be accessed by a logged-in user. In this section, you'll learn how to go about implementing such routes.

Please note that I'm not going to create any login form or have any back-end service authenticate the user. In a real application, you wouldn't implement authentication the way demonstrated here.

Let's create the Profile page component that should only be accessed by the authenticated user.

// pages/Profile.js import { useParams } from "react-router-dom"; const Profile = () => { const { name } = useParams(); return ( 

This is the Profile Page

{name}

Lorem ipsum dolor sit amet, consectetur adipiscing elit.{" "} Pellentesque risus mi, tempus quis placerat ut, porta nec nulla. Vestibulum rhoncus ac ex sit amet fringilla. Nullam gravida purus diam, et dictum felis venenatis efficitur. Aenean ac{" "} eleifend lacus, in mollis lectus. Donec sodales, arcu et sollicitudin porttitor, tortor urna tempor ligula, id porttitor mi magna a neque. Donec dui urna, vehicula et sem eget, facilisis sodales sem. ); };

We will grab the user's name from the URL using route parameters.

Add the Profile route into the router.

Currently the profile page can be accessed directly. So to make it an authenticated route, create a Higher-Order component (HOC) to wrap the authentication logic.

const withAuth = (Component) => { const AuthRoute = () => { const isAuth = !!localStorage.getItem("token"); // ... }; return AuthRoute; };

To determine if a user is authenticated or not, grab the authentication token that is stored in the browser when the user logs in. If the user is not authenticated, redirect the user to the Home page. The Redirect component from React Router can be used to redirect the user to another path.

const withAuth = (Component) => { const AuthRoute = () => { const isAuth = !!localStorage.getItem("token"); if (isAuth) { return ; } else { return ; } }; return AuthRoute; };

You can also pass in other user information like name and user ID using props to the wrapped component.

Next, use the withAuth HOC in the Profile component.

import withAuth from "../components/withAuth"; const Profile = () => { // ... } export default withAuth(Profile);

Now, if you try to visit /profile/JohnDoe, you will get redirected to the Home page. That's because the authentication token is not yet set in your browser storage.

Alright, so, let's return to the Navbar component and add the login and logout functionalities. When the user is authenticated, show the Logout button and when the user is not logged in show the Login button.

// components/Navbar.js const Navbar = () => { // ... return ( {/* ... */} {!isAuth ? (  Log in  ) : (  Log out  )} ); } 

When the user clicks on the login button, set a dummy token in the local storage, and redirect the user to the profile page.

But we cannot use the Redirect component in this case – we need to redirect the user programmatically. Sensitive tokens used for authentication are usually stored in cookies for security reasons.

React Router has a withRouter HOC that injects the history object in the props of the component to leverage the History API. It also passes the updated match and location props to the wrapped component.

// components/Navbar.js import { NavLink, withRouter } from "react-router-dom"; const Navbar = ({ history }) => { const isAuth = !!localStorage.getItem("token"); const loginUser = () => { localStorage.setItem("token", "some-login-token"); history.push("/profile/Vijit"); }; const logoutUser = () => { localStorage.removeItem("token"); history.push("/"); }; return ( {/* ... */} ); }; export default withRouter(Navbar);

And voilà! That's it. You have conquered the land of authenticated routes as well.

Check out the live demo here and the complete code in this repo for your reference.

Conclusion

I hope by now you have a fair idea of how client-side routing works in general and how to implement routing in React using the React Router library.

In this guide, you learned about the vital components in React Router like Route, withRouter, Link, and so on, along with some advanced concepts like authenticated routes, that are required to build an application.

Do check out the React Router docs to get a more detailed overview of each of the components.