SuperAPI AI 工具集

components-guide

编程与开发

查看项目

更新于 10-15 21:51

技能介绍

用途:Convex Components 用于把功能封装成自包含的迷你后端,每个组件打包自己的数据库 schema、函数(queries、mutations、actions)、隔离的数据表以及清晰的 API 边界,类似后端的 npm 包,或无需部署复杂度的微服务。

主要能力:支持安装官方组件、在 convex.config.ts 中配置、在主应用代码中通过 generated api 调用;采用兄弟组件模式让多个组件在同一层协作,各自负责单一关注点(如 auth、storage、payments、analytics)。

必要用法:通过 npm 安装组件,例如 npm install @convex-dev/ratelimiter;在 convex.config.ts 中用 defineApp 注册组件;在业务代码中通过 import { components } from "./_generated/api" 调用组件函数。官方组件涵盖认证、存储、支付、AI、后端工具等类别。

自建组件:当功能自包含、可跨项目复用、含独立数据模型或包装第三方集成时值得创建;一次性业务逻辑、与主应用紧耦合或简单工具函数则不适合。结构包括 convex.config.ts、schema.ts 及函数文件。

通信约束:主应用可调用组件,组件接收父级数据(如传入 ID)是允许的;但组件不能直接访问父级表,组件之间也不能直接互相调用,如需此能力应放到主应用或重构设计。

最佳实践:单一职责、清晰 API 表面、最小耦合、版本化并编写文档。具体价格、平台与效果暂未提供。