Tabnine
Tabnine 是一个 AI 软件开发平台，作为 IDE（例如 VS Code、WebStorm、IntelliJ 等）的扩展提供。
概览
它通过以下方式帮助开发者更快地编写代码：
为何将 Prisma ORM 与 Tabnine 结合使用？
像 Tabnine 这样的 AI 编辑器是强大的工具，可以极大地提高开发人员的工作效率。它特别适用于以下工作流：
- 数据建模和数据库 Schema 设计
- 构建和优化数据库查询
- 生成 CRUD 功能及其他样板代码
- 生成可与 TypedSQL 一起使用的纯 SQL 查询
- 生成单元测试和集成测试的代码
- 指导进行重大重构
- 生成数据填充脚本
利用 Prisma Schema
因为 Prisma 有自己的schema，Tabnine 可以理解你的数据的基本结构，并帮助你为技术栈的其他部分编写代码。
因此，我们建议你首先定义 Prisma schema，然后使用 Tabnine 构建应用层（包括 API 调用、DTO、业务逻辑、第三方集成等）。
数据建模和数据库 Schema 设计
Tabnine 如何提供帮助
从头设计数据库 schema 涉及大量的样板代码，而且可能很耗时。
Tabnine 可以通过以下方式加速这一过程：
- 为模型、索引、约束和关系生成样板代码。
- 遵循命名和其他约定，保持 schema 的一致性。
- 基于常见的数据库模式自动补全模型和字段定义。
- 基于命名约定建议关系和字段类型。
示例：定义 Prisma schema
提示
为一个包含 User（用户）、Organization（组织）和 Subscription（订阅）模型的 SaaS 应用定义一个 Prisma schema。确保关系设置正确。
生成的代码
generator client {
provider = "prisma-client-js"
}
datasource db {
provider = "postgresql"
url = env("DATABASE_URL")
}
model User {
id Int @id @default(autoincrement())
createdAt DateTime @default(now())
updatedAt DateTime @updatedAt
email String @unique
name String
organization Organization @relation(fields: [organizationId], references: [id])
organizationId Int
}
model Organization {
id Int @id @default(autoincrement())
name String
slug String @unique
subscription Subscription?
users User[]
}
model Subscription {
id Int @id @default(autoincrement())
organization Organization @relation(fields: [organizationId], references: [id])
organizationId Int @unique
plan String
status Status
}
enum Status {
Active
Paused
Expired
}
构建和优化数据库查询
Tabnine 如何提供帮助
Prisma ORM 提供了一个方便的高级 API，可以直观地编写数据库查询。然而，涉及过滤器、分页和高级模式的查询仍然可能变得复杂。
Tabnine 可以通过以下方式提供帮助：
- 基于 schema 自动补全 Prisma 查询。
- 为过滤器建议
where子句，为分页逻辑建议skip/take选项。 - 帮助进行效率和性能优化。
示例：使用关系获取数据
提示
生成一个 Prisma 查询，用于从具有活跃订阅的组织中获取所有活跃用户。在查询结果中包含用户所属组织的数据。
生成的代码
const activeUsers = await prisma.user.findMany({
where: {
organization: {
subscription: {
status: "ACTIVE"
}
}
},
include: {
organization: true
}
});
生成 CRUD 功能及其他样板代码
Tabnine 如何提供帮助
大多数应用都需要基本的 CRUD 操作或其他通常源自数据库 schema 结构的样板代码。例如，API 层可能公开一组 HTTP 端点，允许创建、读取、更新或删除特定模型的数据记录。类似地，前端将使用数据获取和状态管理逻辑与这些 API 端点交互并相应地更新 UI。
Tabnine 可以通过以下方式加快这一过程，而无需手动编写代码：
- 为后端生成 Prisma 的
create、read、update和delete操作，并为前端生成 UI 组件。 - 自动补全函数名和参数类型。
- 在遵循 DTO 使用、错误处理、一致的 API 设计等最佳实践的同时编写样板代码。
示例：使用 Next.js 生成 CRUD 功能
提示
基于上述 schema 中的 User 模型，为一个 Next.js 应用生成 CRUD 功能。
生成的代码
API 端点
文件名=app/api/users/routes.ts
import { NextResponse } from 'next/server';
import prisma from '../../../lib/prisma';
export async function GET() {
const users = await prisma.user.findMany({
include: { organization: true },
});
return NextResponse.json(users);
}
export async function POST(request: Request) {
const body = await request.json();
const user = await prisma.user.create({
data: {
email: body.email,
name: body.name,
organization: {
connect: { id: body.organizationId },
},
},
include: { organization: true },
});
return NextResponse.json(user);
}
export async function PUT(request: Request) {
const body = await request.json();
const user = await prisma.user.update({
where: { id: body.id },
data: {
email: body.email,
name: body.name,
organizationId: body.organizationId,
},
include: { organization: true },
});
return NextResponse.json(user);
}
export async function DELETE(request: Request) {
const { searchParams } = new URL(request.url);
const id = searchParams.get('id');
const user = await prisma.user.delete({
where: { id: Number(id) },
});
return NextResponse.json(user);
}
React 组件
文件名=app/components/User.tsx
import React, { useState, useEffect } from 'react';
interface User {
id: number;
email: string;
name: string;
organizationId: number;
}
const User: React.FC = () => {
const [users, setUsers] = useState<User[]>([]);
const [newUser, setNewUser] = useState({ email: '', name: '', organizationId: 0 });
useEffect(() => {
fetchUsers();
}, []);
const fetchUsers = async () => {
const response = await fetch('/api/users');
const data = await response.json();
setUsers(data);
};
const createUser = async () => {
await fetch('/api/users', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify(newUser),
});
fetchUsers();
setNewUser({ email: '', name: '', organizationId: 0 });
};
const deleteUser = async (id: number) => {
await fetch(`/api/users?id=${id}`, { method: 'DELETE' });
fetchUsers();
};
return (
<div>
<h2>Users</h2>
<ul>
{users.map((user) => (
<li key={user.id}>
{user.name} ({user.email}) - Org ID: {user.organizationId}
<button onClick={() => deleteUser(user.id)}>Delete</button>
</li>
))}
</ul>
<h3>Create New User</h3>
<input
type="text"
placeholder="Name"
value={newUser.name}
onChange={(e) => setNewUser({ ...newUser, name: e.target.value })}
/>
<input
type="email"
placeholder="Email"
value={newUser.email}
onChange={(e) => setNewUser({ ...newUser, email: e.target.value })}
/>
<input
type="number"
placeholder="Organization ID"
value={newUser.organizationId}
onChange={(e) => setNewUser({ ...newUser, organizationId: Number(e.target.value) })}
/>
<button onClick={createUser}>Create User</button>
</div>
);
};
export default User;
生成可与 TypedSQL 一起使用的纯 SQL 查询
Tabnine 如何提供帮助
虽然 Prisma 提供了一个用于查询的高级 API，但有时开发者可能需要回退到原始 SQL 以获得更低级别的查询控制。在这些情况下，他们可以使用TypedSQL，它为 Prisma ORM 中的原始 SQL 查询提供完整的类型安全。
一个常见的用例是聚合查询，例如计算上述 schema 示例中不同订阅状态的百分比。
Tabnine 可以通过以下方式提供帮助：
- 基于你的 Prisma schema 生成 SQL 查询。
- 构建复杂的聚合查询，无需手动反复试验。
- 将查询集成到你的应用代码中。
示例：计算活跃、过期和暂停订阅的百分比
提示
生成一个 SQL 查询，返回活跃、暂停和过期订阅的百分比。
生成的 SQL 查询
prisma/sql/subscriptionsReport.sql
SELECT
status,
COUNT(*) * 100.0 / (SELECT COUNT(*) FROM "Subscription") AS percentage
FROM "Subscription"
GROUP BY status;
应用代码
import { PrismaClient } from '@prisma/client'
import { subscriptionsReport } from '@prisma/client/sql'
const prisma = new PrismaClient();
const usersWithPostCounts = await prisma.$queryRawTyped(subscriptionsReport())
console.log(usersWithPostCounts)
生成单元测试和集成测试的代码
Tabnine 如何提供帮助
编写测试可以确保基于 Prisma 的应用正常运行并符合要求和期望。然而，编写测试是一项耗时的活动，并且常常遵循可预测和重复的模式。
Tabnine 可以通过以下方式显著加快编写测试的速度：
- 为单元测试和集成测试生成测试样板代码。
- 为 Prisma 数据库交互建议模拟（mock）和夹具（fixture）。
- 帮助构建测试用例以遵循最佳实践。
- 提供集成测试脚手架，用于使用真实或内存数据库测试 Prisma。
示例：为一个 Prisma 服务编写单元测试
提示
为一个获取所有活跃用户的 Prisma 服务函数生成一个 Jest 单元测试。
生成的代码
文件名=__tests__/userService.test.ts
import { prismaMock } from '../prisma/singleton';
import { getActiveUsers } from '../services/userService';
test('should return only active users', async () => {
prismaMock.user.findMany.mockResolvedValue([
{ id: 1, name: 'Alice', email: 'alice@example.com' },
{ id: 2, name: 'Bob', email: 'bob@example.com' }
]);
const users = await getActiveUsers();
expect(users).toHaveLength(2);
expect(users[0].email).toBe('alice@example.com');
});
指导进行重大重构
Tabnine 如何提供帮助
得益于 Prisma ORM 的类型安全查询，重构比使用其他 ORM 更安全、可预测：在进行 schema 更改后，生成的 Prisma Client 代码将更新，并且 TypeScript 编译器将高亮显示所有需要更改的地方。
然而，在重构过程中仍然可能出现更困难的情况，例如当业务逻辑或复杂查询需要调整时。
Tabnine 可以在重构期间提供帮助，通过：
- 识别代码中的模式并建议重构，同时保持一致性。
- 帮助在 schema 更改后更新数据库查询并减少手动工作。
- 提供函数重写以简化和优化逻辑。
- 建议需要在整个代码库中处理的破坏性变更。
示例：schema 更改后重构 Prisma 查询
提示
重构此 Prisma 查询，以使用 User 模型中的 deletedAt 时间戳字段支持软删除。
初始代码
const users = await prisma.user.findMany();
重构后的代码
const users = await prisma.user.findMany({
where: { deletedAt: null }
});
生成数据填充脚本
Tabnine 如何提供帮助
使用逼真的测试数据填充数据库可能很麻烦。逼真的种子数据在开发过程中很有帮助，因为它让开发者更好地了解应用程序在实际使用中的情况。Tabnine 可以通过以下方式帮助数据库填充：
- 基于 schema 并按照特定要求生成结构化的种子数据脚本。
- 创建看起来逼真的占位数据，可用于测试应用。
- 生成特定数据以覆盖边界情况。
示例：创建数据填充脚本
提示
生成一个 Prisma 数据填充脚本，用于填充 User、Organization 和 Subscription 模型的数据。
生成的代码
import { PrismaClient } from "@prisma/client";
const prisma = new PrismaClient();
async function main() {
await prisma.organization.create({
data: {
name: "Prisma Corp",
slug: "prisma-corp",
subscription: {
create: {
plan: "PRO",
status: "ACTIVE"
}
},
users: {
create: [
{ name: "Alice Doe", email: "alice@prisma.io" },
{ name: "Bob Smith", email: "bob@prisma.io" }
]
}
}
});
console.log("Seed data created successfully");
}
main()
.catch((e) => {
console.error(e);
process.exit(1);
})
.finally(async () => {
await prisma.$disconnect();
});
保持与 Prisma 的联系
通过与以下方式联系，继续你的 Prisma 之旅： 我们的活跃社区。随时了解情况，参与其中，并与其他开发者协作
- 在 X 上关注我们 获取公告、直播活动和实用技巧。
- 加入我们的 Discord 提问、与社区交流，并通过对话获得积极支持。
- 在 YouTube 上订阅 获取教程、演示和直播。
- 在 GitHub 上互动 通过给仓库加星、报告问题或为问题贡献代码。