编程规约

展示常见的规范，其余代码规范参考《阿里巴巴Java开发手册》

数据库

1. 命名风格：小写字母，下划线命名风格
2. 数据库参数
   • 数据库引擎：InnoDB；
   • 字符集：utf8；
   • 字符校对集：generic_utf8_ci
3. 数据库表
   1. 表名：前缀为项目名称首字母缩写，单词之间用下划线分割，单数形式；
   2. 必备三字段：id，create_time，update_time
      • id：逻辑主键
      • create_time：创建时间
      • update_time：更新时间
   3. 主键
      • 逻辑主键：无实际含义，用于唯一标识每个记录
      • 业务主键：有实际含义
   4. 要求每个字段有注释；
4. 属性类型
   1. 逻辑主键：bigint，无符号自增
   2. 业务主键：varchar，后端生成随机uuid
   3. 逻辑值：tinyint
   4. 日期：date
   5. 时间：timestamp（时间戳）
   6. 字符串：varchar，需要指定长度（字段长度应该统一并且适当大一点，否则未知的变化会导致前后端的频繁修改），以下列举常用的字符串长度
      1. 类型、手机号：16位
      2. ID、密码：32位
      3. 名称：60位
      4. 备注：100位
      5. gps：255
      6. 长文本：1000位

后端

1. 类的定义
   1. 命名规则：大驼峰命名（除了DO/BO/DTO/VO/AO/PO/UID等）；
   2. 接口类：方法和属性不要有修饰符号，并加上有效的JavaDoc注释；
   3. 测试类：每个类对应一个测试类，测试类命名以类名开头，Test结尾；
   4. 工具类：类名带上Utils后缀；
   5. 枚举类：类名带上Enum后缀，枚举成员名称（常量）全部大写，单词间用下划线隔开；
   6. 没有内部类：单个文件有且只有一个类，类名和文件名一致；
2. 变量定义
   1. POJO类属性：ORM原则、使用包装数据类型，没有默认值；
   2. 命名规则：小驼峰命名；
   3. 常量命名：全部大写，用下划线分隔单词；
   4. 不使用无意义变量和魔法值；
3. 方法定义
   1. 命名规则：小驼峰命名；
   2. 测试方法：每个方法最好对应一个测试方法，测试方法以方法名开始，Test结尾。
   3. DAO/Service层方法命名
      1. 获取单个对象：get前缀
      2. 获取多个对象：list前缀，复数结尾；
      3. 获取统计值：count前缀
      4. 插入：insert前缀
      5. 删除：delete前缀
      6. 修改：update前缀
4. 注释规约
   1. 类：必须有创建者和创建日期，且使用 JavaDoc注释，格式为/**内容*/；
   2. 类属性、类方法：必须有 JavaDoc注释；
   3. 方法内部
      • 单行注释：在被注释语句上单独一行，而不是在语句后注释，格式为// 内容；
      • 多行注释：与被注释语句对齐，格式为/*内容*/；
   4. 抽象方法（包括接口方法）：要指出返回值、参数、异常，以及方法实现的功能。