代码命名规范

一、数据库命名规范

1.1 数据表命名规范

• 采用26个英文字母(区分大小写)和0-9的自然数(经常不需要)加上下划线'_'组成，命名简洁明确，多个单词用下划线'_'分隔，例如auth_user、auth_group等；

• 全部小写命名，禁止出现大写
• 禁止使用数据库关键字，如：name，time ，datetime，password等；
• 表名称不应该取得太长（一般不超过三个英文单词）；
• 表的名称一般使用名词或者动宾短语；
• 用单数形式表示名称，例如，使用 employee，而不是 employees；
• 表以及字段必须填写描述信息（使用SQL语句建表时）；

1.2 函数命名规范

二、前端命名规范

2.1 React命名规范

• 组件名称全部大写字母开头，例如antd的Modal、Message、Button等；
• 文件夹以xxx-xxx命名，例如ant-design-pro、realtime-data等；
• 文件采用驼峰命名；

三、后端命名规范

3.1 java命名规范

• 方法命名  返回列表的 +s

  public List<ParameterMapping> getParameterMappings()

• 成员属性命名 collection +s

private List<ResultMapping> resultMappings;

•  map成员

Map<Method, MapperMethod> methodCache = new ConcurrentHashMap<>()

• 方法名称,做到望文生义 不要缩写。例如：getUserById、getUserByLoginName、getUerList/getUsers

四、url命名规范

• 新增 /add
• 删除 /delete
• 修改 /update
• 单个查询 /get
• 多个查询 /list
• 根据xx查询 /get-by-xxx