Koa + Prisma 快速入门

最新推荐文章于 2025-05-27 22:50:51 发布
最新推荐文章于 2025-05-27 22:50:51 发布
阅读量1.2k 收藏 2
点赞数
CC 4.0 BY-SA版权
分类专栏： 数据库 Node.js 入门到上道 文章标签： Prisma Node.js Koa.js MySQL
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/Old_Soldier/article/details/132524562
本文展示了如何使用Koa和Prisma在MySQL中实现CRUD操作，包括项目初始化、模型设计和API编写。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

10分钟掌握 Koa + Prisma 实现数据库 CRUD

前言

Prisma 是号称下一代的 ORM 工具，同样是基于 TypeScript 实现，但是带来了很强的类型安全。

本文使用 Koa.js 搭建一个简单的 Web 服务，配合 MySQL 数据库，来演示如何通过 Prisma 实现数据的增删改查。

Prisma

Prisma 是号称下一代的 ORM 工具，下面是 Prisma 中文网站，可以说是技术类网站中相当优秀的中文站了：

image-20230509200931239

Prisma 是一个开源的数据库工具链项目，不仅仅是一个简单的 ORM 工具。它支持的数据库有 PostgreSQL、MySQL、MongoDB、SQL Server和SQLite，本文以 MySQL 进行演示。

在使用方式上，对于第一次接触它的人来讲，稍微有些繁琐。我总结了以下几个流程：

  • 安装依赖
  • 初始化 Prisma 项目
  • 设计 Prisma Schema（数据库信息和模型）
  • 同步到数据库
  • 生成 Prisma Client
  • 使用 Prisma Client 完成 CRUD

下面我们先去创建一个开发环境，再回过头来继续介绍 Prisma。

初始化环境

使用 Koa 快速搭建一个 Web 服务，首先创建目录，并安装依赖：

$ mkdir koa-prisma
$ cd koa-prisma
$ pnpm init

# 安装 Koa 依赖
$ pnpm add koa @koa/router koa-bodyparser
  • @koa/router：路由中间件，方便集成路由功能
  • koa-bodyparser：解析请求体数据，并放到 ctx.request.body 对象上

然后新建一个 index.js，完成一个简单的 Web 服务：

const Koa = require('koa')
const Router = require('@koa/router')
const bodyParser = require('koa-bodyparser')

const app = new Koa()

// 实例化路由器，并设置公共路由前缀 /users
const router = new Router({
  prefix: '/users'
})

app.use(bodyParser())

// 查询用户列表
router.get('/', async ctx => {
 
})

// 查询单个用户
router.get('/:id', async ctx => {
 
})

// 创建用户
router.post('/', async ctx => {

})

// 更新用户
router.patch('/:id', async ctx => {

})

// 删除用户
router.delete('/:id', async ctx => {

})

// 注册路由中间件
app.use(router.routes()).use(router.allowedMethods())

app.listen(3000, () => {
  console.log('服务器运行在 3000 端口')
})

在上面代码中，定义了5个路由方法，分别对应了数据库的查询、插入、更新和删除操作。稍后完成 Prisma 的初始化，将 Prisma Client 引入，就能实现这几个接口了。

然后使用 nodemon 命令来启动服务，最好是在全局安装此模块，方便使用：

$ nodemon src/index.js

Prisma CLI

首先安装下 Prisma 的两个依赖模块：

$ pnpm add -D prisma 
$ pnpm add @prisma/client

安装的第一个 prisma，它是一个 CLI 命令，主要通过它来调用 Prisma 的各种功能，包括数据库迁移，创建Prisma Client 等等。

执行下面的命令，看一下 prisma 的使用说明：

$ npx prisma --help

image-20230509194858894

可以看到，prisma 提供了 7 个命令：

命令说明
init在应用中初始化 Prisma
generate主要用来生成 Prisma Client
db管理数据库的模式和生命周期
migrate迁移数据库
studio启动一个Web 端的工作台来管理数据
validate检查 Prisma 的模式文件的语法是否正确
format格式化Prisma的模式文件，默认就是 prisma/schema.prisma

并且还给出了示例，我们这里主要使用其中的三个，剩下的大家可以自己去使用看看效果：

image-20230509195654406

初始化 Prisma

执行下面的命令，完成初始化：

$ npx prisma init

image-20230509220945387

这个命令的效果是在命令所在目录，也就是现在的根目录中，创建一个 .env 文件，一个 prisma 目录，并在此目录下创建 schema.prisma 文件，如下：

image-20230509195929494

对于 .env 文件，大家都不会陌生，就是一个放置环境变量的文件，这里面的环境变量通常是一些配置信息。

prisma 目录，用来存放和 Prisma 相关的文件，目前只有一个 schema.prisma 文件，这个文件就是前面提及过的 Prisma 模式文件，我们会在此文件中定义数据库的连接信息和模型。

设计 Prisma Schema

schema.prisma 是使用 Primsa 的主要配置文件，称之为 Prisma schema 文件，它包含三个基本结构：

  • 数据源

  • 生成器

  • 数据模型定义

安装 VSC 插件

在编辑模式文件前，在 VS Code 中安装 Prisma 插件，它针对 .prisma 文件提供了代码高亮、格式化、自动补全、跳转定义和检查的功能。没有这个插件的加持，模式文件就是一个纯文本。

image-20230507161551169

设置生成器

使用 generate 定义生成器，通过 provider 属性声明为 prisma-client-js（目前也只支持这一种）。当执行 prisma generate 命令时就会生成 Prisma Client，使用它完成数据的增删改查。

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

设置数据源

使用 datasource 是定义数据源，用来设置 Prisma 连接的数据库所需要的一些信息。provider 是连接到的数据库的类型，默认是 postgresql，我们改为要用到的 mysql。 url 是数据库URL，通常为了保持配置分离，会将其单独定义到一个环境变量文件中，也就是 prisma cli 自动生成的 .env 文件。通过 env() 函数，会去读取此文件中的变量。

datasource db {
  provider = "mysql"
  url      = env("DATABASE_URL")
}

看一下 .env 文件，默认连接的是 Postgresql：

DATABASE_URL=postgresql://johndoe:mypassword@localhost:5432/mydb?schema=public

这是一个 数据库连接 URL的组成：

Structure of the MySQL connection URL

下面都是必填项：

名称占位符描述
HostHOST数据库 IP 或域名, 例如 localhost
PortPORT数据库端口, 例如 3306
UserUSER数据库用户名, 例如 root
PasswordPASSWORD数据库密码
DatabaseDATABASE数据库名称，例如 mydb

根据这个说明，定义我们自己的 MySQL URL：

DATABASE_URL="mysql://root:root123@localhost:3306/prisma"

定义 User 模型

作为 ORM 工具，肯定少不了模型了。Prisma 的模型主要有以下作用：

  • 构成了应用领域的 实体
  • 映射到数据库的 表（关系型数据库，例如 PostgreSQL）或 集合 （MongoDB）
  • 构成 Prisma Client API 中 查询 的基础
  • 在使用 TypeScript 时，Prisma Client 为模型及其 变体 提供 类型定义，保证数据库访问的类型安全

定义模型时会用到形如 @id() 、@default() 这些 Prisma 内置的工具函数。比如 @id() 用来声明主键，@default() 用来设置默认值，命名都非常语义化，基本就是 SQL 中的一些关键字，非常容易理解。

下面是一个 User 模型的定义：

model User {
  id          Int      @id @default(autoincrement())
  name        String   
  email       String   @unique
  password    String
  createdTime DateTime @default(now()) @map("created_time")
  updatedTime DateTime @updatedAt @map("updated_time")

  @@map("user")
}

需要说明的几点信息：

1.模型的名字默认就是创建的数据表的名字，这里是大写的 User，那么数据表名也就是大写的 User，可以使用 @@map() 来设置映射的表名，改为小写的 user。

2.每个模型的记录都是唯一可识别的，也就是要有主键，可以使用 @id 去声明。

3.字段的类型，比如 Int，String，会经过Prisma 转为数据库对应的类型，也就是 int 和 varchar。

4.@unique 是唯一值约束，所以生成的 user 表的 email 字段的值不能重复。

5.像是创建时间和更新时间，为了符合 JS、TS 中的命名规范，使用了小驼峰命名，为了符合数据库命名规范，在后面使用 @map() 重新映射为了下划线命名。

同步数据库

将Prisma 模型同步到数据库，对于我们这样一个新项目，空项目，可以使用下面的命令：

$ npx prisma db push

如果是一个已经有数据的项目，就不能使用这个命令了，转而使用 prisma migrate 迁移。本文先不涉及。

image-20230509213137705

它会创建数据库的schema，并且使用 Prisma schema 同步数据库，还会“偷偷”执行下 prisma generate 命令来生成 Prisma Client。

来到数据库，刷新一下，已经创建好了 prisma 数据库和一张 user 表：

image-20230509213437412

生成 Prisma client

前面同步数据库时，已经执行了 prisma generate。所以现在不需要再次执行了，但是一旦Prisma Schema 文件发生了变动，比如修改了模型，就需要再来执行下这个命令，重新生成 Prisma Client。

generate 命令执行的流程是：

img

CRUD 增删改查

初始化 Prisma Client

有了 Prisma Client，可以使用它来执行 CRUD 操作。初始化：

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

const prisma = new PrismaClient()

Prisma Client 的实例 prisma ，具备丰富的类型，使用方式是 prisma.模型.CRUD方法：

image-20230509214952783

image-20230509215012306

我们先来介绍几个常用的 API：

  • findMany：查询多条记录
  • findUnique：查询单条记录
  • create：创建记录
  • update：更新记录
  • delete：删除记录

使用这几个 API 在路由方法中操作数据库，完成接口的开发。

查询用户列表

findMany 不传入参数，表示查询整张 user 表的所有记录，它返回的是一个数组，是 User 模型的实例集合：

router.get('/', async ctx => {
  const users = await prisma.user.findMany()

  ctx.body = users
})

查询单个用户

在 findUnique 方法中通过 where 设置查询条件，也就是根据指定的 ID 来查询一条用户记录，该方法只返回一条记录，也就是 User 模型的一个实例：

// 查询单个用户
router.get('/:id', async ctx => {
  const id = parseInt(ctx.params.id)
  const user = await prisma.user.findUnique({
    where: { id }
  })

  ctx.body = user
})

需要注意的一点，从 ctx.params.id 获取的 id 是字符串类型，要转为整数类型再去查询。

创建用户

使用 create 可以插入数据，将从请求体中解析的数据，也就是描述 User模型 的一个对象赋值给 data 属性即可：

router.post('/', async ctx => {
  const user = ctx.request.body
  const newUser = await prisma.user.create({
    data: user
  })

  ctx.body = newUser
})

更新用户

使用 update 方法，通过 where 设置查询条件，查询到一个用户，再将待更新的数据赋值给 data，完成更新：

router.patch('/:id', async ctx => {
  const id = parseInt(ctx.params.id)
  const updateUser = ctx.request.body

  const user = await prisma.user.update({
    where: {
      id
    },
    data: updateUser
  })

  ctx.body = user
})

删除用户

使用 delete 方法，直接通过 where 设置删除记录的查询条件即可：

router.delete('/:id', async ctx => {
  const id = parseInt(ctx.params.id)
  const user = await prisma.user.delete({
    where: {
      id
    }
  })

  ctx.body = user
})

注意事项：使用 update 和 delete 时，一定要设置where，否则会更新或者删除数据表的所有记录，非常危险。

测试

创建用户：

image-20230509215720849

查询用户列表：

image-20230509215836753

更新用户：

image-20230509215918093

删除用户：

image-20230509215939149

总结

完整代码在这里。

本文通过一个用户的增删改查的例子，在 Koa 中演示了 Prisma 的基本使用，在此总结一下：

  1. 安装依赖
  2. 初始化 Prisma
  3. 设置 Prisma Schema
  4. 同步数据库
  5. 创建Prisma Client
  6. 使用 Prisma Client 实现 CRUD

Prisma 还有很多优秀的特性，本文抛砖引玉，只介绍了最基本的使用，一个单表的增删改查。推荐大家去阅读中文文档站点了解更多关于 Prisma 的内容。

感谢阅读！

Prisma(一)：初识
Bule_daze的博客
03-08 2941
Prisma 介绍：What，Why，How Prisma 是什么？
Prisma入门教程1-千里之行始于足下
weixin_44510200的博客
03-30 1014
prisma入门，搭建环境，初始化项目
【PostgreSQL】Ubuntu 下使用 Prisma 的初始化流程
纠缠AI的亮子
01-17 826
完成上面准备工作就ok了，不需要手工创建数据库，因为下面将由 Prisma 来创建数据库。整个数据库创建工作就完成了。
create-prisma-generator：快速构建 Prisma 生成器的神器
gitblog_00789的博客
04-29 838
create-prisma-generator：快速构建 Prisma 生成器的神器 项目介绍 create-prisma-generator 是一个开源命令行工具，旨在帮助开发者轻松创建 Prisma 生成器。Prisma 是一个流行的 Node.js 和 TypeScript 数据库 ORM 库，它包含了一个强大的概念——生成器。生成器是一个可执行程序，它接收解析后的 Prisma 模式作为输...
nestjs-graphql-prisma：使用Prisma 2和PostgreSQL样板后端NestJS GraphQL项目
02-22
NestJS-GraphQL-Prisma 示例后端使用和项目 目录 点击这里展开 特征 我创建此仓库用于学习，练习和理解如何一起使用NestJS，GraphQL和Prisma。 还计划如何构建可扩展且可测试的干净架构。 该项目的灵感来自“ 。 项目特点： 具有GraphQL，解决方案并使用 将用于数据库并将用作ORM CRUD操作，数据库关系，分页 使用 ， 和 刷新令牌解决方案 角色基础系统：管理员和用户 数据库播种 I18n的多国语言 带有评分限制API 电子邮件验证 使用自定义异常过滤器，自定义装饰器 PostgreSQL，PGAdmin，Prisma的Docker解决方案 测试：单元测试，集成测试，端到端测试（正在进行中） CI-CD与Travis-ci，Github动作 解决N + 1问题graphql（使用 ） 先决条件 如果只想在本地开发项目，则需要满足以下
详细koa2+ts+prisma+swagger的后端项目部署（部署到宝塔面板）
qq_42820307的博客
08-20 1038
利用koa2+ts+prisma+swagger的完成的后端项目，在本地成功运行后部署到云服务器，选择了宝塔面板
bunjil：具有基于策略的访问控制的模式合并，身份验证和授权的GraphQL堡垒服务器
02-03
入门 yarn add bunjil npm install bunjil // Import Bunjil and the Policy Types import { Bunjil , Policy , PolicyCondition , PolicyEffect } from "bunjil" ; // Create a schema const typeDefs : string =...
nodejs 写后端代码推荐哪个框架
02-26
- **新手入门/快速开发**：选 **Express** 或 **Koa**。 - **大型企业应用**：选 **NestJS** 或 **Egg.js**。 - **极致性能需求**：选 **Fastify**。 - **现代异步与中间件控制**：选 **Koa**。 ### **附加建议...
没用过Express，你还敢说你会Node.js？——10分钟掌握Express实用秘籍，轻松写爆接口！
最新发布
Where there is a will, there is a way !
05-27 619
本文深度解析Express框架的核心技能与实战应用，涵盖路由系统、中间件机制、常见坑点及AI时代新机遇，通过真实案例和面试考点，帮助开发者快速掌握Express精髓，实现从入门到精通的技能跃升。
建议收藏|一文带你读懂 Prisma 的使用
厦门在乎科技
10-18 3996
ORM(Object relational mappers) 的含义是，将数据模型与 Object 建立强力的映射关系，这样我们对数据的增删改查可以转换为操作 Object(对象)。 Prisma 是一个现代 Nodejs ORM 库，根据 Prisma 官方文档 可以了解这个库是如何设计与使用的。 概述 Prisma 提供了大量工具，包括 Prisma Schema、Prisma Client、Prisma Migrate、Prisma CLI、Prisma Studio 等，其中最核心的两个是 P
npx prisma 常用 命令 和 用途
solocao的专栏
07-15 842
npx Prisma 是一个用于数据库访问和管理的工具。根据数据模型生成 Prisma Client，用于与数据库交互。在项目中初始化 Prisma 配置文件和数据模型文件。启动可视化工具，帮助你查看和管理数据库中的数据。从现有数据库自动生成 Prisma 数据模型。创建数据库迁移并将其应用于开发数据库。将数据库迁移应用于生产数据库。将数据模型部署到数据库。
浅谈Koa服务限流方法实践
08-29
本篇文章主要介绍了浅谈Koa服务限流方法实践，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
prisma-docs-generator:Prisma生成器，用于从Prisma模式自动生成文档参考
05-15
Prisma文档生成器 根据您的Prisma架构自动生成参考。 这个软件包包含一个prisma generator，因此每次您运行prisma generate ，引用都会自动更新。 入门 使用以下方法安装此软件包： npm install prisma-docs-generator 将生成器添加到架构 generator docs { provider = " node node_modules/prisma-docs-generator " } 运行npx prisma generate来触发生成器。 这将在prisma/docs创建一个docs文件夹 使用npx prisma-docs-generator serve 选项 指定输出 您可以使用output属性指定文档之外的内容 generator docs { provider = " node node_modu
Prisma.js：JavaScript中的基于代码的ORM
08-22 381
至于模型定义，注意每个模型都有一个id字段，并且我们使用Prisma的注解来获得自动递增的整数ID.id@default(autoincrement()) 为了在User和Idea之间创建关系，我们使用数组括号引用了Idea类型这表示：给我一个Idea的集合，属于该User。然后，我们可以添加列表1中的定义，并使用它来处理数据持久化，使用Prisma内置的SQLite数据库。为了启动我们的应用程序，我们将创建一个新的目录，初始化一个npm项目，并安装依赖项，如列表2所示。来创建一个新的想法。
更适合中国宝宝的入门级Prisma教程
计算机小white博客
07-12 2694
本文简要介绍了在Next.js项目中使用Prisma，一个现代化的数据库工具。通过安装、配置环境、编写数据模型、生成客户端代码和同步数据库等步骤，Prisma能简化数据库交互，具备类型安全、自动生成代码和高效查询的优势，适合有前端或Node基础的开发者入门使用。
NestJs Prisma常见问题（避坑指南，已放弃使用）
weixin_39703282的博客
06-03 1566
关联模型操作 查询子模型多对一情况下，不需要include被关联模型也能查出自己外键id 多对一模型新增数据时，被关联的外键传值，如果model配置的外键为非必填(?)，创建将会报错，多对一不能将外键设置为空 持久化数据到数据库时，Prisma对时区的格式没有识别，如moment.js的utcOffset(8)转换成格式为Moment<2024-06-03T22:55:26+08:00>无法识别时区，此时手动添加8个小时来解决问题，moment().add(8, 'hours').toDa
有了 Prisma，就别用 TypeORM 了
kuizuo12的博客
01-13 2225
要说2024 年 Node.js 的 ORM 框架应该选择哪个？毫无疑问选 Prisma。至于为何，请听我细细道来。
Rasa_nlu_chi：入门教程
Puzzle的博客
12-09 2331
1. 为防止版本兼容问题，创建Python虚拟环境 链接：https://jingyan.baidu.com/article/b7001fe15d584c4e7282ddb2.html 1.1 创建一个文件夹（如pythonEnv），控制台进入该文件夹，运行 python -m venv . 1.2 完成后会在该文件夹下生成一些文件，控制台进入Scripts文件夹，运行activate即可 2. 安装jieba pip install jieba==0.41 ...
Prisma 使用方式的解读
新手新手新的博客
03-05 1913
Prisma 是一个现代化的数据库工具包，旨在简化数据库的建模、迁移和查询操作。它通过提供类型安全、直观的 API 和强大的 CLI 工具，帮助开发者高效管理数据库生命周期。文件定义数据库模型，支持关系型（如 PostgreSQL、MySQL）和文档型（如 MongoDB）数据库。通过 Prisma 的迁移工具链，可安全高效地管理数据库演进，结合类型安全的 Client 减少代码错误。两者协同工作，前者生成代码，后者使用代码，共同实现类型安全的数据库操作。若在开发环境快速迭代，可使用。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

昆吾kw

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值