使用EdgeDB和Drizzle构建书籍笔记应用教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00026/article/details/148391819

使用EdgeDB和Drizzle构建书籍笔记应用教程

edgedb A graph-relational database with declarative schema, built-in migration system, and a next-generation query language 项目地址: https://gitcode.com/gh_mirrors/ed/edgedb

概述

本教程将指导您使用EdgeDB、Drizzle ORM和Next.js构建一个完整的书籍笔记应用。这个应用允许用户记录阅读过的书籍，并为每本书添加个人笔记。我们将采用现代技术栈，结合EdgeDB的强大功能和Drizzle ORM的类型安全特性。

技术栈介绍

EdgeDB

EdgeDB是一个基于PostgreSQL的图式关系数据库，它提供了：

对象-关系映射的直观体验
内置的访问控制和认证功能
强大的EdgeQL查询语言
自动解决N+1查询问题
多语言支持

Drizzle ORM

Drizzle是一个轻量级TypeScript ORM，特点包括：

完全类型安全
简洁的API设计
支持多种数据库方言
自动生成类型定义

Next.js

作为React框架，Next.js提供了：

服务端组件支持
内置路由系统
API路由功能
优秀的开发体验

项目初始化

1. 创建Next.js项目

首先使用create-next-app初始化项目：

npx create-next-app@latest book-notes-app

选择以下配置选项：

TypeScript: 是
ESLint: 是
Tailwind CSS: 是
src目录: 是
App Router: 是

2. 安装EdgeDB依赖

npm i edgedb

3. 初始化EdgeDB项目

npx edgedb project init

数据库模式设计

在dbschema/default.esdl中定义我们的数据模型：

module default {
  type Book {
    required title: str;
    author: str;
    year: int16;
    genre: str;
    read_date: datetime;

    multi notes := .<book[is Note];
  }

  type Note {
    required text: str;
    created_at: datetime {
      default := datetime_current();
    }

    required book: Book;
  }
}

应用迁移：

edgedb migration create
edgedb migrate

集成Drizzle ORM

1. 安装Drizzle

npm i drizzle-orm drizzle-kit

2. 配置Drizzle

创建drizzle.config.ts：

import { defineConfig } from 'drizzle-kit';

export default defineConfig({
  dialect: 'edgedb',
});

3. 拉取数据库模式

npx drizzle-kit pull

4. 配置自动同步

在edgedb.toml中添加钩子：

[hooks]
after_migration_apply = [
  "npx drizzle-kit pull"
]

创建数据库客户端

在src/db/index.ts中设置数据库连接：

import { drizzle } from 'drizzle-orm/edgedb';
import { createClient } from 'edgedb';

import * as schema from '../../drizzle/schema';
import * as relations from '../../drizzle/relations';

const edgedbClient = createClient();

export const db = drizzle({ 
  client: edgedbClient, 
  schema: {
    ...schema,
    ...relations,
  } 
});

// 类型定义
export type Book = typeof schema.book.$inferSelect;
export type NewBook = typeof schema.book.$inferInsert;
export interface BookWithNotes extends Book {
  notes: Note[];
};

export type Note = typeof schema.note.$inferSelect;
export type NewNote = typeof schema.note.$inferInsert;

实现API路由

1. 书籍管理API

app/api/books/route.ts:

import { NextResponse } from 'next/server';
import { db } from '@/src/db';
import { books } from '@/drizzle/schema';

export async function GET() {
  try {
    const allBooks = await db.query.book.findMany({
      with: {
        notes: true,
      },
    });
    return NextResponse.json(allBooks);
  } catch (error) {
    return NextResponse.json(
      { error: '获取书籍列表失败' },
      { status: 500 }
    );
  }
}

export async function POST(request: Request) {
  try {
    const body = await request.json();
    const result = await db.insert(book).values({
      title: body.title,
      author: body.author,
      year: body.year,
      genre: body.genre,
      readDate: new Date(body.read_date),
    }).returning();
    return NextResponse.json(result[0], { status: 201 });
  } catch (error) {
    return NextResponse.json(
      { error: '添加书籍失败' },
      { status: 500 }
    );
  }
}

2. 单个书籍操作API

app/api/books/[id]/route.ts:

export async function GET(
  request: Request,
  { params }: { params: Promise<{ id: string }> }
) {
  const { id } = await params;
  try {
    const requestedBook = await db.query.book.findFirst({
      where: eq(books.id, id),
      with: {
        note: true,
      },
    });
    if (!requestedBook) {
      return NextResponse.json(
        { error: '书籍未找到' },
        { status: 404 }
      );
    }
    return NextResponse.json(requestedBook);
  } catch (error) {
    return NextResponse.json(
      { error: '获取书籍详情失败' },
      { status: 500 }
    );
  }
}

3. 笔记管理API

app/api/books/[id]/notes/route.ts:

export async function POST(
  request: Request,
  { params }: { params: Promise<{ id: string }> }
) {
  const { id } = await params;
  try {
    const body = await request.json();
    const result = await db.insert(note).values({
      text: body.text,
      bookId: id,
    }).returning();
    return NextResponse.json(result[0], { status: 201 });
  } catch (error) {
    return NextResponse.json(
      { error: '添加笔记失败' },
      { status: 500 }
    );
  }
}