跳至主要內容

【约定】企业项目中使用的约定

Chihiro.Star大约 1 分钟

【约定】企业项目中使用的约定

📔 千寻简笔记介绍

千寻简文库已开源,Gitee与GitHub搜索chihiro-doc,包含笔记源文件.md,以及PDF版本方便阅读,文库采用精美主题,阅读体验更佳,如果文章对你有帮助请帮我点一个Star

更新:支持在线阅读文章,根据发布日期分类。

@[toc]

1 常用约定

  • 接口参数统一采用POST json 传参
  • 每个表都需要有个名称为id的主键,统一采用UUID生成,另外需添加4个共有字段(创建人、更新人、创建时间、更新时间),由框架自动注入
  • 统一异常处理,在controller层抛出自定义异常或在advice 中默认处理
  • 时间字段类型timestamp java使用Date获取,数值统一用decimal
  • 方法命名规范 查询 /query List 或者/get 返回单个对象保存/save修改/edit删除/delete导出 /export 前缀
  • 事务使用@Transactional注解即可
  • 使用@Log按需添加业务日志打印入库
  • 业务基础代码使用代码生成器生成,区分模块开发
  • redis缓存相关操作使用RedisUtil工具类
  • 包名统一使用com.公司名称.项目缩写.模块名
  • 建表语句在各自模块下docs中维护起来
  • JSON 统一是使用jackson-databind
  • 自定义业务返回码,枚举类实现IResultCode,使用Result.of()返回;
  • 对一些必要的数据库字段赋初始值
  • pojo属性需满足驼峰命名(强制)