Postgres.js 监听通知功能使用指南

Postgres.js 是一个流行的 Node.js PostgreSQL 客户端库，提供了简洁的 API 来与 PostgreSQL 数据库交互。本文将详细介绍如何使用 Postgres.js 的监听通知功能，以及在实际开发中可能遇到的常见问题。

监听通知的基本用法

Postgres.js 提供了 listen() 方法来监听 PostgreSQL 的 NOTIFY 事件。基本语法如下：

await sql.listen(
  'channel_name',  // 通道名称
  (payload) => {   // 接收到通知时的回调函数
    console.log('收到通知:', payload);
  },
  () => console.log('开始监听...')  // 监听成功后的回调
);

发送通知的三种方式

Postgres.js 支持三种发送通知的方式：

1. 使用 notify() 方法：

   await sql.notify('channel_name', 'message');
   

2. 使用 SQL 的 NOTIFY 命令：

   await sql`NOTIFY channel_name, 'message'`;
   

3. 使用 PostgreSQL 的 pg_notify 函数：

   await sql`select pg_notify('channel_name', 'message')`;
   

常见问题与解决方案

问题：监听器未触发

在最初的示例中，开发者遇到了监听器未触发的问题。原因在于回调函数中尝试解析通知负载为 JSON：

(payload) => {
  const json = JSON.parse(payload)  // 如果payload不是JSON格式，会抛出错误
  console.log('Realtime payload:', json)
}

解决方案：

1. 确保发送的通知是有效的 JSON 字符串
2. 或者直接处理原始字符串负载：

   (payload) => {
     console.log('Realtime payload:', payload)
   }
   

最佳实践

1. 错误处理：始终为监听器添加错误处理逻辑
2. 通道命名：使用有意义的通道名称，避免冲突
3. 负载格式：如果需要复杂数据结构，建议使用 JSON 格式
4. 资源清理：在应用关闭时取消监听

完整示例

// 设置监听器
await sql.listen('realtime', 
  (payload) => {
    try {
      const data = JSON.parse(payload);
      console.log('解析后的数据:', data);
    } catch {
      console.log('原始通知:', payload);
    }
  },
  () => console.log('监听器已启动')
);

// 发送通知的三种方式
await sql.notify('realtime', JSON.stringify({msg: "Hello"}));
await sql`NOTIFY realtime, ${JSON.stringify({msg: "Hi"})}`;
await sql`select pg_notify('realtime', ${JSON.stringify({msg: "Hey"})})`;

通过理解这些概念和最佳实践，开发者可以有效地利用 Postgres.js 的通知功能构建实时应用。