Spring应用开发常见规范

Posted 2020-11-09 马非白即黑

1、Spring应用开发常见包命名规范

• controller：控制器
• service：服务-接口
• impl：服务-实现
• integration
• sao：调用其他模块的，把feign的调用放到这个下面
• web：供前端调用 
• remote：调用外部接口（其他模块提供的接口）
• api：各模块间的调用（对外的接口）
• openapi：对外的接口
• dao：持久层/mybatis接口
• entity：数据库实体
• mapper：持久层/mybatis实现
• vo：前端页面到controller的参数对象
• dto：调用接口传递使用（入参/出参）
• bo：在service层使用
• po:mapper数据库操作入参
• common：公共组件
• config：配置类
• utils：工具类
• constant：常量
• pojo命名：统一都是首字母大写

　　　　比如：PoDetailVO，PoDetailDTO，PoDetailBO

常用：

　　Bo ： 前端请求/外部请求参数（入参），controller层
　　Po：service层

 包目录结构示例：

 

 1、提供给前端或者外部接口调用都是Controller。

 2、remote包：@FeignClient 注解web接口映射（与外部接口Controller方法签名保持一致）

　　eg：@FeignClient(value = "ps",configuration = PSClientFallBlockFactory.class)

　　value是eruka上的服务名

　　--->接口相互调用，参数保持一致。

3、提供web接口的服务，一般将对外web接口写在controller api包中

　　--->eg：/ums/src/main/java/com/ppc/ibc/ums/pcf/controller/api/ApiUserInfoController.java