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

本文涉及的产品
云原生数据库 PolarDB MySQL 版,通用型 2核4GB 50GB
云原生数据库 PolarDB PostgreSQL 版,标准版 2核4GB 50GB
简介: 这篇文章介绍了什么是Prisma以及如何在Node.js和TypeScript后端应用中使用它。Prisma是一个开源的下一代ORM,包含PrismaClient、PrismaMigrate、PrismaStudio等部分。文章详细叙述了安装PrismaCLI和依赖包、初始化Prisma、连接数据库、定义Prisma模型、创建Prisma模块的过程,并对比了Prisma和Sequelize在Nest.js中的使用体验,认为Prisma更加便捷高效,没有繁琐的配置。

什么是 Prisma?

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

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

安装 Prisma

  1. 安装 Prisma CLI 和依赖包
    pnpm add @prisma/client
    pnpm add prisma -D
    
  2. 初始化 Prisma
    npx prisma init
    
    此命令将生成一个基础的 prisma 文件夹和 schema.prisma 文件,文件目录结构如下:
    nest-project
    ├── prisma
    │   ├── schema.prisma // 指定数据库连接并包含数据库 schema
    └── src
    

连接数据库

  1. schema.prisma 文件中配置数据库:

    generator client {
    provider = "prisma-client-js"
    }
    
    datasource db {
    provider = "postgresql" // 这里使用 postgreSQL
    url      = env("DATABASE_URL")
    }
    
  2. .env 文件中配置数据库连接:

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

定义 Prisma 模型

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

  1. 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 // 更新时间
    }
    
  2. 迁移数据库,将上述模型同步到数据库中:
    npx prisma migrate dev --name init
    
    此命令会生成 prisma/migrations 目录,文件目录结构如下:
    nest-project
    ├── prisma
    │  ├── migrations
    │   └── 220240715074827_init
    │       └── migration.sql
    │   ├── schema.prisma // 指定数据库连接并包含数据库 schema
    └── src
    
  3. 每次修改 schema.prisma 后,都需要重新生成 Prisma 客户端:
    npx prisma generate
    

创建 Prisma 模块

  1. 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(); // 在应用程序关闭时断开与数据库的连
    }
    }
    
  2. 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 客户端

  1. 创建 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,
     });
    }
    }
    
  2. 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();
    }
    }
    
  3. 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 {
         
          }
    
  4. src/app.module.ts 中注册:

    import {
         
          Module } from '@nestjs/common';
    
    import {
         
          OrganazationModule } from '@/modules/administrative/organazation/organazation.module';
    
    @Module({
         
         
    imports: [OrganazationModule],
    })
    export class AppModule {
         
          }
    
  5. 如果 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 {
         
          }
    

最终效果

cvkq7xv8ay9ujsczss3w135vl5ud83e0.png

总结

说一下我的使用感受,相比之前用的 Sequelize,感觉在 Nest.js 中使用 Prisma 更加便捷高效,没有繁琐的配置。

Github 仓库Vue3-Admin

相关实践学习
使用PolarDB和ECS搭建门户网站
本场景主要介绍基于PolarDB和ECS实现搭建门户网站。
阿里云数据库产品家族及特性
阿里云智能数据库产品团队一直致力于不断健全产品体系,提升产品性能,打磨产品功能,从而帮助客户实现更加极致的弹性能力、具备更强的扩展能力、并利用云设施进一步降低企业成本。以云原生+分布式为核心技术抓手,打造以自研的在线事务型(OLTP)数据库Polar DB和在线分析型(OLAP)数据库Analytic DB为代表的新一代企业级云原生数据库产品体系, 结合NoSQL数据库、数据库生态工具、云原生智能化数据库管控平台,为阿里巴巴经济体以及各个行业的企业客户和开发者提供从公共云到混合云再到私有云的完整解决方案,提供基于云基础设施进行数据从处理、到存储、再到计算与分析的一体化解决方案。本节课带你了解阿里云数据库产品家族及特性。
相关文章
|
1月前
|
自然语言处理 JavaScript 前端开发
深入理解JavaScript中的闭包:原理与实战
【10月更文挑战第12天】深入理解JavaScript中的闭包:原理与实战
|
13天前
|
关系型数据库 分布式数据库 数据库
PostgreSQL+Citus分布式数据库
PostgreSQL+Citus分布式数据库
45 15
|
21天前
|
SQL 关系型数据库 数据库
PostgreSQL性能飙升的秘密:这几个调优技巧让你的数据库查询速度翻倍!
【10月更文挑战第25天】本文介绍了几种有效提升 PostgreSQL 数据库查询效率的方法,包括索引优化、查询优化、配置优化和硬件优化。通过合理设计索引、编写高效 SQL 查询、调整配置参数和选择合适硬件,可以显著提高数据库性能。
124 1
|
24天前
|
存储 关系型数据库 MySQL
MySQL vs. PostgreSQL:选择适合你的开源数据库
在众多开源数据库中,MySQL和PostgreSQL无疑是最受欢迎的两个。它们都有着强大的功能、广泛的社区支持和丰富的生态系统。然而,它们在设计理念、性能特点、功能特性等方面存在着显著的差异。本文将从这三个方面对MySQL和PostgreSQL进行比较,以帮助您选择更适合您需求的开源数据库。
94 4
|
25天前
|
JavaScript 前端开发 开发者
探索JavaScript原型链:深入理解与实战应用
【10月更文挑战第21天】探索JavaScript原型链:深入理解与实战应用
28 1
|
1月前
|
SQL 前端开发 JavaScript
Nest.js 实战 (十五):前后端分离项目部署的最佳实践
这篇文章介绍了如何使用现代前端框架Vue3和后端Node.js框架Nest.js实现的前后端分离架构的应用,并将其部署到生产环境。文章涵盖了准备阶段,包括云服务器的设置、1Panel面板的安装、数据库的安装、域名的实名认证和备案、SSL证书的申请。在部署Node服务环节,包括了Node.js环境的创建、数据库的配置、用户名和密码的设置、网站信息的填写、静态网站的部署、反向代理的配置以及可能遇到的常见问题。最后,作者总结了部署经验,并希望对读者有所帮助。
135 11
|
1月前
|
存储 JavaScript 前端开发
前端开发:Vue.js入门与实战
【10月更文挑战第9天】前端开发:Vue.js入门与实战
|
17天前
|
前端开发 JavaScript
JavaScript新纪元:ES6+特性深度解析与实战应用
【10月更文挑战第29天】本文深入解析ES6+的核心特性,包括箭头函数、模板字符串、解构赋值、Promise、模块化和类等,结合实战应用,展示如何利用这些新特性编写更加高效和优雅的代码。
34 0
|
10天前
|
SQL 关系型数据库 MySQL
12 PHP配置数据库MySQL
路老师分享了PHP操作MySQL数据库的方法,包括安装并连接MySQL服务器、选择数据库、执行SQL语句(如插入、更新、删除和查询),以及将结果集返回到数组。通过具体示例代码,详细介绍了每一步的操作流程,帮助读者快速入门PHP与MySQL的交互。
25 1
|
12天前
|
SQL 关系型数据库 MySQL
go语言数据库中mysql驱动安装
【11月更文挑战第2天】
28 4