Nest.js 实战 (二)：如何使用 Prisma 和连接 PostgreSQL 数据库

news2024/9/20 16:57:16

什么是 Prisma?

Prisma 是一个开源的下一代 ORM。它包含了以下部分：

Prisma Client: 自动生成、类型安全的查询构建器，用于 Node.js 和 TypeScript
Prisma Migrate: 数据迁移系统
Prisma Studio: 查询和编辑数据库中数据的图形化界面

Prisma 客户端可以被用在任何 Node.js（支持的版本）或 TypeScript 后端应用中（包括 Serverless 应用和微服务）。可以是一个 REST API，一个 GraphQL API，一个 gRPC API，或任何其他需要数据库的东西。

安装 Prisma

安装 Prisma CLI 和依赖包

pnpm add @prisma/client
pnpm add prisma -D

初始化 Prisma

npx prisma init

此命令将生成一个基础的 prisma 文件夹和 schema.prisma 文件，文件目录结构如下：

nest-project
├── prisma
│   ├── schema.prisma // 指定数据库连接并包含数据库 schema
└── src

连接数据库

在 schema.prisma 文件中配置数据库：

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

datasource db {
  provider = "postgresql" // 这里使用 postgreSQL
  url      = env("DATABASE_URL")
}

.env 文件中配置数据库连接：

DATABASE_URL="postgresql://postgres:123456@localhost:5432/vue3-admin?schema=public"

定义 Prisma 模型

假设现在我们需要开发一个组织管理模块，而且组织是树形层级结构。

在 schema.prisma 文件中定义 Organization 模型

model Organization {
  id        String     @id @default(uuid()) // 主键
  name      String     @unique // 组织名称
  code      String     @unique // 组织编码
  parentId    String?  
  parent      Organization? @relation(name: "OrgHierarchy", fields: [parentId], references: [id])
  children Organization[] @relation(name: "OrgHierarchy")
  sort       Int // 排序
  description String? // 组织描述
  icon       String? // 组织图标
  createdAt DateTime @default(now()) // 创建时间
  updatedAt DateTime @updatedAt // 更新时间
}

迁移数据库，将上述模型同步到数据库中:

npx prisma migrate dev --name init

此命令会生成 prisma/migrations 目录，文件目录结构如下：

nest-project
├── prisma
│  ├── migrations
│   └── 220240715074827_init
│       └── migration.sql
│   ├── schema.prisma // 指定数据库连接并包含数据库 schema
└── src

每次修改 schema.prisma 后，都需要重新生成 Prisma 客户端：

npx prisma generate

创建 Prisma 模块

在 src/modules/prisma 目录中创建 prisma.service.ts 文件：

 import { Injectable, OnModuleDestroy, OnModuleInit } from '@nestjs/common';
 import { PrismaClient } from '@prisma/client';

 @Injectable()
 export class PrismaService extends PrismaClient implements OnModuleInit, OnModuleDestroy {
   constructor() {
     super();
   }
   async onModuleInit() {
     await this.$connect(); // 在模块初始化时连接到数据库
   }

   async onModuleDestroy() {
     await this.$disconnect(); // 在应用程序关闭时断开与数据库的连
   }
 }

在 src/modules/prisma 目录中创建 prisma.module.ts 文件：

 import { Module } from '@nestjs/common';

 import { PrismaService } from './prisma.service';

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

使用 Prisma 客户端

创建 organazation 模块，新建 organazation.service.ts 文件：

import { Injectable } from '@nestjs/common';

import { PrismaService } from '@/modules/prisma/prisma.service';
import { responseMessage } from '@/utils';

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

  /**
   * @description: 查询组织列表
   */
  async findAll() {
    const result = await this.prisma.organization.findMany();
    return responseMessage({
       records: result,
    });
  }
}

organazation.controller.ts 中使用 OrganazationService :

import { Controller, Get} from '@nestjs/common';
import { OrganazationService } from './organazation.service';

@Controller('organazation')
export class OrganazationController {
 constructor(private readonly organazationService: OrganazationService) { }
 /**
  @description: 查询组织列表
  */
 @Get()
 findAll() {
   return this.organazationService.findAll();
 }
}

organazation.module.ts 文件：

 import { Module } from '@nestjs/common';

 import { PrismaModule } from '@/modules/prisma/prisma.module';

 import { OrganazationController } from './organazation.controller';
 import { OrganazationService } from './organazation.service';

 @Module({
   imports: [PrismaModule],
   controllers: [OrganazationController],
   providers: [OrganazationService],
   exports: [OrganazationService],
 })
 export class OrganazationModule { }

src/app.module.ts 中注册：

 import { Module } from '@nestjs/common';

 import { OrganazationModule } from '@/modules/administrative/organazation/organazation.module';

 @Module({
   imports: [OrganazationModule],
 })
 export class AppModule { }

如果 PrismaModule 需要全局注册，修改 prisma.module.ts，并在 AppModule 中导入：

 import { Global, Module } from '@nestjs/common';

 import { PrismaService } from './prisma.service';

 @Global() // 添加这个装饰器表明这个模块的提供商应该是全局的
 @Module({
   providers: [PrismaService],
   exports: [PrismaService],
 })
 export class PrismaModule { }