NestJS Prisma CRUD 项目教程

NestJS Prisma CRUD 项目教程

1. 项目介绍

nestjs-prisma-crud 是一个用于 NestJS 和 Prisma ORM 的 CRUD 工具包。它旨在简化 REST API 的开发，提供了一些常见的功能，如高级客户端侧的连接、排序、过滤和分页，以及服务器侧的验证和访问控制。该项目灵感来自于 @nestjsx/crud，并提供了一些额外的功能，如原子操作和事务支持。

2. 项目快速启动

安装依赖

首先，确保你已经安装了 NestJS 和 Prisma。然后，通过以下命令安装 nestjs-prisma-crud 和 nestjs-prisma-crud-schematics：

npm i nestjs-prisma-crud --save
npm i nestjs-prisma-crud-schematics --save-dev

生成 CRUD 模块

使用以下命令生成一个 CRUD 模块：

nest g -c nestjs-prisma-crud-schematics crud-resource post

设置服务和控制器

在生成的 post.service.ts 中，设置你的服务：

import { Injectable } from '@nestjs/common';
import { PrismaCrudService } from 'nestjs-prisma-crud';

@Injectable()
export class PostService extends PrismaCrudService {
  constructor() {
    super({
      model: 'post',
      allowedJoins: ['comments', 'author'],
    });
  }
}

在 post.controller.ts 中，设置你的控制器：

import { Controller, Get, Query } from '@nestjs/common';
import { PostService } from './post.service';

@Controller('post')
export class PostController {
  constructor(private readonly postService: PostService) {}

  @Get()
  async findMany(@Query('crudQuery') crudQuery: string) {
    const matches = await this.postService.findMany(crudQuery);
    return matches;
  }
}

3. 应用案例和最佳实践

应用案例

nestjs-prisma-crud 适用于需要快速构建 REST API 的场景。例如，一个博客系统可能需要对文章、评论和用户进行 CRUD 操作。使用 nestjs-prisma-crud，你可以快速生成这些模块，并专注于业务逻辑的实现。

最佳实践

1. 模块化设计：将不同的 CRUD 操作拆分为不同的模块，以便于维护和扩展。
2. 访问控制：使用 @AccessPolicy 装饰器来实现访问控制，确保只有授权用户可以执行某些操作。
3. 错误处理：在控制器中添加错误处理逻辑，以确保 API 的健壮性。

4. 典型生态项目

NestJS

NestJS 是一个用于构建高效、可扩展的 Node.js 服务器端应用程序的框架。它使用现代 JavaScript，基于 TypeScript 构建，并结合了 OOP（面向对象编程）、FP（函数式编程）和 FRP（函数式响应编程）的元素。

Prisma

Prisma 是一个现代的数据库工具，它提供了一种声明式的方式来定义数据库模式，并自动生成类型安全的查询构建器。Prisma 支持多种数据库，包括 PostgreSQL、MySQL 和 SQLite。

TypeScript

TypeScript 是 JavaScript 的一个超集，它添加了可选的静态类型和基于类的面向对象编程。TypeScript 提供了更好的工具支持，并且在大型项目中更易于维护。

通过结合这些工具，nestjs-prisma-crud 提供了一个强大的开发环境，帮助开发者快速构建和维护 REST API。