Auth.js | Installation | 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。这是一个随机值，用于加密令牌（tokens）和电子邮件验证哈希值。(详情请参见部署章节）。你可以通过运行官方提供的 Auth.js 命令行工具自动生成一个：

npx auth secret

上述命令还会将生成的随机值添加到您的 .env 文件中，并遵守所用框架约定（例如：Next.js’ 是 .env.local 文件）。

配置

Next, create the Auth.js config file and object. This is where you can control the behaviour of the library and specify custom authentication logic, adapters, etc. We recommend all frameworks to create an auth.ts file in the project. In this file we’ll pass in all the options to the framework specific initialization function and then export the route handler(s), signin and signout methods, and more.

其实你可以给这个文件起任何你想要的名字，也可以把它放在任何你喜欢的地方，但上面这些都是我们经过实践所形成的惯例。

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

./auth.ts

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

在 /app/api/auth/[...nextauth]/route.ts 文件中添加路由处理程序。

💡

该文件必须是 app/ 路由器的路由处理程序，但应用程序的其他部分可以放在 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 目录下新建一个 plugin@auth.ts 文件，内容如下。

/src/routes/plugin@auth.ts

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 方法重新导出（Re-export）。

./src/hooks.server.ts

export { handle } from "./auth"

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

./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 数组。

迁移到 Better Auth 身份验证

安装 Auth.js

环境设置

配置

设置身份验证方法

关于 Auth.js

下载

致谢

友链