React / 系统课时

使用 ORM 访问数据

使用 ORM 访问数据

完成数据库连接后,业务代码应通过模型 API 读写数据,而不是在每个接口中手工拼接 SQL。本课使用 Prisma Client 实现用户的新增、列表查询、修改与删除,并说明唯一约束和不存在记录的处理边界。

学习目标

  • 使用 Prisma Client 完成基础 CRUD
  • 通过 select 控制接口返回字段
  • 识别唯一键冲突和记录不存在等边界

准备用户模型

在 prisma/schema.prisma 中定义最小用户模型:

prisma
generator client {
  provider = "prisma-client"
  output   = "../generated/prisma"
}

datasource db {
  provider = "postgresql"
}

model User {
  id        Int      @id @default(autoincrement())
  email     String   @unique
  name      String
  createdAt DateTime @default(now())
  updatedAt DateTime @updatedAt
}

生效行为:email 由数据库保证唯一,主键自动递增,更新时间由 Prisma 自动维护。

单独练习本课时,需要已安装 Prisma ORM 7、设置 DATABASE_URL,并创建连接模块:

ts
// lib/prisma.ts
import { PrismaPg } from "@prisma/adapter-pg";
import { PrismaClient } from "@/generated/prisma/client";

const globalForPrisma = globalThis as unknown as {
  prisma: PrismaClient | undefined;
};

function createClient() {
  const connectionString = process.env.DATABASE_URL;

  if (!connectionString) {
    throw new Error("缺少 DATABASE_URL");
  }

  return new PrismaClient({
    adapter: new PrismaPg({ connectionString }),
  });
}

export const prisma =
  globalForPrisma.prisma ?? createClient();

if (process.env.NODE_ENV !== "production") {
  globalForPrisma.prisma = prisma;
}

生效行为:Route Handler 可以通过 @/lib/prisma 复用同一个类型安全客户端。应用初始迁移并重新生成客户端:

bash
npx prisma migrate dev --name init
npx prisma generate

预期结果:

text
Your database is now in sync with your schema.
Generated Prisma Client to ./generated/prisma

实现新增与列表查询

集合路由负责创建用户和读取最近用户。select 明确排除未来可能加入的密码摘要等敏感字段。

ts
// app/api/users/route.ts
import { prisma } from "@/lib/prisma";

export async function POST(request: Request) {
  const input = (await request.json()) as {
    email?: string;
    name?: string;
  };

  const email = input.email?.trim().toLowerCase();
  const name = input.name?.trim();

  if (!email || !name) {
    return Response.json(
      { code: "INVALID_INPUT", message: "email 和 name 必填", data: null },
      { status: 400 },
    );
  }

  const user = await prisma.user.create({
    data: { email, name },
    select: {
      id: true,
      email: true,
      name: true,
      createdAt: true,
    },
  });

  return Response.json(
    { code: "OK", message: "创建成功", data: user },
    { status: 201 },
  );
}

export async function GET() {
  const users = await prisma.user.findMany({
    orderBy: { createdAt: "desc" },
    take: 20,
    select: {
      id: true,
      email: true,
      name: true,
      createdAt: true,
    },
  });

  return Response.json({
    code: "OK",
    message: "查询成功",
    data: users,
  });
}

生效行为:POST 创建一条用户记录,GET 最多返回最近 20 条记录,且只暴露显式选择的字段。

实现修改与删除

动态路由 app/api/users/[id]/route.ts 处理单个用户。当前 Next.js Route Handler 的路径参数需要先 await。

ts
import { prisma } from "@/lib/prisma";

type RouteContext = {
  params: Promise<{ id: string }>;
};

function parseId(value: string) {
  const id = Number(value);
  return Number.isInteger(id) && id > 0 ? id : null;
}

export async function PATCH(
  request: Request,
  context: RouteContext,
) {
  const { id: idText } = await context.params;
  const id = parseId(idText);
  const input = (await request.json()) as { name?: string };
  const name = input.name?.trim();

  if (!id || !name) {
    return Response.json(
      { code: "INVALID_INPUT", message: "id 和 name 不合法", data: null },
      { status: 400 },
    );
  }

  const user = await prisma.user.update({
    where: { id },
    data: { name },
    select: { id: true, email: true, name: true },
  });

  return Response.json({
    code: "OK",
    message: "更新成功",
    data: user,
  });
}

export async function DELETE(
  _request: Request,
  context: RouteContext,
) {
  const { id: idText } = await context.params;
  const id = parseId(idText);

  if (!id) {
    return Response.json(
      { code: "INVALID_ID", message: "id 不合法", data: null },
      { status: 400 },
    );
  }

  await prisma.user.delete({ where: { id } });

  return new Response(null, { status: 204 });
}

生效行为:PATCH 只更新姓名,DELETE 删除指定主键。生产代码应捕获 Prisma 的唯一键冲突和记录不存在错误,分别转换为 409 与 404。

验证 CRUD

依次执行命令,其中 <PORT> 替换为实际端口,后续 <ID> 使用创建接口返回的主键:

bash
curl -X POST "http://localhost:<PORT>/api/users" \
  -H "Content-Type: application/json" \
  -d '{"email":"ada@example.com","name":"Ada"}'
curl "http://localhost:<PORT>/api/users"
curl -X PATCH "http://localhost:<PORT>/api/users/<ID>" \
  -H "Content-Type: application/json" \
  -d '{"name":"Ada Lovelace"}'
curl -i -X DELETE "http://localhost:<PORT>/api/users/<ID>"

预期结果中的 <ID> 和 <TIME> 为数据库实际值:

text
{"code":"OK","message":"创建成功","data":{"id":<ID>,"email":"ada@example.com","name":"Ada","createdAt":"<TIME>"}}
{"code":"OK","message":"查询成功","data":[{"id":<ID>,"email":"ada@example.com","name":"Ada","createdAt":"<TIME>"}]}
{"code":"OK","message":"更新成功","data":{"id":<ID>,"email":"ada@example.com","name":"Ada Lovelace"}}
HTTP/1.1 204 No Content
按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

使用 ORM 访问数据

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通