react-query-external-sync 的安装和配置教程

项目基础介绍

react-query-external-sync 是一个强大的调试工具，它可以同步 React Query 状态、设备存储（MMKV、AsyncStorage、SecureStorage）以及环境变量从你的 React/React Native 应用到一个外部仪表板，通过 Socket.IO 实现。这个工具支持实时调试，适用于网页、移动端、桌面和电视平台，并且在生产环境中不会产生任何影响。

该项目主要使用 JavaScript 编程语言，并针对 React 和 React Native 应用进行了优化。

项目使用的关键技术和框架

• React Query：用于在 React 应用中管理异步数据的库。
• Socket.IO：用于在浏览器和服务器之间实现实时、双向和事件驱动的通信。
• MMKV：一种适用于 React Native 的键值存储库。
• AsyncStorage：一种异步、持久化的键值存储系统，用于在 React Native 应用中保存数据。
• SecureStore：Expo 提供的一个用于安全存储敏感信息的 API。

准备工作

在开始安装和配置 react-query-external-sync 之前，请确保你的开发环境满足以下要求：

• 安装了 Node.js 和 npm（或 yarn/pnpm）。
• 创建了一个新的 React 或 React Native 项目。
• 确保你的项目可以使用 react-query。

安装步骤

1. 安装依赖

首先，你需要安装 react-query-external-sync 和 socket.io-client。

npm install --save-dev react-query-external-sync socket.io-client
# 或者使用 yarn
# yarn add -D react-query-external-sync socket.io-client
# 或者使用 pnpm
# pnpm add -D react-query-external-sync socket.io-client

2. 配置 React Query 客户端

在你的 React 或 React Native 应用中，设置 React Query 客户端。

import { QueryClient, QueryClientProvider } from '@tanstack/react-query';
import { useSyncQueriesExternal } from 'react-query-external-sync';

// 创建你的 query client
const queryClient = new QueryClient();

3. 集成外部同步钩子

在你的应用的根组件中，使用 useSyncQueriesExternal 钩子来集成外部同步功能。

import { Platform } from 'react-native';
import AsyncStorage from '@react-native-async-storage/async-storage';
import * as SecureStore from 'expo-secure-store';
import { storage } from './mmkv'; // 你的 MMKV 实例

function App() {
  // 统一存储查询和外部同步 - 所有操作都在一个钩子中！
  useSyncQueriesExternal({
    queryClient,
    socketURL: 'http://localhost:42831', // 你的 Socket 服务器 URL
    deviceName: Platform.OS, // 设备的可读名称
    platform: Platform.OS, // 平台标识符
    deviceId: Platform.OS, // 设备的唯一标识符
    extraDeviceInfo: { appVersion: '1.0.0' }, // 额外的设备信息
    enableLogs: true, // 启用控制台日志
    // 存储监控，支持 CRUD 操作
    mmkvStorage: storage, // MMKV 存储
    asyncStorage: AsyncStorage, // AsyncStorage
    secureStorage: SecureStore, // SecureStore
    secureStorageKeys: ['userToken', 'refreshToken', 'biometricKey', 'deviceId'], // 要监控的 SecureStore 键
  });

  // 你的应用内容
  return <YourApp />;
}

确保你已经正确配置了 Socket 服务器的 URL，并且这个服务器是可用的。

4. 启动应用

完成上述步骤后，你可以启动你的 React 或 React Native 应用。如果你的应用和 DevTools 应用程序一起使用，确保先启动 DevTools 应用程序。

以上就是 react-query-external-sync 的安装和配置指南。按照这些步骤操作，你就可以在你的应用中启用强大的调试功能了。