⚡

Convex最佳实践Skill convex-best-practices

这个技能提供了构建生产就绪Convex应用程序的全面指南，涵盖函数组织、查询优化、验证、TypeScript使用、错误处理和避免写冲突，适用于后端开发和云原生应用构建。关键词：Convex, 后端开发, 云原生, 实时同步, TypeScript, 最佳实践, 数据库优化。

后端开发 0 次安装 0 次浏览 更新于 3/17/2026

name: convex-best-practices description: 构建生产就绪Convex应用程序的指南，涵盖函数组织、查询模式、验证、TypeScript使用、错误处理和Convex设计哲学的禅意。

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

文档来源

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

说明

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;
  },
});

// 好：尽可能直接修补，无需先读取
export const updateNote = mutation({
  args: { id: v.id("notes"), content: v.string() },
  returns: v.null(),
  handler: async (ctx, args) => {
    // 直接修补 - 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;

    // 移除未定义的值
    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. 使用过滤器而非withIndex - 始终定义索引并使用withIndex
  2. 缺少返回验证器 - 始终指定returns字段
  3. 非幂等突变 - 在更新前检查当前状态
  4. 不必要地先读取再修补 - 尽可能直接修补
  5. 未处理空返回 - 文档ID可能不存在

参考文献