工程规范

这几天在写一个内部的小需求，需求很简单。但是在搭建工程的时候遇到了不少问题，本来一天半能搞定所有的东西上线，但是不符合公司上线的规范要求重构。特此记录一下

项目结构

大部分项目应该使用CRUD模式，只有在绝对必要的时候使用更为负载CQRS模式。

Java服务的结构如下（假设项目名为demo):

• demo-api: HTTP 服务入口 (包括dubbo服务，controller等)
• demo-common: 公用代码 (包括enmus,exception,utils等等)
• demo-contract: RPC服务接口(原生java不应该依赖任何东西，比如rpc服务接口，自定义的HttpRequest实体类等)
• demo-core: command操作/应该仅用于CQPS模式
• demo-domain: 领域对象
• demo-integration: 外部HTTP接口访问层
• demo-logic: 业务逻辑层/用于CRUD模式
• demo-manager: 通用业务逻辑层(新增)
• demo-mq: 消息队列接入层
• demo-repository: 数据库访问层/DAO层
• demo-query: 在线业务逻辑层/应该仅用于CQRS 模式
• demo-service: RPC 服务入口
• demo-task: 离线任务
• demo-tool: 工具
• docs: 文档
• 其他: 项目特有的其他目录

应用分层

以CRUD模式为例子

 

1. 【推荐】图中默认上层依赖于下层,箭头关系表示可直接依赖,如:开放接口层可以依赖于Web 层,也可以直接依赖于 Service 层,依此类推:
   • Open API层:可直接封装 Service 接口暴露成 RPC 接口 ; 通过 Web 封装成 http 接口 ; 网关控制层等。
   • API层:主要是对访问控制进行转发,各类基本参数校验,或者不复用的业务简单处理等。
   • Service层: RPC接口层
   • Logic层:相对具体的业务逻辑服务层。
   • Manager层:通用业务处理层,它有如下特征:
     1. 对第三方平台封装的层,预处理返回结果及转化异常信息 ;
     2.  对 Logic 层通用能力的下沉,如缓存方案、中间件通用处理 ;
     3.  与 DAO 层交互,对 DAO 的业务通用能力的封装。
   • DAO 层:数据访问层,与底层 MySQL，Redis，Hbase 进行数据交互。
   • 外部接口或第三方平台:包括其它部门 RPC 开放接口,基础平台,其它公司的 HTTP 接口。
2. 【参考】 ( 分层异常处理规约 ) 在 DAO 层,产生的异常类型有很多,无法用细粒度异常进行catch ,使用 catch(Exception e) 方式,并 throw new DAOException(e) ,不需要打印日志,因为日志在 Manager / Logic 层一定需要捕获并打到日志文件中去,如果同台服务器再打日志,浪费性能和存储。在 Logic 层出现异常时,必须记录日志信息到磁盘,尽可能带上参数信息,相当于保护案发现场。如果 Manager 层与 Logic 同机部署,日志方式与 DAO 层处理一致,如果是单独部署,则采用与 Logic 一致的处理方式。 API 层绝不应该继续往上抛异常,因为已经处于顶层,无继续处理异常的方式,如果意识到这个异常将导致页面无法正常渲染,那么就应该直接跳转到友好错误页面,尽量加上友好的错误提示信息。开放接口层要将异常处理成错误码和错误信息方式返回。
3. 【参考】分层领域模型规约:
   • DO(Data Object): 与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。
   • DTO(Data Transfer Object): 数据传输对象, Logic 和 Manager 向外传输的对象。
   • BO(Business Object): 业务对象。可以由 Logic 层输出的封装业务逻辑的对象。
   • QUERY: 数据查询对象,各层接收上层的查询请求。注:超过 2 个参数的查询封装,禁止使用 Map 类来传输。
   • VO(View Object): 显示层对象,通常是 Web 向前端渲染传输的对象。