Auth.js | 安装 - Auth.js 中文

安装 Auth.js

首先安装适合您框架的包。

npm install next-auth@beta

pnpm add next-auth@beta

yarn add next-auth@beta

bun add next-auth@beta

npm run qwik add auth

pnpm run qwik add auth

yarn qwik add auth

bun run qwik add auth

npm install @auth/sveltekit

pnpm add @auth/sveltekit

yarn add @auth/sveltekit

bun add @auth/sveltekit

npm install @auth/express

pnpm add @auth/express

yarn add @auth/express

bun add @auth/express

安装 @auth/core 是不必要的，作为用户，您永远不需要与 @auth/core 交互。

设置环境

唯一必不可少的环境变量是 AUTH_SECRET。这是一个随机值，库使用它来加密令牌和电子邮件验证哈希。（有关更多信息，请参阅部署）。您可以通过官方 Auth.js CLI 运行来生成一个

npx auth secret

这也会将它添加到您的 .env 文件中，并尊重框架约定（例如：Next.js 的 .env.local）。

配置

接下来，创建 Auth.js 配置文件和对象。在这里，您可以控制库的行为并指定自定义身份验证逻辑、适配器等。我们建议所有框架在项目中创建一个 auth.ts 文件。在这个文件中，我们将所有选项传递给框架特定的初始化函数，然后导出路由处理程序、登录和登出方法等。

您可以随意命名此文件，并将其放在任何您喜欢的位置，这些只是我们想出来的约定。

首先，在您的应用程序的根目录中创建一个新的 auth.ts 文件，内容如下。

./auth.ts

import NextAuth from "next-auth"
 
export const { handlers, signIn, signOut, auth } = NextAuth({
  providers: [],
})

在 /app/api/auth/[...nextauth]/route.ts 下添加一个路由处理程序。

💡

此文件必须是 App Router 路由处理程序，但是，如果您愿意，应用程序的其余部分可以保留在 page/ 下。

./app/api/auth/[...nextauth]/route.ts

import { handlers } from "@/auth" // Referring to the auth.ts we just created
export const { GET, POST } = handlers

添加可选的中介软件以保持会话处于活动状态，这将在每次调用时更新会话过期时间。

./middleware.ts

export { auth as middleware } from "@/auth"

首先，在您的 src/routes 目录中创建一个新的 [email protected] 文件，内容如下。

/src/routes/[email protected]

import { QwikAuth$ } from "@auth/qwik"
 
export const { onRequest, useSession, useSignIn, useSignOut } = QwikAuth$(
  () => ({
    providers: [...],
  })
)

首先，在您的 src/ 目录中创建一个新的 auth.ts 文件，内容如下。

./src/auth.ts

import { SvelteKitAuth } from "@auth/sveltekit"
 
export const { handle } = SvelteKitAuth({
  providers: [],
})

在 SvelteKit 的 src/hooks.server.ts 文件中重新导出 handle 方法。

./src/hooks.server.ts

export { handle } from "./auth"

该处理函数在我们的 event.locals 上添加了一个 auth() 方法，该方法在任何 +layout.server.ts 或 +page.server.ts 文件中都可用。因此，我们可以在我们的 load 函数中像这样访问会话。

./src/routes/+layout.server.ts

import type { LayoutServerLoad } from "./$types"
 
export const load: LayoutServerLoad = async (event) => {
  const session = await event.locals.auth()
 
  return {
    session,
  }
}

首先导入 ExpressAuth 并将处理程序添加到身份验证路由。

./src/routes/auth.route.ts

import { ExpressAuth } from "@auth/express"
import express from "express"
 
const app = express()
 
// If your app is served through a proxy
// trust the proxy to allow us to read the `X-Forwarded-*` headers
app.set("trust proxy", true)
app.use("/auth/*", ExpressAuth({ providers: [] }))

请注意，这会创建 Auth.js API，但不会保护资源。要了解更多信息，请继续访问保护资源。

设置身份验证方法

有了这些，基本设置就完成了！接下来，我们将设置第一个身份验证方法并填写 providers 数组。

迁移到 NextAuth.js v5 身份验证

安装 Auth.js

设置环境

配置

设置身份验证方法

关于 Auth.js

下载

鸣谢