如何编写可重用的SQL存储过程_利用模块化设计简化代码维护

冬瑶君_3732

冬瑶君_3732

2026-03-22

164人浏览

原创

存储过程命名须带业务前缀和动词,禁用sp_开头;参数统一加@in/@out/@is前缀且默认null;禁用动态sql;返回一律用select;错误用throw;单过程只做一件事。

如何编写可重用的sql存储过程_利用模块化设计简化代码维护

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

SQL Server 会优先在 master 数据库里找 sp_ 开头的存储过程,哪怕你明确指定了数据库名,也可能触发额外解析开销甚至误调用系统过程。更实际的问题是:团队里没人能一眼看出这个过程属于订单模块还是用户模块。

实操建议:

  • 用业务域+动作命名,比如 orders_create_from_cart、users_merge_duplicate_profiles
  • 所有参数加统一前缀,如 @in_user_id(输入)、@out_order_id(输出)、@is_debug(控制日志)
  • 避免在过程名里塞版本号或日期,比如 sp_report_v2_2024——重用的前提是稳定,不是靠改名绕过维护

参数默认值只设 NULL,别设具体值如 0 或空字符串

设具体默认值等于悄悄改变调用方语义。比如 @in_status INT = 0,调用时没传参,结果过滤出所有 status=0 的记录;但业务上“不指定状态”本意是“不限制”,不是“只查禁用状态”。

常见错误现象:前端分页接口传了 @page_size = NULL,但过程里写成 ISNULL(@page_size, 20),导致后台导出全量数据时被截断。

实操建议:

  • 所有参数默认为 NULL,并在开头用 ISNULL() 或 CASE 显式处理“未提供”的逻辑
  • 对必填参数,在注释里写清约束,比如 -- @in_order_id: 必填,非零正整数
  • 布尔类开关参数用 BIT 类型,设默认 = NULL,而不是 = 0,留出“未启用”语义空间

别在存储过程里拼接 SQL 字符串执行 EXEC(@sql)

动态 SQL 看似灵活,实则直接杀死可重用性:执行计划无法复用、参数化失效、SQL 注入风险陡增、调试时根本看不到真实执行语句。

使用场景只有极少数例外:分表查询(如按月日志表)、兼容旧字段名的迁移过渡期。其余情况,99% 都能用 CASE WHEN、临时表或 CTE 替代。

实操建议:

  • 用 IF @in_sort_by = 'created' 分支代替拼接 ORDER BY created DESC
  • 需要条件过滤字段时,用 AND (@in_category_id IS NULL OR category_id = @in_category_id)
  • 真要动态列,先用视图或计算列固化逻辑,而不是在过程里 EXEC

返回结果统一用 SELECT,别混用 RETURN、OUTPUT 参数或临时表

RETURN 只能传整数状态码,OUTPUT 参数难调试且客户端支持不一,临时表跨过程不可见——这三者都会让下游(尤其是 ORM 或 BI 工具)抓瞎。

性能影响明显:用 OUTPUT 返回 100 行数据,比直接 SELECT 多一次数据序列化;临时表还可能引发锁竞争。

实操建议:

  • 所有业务数据一律走 SELECT,结构固定(字段名、类型、顺序不变)
  • 错误信息不塞进结果集,改用 THROW 抛异常,由调用方捕获
  • 需要多结果集?用多个 SELECT 语句,现代驱动都支持(如 .NET 的 SqlDataReader.NextResult())

最常被忽略的一点:重用不是靠“写得通用”,而是靠“边界清晰”。一个存储过程只做一件事,参数只暴露必要维度,返回结构不随内部逻辑调整而变——否则每次修改都在给下游埋雷。

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

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

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

4263

8

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

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

2023.10.27

891

4

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

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

2024.02.23

1109

5

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

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

2024.03.06

6181

10

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

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

2024.03.06

3023

4

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

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

2024.04.07

6160

11

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

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

2024.04.29

8321

6

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

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

2024.04.29

1130

5

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

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

2024.04.29

992

5

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习