Jbone 项目开发规范
现有项目介绍
项目结构规范
一级项目标准
满足以下条件才能设为一级项目:
1、 完全独立于其他模块的功能
2、 其他模块共同依赖,如 common、configuration、tag
3、 功能类型相同的项目,可以组合起来设立一个一级项目,如 cas、sm
项目结构规范
以系统管理模块为例:
core:系统核心,包含业务逻辑层和数据访问层。
server:对外提供的微服务,可独立打包运行,注册到注册中心供其他服务调用。
api: 对外接口定义,本模块中只提供接口定义和 model。
api-feign:对外接口的 Feign 配置,调用端只需要添加此依赖,就完成了配置,
不需要其他额外的代码实现。
admin: 管理后台,一般情况下每个模块都要对应一个管理后台,供管理员维护
和管理系统。
front:前台展示模块,主要面向外部用户。
依赖关系
admin -> core
server-> core
->api
特别注意,项目之间的依赖除了客户端等公共 Jar(如 jbone-cas-client)以外,
只允许依赖 api 和 api-feign 模块,不能有其他的依赖。很好理解,service 等其
他模块是微服务的自己的,不应该耦合在一块的。Api 模块是微服务的客户端封
装,所以要使用其他服务的功能的话,需要引入 API,然后调用。