Featured image of post Java真实开发规范

Java真实开发规范

实体类

  • 公共的字段,如id,createTime,updateTime,提取出来,放到一个公共的类上,其他的实体类继承
  • 每个实体类都需要实现Serializable接口(序列化)

URL路径

  • 所有的接口必须根据该接口的版本,在 /api 后添加 /v1 或其他版本号。且根据该接口的功能在随后添加功能。(例:/api/v1/auth/login)
  • 请求方式采用 Restful 风格,例:GET POST PUT DELETE,这四种请求方式必须与业务相契合。

数据库设计

  • 主键 Id 的类型应设为 bigint,数据库字符集应设为 utf8_mb4
  • 每张表必须含有创建时间更新时间这两个关键字段
  • 每个字段一定要写备注
  • 当字段设为 not null 时,应为其设置默认值

Redis

  • 在redisTemplete的基础上封装一个redisUtils加以利用