mysql函数命名有哪些规范_mysql代码规范说明

老强姑娘_4836

老强姑娘_4836

2026-01-20

718人浏览

原创

MySQL自定义函数名应全小写、下划线分隔、见名知意、避开保留字,并与表/字段命名风格统一;需注意作用域、调用上下文及上线后改名的高成本。

mysql函数命名有哪些规范_mysql代码规范说明

MySQL 本身没有用户可定义的函数命名规范强制约束,但实际开发中,为避免冲突、提升可维护性、适配 ORM 或运维工具,必须遵循一套隐性但强效的命名约定。直接说结论:自定义函数名应和表/字段/索引一样,全小写 + 下划线分隔 + 见名知意 + 避开保留字,且需额外注意函数作用域与调用上下文。

MySQL 自定义函数名必须全小写 + 下划线

Linux 环境下 MySQL 默认对函数名大小写敏感(依赖 lower_case_table_names 设置),而绝大多数生产环境设为 1(即强制转小写存储)。若你写 CREATE FUNCTION GetUserName(),MySQL 会存成 getusername,后续调用 SELECT GetUserName(...) 可能报错或行为不一致。
所以统一用小写+下划线,既是兼容性底线,也是团队协作前提:

CREATE FUNCTION user_full_name(user_id INT) RETURNS VARCHAR(100)
READS SQL DATA
DETERMINISTIC
BEGIN
  RETURN (SELECT CONCAT(first_name, ' ', last_name) FROM users WHERE id = user_id);
END;

✅ 正确:user_full_name
❌ 危险:UserFullName、get_user_name(虽语法通过,但和索引/字段风格割裂,易被误认为是 ORM 方法)

别碰 MySQL 保留字,哪怕加了反引号也不推荐

像 order、group、rank、match 这些词,即使你用反引号包起来能创建成功(`rank`),但在跨语言调用(如 Python 的 SQLAlchemy、Java 的 MyBatis)或导出为 DDL 脚本时,极易引发解析失败或静默错误。

JavaScript 开发专家
JavaScript 开发专家

掌握包含 ES6+、异步模式和 Node.js API 的现代 JavaScript。处理 Promise、事件循环和浏览器/Node 兼容性。在 JavaSc

下载
  • ❌ 避免:CREATE FUNCTION rank_by_score(...) → rank 是保留字,即便没报错,SQL 解析器可能歧义
  • ✅ 替代:user_rank_by_score、score_ranking(加业务前缀或换词)
  • 查保留字清单用:SELECT * FROM INFORMATION_SCHEMA.KEYWORDS WHERE RESERVED = 1;

函数名要体现“做什么”,而不是“怎么做的”

MySQL 函数不是过程式脚本,它会被嵌入到 SELECT、WHERE 甚至触发器中。名字必须让调用者一眼明白语义,否则极易误用或重复造轮子。

  • ❌ 模糊:calc_val、do_something —— 完全无法判断输入输出和副作用
  • ✅ 清晰:format_phone_cn(格式化中国手机号)、is_valid_email(校验邮箱格式)、days_since_last_login(返回距上次登录天数)
  • ⚠️ 注意:is_ 前缀仅用于返回 BOOLEAN/TINYINT(1) 的函数;若返回字符串或数字,别硬套,比如 is_user_active 合理,is_user_name 就很怪

和表/字段命名保持同一套语义体系

一个项目里如果表叫 t_user_basic、字段叫 create_time、索引叫 idx_user_status,结果函数却叫 GetUserCreationDate(),这种混搭会让新人完全失去命名线索,也阻碍自动化工具识别(比如 DBA 工具扫描所有 user_* 对象)。

  • 统一前缀示例:
    – 用户相关:user_is_vip、user_total_orders、user_avatar_url
    – 订单相关:order_is_paid、order_amount_with_tax
  • 字段名和函数名语义对齐:
    若字段是 status(TINYINT),对应函数就该是 user_status_label 而非 getUserStatusText
  • 禁止缩写歧义:usr_name_len 不如 user_name_length 明确(usr 可能被读作 “user” 或 “usurper”)

真正容易被忽略的是:函数名一旦上线,改名成本极高——不只是改函数定义,还要全局搜索所有 SQL、视图、存储过程、应用代码里的调用点。所以第一次命名就得想清楚边界:它只处理单行?是否允许 NULL 输入?是否依赖特定时区或变量?这些都该在名字里留出可扩展空间,比如 user_name_normalized 比 user_name_trim 更可持续。

相关文章

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

5003

8

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

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

2023.10.27

1011

4

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

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

2024.02.23

1309

5

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

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

2024.03.06

7061

10

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

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

2024.03.06

3723

4

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

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

2024.04.07

7060

11

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

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

2024.04.29

9881

6

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

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

2024.04.29

1350

5

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

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

2024.04.29

1172

5

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程