PostgreSQL中RETURNS与单OUT参数的差异及替代可行性问询

可以用OUT参数替代RETURNS，但二者并非完全等价，存在一些需要注意的细节和潜在问题，以下是具体分析：

1. 单OUT参数与RETURNS的等价性 #

当函数仅定义一个OUT参数时，其效果和用RETURNS指定返回类型几乎一致。比如你提供的示例：
错误的初始代码（RETURNS方式）：

create function arraycol(v anyelement,n int,i int) returns anyarray language plpgsql

替换后的OUT参数写法：

create function arraycol(v anyelement,n int,i int,OUT r anyarray) language plpgsql

这两种定义在调用时返回的结果完全相同，PostgreSQL会将唯一的OUT参数作为函数的返回值。

2. 多OUT参数的行为差异 #

如果定义多个OUT参数，函数会自动返回一个record类型，每个OUT参数对应record的一个字段。而使用RETURNS的话，你需要显式定义复合类型或使用RETURNS TABLE来返回多列，虽然最终效果类似，但语法和语义上的表达更清晰，也更符合常规的函数返回逻辑。

3. 潜在弊端与注意事项 #

• 可读性降低：OUT参数会和输入参数混在一起，不熟悉代码的开发者可能会误以为是输入参数，增加理解成本。而RETURNS明确标注了函数的返回类型，意图更直观。
• 重载函数冲突风险：PostgreSQL的函数重载依赖参数列表的属性（包括参数类型、数量、输入/输出属性）。用OUT参数替代RETURNS会改变参数的属性，可能导致原本的重载函数匹配异常或冲突。
• 语法特性兼容性问题：当需要返回集合类型时，RETURNS SETOF [类型]的写法比用OUT参数配合RETURNS SETOF record更清晰，也更符合PostgreSQL的常规语法规范。此外，部分第三方工具或框架对RETURNS的支持更完善，解析返回类型时更准确。
• 变量初始化差异：OUT参数在函数执行开始时会自动初始化为NULL，而使用RETURNS时需要你自行声明返回变量并初始化，这一点在逻辑处理中需要注意，避免出现意外的NULL值。

总结 #

如果是简单的单一返回值场景，OUT参数和RETURNS差异不大，但从代码可读性和团队协作角度，优先选择RETURNS更符合常规开发习惯；如果需要返回多个值，或者处理像anyarray这类在RETURNS中需要特殊处理的动态类型场景，OUT参数确实更灵活，但要留意上述潜在问题。

内容的提问来源于stack exchange，提问作者George Kourtis