convex-best-practices

Convex 最佳实践

通过遵循函数组织、查询优化、验证、TypeScript 使用和错误处理的既定模式，构建生产级 Convex 应用。

代码质量

本技能中的所有模式均符合 @convex-dev/eslint-plugin。安装它以在构建时进行验证：

npm i @convex-dev/eslint-plugin --save-dev

// eslint.config.js
import { defineConfig } from "eslint/config";
import convexPlugin from "@convex-dev/eslint-plugin";

export default defineConfig([
  ...convexPlugin.configs.recommended,
]);

该插件强制执行四条规则：

规则	强制执行的内容
no-old-registered-function-syntax	使用 handler 的对象语法
require-argument-validators	所有函数上必须有 args: {}
explicit-table-ids	数据库操作中指定表名
import-wrong-runtime	不在 Convex 运行时中导入 Node 模块

文档：https://docs.convex.dev/eslint

文档来源

在实现之前，不要假设；请获取最新文档：

• 主要：https://docs.convex.dev/understanding/best-practices/
• 错误处理：https://docs.convex.dev/functions/error-handling
• 写入冲突：https://docs.convex.dev/error#1
• 更广泛的上下文：https://docs.convex.dev/llms.txt

说明

Convex 的精髓

1. Convex 处理困难的部分 - 让 Convex 处理缓存、实时同步和一致性
2. 函数即 API - 将函数设计为应用程序的接口
3. 模式即真理 - 在 schema.ts 中显式定义数据模型
4. TypeScript 无处不在 - 利用端到端的类型安全
5. 查询是响应式的 - 以订阅而非请求的方式思考

函数组织

按领域组织 Convex 函数：

// convex/users.ts - 用户相关函数
import { query, mutation } from "./_generated/server";
import { v } from "convex/values";

export const get = query({
  args: { userId: v.id("users") },
  returns: v.union(
    v.object({
      _id: v.id("users"),
      _creationTime: v.number(),
      name: v.string(),
      email: v.string(),
    }),
    v.null(),
  ),
  handler: async (ctx, args) => {
    return await ctx.db.get("users", args.userId);
  },
});

参数和返回值验证

始终为参数和返回类型定义验证器：

export const createTask = mutation({
  args: {
    title: v.string(),
    description: v.optional(v.string()),
    priority: v.union(v.literal("low"), v.literal("medium"), v.literal("high")),
  },
  returns: v.id("tasks"),
  handler: async (ctx, args) => {
    return await ctx.db.insert("tasks", {
      title: args.title,
      description: args.description,
      priority: args.priority,
      completed: false,
      createdAt: Date.now(),
    });
  },
});

查询模式

使用索引而非过滤器进行高效查询：

// 带索引的模式
export default defineSchema({
  tasks: defineTable({
    userId: v.id("users"),
    status: v.string(),
    createdAt: v.number(),
  })
    .index("by_user", ["userId"])
    .index("by_user_and_status", ["userId", "status"]),
});

// 使用索引查询
export const getTasksByUser = query({
  args: { userId: v.id("users") },
  returns: v.array(
    v.object({
      _id: v.id("tasks"),
      _creationTime: v.number(),
      userId: v.id("users"),
      status: v.string(),
      createdAt: v.number(),
    }),
  ),
  handler: async (ctx, args) => {
    return await ctx.db
      .query("tasks")
      .withIndex("by_user", (q) => q.eq("userId", args.userId))
      .order("desc")
      .collect();
  },
});

错误处理

使用 ConvexError 处理面向用户的错误：

import { ConvexError } from "convex/values";

export const updateTask = mutation({
  args: {
    taskId: v.id("tasks"),
    title: v.string(),
  },
  returns: v.null(),
  handler: async (ctx, args) => {
    const task = await ctx.db.get("tasks", args.taskId);

    if (!task) {
      throw new ConvexError({
        code: "NOT_FOUND",
        message: "任务未找到",
      });
    }

    await ctx.db.patch("tasks", args.taskId, { title: args.title });
    return null;
  },
});

避免写入冲突（乐观并发控制）

Convex 使用 OCC。遵循以下模式以最小化冲突：

// 好：使变更幂等
export const completeTask = mutation({
  args: { taskId: v.id("tasks") },
  returns: v.null(),
  handler: async (ctx, args) => {
    const task = await ctx.db.get("tasks", args.taskId);

    // 如果已完成则提前返回（幂等）
    if (!task || task.status === "completed") {
      return null;
    }

    await ctx.db.patch("tasks", args.taskId, {
      status: "completed",
      completedAt: Date.now(),
    });
    return null;
  },
});

// 好：尽可能直接 patch 而不先读取
export const updateNote = mutation({
  args: { id: v.id("notes"), content: v.string() },
  returns: v.null(),
  handler: async (ctx, args) => {
    // 直接 patch - 如果文档不存在，ctx.db.patch 会抛出异常
    await ctx.db.patch("notes", args.id, { content: args.content });
    return null;
  },
});

// 好：对并行的独立更新使用 Promise.all
export const reorderItems = mutation({
  args: { itemIds: v.array(v.id("items")) },
  returns: v.null(),
  handler: async (ctx, args) => {
    const updates = args.itemIds.map((id, index) =>
      ctx.db.patch("items", id, { order: index }),
    );
    await Promise.all(updates);
    return null;
  },
});

TypeScript 最佳实践

import { Id, Doc } from "./_generated/dataModel";

// 使用 Id 类型表示文档引用
type UserId = Id<"users">;

// 使用 Doc 类型表示完整文档
type User = Doc<"users">;

// 正确定义 Record 类型
const userScores: Record<Id<"users">, number> = {};

内部函数与公共函数

// 公共函数 - 暴露给客户端
export const getUser = query({
  args: { userId: v.id("users") },
  returns: v.union(
    v.null(),
    v.object({
      /* ... */
    }),
  ),
  handler: async (ctx, args) => {
    // ...
  },
});

// 内部函数 - 仅可从其他 Convex 函数调用
export const _updateUserStats = internalMutation({
  args: { userId: v.id("users") },
  returns: v.null(),
  handler: async (ctx, args) => {
    // ...
  },
});

示例

完整 CRUD 模式

// convex/tasks.ts
import { query, mutation } from "./_generated/server";
import { v } from "convex/values";
import { ConvexError } from "convex/values";

const taskValidator = v.object({
  _id: v.id("tasks"),
  _creationTime: v.number(),
  title: v.string(),
  completed: v.boolean(),
  userId: v.id("users"),
});

export const list = query({
  args: { userId: v.id("users") },
  returns: v.array(taskValidator),
  handler: async (ctx, args) => {
    return await ctx.db
      .query("tasks")
      .withIndex("by_user", (q) => q.eq("userId", args.userId))
      .collect();
  },
});

export const create = mutation({
  args: {
    title: v.string(),
    userId: v.id("users"),
  },
  returns: v.id("tasks"),
  handler: async (ctx, args) => {
    return await ctx.db.insert("tasks", {
      title: args.title,
      completed: false,
      userId: args.userId,
    });
  },
});

export const update = mutation({
  args: {
    taskId: v.id("tasks"),
    title: v.optional(v.string()),
    completed: v.optional(v.boolean()),
  },
  returns: v.null(),
  handler: async (ctx, args) => {
    const { taskId, ...updates } = args;

    // 移除 undefined 值
    const cleanUpdates = Object.fromEntries(
      Object.entries(updates).filter(([_, v]) => v !== undefined),
    );

    if (Object.keys(cleanUpdates).length > 0) {
      await ctx.db.patch("tasks", taskId, cleanUpdates);
    }
    return null;
  },
});

export const remove = mutation({
  args: { taskId: v.id("tasks") },
  returns: v.null(),
  handler: async (ctx, args) => {
    await ctx.db.delete("tasks", args.taskId);
    return null;
  },
});

最佳实践

• 除非明确指示，否则不要运行 npx convex deploy
• 除非明确指示，否则不要运行任何 git 命令
• 始终为函数定义返回值验证器
• 对所有过滤数据的查询使用索引
• 使变更幂等以优雅地处理重试
• 使用 ConvexError 处理面向用户的错误消息
• 按领域组织函数（users.ts、tasks.ts 等）
• 对敏感操作使用内部函数
• 利用 TypeScript 的 Id 和 Doc 类型

常见陷阱

1. 使用 filter 而非 withIndex - 始终定义索引并使用 withIndex
2. 缺少返回值验证器 - 始终指定 returns 字段
3. 非幂等变更 - 在更新前检查当前状态
4. 不必要地先读取再 patch - 尽可能直接 patch
5. 未处理 null 返回值 - 文档 ID 可能不存在

参考

• Convex 文档：https://docs.convex.dev/
• Convex LLMs.txt：https://docs.convex.dev/llms.txt
• 最佳实践：https://docs.convex.dev/understanding/best-practices/
• 错误处理：https://docs.convex.dev/functions/error-handling
• 写入冲突：https://docs.convex.dev/error#1