PostgreSQL 19 preview - 協議擴展: 新增宏替代魔法字符

https://github.com/postgres/postgres/commit/9ea3b6f751abd7701f3f32d9df26d66410754c94

該提交（9ea3b6f751abd7701f3f32d9df26d66410754c94）的主要內容和意義如下：

變更解讀

標題： Expand usage of macros for protocol characters
作者： Nathan Bossart
提交時間： 2025-08-06
鏈接： https://github.com/postgres/postgres/commit/9ea3b6f751abd7701f3f32d9df26d66410754c94

主要內容

• 本次提交將協議消息中的“魔法字符（protocol characters）”硬編碼，替換為了統一的宏定義（macro）。
• 新增了多個宏，如 PqReplMsg_* 和 PqBackupMsg_*，分別用于復制、備份相關的特殊消息。
• 在多處代碼（如流復制、邏輯復制、BaseBackup、pg_basebackup工具等）用宏替換了原本的字符字面量，如 'w'、'k'、'r'、'm'等。
• 在 src/include/libpq/protocol.h 頭文件中集中定義了這些宏，提升了可維護性和可讀性，降低了出錯風險。

影響范圍

• 邏輯和物理復制協議
• BaseBackup 相關備份協議
• 客戶端工具（如pg_basebackup、pg_recvlogical等）
• 代碼中所有涉及協議符號的地方均由宏定義統一

使用示例

以物理復制和 BaseBackup 協議為例：

1. 后端發送 WAL 數據

原代碼（偽代碼）：

pq_sendbyte(ctx->out, 'w'); // 發送WAL數據  

新代碼：

pq_sendbyte(ctx->out, PqReplMsg_WALData);  

2. 客戶端接收消息類型

原代碼：

if (copybuf[0] == 'k') { ... } // 保活消息  

新代碼：

if (copybuf[0] == PqReplMsg_Keepalive) { ... }  

3. 備份流程中處理新歸檔文件

原代碼：

switch (GetCopyDataByte(...)) {  
  case 'n': // 新歸檔  
    ...  
}  

新代碼：

switch (GetCopyDataByte(...)) {  
  case PqBackupMsg_NewArchive:  
    ...  
}  

4. 定義宏（src/include/libpq/protocol.h）

#define PqReplMsg_Keepalive         'k'  
#define PqReplMsg_WALData           'w'  
#define PqReplMsg_StandbyStatusUpdate 'r'  
#define PqBackupMsg_NewArchive      'n'  
#define PqBackupMsg_ProgressReport  'p'  
#define PqBackupMsg_Manifest        'm'  

總結

此次提交將協議相關的關鍵字母全部用宏封裝，便于后續協議拓展和維護，也減少了開發者“魔法字符”誤用、出錯的可能性。所有涉及協議通信的地方都推薦采用這些宏。

參考鏈接

• 該提交詳情
• protocol.h 新增宏定義

如需進一步了解如何在自己的代碼中應用這些宏，請告知具體使用場景。