实践：在 NestJS 和 GraphQL 中使用 Prisma ORM

引言

随着前端技术的不断发展，前后端分离的开发模式越来越受到欢迎。在这种开发模式下，前端负责 UI 界面的展示和交互逻辑，而后端则负责数据的存储和处理。在后端开发中，ORM（Object Relational Mapping）技术的应用越来越广泛，其中 Prisma ORM 是一种比较新的 ORM 技术，它可以与多种语言和框架集成，如 NestJS、GraphQL、React 等，本文将介绍在 NestJS 和 GraphQL 中如何使用 Prisma ORM。

简介

Prisma ORM 是一款现代化的 ORM 工具，它使用 TypeScript 编写，可以与多种数据库集成，如 MySQL、PostgreSQL、MongoDB 等。Prisma ORM 提供了类型安全、自动化数据迁移等特性，可以帮助开发者更轻松地进行数据管理。

NestJS 是一款基于 TypeScript 的后端框架，它提供了模块化、依赖注入等特性，可以帮助开发者更好地组织代码。GraphQL 是一种新兴的 API 查询语言，它可以帮助客户端精确地获取需要的数据，避免了传统 RESTful API 中的“过度获取”问题。

安装和配置

在使用 Prisma ORM 前，我们需要先安装和配置它。首先，我们需要在项目中安装 Prisma CLI：

npm install --save-dev prisma

然后，我们可以使用 Prisma CLI 初始化一个 Prisma 项目：

npx prisma init

初始化完成后，我们需要在 prisma/schema.prisma 文件中定义数据模型，例如：

// javascriptcn.com 代码示例
datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model User {
  id       Int      @id @default(autoincrement())
  email    String   @unique
  name     String?
  password String?
}

在这个数据模型中，我们定义了一个名为 User 的数据模型，它包含了 id、email、name、password 四个字段。其中，@id 表示该字段为主键，@default(autoincrement()) 表示该字段自增，@unique 表示该字段唯一。

定义好数据模型后，我们需要使用 Prisma CLI 来生成 Prisma Client：

npx prisma generate

生成的 Prisma Client 代码将保存在 node_modules/.prisma/client 目录下，我们可以在代码中使用该 Client 来操作数据库。

在 NestJS 中使用 Prisma ORM

在 NestJS 中使用 Prisma ORM 相对简单，我们只需要在 app.module.ts 中导入 Prisma Client 并将其注入到需要使用的 Service 中即可。例如：

import { Module } from '@nestjs/common';
import { PrismaService } from './prisma.service';

@Module({
  providers: [PrismaService],
  exports: [PrismaService],
})
export class PrismaModule {}

// javascriptcn.com 代码示例
import { Injectable } from '@nestjs/common';
import { PrismaClient } from '@prisma/client';

@Injectable()
export class PrismaService extends PrismaClient {
  constructor() {
    super();
  }
}

在上面的代码中，我们创建了一个名为 PrismaService 的 Service，并将其注入到了 PrismaModule 中。在 PrismaService 中，我们继承了 PrismaClient，并在构造函数中调用了父类的构造函数，以创建一个 Prisma Client 实例。

然后，在其他需要使用 Prisma ORM 的 Service 中，我们可以通过依赖注入的方式来使用 PrismaService，例如：

// javascriptcn.com 代码示例
import { Injectable } from '@nestjs/common';
import { PrismaService } from '../prisma/prisma.service';
import { User } from '@prisma/client';

@Injectable()
export class UserService {
  constructor(private prisma: PrismaService) {}

  async createUser(data: { email: string; name?: string; password?: string }): Promise<User> {
    return this.prisma.user.create({ data });
  }

  async findUserByEmail(email: string): Promise<User | null> {
    return this.prisma.user.findUnique({ where: { email } });
  }

  async updateUser(id: number, data: { name?: string; password?: string }): Promise<User> {
    return this.prisma.user.update({ where: { id }, data });
  }

  async deleteUser(id: number): Promise<User> {
    return this.prisma.user.delete({ where: { id } });
  }
}

在上面的代码中，我们创建了一个名为 UserService 的 Service，它依赖于 PrismaService。在 UserService 中，我们定义了一些用于操作 User 数据的方法，例如 createUser、findUserByEmail、updateUser、deleteUser 等。这些方法中，我们都使用了 PrismaService 提供的方法来操作数据库。

在 GraphQL 中使用 Prisma ORM

在 GraphQL 中使用 Prisma ORM 也相对简单，我们只需要在 Resolver 中使用 Prisma Client 就可以了。例如：

// javascriptcn.com 代码示例
import { Resolver, Query, Args, Mutation } from '@nestjs/graphql';
import { PrismaService } from '../prisma/prisma.service';
import { User } from '@prisma/client';

@Resolver('User')
export class UserResolver {
  constructor(private prisma: PrismaService) {}

  @Query()
  async user(@Args('id') id: number): Promise<User | null> {
    return this.prisma.user.findUnique({ where: { id } });
  }

  @Mutation()
  async createUser(
    @Args('email') email: string,
    @Args('name') name: string,
    @Args('password') password: string,
  ): Promise<User> {
    return this.prisma.user.create({ data: { email, name, password } });
  }

  @Mutation()
  async updateUser(
    @Args('id') id: number,
    @Args('name') name: string,
    @Args('password') password: string,
  ): Promise<User> {
    return this.prisma.user.update({ where: { id }, data: { name, password } });
  }

  @Mutation()
  async deleteUser(@Args('id') id: number): Promise<User> {
    return this.prisma.user.delete({ where: { id } });
  }
}

在上面的代码中，我们创建了一个名为 UserResolver 的 Resolver，并在其中使用了 PrismaService 来操作数据库。在 Resolver 中，我们定义了一些 Query 和 Mutation，例如 user、createUser、updateUser、deleteUser 等。在这些 Query 和 Mutation 中，我们都使用了 PrismaService 提供的方法来操作数据库。

总结

使用 Prisma ORM 可以帮助开发者更轻松地进行数据管理，而在 NestJS 和 GraphQL 中使用 Prisma ORM 也非常简单。在本文中，我们介绍了如何在 NestJS 和 GraphQL 中使用 Prisma ORM，并提供了相应的示例代码。希望本文能够对大家有所帮助。

来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65878ed9eb4cecbf2dccce63