在 React/NextJS 中使用 cookies

为了在 NextJS 中使用 cookies，我们需要安装两个 packages。在本文中，我们将会使用 cookie 和 react-cookie。react-cookie 允许我们从客户端设置 cookie，而 cookie 则让我们能从服务器端访问设置的 cookie。运行以下命令安装 packages。

 1npm install react-cookie cookie

Cookie-cutter 功能与 react-cookie 相同，但是包体积更小。

安装了上面的两个 packages 后，现在来设置一个 cookie。通常，我们会在用户成功注册或登录时设置一个 cookie。要在登录时设置一个 cookie，可以遵循下面的例子。

 1// pages/login.js
 2import { useCookies } from "react-cookie"
 3
 4const Login = (
 5
 6) => {
 7  const [setCookie] = useCookies(["user"])
 8
 9  const handleSignIn = async (
10
11) => {
12    try {
13      const response = await yourLoginFunction(username) //执行用以登录的 API 调用
14      const data = response.data
15
16      setCookie("user", JSON.stringify(data), {
17        path: "/",
18        maxAge: 3600, // cookeie 一小时后过期
19        sameSite: true,
20      })
21    } catch (err) {
22      console.log(err)
23    }
24  }
25
26  return (
27    <> <label htmlFor="username"> <input type="text" placeholder="enter username" /> </label> </>
28  )
29}
30
31export default Login

在上面的代码片中，我们调用了 react-cookies 包中的 setCookie 钩子并为其设置了默认值。在我们的示例中，默认值为 user。然后，我们通过调用登录函数，发起一个请求用以用户登录。我们从 API 调用中获取 response 后，将 response.data 字符串化（cookies 应格式化为文本）并存储在 cookie 中。

我们也传递了额外的选项参数到 cookie 中，如：path，确保你的 cookie 在所有的路由中均可访问； maxAge，定义了从设置 cookie 开始到过期的时间，即 cookie 的有效期；sameSite，Samesite 指示 cookie 仅能用于设置了 cookie 的站点——将其设置为 true 非常重要，因为可以避免其在 Firefox 日志出现错误。

为了确保应用中的所有路由都能访问到 cookie，我们需要将 App 组件包装在提供 cookie 的组件内。

在 _app.js 文件中，添加下列代码。

 1// pages/_app.js
 2import { CookiesProvider } from "react-cookie"
 3
 4export default function MyApp({ pageProps }) {
 5  return (
 6    <CookiesProvider> <Component {...pageProps} /> </CookiesProvider>
 7  )
 8}

接下来，我们需要设置一个函数用来检查 cookie 是否存在于服务器上，（存在的话）解析 cookie 并将其作为返回值。新建一个名为 helpers 的文件夹，并在里面添加一个 index.js 文件。

在文件内，添加如下代码。

 1// helpers/index.js
 2
 3import cookie from "cookie"
 4
 5export function parseCookies(req) {
 6  return cookie.parse(req ? req.headers.cookie || "" : document.cookie)
 7}

上面的函数接收一个 request 对象，然后检查 request 的 headers 以找到存储的 cookie。

最后，在渲染请求的路由前，我们将使用组件中的 getInitialProps 来检查用户在服务器端是否存在有效的 cookie。另外，你可以使用 getServerSideProps 作为替代。

 1import { parseCookies } from "../helpers/"
 2
 3export default function HomePage({ data }) {
 4  return (
 5    <> <div> <h1>Homepage </h1> <p>Data from cookie: {data.user}</p> </div> </>
 6  )
 7}
 8
 9HomePage.getInitialProps = async ({ req }) => {
10  const data = parseCookies(req)
11
12if (res) {
13    if (Object.keys(data).length === 0 && data.constructor === Object) {
14      res.writeHead(301, { Location: "/" })
15      res.end()
16    }
17  }
18
19  return {
20    data: data && data,
21  }
22}

在 getInitialProps 中，我们把在 NextJS 服务器端可用的 request 对象（req）传递给 parseCookies 函数。该函数将 cookie 返回给我们，我们就可以将 cookie 作为参数发送给客户端。

我们同样会在服务器端检查 response 对象是否可用。res 对象（response）仅在服务器端可用。如果用户使用 next/link 或 next/router 访问到 HomePage 路由，res 对象将不可用。

通过使用 res 对象，我们可以检查是否存在 cookies 以及它们是否有效。如果 data 是空对象，则意味着 cookie 无效。如果 cookie 无效，我们将重定向用户返回至主页而不是在重定向用户前显示刷新的主页。

注意到，后续使用 next/link 或 next/router 以及包含 getInitialProps 的页面请求会在客户端被完成。也就是说，对于通过使用 next/link 或 next/router 访问的其他路由，cookie 会从客户端提取而不是服务器端。

这样，你可以在应用中存储用户的 cookies，过期无效 cookies 以及很好地保证应用的安全。

在 React/NextJS 中使用 cookies

设置 cookie

赋予应用访问 Cookie 的权限

设置解析 cookie 的函数

在组件中访问 cookie