React Router Tutorial - Как да изобразявате, пренасочвате, превключвате, свързвате и още, с примери за кодове

Ако току-що сте започнали с React, вероятно все още увивате главата си около цялата концепция за приложението на една страница.

Традиционно маршрутизацията работи по следния начин: да предположим, че въвеждате /contactURL адреса. Браузърът ще направи GET заявка към сървъра и сървърът ще върне HTML страница като отговор.

Но с новата парадигма на приложението за една страница, всички заявки за URL адреси се обслужват с помощта на клиентски код.

Прилагайки това в контекста на React, всяка страница ще бъде React компонент. React-Router съвпада с URL адреса и зарежда компонента за конкретната страница.

Всичко се случва толкова бързо и безпроблемно, че потребителят получава собствено приложение, подобно на приложението, в браузъра. Между проходите по маршрута няма блестяща празна страница.

В тази статия ще научите как да използвате React-Router и неговите компоненти, за да създадете приложение за една страница. Затова отворете любимия си текстов редактор и нека да започнем.

Настройте проекта

Създайте нов проект на React, като изпълните следната команда.

yarn create react-app react-router-demo

Ще използвам прежда за инсталиране на зависимостите, но можете да използвате и npm.

След това нека инсталираме react-router-dom.

yarn add react-router-dom

За оформяне на компонентите ще използвам Bulma CSS рамката. Така че нека добавим и това.

yarn add bulma

След това импортирайте bulma.min.cssвъв index.jsфайла и изчистете целия код на шаблона от App.jsфайла.

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

След като вече сте настроили проекта, нека започнем със създаването на няколко компонента на страницата.

Създаване на компонентите на страницата

Създайте директория на страници в папката src, където ще паркираме всички компоненти на страницата.

За тази демонстрация създайте три страници - Начало, Информация и Профил.

Поставете следното в компонентите Home и About.

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

По-късно в статията ще създадем страницата с профила.

Създайте компонента Navbar

Нека започнем със създаването на лентата за навигация за нашето приложение. Този компонент ще използва компонента от react-router-dom.

Създайте директория, наречена "компоненти", в папката 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;

В isOpenпроменливата състояние ще се използват за задействане на менюто на мобилни или таблетни устройства.

Така че нека добавим менюто за хамбургер.

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

За да добавите връзката в менюто, използвайте компонента до react-router-dom.

В NavLinkкомпонента предоставя декларативен начин да се движите около заявлението. Той е подобен на Linkкомпонента, освен че може да приложи активен стил към връзката, ако е активен.

За да посочите до кой маршрут да навигирате, използвайте toподпората и предайте името на пътя.

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

Ако забележите тук, добавих бутон за вход. Ще се върнем към Navbarкомпонента отново, когато обсъдим защитените маршрути по-късно в ръководството.

Оказване на страниците

Сега, когато Navbarкомпонентът е настроен, нека добавим това към страницата и да започнем с изобразяването на страниците.

Тъй като лентата за навигация е общ компонент на всички страници, вместо да извиквате компонента във всеки компонент на страницата, ще бъде по-добър подход за изобразяване на Navbarв общо оформление.

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

Сега добавете компонентите на страницата вътре в контейнера.

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

Ако проверите резултатите сега, ще забележите, че както начало, така и компонентът за страницата се визуализират на страницата. Това е така, защото все още не сме добавили никаква логика за маршрутизиране.

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.