share-platform/doc/后端开发约定.md

1.1 KiB
Raw Permalink Blame History

能力超市后端开发约定

关于数据库或orm

  • 数据库版本管理工具使用flyway请将文件resource目录下对应位置文件名称使用 R__XXX 或 Vn.n__XXX R开头文件表明该文件为可重复执行sql当文件内容更改时该sql文件会在启动时再次执行一次即该文件无版本执行限制常用于数据初始化或数据迁移V开头的文件为版本约束文件常用于数据库表DDL操作使用场景一般为创表、加字段、加索引等ddl操作文件一旦被执行过不会再次重复执行
  • 使用flyway管理的ddl语句对表的操作语句不要指定SchemaDatabase防止在不同地区部署的数据库名称不一致导致执行异常
  • 使用flyway管理的ddl语句增加表的字段时不要指定新增字段位于已有字段后;防止表内不存在指定表字段导致ddl失败

关于编码风格checkstyle

  • 使用idea的同事可以安装checkstyle插件对更改的文件内容进行代码格式化

关于性能

  • 减少使用递归的使用