从 Auth.js 迁移到 Better Auth

创建 Better Auth 实例

在开始迁移过程之前，在您的项目中设置 Better Auth。请按照安装指南开始。

例如，如果您使用 GitHub OAuth 提供程序，以下是 auth.ts 文件的对比。

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

创建客户端实例

此客户端实例包含一组用于与 Better Auth 服务端实例交互的函数。有关更多信息，请参阅客户端文档。

import { createAuthClient } from "better-auth/react"

export const authClient = createAuthClient()

更新路由处理程序

将 /app/api/auth/[...nextauth] 文件夹重命名为 /app/api/auth/[...all]，以避免混淆。然后，按如下方式更新 route.ts 文件：

import { handlers } from "@/lib/auth"

export const { GET, POST } = handlers

会话管理

在本节中，我们将了解 Better Auth 与 Auth.js 相比如何管理会话。有关更多信息，请参阅会话管理文档。

客户端

登录

以下是在登录用户时，Auth.js 与 Better Auth 的区别。例如，使用 GitHub OAuth 提供程序：

"use client"

import { signIn } from "next-auth/react"

signIn("github")

登出

以下是在登出用户时，Auth.js 与 Better Auth 的区别。

"use client"

import { signOut } from "next-auth/react"

signOut()

获取会话

以下是在获取当前活跃会话时，Auth.js 与 Better Auth 的区别。

"use client"

import { useSession } from "next-auth/react"

const { data, status, update } = useSession()

服务端

登录

以下是在登录用户时，Auth.js 与 Better Auth 的区别。例如，使用 GitHub OAuth 提供程序：

import { signIn } from "@/lib/auth"

await signIn("github")

登出

以下是在登出用户时，Auth.js 与 Better Auth 的区别。

import { signOut } from "@/lib/auth"

await signOut()

获取会话

以下是在获取当前活跃会话时，Auth.js 与 Better Auth 的区别。

import { auth } from "@/lib/auth";

const session = await auth()

保护资源

代理（中间件）不适用于缓慢的数据获取。虽然代理对于基于权限的重定向等乐观检查可能很有用，但我们建议在每个页面或路由上处理身份验证检查，而不是在代理或布局中。以下是使用 Better Auth 保护资源的基本示例。

Auth.js 提供了使用代理（中间件）的方法，但我们建议在页面或路由本身上处理身份验证检查，而不是在代理或布局中。以下是使用 Better Auth 保护资源的基本示例。

"use client";

import { authClient } from "@/lib/auth-client";
import { redirect } from "next/navigation";

const DashboardPage = () => {
  const { data, error, isPending } = authClient.useSession();

  if (isPending) {
    return <div>Pending</div>;
  }
  if (!data || error) {
    redirect("/sign-in");
  }

  return (
    <div>
      <h1>Welcome {data.user.name}</h1>
    </div>
  );
};

export default DashboardPage;

数据库模型

Auth.js 和 Better Auth 都提供无状态（JWT）和数据库会话策略。如果您之前在 Auth.js 中使用了数据库会话策略并计划继续在 Better Auth 中使用它，您还需要迁移数据库。

就像 Auth.js 有数据库模型一样，Better Auth 也有核心架构。在本节中，我们将对两者进行比较并探索它们之间的差异。

用户 -> 用户

会话 -> 会话

账户 -> 账户

验证令牌 -> 验证

对比

表格: 用户

• name、email 和 emailVerified 在 Better Auth 中是必填项，而在 Auth.js 中是可选的
• Better Auth 中 emailVerified 使用布尔值，而 Auth.js 中使用时间戳
• Better Auth 包含 createdAt 和 updatedAt 时间戳

表格: 会话

• Better Auth 使用 token 而不是 sessionToken
• Better Auth 使用 expiresAt 而不是 expires
• Better Auth 包含 ipAddress 和 userAgent 字段
• Better Auth 包含 createdAt 和 updatedAt 时间戳

表格: 账户

• Better Auth 使用 camelCase 命名（例如，refreshToken 与 refresh_token）
• Better Auth 使用 id 作为本地账户记录，并使用唯一的 issuer 与 accountId 组合作为外部身份标识
• Better Auth 使用 providerId 而不是 provider
• Better Auth 包含用于令牌管理的 accessTokenExpiresAt 和 refreshTokenExpiresAt
• Better Auth 包含 password 字段，以支持内置凭据身份验证
• Better Auth 没有 type 字段，因为它由 providerId 决定
• Better Auth 移除了 token_type 和 session_state 字段
• Better Auth 包含 createdAt 和 updatedAt 时间戳

表格: 验证令牌 -> 验证

• Better Auth 使用 Verification 表代替 VerificationToken
• Better Auth 使用单一主键 id 而不是复合主键
• Better Auth 使用 value 而不是 token 以支持各种验证类型
• Better Auth 使用 expiresAt 而不是 expires
• Better Auth 包含 createdAt 和 updatedAt 时间戳

自定义

您可能已经扩展了 Auth.js 的数据库模型或实现了其他逻辑。Better Auth 允许您以类型安全的方式自定义核心架构。您还可以定义数据库操作的生命周期期间的自定义逻辑。更多详细信息，请参见概念 - 数据库。