Better Auth 项目安装与配置指南

前言

Better Auth 是一个现代化的身份验证解决方案，为开发者提供了简单易用且功能强大的认证系统。本文将详细介绍如何在项目中安装和配置 Better Auth，帮助开发者快速搭建安全可靠的用户认证体系。

安装步骤

1. 安装依赖包

首先，我们需要将 Better Auth 添加到项目中：

npm install better-auth

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

2. 配置环境变量

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

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

BETTER_AUTH_SECRET=your_secure_secret_here

2. 基础URL：设置应用的基础URL

BETTER_AUTH_URL=http://localhost:3000

建议使用强密码生成器创建安全密钥，确保认证系统的安全性。

3. 创建 Auth 实例

在项目中创建 auth.ts 文件，通常位于以下目录之一：

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

文件内容示例：

import { betterAuth } from "better-auth";

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

4. 数据库配置

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({
        // 连接配置
    })
})

• MySQL：

import { createPool } from "mysql2/promise";

export const auth = betterAuth({
    database: createPool({
        // 连接配置
    })
})

ORM 适配器

• Prisma 适配器：

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

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

• Drizzle 适配器：

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

export const auth = betterAuth({
    database: drizzleAdapter(db, {
        provider: "pg", // 或其他数据库类型
    })
});

5. 创建数据库表

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,
        },
    },
});

7. 设置路由处理器

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

Next.js 示例

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

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

Express 示例

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

const app = express();
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"
})

总结

通过以上步骤，你已经成功在项目中集成了 Better Auth 认证系统。接下来可以开始实现用户注册、登录等核心功能。Better Auth 的设计理念是简单易用且高度可定制，开发者可以根据项目需求灵活配置各种认证方式。

最佳实践建议：

1. 生产环境务必使用强密码作为安全密钥
2. 定期备份数据库
3. 根据业务需求选择合适的认证方式组合
4. 充分利用类型提示提高开发效率

希望本指南能帮助你顺利开始使用 Better Auth 构建安全可靠的用户认证系统。