使用React Router v6 添加身份验证的方法

react router v6是react应用程序的一个流行且功能强大的路由库。它提供了一种声明式的、基于组件的路由方法，并能处理url参数、重定向和加载数据等常见任务。

这个最新版本的react router引入了很多新概念，比如<outlet />和layout布局路由，但相关文档仍然很少。

本文将演示如何使用react router v6创建受保护的路由以及如何添加身份验证。

开始

打开终端，运行以下命令创建一个新的 react 项目:

> npx create-react-app reactrouterauthdemo
> cd reactrouterauthdemo

接下来，在 react 应用程序中安装 react router 作为依赖项:

> npm install react-router-dom

一旦 react router 依赖项安装好，我们就可以开始编辑src/index.js文件。

首先，从 react-router-dom 中导入 browserrouter组件，然后用<browserrouter /> 包裹 <app /> 组件，就像这样:

import { strictmode } from "react";
import { createroot } from "react-dom/client";
import { browserrouter } from "react-router-dom";
import app from "./app";
const rootelement = document.getelementbyid("root");
const root = createroot(rootelement);

root.render(
  <strictmode>
    <browserrouter>
      <app />
    </browserrouter>
  </strictmode>
);

基础路由

react router提供了 <routes /> 和 <route /> 组件，使我们能够根据组件的当前位置来渲染它们。

import { routes, route } from "react-router-dom";
import { loginpage } from "./pages/login";
import { homepage } from "./pages/home";
import "./styles.css";

export default function app() {
  return (
    <routes>
      <route path="/" element={<homepage />} />
      <route path="/login" element={<loginpage />} />
    </routes>
  );
}

<route />提供了应用程序和 react 组件之间路径的映射。例如，当用户导航到/login时，要渲染loginpage组件，我们只需要像这样提供<route />:

<route path="/login" element={<loginpage />} />

<route /> 组件可以看作是一个 if 语句，只有当元素与指定的路径匹配时，它才会作用于url的位置。

<routes /> 组件是 react router v5 中的 <switch /> 组件的替代品。

我们可以通过创建login.jsx和home.jsx来使用 <routes />：

// login.jsx
export const loginpage = () => (
  <div>
    <h1>this is the login page</h1>
  </div>
);

// home.jsx
export const homepage = () => (
  <div>
    <h1>this is the home page</h1>
  </div>
);

接下来，我们将运行下面的命令来启动应用程序:

> npm run start

在浏览器中，我们默认会看到home组件。如果我们使用/login路由，我们将看到loginpage组件呈现在屏幕上。

或者，我们也可以使用一个普通的javascript对象，通过useroutes钩子来表示应用程序中的路由。这是一种定义路由的功能方法，其工作方式与< routes />和<route />组件相同。

import { useroutes } from "react-router-dom";
// ...

export default function app() {
  const routes = useroutes([
    {
      path: "/",
      element: <homepage />
    },
    {
      path: "/login",
      element: <loginpage />
    }
  ]);
  return routes;
}

既然基本设置已经完成，让我们看看如何创建受保护的路由，从而使未经身份验证的用户无法访问应用程序中的某些内容。

创建受保护的路由

在创建受保护的路由之前，让我们先创建一个自定义钩子，它将使用context api和usecontext钩子处理通过身份验证的用户的状态。

import { createcontext, usecontext, usememo } from "react";
import { usenavigate } from "react-router-dom";
import { uselocalstorage } from "./uselocalstorage";
const authcontext = createcontext();

export const authprovider = ({ children }) => {
  const [user, setuser] = uselocalstorage("user", null);
  const navigate = usenavigate();

  // 验证用户权限的时候，访问该函数
  const login = async (data) => {
    setuser(data);
    navigate("/profile");
  };

  // 登出
  const logout = () => {
    setuser(null);
    navigate("/", { replace: true });
  };

  const value = usememo(
    () => ({
      user,
      login,
      logout
    }),
    [user]
  );
  return <authcontext.provider value={value}>{children}</authcontext.provider>;
};

export const useauth = () => {
  return usecontext(authcontext);
};

上述 useauth 钩子中，我们暴露了用户的状态和一些用于用户登录和注销的方法。当用户登出时，我们使用 react router 的 usenavigate 钩子将他们重定向到主页。

为了在页面刷新时保持用户的状态，我们将使用 uselocalstorage 钩子，它将在浏览器的本地存储中同步状态值。

import { usestate } from "react";

export const uselocalstorage = (keyname, defaultvalue) => {
  const [storedvalue, setstoredvalue] = usestate(() => {
    try {
      const value = window.localstorage.getitem(keyname);
      if (value) {
        return json.parse(value);
      } else {
        window.localstorage.setitem(keyname, json.stringify(defaultvalue));
        return defaultvalue;
      }
    } catch (err) {
      return defaultvalue;
    }
  });
  const setvalue = (newvalue) => {
    try {
      window.localstorage.setitem(keyname, json.stringify(newvalue));
    } catch (err) {}
    setstoredvalue(newvalue);
  };
  return [storedvalue, setvalue];
};

<protectedroute /> 组件将从 useauth 钩子中检查当前用户的状态，如果用户没有经过身份验证，则重定向到/路径。

import { navigate } from "react-router-dom";
import { useauth } from "../hooks/useauth";

export const protectedroute = ({ children }) => {
  const { user } = useauth();
  if (!user) {
    // user is not authenticated
    return <navigate to="/" />;
  }
  return children;
};

要重定向用户，我们使用 <navigate /> 组件。当父组件呈现当前位置时，<navigate /> 组件会改变当前位置。它在内部使用 usenavate 钩子。

在 app.js 文件中，我们可以用 <protectedroute /> 组件包装page 组件。例如下面，我们使用 <protectedroute /> 包装<settingspage /> 和 <profilepage /> 组件。现在，当未经身份验证的用户试图访问 /profile 或 /settings 路径时，他们将被重定向到主页。

import { routes, route } from "react-router-dom";
import { loginpage } from "./pages/login";
import { homepage } from "./pages/home";
import { signuppage } from "./pages/signup";
import { profilepage } from "./pages/profile";
import { settingspage } from "./pages/settings";
import { protectedroute } from "./components/protectedroute";
export default function app() {
  return (
    <routes>
      <route path="/" element={<homepage />} />
      <route path="/login" element={<loginpage />} />
      <route path="/register" element={<signuppage />} />
      <route
        path="/profile"
        element={
          <protectedroute>
            <profilepage />
          </protectedroute>
        }
      />
      <route
        path="/settings"
        element={
          <protectedroute>
            <settingspage />
          </protectedroute>
        }
      />
    </routes>
  );
}

如果受保护的路由数量有限，上面的方法工作得很好，但如果有多个这样的路由，我们就必须把每个都包装起来，这很繁琐。

相反，我们可以使用react router v6的嵌套路由特性，将所有受保护的路由封装在一个布局中。

使用嵌套路由和< outlet />

react router v6中最强大的特性之一是嵌套路由。这个特性允许我们有一个包含其他子路由的路由。我们的大多数布局都与url上的片段相耦合，react router完全支持这一点。

例如，我们可以在<homepage /> 和 <loginpage /> 路由中添加一个父组件 <route />，就像这样:

import { protectedlayout } from "./components/protectedlayout";
import { homelayout } from "./components/homelayout";
// ...

export default function app() {
  return (
    <routes>
      <route element={<homelayout />}>
        <route path="/" element={<homepage />} />
        <route path="/login" element={<loginpage />} />
      </route>

      <route path="/dashboard" element={<protectedlayout />}>
        <route path="profile" element={<profilepage />} />
        <route path="settings" element={<settingspage />} />
      </route>
    </routes>
  );
}

父组件 <route /> 也可以有一个路径，它负责在屏幕上呈现子组件<route />。

当用户导航到 /dashboard/profile 时，路由器将呈现 <profilepage />。为了实现这一点，父路由元素必须有一个 <outlet /> 组件来呈现子元素。outlet 组件使嵌套的 ui 在呈现子路由时可见。

父路由元素还可以具有额外的公共业务逻辑和用户界面。例如，在<protectedlayout /> 组件中，我们已经包含了私有路由逻辑和一个通用导航条，当子路由被呈现时，它将是可见的。

import { navigate, outlet } from "react-router-dom";
import { useauth } from "../hooks/useauth";

export const protectedlayout = () => {
  const { user } = useauth();

  if (!user) {
    return <navigate to="/" />;
  }

  return (
    <div>
      <nav>
        <link to="/settings">settings</link>
        <link to="/profile">profile</link>
      </nav>
      <outlet />
    </div>
  )
};

除了<outlet />组件，我们还可以选择使用 useoutlet 钩子，它的作用是一样的:

import { link, navigate, useoutlet } from "react-router-dom";
// ...
export const protectedlayout = () => {
  const { user } = useauth();
  const outlet = useoutlet();

  if (!user) {
    return <navigate to="/" />;
  }

  return (
    <div>
      <nav>
        <link to="/settings">settings</link>
        <link to="/profile">profile</link>
      </nav>
      {outlet}
    </div>
  );
};

与受保护路由类似，我们不希望通过身份验证的用户访问 /login 路径。让我们在 <homelayout /> 组件中处理它:

import { navigate, outlet } from "react-router-dom";
import { useauth } from "../hooks/useauth";
export const homelayout = () => {
  const { user } = useauth();

  if (user) {
    return <navigate to="/dashboard/profile" />;
  }

  return (
    <div>
      <nav>
        <link to="/">home</link>
        <link to="/login">login</link>
      </nav>
      <outlet />
    </div>
  )
};

结尾

值得花一些时间来更好地理解 react router v6 的工作原理，特别是用户身份验证。

与以前的版本相比，react router v6是一个巨大的改进。它快速、稳定、可靠。除了更容易使用之外，它还有很多新特性，比如<outlets />和一个改进的<route />组件，这大大简化了 react 应用中的路由。

我希望本指南对您有所帮助，希望您对如何使用react router v6处理用户身份验证有了更好的理解。

到此这篇关于使用react router v6 进行身份验证完全指南的文章就介绍到这了,更多相关react router v6验证内容请搜索以前的文章或继续浏览下面的相关文章希望大家以后多多支持！