Supabase实时客户端实操指南：supabase-realtime-js

1. 项目介绍

Supabase实时客户端（@supabase/realtime-js）是专为Supabase平台设计的一个强大的Isomorphic JavaScript库，它让开发者能够无缝地集成实时功能到自己的应用程序中。该库支持广播消息、状态同步（通过CRDTs）、以及基于PostgreSQL数据库改变数据捕获（CDC）。这意味着，你可以即时发送消息从客户端到客户端，跟踪并同步多用户的共享状态，并监听数据库的变化，无需繁琐的轮询。

2. 项目快速启动

安装客户端

首先，你需要安装@supabase/realtime-js包到你的项目中。可以通过npm完成：

npm install @supabase/realtime-js

连接到Supabase实时服务

接下来，创建一个客户端实例并连接到Supabase的实时服务器。记得替换REALTIME_URL和API_KEY为你的实际Supabase项目设置。

import { RealtimeClient } from '@supabase/realtime-js';

const REALTIME_URL = 'wss://<your_project_id>.supabase.co/realtime/v1';
const API_KEY = '<your_api_key>'; // 使用JWT令牌
const client = new RealtimeClient(REALTIME_URL, { params: { apikey: API_KEY } });

// 创建并订阅到一个频道
const channel = client.channel('test-channel', []);
channel.subscribe((status, err) => {
    if (status === 'SUBSCRIBED') console.log('已连接');
});

发送和接收广播消息

channel.on('broadcast', { event: 'greeting' }, (payload) => {
    console.log('接收到广播消息:', payload);
});

channel.subscribe(async (_) => {
    if (_ === 'SUBSCRIBED') {
        await channel.send({ type: 'broadcast', event: 'greeting', payload: { msg: 'Hello World!' } });
    }
});

3. 应用案例和最佳实践

实时聊天应用

在构建实时聊天应用时，可以利用广播功能来传递消息。每个用户的消息通过广播事件发送到所有其他在线用户，确保即时通讯体验。

channel.on('chat-message', async (payload) => {
    displayMessage(payload); // 假设存在一个显示消息的函数
});

channel.subscribe(() => {
    if (_ === 'SUBSCRIBED') {
        sendMessageToServer({ message: '加入聊天室' }); // 向后端发送加入信息
    }
});

用户在线状态同步

通过Supabase实时客户端的Presence特性，可以轻松实现用户在线列表的自动更新。

channel = client.channel('presence', [{ presence: [{ key: 'user_id' }] }]);
channel.on('presence', { event: 'sync' }, () => {
    console.log('当前在线用户:', channel.presenceState());
});
channel.subscribe();

4. 典型生态项目

虽然该项目本身主要作为Supabase生态的一部分，但与之相结合的其他开源组件（如@supabase/supabase-js用于数据库操作）可以构成完整的全栈解决方案。例如，在构建实时数据分析仪表板或协作工具时，Supabase实时客户端配合其数据库访问库，可以极大简化实时数据推送和交互逻辑的开发工作。

请注意，为了更好地整合Supabase实时功能到你的应用中，深入研究其官方文档和社区示例是非常重要的。这将帮助你理解如何最大化利用这个库的功能，并在实际应用中实现高效且可靠的实时交互。