如何实现SQL存储过程标准化输出_统一JSON响应格式

夜枫大大_1144

夜枫大大_1144

2026-04-27

307人浏览

原创

关键不是能否转JSON,而是确保每次输出结构可预测:SQL Server需用WITHOUT_ARRAY_WRAPPER和ISNULL;MySQL要CAST防类型误转;PostgreSQL宜用to_jsonb+jsonb_strip_nulls;跨库应由应用层统一序列化并校验Schema。

如何实现sql存储过程标准化输出_统一json响应格式

SQL Server 存储过程中用 FOR JSON 生成标准响应结构

SQL Server 2016+ 原生支持 FOR JSON,但直接拼接会导致字段名大小写不一致、空数组变 null、无数据时返回空字符串而非 {} —— 这些都会让前端解析出错。
关键不是“能不能转 JSON”,而是“怎么让每次输出的结构可预测”。

  • 必须显式指定 ROOT 或 WITHOUT_ARRAY_WRAPPER:否则单条记录会包一层数组,多条又没包,前端 Array.isArray() 判断失效
  • 用 ISNULL(col, '') 或 COALESCE(col, '') 处理 NULL 字段:避免 JSON 中出现 "field": null,前端若期望字符串类型就容易报错
  • 统一外层包装键名,比如固定用 "data" 和 "code":别依赖业务逻辑动态拼 key,否则下游要写一堆 if-else

示例(安全返回空对象):

SELECT 
  200 AS code,
  ISNULL((SELECT * FROM users WHERE id = @id FOR JSON PATH, WITHOUT_ARRAY_WRAPPER), '{}') AS data
FOR JSON PATH, WITHOUT_ARRAY_WRAPPER;

MySQL 存储过程里拼 JSON 要绕开 JSON_OBJECT 的隐式类型转换陷阱

MySQL 5.7+ 的 JSON_OBJECT 看似方便,但它会把整数 0 当成 false、空字符串当 null,甚至把时间字段转成带引号的字符串(如 "2024-01-01"),破坏前后端约定的数据类型。

  • 所有字段值先过 CAST(... AS CHAR):尤其数值、布尔、日期类字段,防止自动降级或误转
  • 用 IFNULL 替代 COALESCE:MySQL 的 COALESCE 在 JSON 上下文中可能触发意外类型推导
  • 不要嵌套调用 JSON_OBJECT:多层嵌套易触发 Invalid JSON text 错误,改用拼接 + JSON_VALID 校验

示例(可控字段类型):

SELECT JSON_OBJECT(
  'code', 200,
  'data', IFNULL(
    (SELECT JSON_OBJECT('id', CAST(id AS CHAR), 'name', name) 
     FROM user WHERE id = ?),
    JSON_OBJECT()
  )
) AS result;

PostgreSQL 存储过程返回 JSON 时,row_to_json 和 to_jsonb 别混用

PostgreSQL 中 row_to_json 保留字段顺序但不支持 NULL 过滤;to_jsonb 支持 jsonb_strip_nulls 却会打乱字段顺序 —— 两者行为差异直接影响前端解构逻辑。

arcgis-js
arcgis-js

提供 ArcGIS Maps SDK for JavaScript 开发辅助,涵盖 2D/3D 地图视图、图层管理、数据可视化、空间分析等功能模块的参考和示例指导。

下载
  • 统一用 to_jsonb + jsonb_strip_nulls:前端通常不依赖字段顺序,但需要干净的非空结构
  • 手动构造顶层对象,别依赖 SELECT ... INTO 自动映射:否则函数返回 record 类型,JSON 化后 key 名可能含 schema 前缀(如 "public.users.id")
  • 在函数结尾加 RETURN COALESCE(result, '{}'::jsonb):避免 NULL 返回导致调用方收到 SQLSTATE 错误而非预期 JSON

示例(防 NULL + 固定结构):

CREATE OR REPLACE FUNCTION get_user_json(id INT)
RETURNS JSONB AS $$
DECLARE
  result JSONB;
BEGIN
  SELECT JSONB_STRIP_NULLS(
    TO_JSONB(u.*) || '{"code":200}'::jsonb
  ) INTO result
  FROM users u WHERE u.id = id;
<p>RETURN COALESCE(result, '{"code":404,"data":{}}'::jsonb);
END;
$$ LANGUAGE plpgsql;</p>

跨数据库统一响应格式,靠中间层兜底比 DB 层硬编码更可靠

不同数据库对 JSON 的支持粒度、错误码含义、NULL 处理逻辑都不一样。试图在每个存储过程中写一套“标准 JSON 模板”,结果是维护成本飙升,且一旦 DB 升级(比如 SQL Server 2022 对 FOR JSON 加了新选项),旧逻辑就可能崩。

  • 存储过程只负责查数据、做简单映射,不拼 JSON:返回标准 result set,让应用层(Go/Python/Node)用成熟 JSON 库序列化
  • 如果必须 DB 层输出 JSON,用视图 + 统一包装函数封装逻辑:比如所有查询走 v_api_response 视图,它内部调用 format_api_json() 函数做字段标准化
  • 在应用层加 JSON Schema 校验:哪怕 DB 返回了 JSON,也用 ajv 或 jsonschema 验证结构,提前暴露字段缺失、类型错位问题

真正难的不是“怎么生成 JSON”,而是“怎么让所有人——DBA、后端、前端——对同一个字段的类型、可空性、嵌套层级达成稳定共识”。这个共识没法靠一个存储过程实现,得靠接口定义文档 + 自动化校验卡点。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

js json

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
数据分析工具有哪些
数据分析工具有哪些

数据分析工具有Excel、SQL、Python、R、Tableau、Power BI、SAS、SPSS和MATLAB等。详细介绍:1、Excel,具有强大的计算和数据处理功能;2、SQL,可以进行数据查询、过滤、排序、聚合等操作;3、Python,拥有丰富的数据分析库;4、R,拥有丰富的统计分析库和图形库;5、Tableau,提供了直观易用的用户界面等等。

2023.10.12

4583

8

SQL中distinct的用法
SQL中distinct的用法

SQL中distinct的语法是“SELECT DISTINCT column1, column2,...,FROM table_name;”。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.27

951

4

SQL中months_between使用方法
SQL中months_between使用方法

在SQL中,MONTHS_BETWEEN 是一个常见的函数,用于计算两个日期之间的月份差。想了解更多SQL的相关内容,可以阅读本专题下面的文章。

2024.02.23

1209

5

SQL出现5120错误解决方法
SQL出现5120错误解决方法

SQL Server错误5120是由于没有足够的权限来访问或操作指定的数据库或文件引起的。想了解更多sql错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

6561

10

sql procedure语法错误解决方法
sql procedure语法错误解决方法

sql procedure语法错误解决办法:1、仔细检查错误消息;2、检查语法规则;3、检查括号和引号;4、检查变量和参数;5、检查关键字和函数;6、逐步调试;7、参考文档和示例。想了解更多语法错误的相关内容,可以阅读本专题下面的文章。

2024.03.06

3323

4

oracle数据库运行sql方法
oracle数据库运行sql方法

运行sql步骤包括:打开sql plus工具并连接到数据库。在提示符下输入sql语句。按enter键运行该语句。查看结果,错误消息或退出sql plus。想了解更多oracle数据库的相关内容,可以阅读本专题下面的文章。

2024.04.07

6540

11

sql中where的含义
sql中where的含义

sql中where子句用于从表中过滤数据,它基于指定条件选择特定的行。想了解更多where的相关内容,可以阅读本专题下面的文章。

2024.04.29

8981

6

sql中删除表的语句是什么
sql中删除表的语句是什么

sql中用于删除表的语句是drop table。语法为drop table table_name;该语句将永久删除指定表的表和数据。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1210

5

sql中删除一列的命令是什么
sql中删除一列的命令是什么

在sql中,使用alter table语句可以删除一列,语法为:alter table table_name drop column column_name。想了解更多sql的相关内容,可以阅读本专题下面的文章。

2024.04.29

1072

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 21.2万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 4.9万人学习