Prisma的简介和使用

2023-11-10 | 61分钟 | yrobot | Prisma,ORM,数据库,graphql,Nodejs,server,简介,使用

什么是 Prisma#

这是 Prisma 官网的 slogan 翻译过来就是说：

Prisma 是一个基于 Nodejs 和 TypeScript 的 ORM，它可以帮助开发者以更快的开发速度和更少的错误来管理数据库。

关于是 ORM (Object/Relational Mapping)，简单的来说就是一个可以像操作对象一样操作数据库的工具。
具体 ORM 介绍可以参看阮一峰老师的《ORM 实例教程》

明确几个实体#

基本上所有 ORM 都在处理这几个实体之间的关系：数据库 DB、ORM 客户端、数据结构描述文件

一个完整的 ORM 需要做的事有以下几个：

一种支持特别语法的数据结构描述文件，来 1 声明数据库结构和 2 生成客户端类型声明代码：/prisma/schema.prisma
编译时可以根据数据结构描述文件更新数据库结构
运行时可以通过操作 ORM 客户端操作数据库

Prisma 组成#

Prisma 主要由 3 块组成

Prisma Client

Auto-generated and type-safe query builder for Node.js & TypeScript
- 自动生成和类型安全的查询器，将对象操作映射数据库
- 这是 ORM 最主要的能力
Prisma Migrate

Migration tool to easily evolve your database schema from prototyping to production
- 工具可以将你的 schema 设计转化为数据库结构
Prisma Studio

GUI to view and edit data in your database
- 一个查看编辑数据库的可视化工具

使用 Prisma#

1.安装 prisma#

run yarn add -D prisma or npm install prisma -D

2.项目 init - 生成配置#

run npx prisma init
主要是生成了一个文件/prisma/schema.prisma

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}
generator client {
  provider = "prisma-client-js"
}

3.配置`schema.prisma`#

schema.prisma 是 Prisma 主要的配置文件

schema.prisma 配置纬度主要包含以下 3 点：

DB 连接的配置
Prisma Client 配置
data model 定义

schema.prisma配置参看 Prisma schema

example:#

方便起见，我选用 sqlite 作为 prisma 的数据库，并定义一个 User 的数据模型

schema.prisma:

datasource db {
  provider = "sqlite"
  url      = "file:dev.db"
}

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

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

4.运行 `prisma migrate` 生成数据表和 client#

使用 migrate 将定义的数据模型映射到数据库表结构。

migrate还会自动生成 node_modules/.prisma/client，一个 runtime 的 prisma 客户端，提供良好的代码提示等能力。

运行 migrate，并指定环境为 dev，名字为 init

run: npx prisma migrate dev --name init

example:#

DB 生成：

client 生成：

5.使用 client 对数据库进行 CRUD#

接下来就可以使用 Prisma Client 对数据库进行增删改查了

链式对象操作 + 优秀的代码提示，行云流水的开发体验，真的舒服

Prisma CRUD 文档

example:#

本节示例我将直接使用 node 对 client 进行操作，去增删改查数据库

test.js: // 点击展开代码

const { PrismaClient } = require("@prisma/client");

const prisma = new PrismaClient();

async function main() {
  // Create 3 users
  await Promise.all(
    [
      { email: "user1@mail.com", name: "user1" },
      { email: "user2@mail.com", name: "user2" },
      { email: "user3@mail.com", name: "user3" },
    ].map(async (user) =>
      prisma.user.create({
        data: user,
      })
    )
  );

  // Read
  console.log(await prisma.user.findMany());

  // Update user2 name as yrobot
  await prisma.user.update({
    where: {
      email: "user2@mail.com",
    },
    data: {
      name: "yrobot",
    },
  });

  // Delete user3
  await prisma.user.delete({
    where: {
      email: "user3@mail.com",
    },
  });

  // Read
  console.log(await prisma.user.findMany());
}

main()
  .catch((e) => {
    throw e;
  })
  .finally(async () => {
    await prisma.$disconnect();
  });

node logs:

6.使用 Prisma Studio GUI 查看并操作数据库#

Prisma Studio 算是 Prisma 作为 ORM 的另一个亮点优秀的使用体验，省去了传统查看数据库的繁琐操作和配置

run: npx prisma studio

terminal logs:

open studio in Browser: http://localhost:5555

7.配合 Express 快速搭建 RESTful 服务#

主要代码逻辑：server.js

const { PrismaClient } = require("@prisma/client");
const express = require("express");
const bodyParser = require("body-parser");

const prisma = new PrismaClient();
const app = express();
app.use(bodyParser());
const port = 3000;

app.get("/users", async function (req, res) {
  const users = await prisma.user.findMany();
  res.send(users);
});

app.get("/user/:id", async function (req, res) {
  const { id } = req.params;
  const user = await prisma.user.findUnique({
    where: {
      id: parseInt(id),
    },
  });
  res.send(user);
});

app.post("/user/create", async function (req, res) {
  const { user } = req.body;
  const result = await prisma.user.create({
    data: user,
  });
  res.send(result);
});

app.post("/user/update", async function (req, res) {
  const { user, id } = req.body;
  const result = await prisma.user.update({
    where: {
      id: parseInt(id),
    },
    data: user,
  });
  res.send(result);
});

app.delete("/user/delete", async function (req, res) {
  const { id } = req.body;
  const result = await prisma.user.delete({
    where: {
      id: parseInt(id),
    },
  });
  res.send(result);
});

app.listen(port, () => {
  console.log(`Server run at http://localhost:${port}`);
});

测试逻辑：

### get user list
GET http://localhost:3000/users

### get user detail
GET http://localhost:3000/user/8

### create user
POST http://localhost:3000/user/create

### update user
POST http://localhost:3000/user/update

### delete user
DELETE http://localhost:3000/user/delete