应用分层&包结构划分

参考自阿里巴巴的java开发手册
四、工程规约
(一)应用分层

图中默认上层依赖于下层,箭头关系表示可直接依赖,如:开放接口层可以依赖于
Web 层,也可以直接依赖于 Service 层,依此类推:
这里写图片描述

  • 开放接口层:可直接封装 Service 接口暴露成 RPC 接口; 通过 Web 封装成 http 接口; 网关控
    制层等。

  • 终端显示层:各个端的模板渲染并执行显示层。 当前主要是 velocity 渲染, JS 渲染, JSP 渲
    染,移动端展示层等。

  • Web 层:主要是对访问控制进行转发,各类基本参数校验,或者不复用的业务简单处理等。

  • Service 层:相对具体的业务逻辑服务层。

  • Manager 层:通用业务处理层,它有如下特征:
    1) 对第三方平台封装的层,预处理返回结果及转化异常信息;
    2) 对 Service 层通用能力的下沉,如缓存方案、 中间件通用处理;
    3) 与 DAO 层交互,对 DAO 的业务通用能力的封装。

  • DAO 层:数据访问层,与底层 MySQL、 Oracle、 Hbase 进行数据交互。

  • 外部接口或第三方平台:包括其它部门 RPC 开放接口,基础平台,其它公司的 HTTP 接口。

  • 【参考】 (分层异常处理规约) 在 DAO 层,产生的异常类型有很多,无法用细粒度异常进行
    catch,使用 catch(Exception e)方式,并 throw new DAOException(e),不需要打印日志,
    因为日志在 Manager/Service 层一定需要捕获并打到日志文件中去,如果同台服务器再打日
    志,浪费性能和存储。在 Service 层出现异常时,必须记录日志信息到磁盘,尽可能带上参数
    信息,相当于保护案发现场。如果 Manager 层与 Service 同机部署,日志方式与 DAO 层处理
    一致,如果是单独部署,则采用与 Service 一致的处理方式。Web 层绝不应该继续往上抛异常,
    因为已经处于顶层,无继续处理异常的方式,如果意识到这个异常将导致页面无法正常渲染,
    那么就应该直接跳转到友好错误页面,尽量加上友好的错误ᨀ示信息。开放接口层要将异常处
    理成错误码和错误信息方式返回。

  • 【参考】分层领域模型规约:

  • DO(Data Object) :与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。

  • DTO(Data Transfer Object) :数据传输对象, Service 和 Manager 向外传输的对象。

  • BO(Business Object) :业务对象。 可以由 Service 层输出的封装业务逻辑的对象。

  • QUERY:数据查询对象,各层接收上层的查询请求。 注:超过 2 个参数的查询封装,禁止
    使用 Map 类来传输。

  • VO(View Object) :显示层对象,通常是 Web 向模板渲染引擎层传输的对象。


包结构划分

  • 通用的划分:com.公司名称.业务线(或者项目名称).业务子线

  • 开放接口层:可直接封装 Service 接口暴露成 RPC 接口; 通过 Web 封装成 http 接口; 网关控
    制层等。
    com.公司名.项目名.xxx.openapi

  • 终端显示层:各个端的模板渲染并执行显示层。 当前主要是 velocity 渲染, JS 渲染, JSP 渲
    染,移动端展示层等。

  • Web 层:主要是对访问控制进行转发,各类基本参数校验,或者不复用的业务简单处理等。
    com.公司名.项目名.xxx.web
    该层比较大的时候,可以再具体划分为:
    com.公司名.项目名.xxx.web.admin
    com.公司名.项目名.xxx.web.user
    com.公司名.项目名.xxx.web.bill

  • Service 层:相对具体的业务逻辑服务层。
    com.公司名.项目名.xxx.service
    一般来说,该层也会比较大
    com.公司名.项目名.xxx.service.admin
    com.公司名.项目名.xxx.service.bill

  • Manager 层:通用业务处理层,它有如下特征:
    1) 对第三方平台封装的层,预处理返回结果及转化异常信息;
    2) 对 Service 层通用能力的下沉,如缓存方案、 中间件通用处理;
    3) 与 DAO 层交互,对 DAO 的业务通用能力的封装。
    com.公司名.项目名.xxx.manager.wuzhong
    com.公司名.项目名.xxx.manager.cache
    com.公司名.项目名.xxx.manager.dao

  • DAO 层:数据访问层,与底层 MySQL、 Oracle、 Hbase 进行数据交互。
    com.公司名.项目名.xxx.dao

  • 外部接口或第三方平台:包括其它部门 RPC 开放接口,基础平台,其它公司的 HTTP 接口。
    com.公司名.项目名.xxx.extraapi(我们直接调用外部的层)

  • 【参考】分层领域模型规约:

  • DO(Data Object) :与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。

  • DTO(Data Transfer Object) :数据传输对象, Service 和 Manager 向外传输的对象。

  • BO(Business Object) :业务对象。 可以由 Service 层输出的封装业务逻辑的对象。

  • QUERY:数据查询对象,各层接收上层的查询请求。 注:超过 2 个参数的查询封装,禁止
    使用 Map 类来传输。

  • VO(View Object) :显示层对象,通常是 Web 向模板渲染引擎层传输的对象。


关于是否需要跨层次调用的考虑

如果是基于SSH的,则不太建议跨层次调用.遵循:dao->service->controller->view这样比较好(因为要考虑集成缓存功能的时候,如果dao层到处都有,则很难控制),而且hibernate有状态的问题,缓存起来的对象,可能已经不是持久化对象了,并且有集群的问题需要考虑.

如果是基于SSM的,如果需要缓存功能,则不建议在controller中直接调用dao(不推荐通过直接注入sqlsession的方式),最好是有对应的dao接口,这样方便管理,并且集成缓存功能也方便.