工匠智造文档

Java开发规范

说明

base包

其他模块只能引用该包

  • client(客户端):SpringCloud的Feign,用作其他服务调用自己
  • dto(数据传输对象)
  • entity(实体类型)
  • enumerate(枚举)
  • mapper(映射)
  • bo(业务对象): Business Object, 由通用业务方法处理的业务数据的对象(根据需要自行新增)
  • method(通用业务方法): 根据需要自行新增

app包

服务运行包,引用base包

  • config(配置): 数据源等
  • controller(接口): 提供对外服务调用,每个实体对应一个(待考虑)
  • model: 操作实体持久化
  • param: 接口参数
  • service(方法): 内部方法,大部分是被controller调用

命名规范

  • 包名:地区-公司-产品-模块
  • 实体名:大驼峰
  • 枚举名:大驼峰,并且以Enum结尾
  • 枚举名称:如果是设置多语key,小驼峰,否则按普通文本处理
  • 字段名:小驼峰
  • get、set,所有字段不得直接访问,必须通过get和set方法访问,不得直接访问属性
  • 方法名:采用小驼峰形式

约束

  1. 各模块之间的引用,只能引用base包(只包含引用模块的实体类型)
  2. 跨模块访问数据,必须通过调用服务的形式(FeignClient),各模块创建时都会自带自身的FeignClient,供其他模块调用