Payload Better Auth 项目安装与配置指南

项目概述

Payload Better Auth 是一个现代化的身份验证解决方案，为开发者提供了简单易用且功能强大的身份验证系统。它支持多种数据库、多种身份验证方式，并能轻松集成到各种前端框架中。

安装步骤

1. 安装核心包

首先需要通过包管理器安装核心包：

npm install better-auth

重要提示：如果你的项目采用前后端分离架构，需要在客户端和服务端都安装此包。

2. 配置环境变量

创建 .env 文件并添加以下环境变量：

1. 安全密钥 - 用于加密和哈希生成的随机值

BETTER_AUTH_SECRET=your-secret-key-here

2. 基础URL（可选）

BETTER_AUTH_URL=http://localhost:3000

建议使用强密码生成工具创建安全密钥，确保其长度至少为32个字符。

3. 创建Auth实例

在项目中创建 auth.ts 文件（可放置在以下位置）：

• 项目根目录
• lib/ 或 utils/ 文件夹
• 或嵌套在 src/、app/、server/ 目录下

基本配置示例：

import { betterAuth } from "better-auth";

export const auth = betterAuth({
    // 配置项将在此添加
})

4. 数据库配置

Payload Better Auth 支持多种数据库解决方案：

原生支持数据库

• SQLite

import Database from "better-sqlite3";

export const auth = betterAuth({
    database: new Database("./sqlite.db"),
})

• PostgreSQL

import { Pool } from "pg";

export const auth = betterAuth({
    database: new Pool({
        connectionString: process.env.DATABASE_URL
    })
})

• MySQL

import { createPool } from "mysql2/promise";

export const auth = betterAuth({
    database: createPool({
        uri: process.env.DATABASE_URL
    })
})

适配器支持

对于使用ORM的项目，提供了多种适配器：

• Prisma适配器

import { prismaAdapter } from "better-auth/adapters/prisma";
import { PrismaClient } from "@prisma/client";

const prisma = new PrismaClient();
export const auth = betterAuth({
    database: prismaAdapter(prisma, {
        provider: "postgresql" // 或其他数据库类型
    }),
});

• Drizzle适配器

import { drizzleAdapter } from "better-auth/adapters/drizzle";

export const auth = betterAuth({
    database: drizzleAdapter(db, {
        provider: "pg"
    })
});

• MongoDB适配器

import { mongodbAdapter } from "better-auth/adapters/mongodb";

export const auth = betterAuth({
    database: mongodbAdapter(client)
});

5. 数据库表创建

Payload Better Auth 提供了CLI工具来管理数据库表：

1. 生成迁移文件

npx @better-auth/cli generate

2. 直接执行迁移

npx @better-auth/cli migrate

6. 配置认证方法

支持多种认证方式：

export const auth = betterAuth({
    emailAndPassword: {
        enabled: true
    },
    socialProviders: {
       github: {
        clientId: process.env.GITHUB_CLIENT_ID,
        clientSecret: process.env.GITHUB_CLIENT_SECRET,
       }
    },
});

还支持通过插件扩展更多认证方式，如Passkey、用户名登录、魔法链接等。

7. 设置API路由处理器

根据你的后端框架配置路由处理器：

Next.js示例

import { toNextJsHandler } from "better-auth/next-js";

export const { POST, GET } = toNextJsHandler(auth);

Express示例

import { toNodeHandler } from "better-auth/node";

app.all("/api/auth/*", toNodeHandler(auth));

8. 创建客户端实例

根据前端框架创建客户端：

React示例

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

export const authClient = createAuthClient({
    baseURL: "http://localhost:3000"
})

Vue示例

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

export const authClient = createAuthClient({
    baseURL: "http://localhost:3000"
})

最佳实践

1. 安全密钥：务必使用强密码生成工具创建安全密钥，并妥善保管
2. 环境隔离：开发、测试和生产环境使用不同的密钥和配置
3. 错误处理：实现全面的错误处理机制，特别是对于认证失败的情况
4. 日志记录：记录关键认证事件，便于审计和故障排查
5. 定期更新：保持库和依赖项的更新，以获取最新的安全修复

总结

通过以上步骤，你已经成功在项目中集成了Payload Better Auth系统。这个现代化的身份验证解决方案将为你的应用提供安全、灵活且易于维护的认证功能。接下来，你可以开始实现具体的用户认证流程，如注册、登录、密码重置等功能。