使用Convex

运行 EAS CLI 集成命令

🌐 Run the EAS CLI integration command

在你的 Expo 项目目录中，运行：

🌐 From your Expo project directory, run:

该命令将在需要时提示输入 Convex 部署区域、项目名称和团队名称。只有在需要创建新的 Convex 团队连接时，它才会要求输入团队名称。

🌐 The command will prompt for a Convex deployment region, project name, and team name when needed. It only asks for a team name when it needs to create a new Convex team connection.

你也可以显式传递值：

🌐 You can also pass values explicitly:

集成命令：

🌐 The integration command:

• 使用 npx expo install convex 安装 convex 包
• 为你的 EAS 账户创建一个 Convex 团队连接，或重用现有连接
• 为当前的 Expo 应用创建一个 Convex 项目和部署
• 将 CONVEX_DEPLOY_KEY 和 EXPO_PUBLIC_CONVEX_URL 写入 .env.local
• 为生产、预览和开发环境创建或更新 EXPO_PUBLIC_CONVEX_URL EAS 项目环境变量
• 向你已验证的电子邮件发送邀请，以便你可以认领 Convex 团队并打开 Convex 仪表板

在本地启动 Convex

🌐 Start Convex locally

在集成命令完成后，启动 Convex 开发服务器：

🌐 After the integration command finishes, start the Convex dev server:

如果你的项目还没有本地 convex 目录，这将创建该目录，生成类型化的 API 文件，并在运行时将你的 Convex 函数与部署同步。

🌐 This creates the local convex directory if your project does not have one yet, generates the typed API files, and syncs your Convex functions with your deployment while it runs.

添加 Convex 提供者

🌐 Add a Convex provider

使用 EAS 集成写入 .env.local 的部署 URL 创建一个 Convex 客户端，然后将你的应用封装在 ConvexProvider 中。

🌐 Create a Convex client with the deployment URL that the EAS integration wrote to .env.local, then wrap your app in ConvexProvider.

对于一个 Expo Router 项目，更新 src/app/_layout.tsx:

🌐 For an Expo Router project, update src/app/_layout.tsx:

import { ConvexProvider, ConvexReactClient } from 'convex/react';
import { Stack } from 'expo-router';

const convex = new ConvexReactClient(process.env.EXPO_PUBLIC_CONVEX_URL!, {
  unsavedChangesWarning: false,
});

export default function RootLayout() {
  return (
    <ConvexProvider client={convex}>
      <Stack />
    </ConvexProvider>
  );
}

从你的应用查询 Convex

🌐 Query Convex from your app

在 convex 目录中添加查询功能：

🌐 Add a query function in the convex directory:

import { query } from './_generated/server';

export const get = query({
  args: {},
  handler: async ctx => {
    return await ctx.db.query('tasks').collect();
  },
});

然后在你的应用中用 useQuery 调用它：

🌐 Then call it from your app with useQuery:

import { api } from '@/convex/_generated/api';
import { useQuery } from 'convex/react';
import { Text, View } from 'react-native';

export default function Index() {
  const tasks = useQuery(api.tasks.get);

  return (
    <View>
      {tasks?.map(task => (
        <Text key={task._id}>{task.text}</Text>
      ))}
    </View>
  );
}