参考阿里规范,优秀的 Java 项目代码该如何分层?

爱丽丝13 等级 688 1 0

1.背景

说起应用分层,大部分人都会认为这个不是很简单嘛 就controller,service, mapper三层。看起来简单,很多人其实并没有把他们职责划分开,在很多代码中,controller做的逻辑比service还多,service往往当成透传了,这其实是很多人开发代码都没有注意到的地方,反正功能也能用,至于放哪无所谓呗。这样往往造成后面代码无法复用,层级关系混乱,对后续代码的维护非常麻烦。

的确在这些人眼中分层只是一个形式,前辈们的代码这么写的,其他项目代码这么写的,那么我也这么跟着写。但是在真正的团队开发中每个人的习惯都不同,写出来的代码必然带着自己的标签,有的人习惯controller写大量的业务逻辑,有的人习惯在service中之间调用远程服务,这样就导致了每个人的开发代码风格完全不同,后续其他人修改的时候,一看,我靠这个人写的代码和我平常的习惯完全不同,修改的时候到底是按着自己以前的习惯改,还是跟着前辈们走,这又是个艰难的选择,选择一旦有偏差,你的后辈又维护你的代码的时候,恐怕就要骂人了。

所以一个好的应用分层需要具备以下几点:

  • 方便后续代码进行维护扩展。

  • 分层的效果需要让整个团队都接受

  • 各个层职责边界清晰

2.如何进行分层

2.1阿里规范

在阿里的编码规范中约束的分层如下:

参考阿里规范,优秀的 Java 项目代码该如何分层?

开放接口层: 可直接封装 Service 方法暴露成 RPC 接口;通过 Web 封装成 http 接口;进行 网关安全控制、流量控制等。

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

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

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

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

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

阿里巴巴规约中的分层比较清晰简单明了,但是描述得还是过于简单了,以及service层和manager层有很多同学还是有点分不清楚之间的关系,就导致了很多项目中根本没有Manager层的存在。下面介绍一下具体业务中应该如何实现分层

2.2优化分层

从我们的业务开发中总结了一个较为的理想模型,这里要先说明一下由于我们的rpc框架选用的是thrift可能会比其他的一些rpc框架例如dubbo会多出一层,作用和controller层类似

参考阿里规范,优秀的 Java 项目代码该如何分层?

1.最上层controller和TService是我们阿里分层规范里面的第一层: 轻业务逻辑,参数校验,异常兜底。通常这种接口可以轻易更换接口类型,所以业务逻辑必须要轻,甚至不做具体逻辑。

2.Service: 业务层,复用性较低,这里推荐每一个controller方法都得对应一个service,不要把业务编排放在controller中去做,为什么呢?

如果我们把业务编排放在controller层去做的话,如果以后我们要接入thrift,我们这里又需要把业务编排在做一次,这样会导致我们每接入一个入口层这个代码都得重新复制一份如下图所示:

参考阿里规范,优秀的 Java 项目代码该如何分层?

这样大量的重复工作必定会导致我们开发效率下降,所以我们需要把业务编排逻辑都得放进service中去做:

参考阿里规范,优秀的 Java 项目代码该如何分层?

3.Mannager: 可复用逻辑层。这里的Mannager可以是单个服务的,比如我们的cache,mq等等,当然也可以是复合的,当你需要调用多个Mannager的时候,这个可以合为一个Mannager,比如逻辑上的连表查询等。如果是httpMannager或rpcMannager需要在这一层做一些数据转换

4.DAO: 数据库访问层。主要负责“操作数据库的某张表,映射到某个java对象”,dao应该只允许自己的Service访问,其他Service要访问我的数据必须通过对应的Service。

3.分层领域模型的转换

在阿里巴巴编码规约中列举了下面几个领域模型规约:

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

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

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

  • AO(Application Object):应用对象。在Web层与Service层之间抽象的复用对象模型,极为贴近展示层,复用度不高。

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

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

每一个层基本都自己对应的领域模型,这样就导致了有些人过于追求每一层都是用自己的领域模型,这样就导致了一个对象可能会出现3次甚至4次转换在一次请求中,当返回的时候同样也会出现3-4次转换,这样有可能一次完整的请求-返回会出现很多次对象转换。如果在开发中真的按照这么来,恐怕就别写其他的了,一天就光写这个重复无用的逻辑算了吧。

所以我们得采取一个折中的方案:

  1. 允许Service/Manager可以操作数据领域模型,对于这个层级来说,本来自己做的工作也是做的是业务逻辑处理和数据组装。

  2. Controller/TService层的领域模型不允许传入DAO层,这样就不符合职责划分了。

  3. 同理,不允许DAO层的数据传入到Controller/TService.

参考阿里规范,优秀的 Java 项目代码该如何分层?

4.总结

总的来说业务分层对于代码规范是比较重要,决定着以后的代码是否可复用,是否职责清晰,边界清晰。

当然这种分层其实见仁见智, 团队中的所有人的分层习惯也不同,所以很难权衡出一个标准的准则,总的来说只要满足职责逻辑清晰,后续维护容易,就是好的分层。

最后,如果你的团队有更好的分层,或者上面所描述的有什么错误的地方还请留言指正一下。

收藏
评论区

相关推荐

ES6+的新语法
1. opts:Object 表示opts的类型是Object类型。 这有点类似.Net中的为泛型指定类型。java中为泛型指定类型是用 **extends**关键词。 //TODO .Net 和 java中相同写法的CASE 2. opts:?Object 表示该类型是非必须的。在java 中有类似的学法。 //TODO java中的相同语法
Java 基础 SDK区别简介
1. Java SE(Java Platform,Standard Edition),应该先说这个,因为这个是标准版本。 Java EE (Java Platform,Enterprise Edition),java 的企业版本 Java ME(Java Platform,Micro Edition),java的微型版本。 1). JavaSE 可以
Java中的native关键字
**一.  什么是Native Method**    简单地讲,一个Native Method就是一个java调用非java代码的接口。一个Native Method是这样一个java的方法:该方法的实现由非java语言实现,比如C。这个特征并非java所特有,很多其它的编程语言都有这一机制,比如在C++中,你可以用extern "C"告知C++编译器去
Java人的双十一应该囤点啥?
前几天一篇公众号文章在朋友圈刷屏,一下戳中许多同行的泪点。这些程序员别看平时爱吹点牛逼,其实内心都很焦虑。 ![](https://oscimg.oschina.net/oscnet/da004d30-3b26-42ab-85e0-f7deb54de04c.jpg) **到底何为“底层程序员”?** 像文章里那样,半路出家被线下培训班填鸭式教学,然后
Java基础知识总结
一:java概述: ========= **1,JDK:Java Development Kit,**java的开发和运行环境,java的开发工具和jre。 **2,JRE:Java Runtime Environment,**java程序的运行环境,java运行的所需的类库+JVM(java虚拟机)。 **3,配置环境变量:**让java jdk\\
Java多线程之内存可见性
Java多线程之内存可见性 ============= 一、Java内存模型介绍 ------------ ### 什么是JMM? Java内存模型(Java Memory Model)描述了Java程序中各种变量(线程共享变量)的访问规则,以及在JVM中将变量存储到内存和从内存中读取出变量这样的细节 所有的变量都存储在主内存中 每个线程都
Java字节码详解
也许你写了无数行的代码,也许你能非常溜的使用高级语言,但是你未必了解那些高级语言的执行过程。例如大行其道的Java。 Java号称是一门“一次编译到处运行”的语言,但是我们对这句话的理解深度又有多少呢?从我们写的java文件到通过编译器编译成java字节码文件(也就是.class文件),这个过程是java编译过程;而我们的java虚拟机执行的就是字节码文件
Java小入坑
Java入坑指南 是滴,下面是一个最低的入坑 > 还应该有23种设计模式应该掌握的。╮(╯▽╰)╭ 注意,第一个j是大写。 Java的特点跨平台,风格接近C++ 最重要的api文档 [https://docs.oracle.com/javase/10/docs/api/overview-summary.html](https://www.oschina.
Java文件格式
\*.java文件是保存源代码的文本文件 (\*代表类名) 使用 javac \*.java可以编译该文件 使用 java \*可以运行该类 \*.class是用于保存 Java类的 二进制编码以及Class对象,每一个 Java类都有一个解释该类特征的 Class对象。 \*.jar文件 是一种压缩文件格式 打包命令 jar cvf
Java高并发编程四
_做个笔记,java线程常用的方法,耐心看完._ 编号 方法 说明 1 `public void start()` 使该线程开始执行;Java 虚拟机调用该线程的 run 方法。 2 `public void run()` 如果该线程是使用独立的 Runnable 运行对象构造的,则调用该 Runnable 对象的 run 方法;否则,该方
java native方法与JNI实现
<div id="cnblogs\_post\_body" class="blogpost-body"><p><span style="color: #ff0000"><strong>native方法定义:</strong></span> &nbsp; &nbsp; &nbsp; &nbsp;</p> <p>&nbsp; &nbsp; &nbsp; 简单地讲
java基础类库
java类库的基本介绍 ### 与用户互动 #### 运行Java程序的参数 main()方法分析 * `public`修饰符:Java类由JVM调用,为了让JVM可以自由调用这个main()方法,所以使用public修饰符把这个方法暴露出来 * `static`修饰符:JVM调用这个主方法时,不会先创建该类的对象,然后通过对象来调用该主方法
java语言与jvm虚拟机简介
**一、java语言**     **1.1 支持面向对象编程oop**         强调支持,因为java同样可以面向过程编程,但java是为oop而生的。         oop的三大特性是:封装、继承、多态。         封装主要针对成员变量而言,oop的思想要求成员变量均为私有,不应该对外能够访问,一个符合oop思想的类应该只有公共方
Elasticsearch学习记录(1.安装,简单的查询,聚合,防止数据重复,冲突控制等)
首先我的学习是基于该教程进行的(下列部分代码文字出自该教程,在学习过程中增加我自己的理解和补充,便于更好的裂解和学习,并指出下列教程错误的地方): > [http://es.xiaoleilu.com/](https://www.oschina.net/action/GoToLink?url=http%3A%2F%2Fes.xiaoleilu.com%2F
Neo4j学习(3)
Neo4j Java操作 1\. Neo4j Java Driver方式操作    使用该方式对数据进行操作时,必须先将Neo4j的服务启动起来。    从官方下载neo4j的Java驱动:https://neo4j.com/download-center/#drivers    将驱动导入eclipse的项目中,具体操作如下: import or