0

0

如何编写SQL存储过程接口规范_统一调用格式方便对接

P粉602998670

P粉602998670

发布时间:2026-03-16 16:32:03

|

175人浏览过

|

来源于php中文网

原创

存储过程命名须带业务前缀和动词,禁用sp_开头;参数全用@前缀且明确类型,必填项不设默认值;返回仅用SELECT统一结构;错误处理必须TRY...CATCH+THROW;多表写入须显式事务。

如何编写sql存储过程接口规范_统一调用格式方便对接

存储过程命名必须带业务前缀和动词,避免 sp_ 开头

SQL Server 里以 sp_ 开头的存储过程会被引擎优先从系统库查找,哪怕你定义在用户库,也可能触发额外解析开销甚至调用错对象。其他数据库虽无此限制,但统一前缀能立刻区分用途。

实际对接时,前端或中间件靠名字识别能力(比如「查订单」还是「删订单」),光看 GetOrder 不如 order_get_by_id 明确——后者一眼看出是按 ID 查,且归属 order 模块。

  • order_createuser_update_statuspayment_refund_apply:小写下划线,动词+名词+限定词
  • 禁止 spUpdateUserproc_GetOrderList 这类混用大小写或加冗余前缀的写法
  • 同一业务域下,所有存储过程统一用相同前缀(如全部以 order_ 开头),方便权限批量管控

输入参数全用 @ 前缀 + 明确类型,禁用 NULL 默认值掩盖必填逻辑

接口规范的核心是“调用方能不查文档就懂怎么传”。如果参数默认为 NULL,调用方可能误以为可省略,结果过程内部没做非空判断,直接报错或逻辑跳过。

更麻烦的是,有些 ORM 或 JDBC 驱动对 NULL 参数处理不一致——有的发空字符串,有的发 SQL NULL,有的干脆跳过该参数,导致行为不可控。

  • 必填参数:声明为 @order_id BIGINT,不设默认值;由调用方保证传入
  • 可选参数:显式写 @status_filter VARCHAR(20) = NULL,并在过程开头用 IF @status_filter IS NULL 分支处理
  • 避免用 GETDATE() 这类运行时函数作默认值,会破坏测试可重现性

返回结果只走 SELECT,禁用 PRINTRAISERROR 干扰数据流

很多老代码喜欢用 PRINT 'Success'RAISERROR 输出状态,但这会让客户端收到多结果集(data + message),尤其 Java 的 ResultSet 或 Python 的 fetchall() 容易只取第一个,把错误信息漏掉或当成数据解析失败。

米粿AI
米粿AI

AI辅助动漫创作工具,专为专业漫画师和动画制作团队设计

下载

真正需要反馈执行结果(比如影响行数、生成 ID、错误码),应该统一塞进结果集字段里,而不是混在消息通道中。

  • 成功时只返回一张表:SELECT 1 AS code, 'OK' AS msg, @new_order_id AS data
  • 失败时也返回同结构:SELECT -1 AS code, 'Invalid user_id' AS msg, NULL AS data
  • 绝对不用 SET NOCOUNT ON 关闭行数提示——它虽减少网络包,但让调用方无法感知是否真有数据返回

错误处理必须用 TRY...CATCH 封装,且 CATCH 块里只抛出带状态码的 THROW

裸写 IF @@ERROR 0 很难覆盖所有异常场景(比如死锁、超时、权限拒绝),而且分散在各处难以维护。统一用 TRY...CATCH 是底线。

但很多人在 CATCH 里又写 RAISERROR,这会导致原错误号丢失(变成 50000),调用方无法区分是唯一键冲突(2627)还是死锁(1205)。SQL Server 2012+ 支持 THROW,它能原样透传错误号和消息。

  • THROW 50001, 'Order not found', 1:自定义业务错误,客户端可按 50001 特殊处理
  • THROW(无参数):原样重抛上层错误,保留原始错误号与上下文
  • CATCH 块末尾必须有 RETURN,防止控制流意外继续往下执行

最常被绕过的其实是事务边界——不是所有存储过程都自动套事务,但只要涉及多表写入,就必须显式 BEGIN TRAN + COMMIT/ROLLBACK,且 ROLLBACK 必须放在 CATCH 里。这点一旦漏掉,数据不一致不会立刻报错,而是悄悄发生。

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

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

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

1135

2023.10.12

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

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

340

2023.10.27

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

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

381

2024.02.23

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

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

2256

2024.03.06

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

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

380

2024.03.06

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

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

1743

2024.04.07

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

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

587

2024.04.29

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

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

441

2024.04.29

chatgpt使用指南
chatgpt使用指南

本专题整合了chatgpt使用教程、新手使用说明等等相关内容,阅读专题下面的文章了解更多详细内容。

0

2026.03.16

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号