pgFormatter 中临时表创建语句的缩进问题解析

在 PostgreSQL 数据库开发中，pgFormatter 是一个广受欢迎的 SQL 代码格式化工具。近期，用户 Olamshin 报告了一个关于临时表创建语句后缩进异常的问题，这个问题在版本 5.5 中出现，并已在后续提交中被修复。

问题现象

当开发者在 PL/pgSQL 存储过程中使用 CREATE TEMPORARY TABLE 语句后，紧接着的 INSERT 语句会出现缩进不正确的现象。具体表现为 INSERT 语句没有按照预期的缩进层级显示，导致代码可读性下降。

问题复现

通过以下示例代码可以重现该问题：

CREATE OR REPLACE PROCEDURE do_something ()
LANGUAGE plpgsql
AS $$
DECLARE
    salt text;
BEGIN
    -- 创建临时表
    CREATE TEMPORARY TABLE IF NOT EXISTS temp_id (
        id varchar
    ) ON COMMIT DELETE ROWS;
    TRUNCATE TABLE temp_id;
INSERT INTO temp_id  -- 这里的缩进不正确
SELECT
    id
FROM
    jones;
END;
$$

有趣的是，如果在 INSERT 语句前添加注释，这个问题就会消失，这说明问题与语句解析逻辑有关。

技术分析

这个问题本质上属于语法解析器的缩进处理逻辑缺陷。在解析 PL/pgSQL 代码块时，pgFormatter 需要正确识别不同类型的语句边界，并应用适当的缩进规则。对于临时表创建语句后的语句，格式化工具未能正确维护当前的缩进层级。

解决方案

项目维护者 darold 在提交 8a04008 中修复了这个问题。修复的核心在于改进了语法解析器对临时表创建语句后语句缩进的处理逻辑，确保后续语句能够保持正确的缩进层级。

最佳实践

虽然这个问题已被修复，但在使用任何代码格式化工具时，开发者应该注意：

1. 定期更新工具版本以获取最新的错误修复
2. 对于复杂的存储过程，可以分段格式化以确保结果符合预期
3. 在关键语句前后添加注释有时可以帮助格式化工具更好地理解代码结构

总结

代码格式化工具在提高开发效率的同时，也会遇到各种边界条件的挑战。pgFormatter 团队对这类问题的快速响应体现了开源项目的优势。开发者在使用时应当了解工具的局限性，并在发现问题时及时反馈，共同完善工具功能。