跳到主要内容

Tabnine

Tabnine 是一个 AI 软件开发平台,以 扩展 的形式提供给你的 IDE(例如 VS Code、WebStorm、IntelliJ 等)。

概述

它通过以下方式帮助开发者更快地编写代码:

  • 在编辑器中提供上下文感知的 代码补全 建议,用于小型重复性编码任务
  • 提供集成的 聊天 功能,用于更高级别的任务和详细说明

为什么将 Prisma ORM 与 Tabnine 结合使用?

Tabnine 等 AI 编辑器是功能强大的工具,可以显著提高开发人员的生产力。它在以下工作流程中表现尤为出色:

  • 数据建模和数据库模式设计
  • 构建和优化数据库查询
  • 生成 CRUD 功能和其他样板代码
  • 生成可与 TypedSQL 一起使用的纯 SQL 查询
  • 生成单元测试和集成测试的代码
  • 指导进行重大重构
  • 生成种子脚本

利用 Prisma Schema

由于 Prisma 拥有自己的 schema,Tabnine 可以理解数据的基本结构,并帮助你为技术栈的其他部分编写代码。

因此,我们建议你首先定义 Prisma schema,然后使用 Tabnine 构建围绕它的应用层(包括 API 调用、DTO、业务逻辑、第三方集成等)。

数据建模和数据库模式设计

Tabnine 如何提供帮助

从头开始设计数据库模式涉及大量样板代码,并且可能非常耗时。

Tabnine 可以通过以下方式加速此过程:

  • 为模型、索引、约束和关系生成样板代码。
  • 通过遵循命名和其他约定来保持模式的一致性。
  • 根据常见的数据库模式自动完成模型和字段定义。
  • 根据命名约定建议关系和字段类型。

示例:定义 Prisma schema

提示

为一个 SaaS 应用定义 Prisma schema,包含 User、Organization 和 Subscription 模型。确保正确设置关系。

生成的代码

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 操作或其他样板代码,这些代码通常源自数据库模式的结构。例如,API 层可以公开一组 HTTP 端点,允许创建、读取、更新或删除特定模型记录。类似地,前端将拥有数据获取和状态管理逻辑,以与这些 API 端点交互并相应地更新 UI。

Tabnine 可以通过以下方式加速此过程,而无需手动编写代码:

  • 为后端生成 Prisma 的 createreadupdatedelete 操作,以及为前端生成 UI 组件。
  • 自动补全函数名和参数类型。
  • 在遵循 DTO 使用、错误处理、一致性 API 设计等最佳实践的同时编写样板代码。

示例:使用 Next.js 生成 CRUD 功能

提示

根据上述 schema 中的 User 模型,为 Next.js 应用生成 CRUD 功能。

生成的代码

API 端点
filename=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 组件
filename=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 数据库交互建议模拟和固定数据。
  • 帮助构建测试用例以遵循最佳实践。
  • 提供集成测试脚手架,用于使用真实或内存数据库测试 Prisma。

示例:为 Prisma 服务编写单元测试

提示

为一个获取所有活跃用户的 Prisma 服务函数生成 Jest 单元测试。

生成的代码

filename=__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 之旅: 我们活跃的社区。随时了解最新信息,积极参与,并与其他开发者协作

我们真诚地珍视你的参与,并期待你成为我们社区的一员!

© . All rights reserved.