参考文档

基础规范

  1. 项目中引入了 lombok，Idea 需要安装 lombok 插件
  2. 提交代码前养成先 update 的习惯（拉取最新代码合并到本地），别把别人提交的代码覆盖了
  3. 实体类中默认为数据库字段，如果需要扩展逻辑字段「前端展示使用」，在实体类下面扩展，示例如下「代码生成器生成的实体类添加有 @Data注解，就不需要实现 get set 方法了」：
1
2
3
4
5
6
// 以下为扩展的逻辑字段
@TableField(exist = false)
private String userName; 

@TableField(exist = false)
private List<SysUser> noticeUsers;
  1. 后端代码中涉及到数据库操作时，不管是单表还是多表，优先考虑使用 MybatisPlus 方式，尽量避免在 xml 中写 sql，特别是引入各种联表，各种函数。一方面可读性不高，修改有一定难度，另一方面函数对数据库的兼容性可能存在问题。推荐使用 MybatisPlus 方式 ，代码看起来简单明了，其本身对常见的数据库做了适配，避免了很多问题

特殊情况：如果存在联表（涉及2、3个表）过滤的情况，表数据量比较大（十万级以上），可以在 xml 中写 sql，执行效率高一些

  1. 新开发的模块如果是基于原模块的升级，优先考虑使用原数据库表，扩展字段来升级新功能，原字段不要修改删除。保证原接口继续可用。字段数据，在原对应关系上扩展，如增加字典项或前端增加选项

检查工具

  • 开发工具 IDEA 安装插件 Alibaba Java Coding Guidelines，CheckStyle-IDEA、Ali Check 作为代码质量检查工具

    image-20210923132833934

  • 可以使用IDEA 自带工具 Analyze Inspect Code，更全面的代码质量检查工具，包含第三方，如 Ali Check