Java 代码编程规范记录

2022.08.10

  • 接口定义入参出参和函数间的转换等，需要把数据格式规范成RO、DTO、DO、VO 等数据形式。
  • 对于API接口入参等的数据校验，一般都在controller层一起做了。
  • 对于错误信息或提示信息等，要用定义枚举，然后使用枚举值，便于更新迭代和维护消息。
  • 对于try....catch....，异常的捕获，异常捕获后也要能够正常运行下去，规范异常。
  • 返回形式都用Result<>包一层，且一定不要用Void。
  • 出参形式Result.unSuccess，加上自己定义的错误信息枚举值。
  • 接口的Restful形式，集中请求的格式规范。