React Router Tutorial - Rendern, Umleiten, Wechseln, Verknüpfen und mehr anhand von Codebeispielen

Wenn Sie gerade erst mit React begonnen haben, beschäftigen Sie sich wahrscheinlich immer noch mit dem gesamten Single Page Application-Konzept.

Traditionell funktioniert das Routing folgendermaßen: Nehmen wir an, Sie geben /contactdie URL ein. Der Browser sendet eine GET-Anfrage an den Server und der Server gibt eine HTML-Seite als Antwort zurück.

Mit dem neuen Single Page Application-Paradigma werden jedoch alle URL-Anforderungen mithilfe des clientseitigen Codes bedient.

Wenn Sie dies im Kontext von React anwenden, ist jede Seite eine React-Komponente. React-Router stimmt mit der URL überein und lädt die Komponente für diese bestimmte Seite.

Alles geschieht so schnell und nahtlos, dass der Benutzer eine native App-ähnliche Erfahrung im Browser erhält. Zwischen den Routenübergängen befindet sich keine auffällige leere Seite.

In diesem Artikel erfahren Sie, wie Sie mit React-Router und seinen Komponenten eine Einzelseitenanwendung erstellen. Öffnen Sie also Ihren bevorzugten Texteditor und legen Sie los.

Richten Sie das Projekt ein

Erstellen Sie ein neues React-Projekt, indem Sie den folgenden Befehl ausführen.

yarn create react-app react-router-demo

Ich werde Garn verwenden, um die Abhängigkeiten zu installieren, aber Sie können auch npm verwenden.

Als nächstes installieren wir react-router-dom.

yarn add react-router-dom

Für das Styling der Komponenten werde ich das Bulma CSS-Framework verwenden. Fügen wir das also auch hinzu.

yarn add bulma

Als nächstes importieren Sie bulma.min.cssin die index.jsDatei und bereinigen den gesamten Boilerplate-Code aus der App.jsDatei.

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

Nachdem Sie das Projekt eingerichtet haben, erstellen wir zunächst einige Seitenkomponenten.

Seitenkomponenten erstellen

Erstellen Sie ein Seitenverzeichnis im Ordner src, in dem alle Seitenkomponenten geparkt werden.

Erstellen Sie für diese Demo drei Seiten - Startseite, Info und Profil.

Fügen Sie Folgendes in die Komponenten Home und About ein.

// 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;

Wir werden die Profilseite später im Artikel erstellen.

Erstellen Sie die Navbar-Komponente

Beginnen wir mit der Erstellung der Navigationsleiste für unsere App. Diese Komponente verwendet die Komponente von react-router-dom.

Erstellen Sie ein Verzeichnis mit dem Namen "Komponenten" im Ordner "src".

// 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;

Die isOpenStatusvariable wird verwendet, um das Menü auf Mobil- oder Tablet-Geräten auszulösen.

Fügen wir also das Hamburger-Menü hinzu.

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

Verwenden Sie die Komponente von, um den Link im Menü hinzuzufügen react-router-dom.

Die NavLinkKomponente bietet eine deklarative Möglichkeit zum Navigieren in der Anwendung. Es ähnelt der LinkKomponente, kann jedoch einen aktiven Stil auf den Link anwenden, wenn dieser aktiv ist.

Um anzugeben, zu welcher Route Sie navigieren möchten, verwenden Sie die toRequisite und übergeben Sie den Pfadnamen.

Die activeClassNameRequisite fügt dem Link eine aktive Klasse hinzu, wenn sie gerade aktiv ist.

 Home 

Im Browser wird die NavLinkKomponente als Tag mit einem hrefAttributwert gerendert , der in der toRequisite übergeben wurde.

Außerdem müssen Sie hier die exactRequisite angeben, damit sie genau mit der URL übereinstimmt.

Fügen Sie alle Links hinzu und beenden Sie die NavbarKomponente.

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; 

Wenn Sie hier bemerken, habe ich eine Anmeldeschaltfläche hinzugefügt. Wir werden noch einmal auf die NavbarKomponente zurückkommen, wenn wir später im Handbuch über geschützte Routen sprechen.

Seiten rendern

Nachdem die NavbarKomponente eingerichtet wurde, fügen wir sie der Seite hinzu und beginnen mit dem Rendern der Seiten.

Da die Navigationsleiste eine gemeinsame Komponente auf allen Seiten ist, anstatt die Komponente in jeder Seitenkomponente aufzurufen, ist es besser, sie Navbarin einem gemeinsamen Layout zu rendern .

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

Fügen Sie nun die Seitenkomponenten in den Container ein.

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

Wenn Sie die Ergebnisse jetzt überprüfen, werden Sie feststellen, dass sowohl die Home- als auch die About-Seitenkomponente auf der Seite gerendert werden. Das liegt daran, dass wir noch keine Routing-Logik hinzugefügt haben.

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.