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

本文介绍了一套企业级项目开发约定,包括接口参数、数据库设计、异常处理、命名规范等内容,旨在提升开发效率与代码质量。

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

  • 接口参数统一采用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属性需满足驼峰命名(强制)
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

千寻简

感谢支持

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值