Skip to content

命名规范

命名规范

  • 规范:命名规范-强制执行
  • 说明:为解决sql语句查询命名冲突,java类命名含意不清晰问题,定义以下命名规范(方式)
    1. 确认sql查询,java类的主体。比如:user 用户【以下基于用户为主体的命名】
    2. 简单命名:主体内容命名采用简单命名,比如 id = 用户编号。name = 用户名称。status = 用户状态
    3. 完整命名:非主体内容命名采用完整命名,比如 school_id = 学校编号。school_name = 学校名称。school_status = 学校状态。
    4. 无法确认主体的sql查询,java类,全部采用完整命名,不允许出现 id, name, status 等命名方式。
    5. 表字段 为下划线规范,类为驼峰规范。两者已经实现自动转换
    6. 表名、字段名必须使用小写字母或数字,禁止出现数字开头,禁止两个下划线中间只出现数字,禁止使用驼峰命名
    7. 表名不使用复数名词
    8. 字段禁用官方保留字
    9. 唯一索引用 uk_字段名 ,普通索引用 idx_字段名
    10. 表名前应该加上前缀,一般为:业务名称_表的作用
    11. 日志表均以_log后缀
    12. 临时表要以tmp_前缀,以时间后缀, 备份表要以bak_前缀,以时间后缀

Released under the MIT License.