瑞_Java开发手册_（六）工程结构

文章目录

- 工程结构的意义
- (一) 应用分层
- (二) 二方库依赖
- (三) 服务器

🙊前言：本文章为瑞_系列专栏之《Java开发手册》的工程结构篇，主要介绍应用分层、二方库依赖、服务器。由于博主是从阿里的《Java开发手册》学习到Java的编程规约，所以本系列专栏主要以这本书进行讲解和拓展，有需要的小伙伴可以点击链接下载。本文仅供大家交流、学习及研究使用，禁止用于商业用途，违者必究！

本系列第一篇链接：（一）编程规约
本系列第二篇链接：（二）异常日志
本系列第三篇链接：（三）单元测试
本系列第四篇链接：（四）安全规约
本系列第五篇链接：（五）MySQL数据库
本系列第六篇链接：（六）工程结构
本系列第七篇链接：（七）设计规约

在这里插入图片描述

工程结构的意义

工程结构是整个软件开发过程中非常重要的一环，它定义了各个模块之间的层次关系和依赖关系，使得开发人员能够更加清晰地理解和管理复杂的软件系统。它通过合理的层次划分、模块化开发、减少冗余、提高可扩展性、便于测试和维护以及促进团队协作等方面，工程结构有助于提高软件开发的效率和质量，降低维护成本和风险。

工程结构就像一座城市的规划，合理的规划可以让城市更加有序、美观和宜居。同样，合理的工程结构可以让软件系统更加有序、可维护和可扩展，可以为开发人员提供了一种组织和构建复杂软件系统的有效方法。当你开始认知到所有的代码不能全部写在main方法里的时候，就是理解工程结构意义的开始。

工程结构主要的作用和意义如下：

层次划分：工程结构将整个软件系统划分为不同的层次，每个层次都有明确的职责和功能。层次之间的划分使得开发人员能够更好地理解系统的整体结构，并更好地组织代码和模块。
模块化开发：工程结构使得开发人员可以将复杂的软件系统划分为多个模块，每个模块负责特定的功能或业务领域。这种模块化开发方式可以提高代码的可维护性和可重用性，降低系统的耦合度，使得开发更加高效和可靠。
减少冗余：工程结构通过合理的层次划分和模块化开发，可以避免代码的冗余和重复。每个层次和模块只关注自己的业务逻辑和功能，避免了代码的交叉和耦合，减少了不必要的复杂度。
提高可扩展性：工程结构使得软件系统更加易于扩展。当需要增加新的功能或业务时，只需要在相应的层次上添加新的模块或组件，而不会对其他部分造成影响。这种可扩展性使得软件系统能够更好地适应变化和未来的发展。
便于测试和维护：工程结构使得测试和维护变得更加容易。每个层次和模块都有明确的接口和功能，可以单独进行测试和调试。同时，层次之间的依赖关系使得代码更加易于理解和维护，降低了维护成本和难度。
促进团队协作：工程结构有助于促进团队协作和分工。不同开发人员可以负责不同的层次和模块，共同完成复杂的软件系统。合理的分工可以提高开发效率和代码质量，使得团队协作更加顺畅和高效。

(一) 应用分层

【推荐】图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于Web 层，也可以直接依赖于 Service 层，依此类推：

在这里插入图片描述

开放接口层：可直接封装 Service 方法暴露成 RPC 接口；通过 Web 封装成 http 接口；网关控制层等。
终端显示层：各个端的模板渲染并执行显示的层。当前主要是 velocity 渲染，JS 渲染，JSP 渲染，移动端展示等。
Web 层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
Service 层：相对具体的业务逻辑服务层。
Manager 层：通用业务处理层，它有如下特征：
1）对第三方平台封装的层，预处理返回结果及转化异常信息。
2）对 Service 层通用能力的下沉，如缓存方案、中间件通用处理。
3）与 DAO 层交互，对多个 DAO 的组合复用。
DAO 层：数据访问层，与底层 MySQL、Oracle、Hbase、OB 等进行数据交互。
外部接口或第三方平台：包括其它部门 RPC 开放接口，基础平台，其它公司的 HTTP 接口。

瑞：本条需要长时间的经验累积才能理解，如果是初学者的话请先记住本条即可，后续慢慢形成自己的理解。

博主对应用分层的理解是：要根据自己的业务结构去进行分层设计，如常见的三层模型：用户表示层、业务逻辑层、数据层。根据自身的业务面向接口编程进行N层架构设计，每一层都各司其职互不干扰，各层之间应当尽量解耦。

博主对DAO数据访问层的理解：
DAO层只进行数据访问，它只负责将SQL传给底层数据库进行数据交互，而不进行其上层业务逻辑层的工作，无论业务逻辑层传递什么参数进来，都应传递至数据库进行执行操作而不进行业务判断校验处理。所以类似数据库连接对象不应当向上层即业务逻辑层传递，这不仅违反了分层设计的意义也污染了接口。
所以按照博主的理解，对于Java后端程序控制事务的回滚，只能做到数据行级别的控制，因为数据库访问对象不应当在service层传递和操作，无法做到service调用多个dao层方法去回滚，毕竟要用到同一个连接对象才可以回滚事务。
要用到同一个连接对象，这在实际开发中是不切和实际的。既然dao层不去传递数据库连接对象，那需要多个数据库操作的业务的事务如何处理呢？想想场景，比如支付宝充值话费（支付宝扣款，话费增加），阿里和电信的接口不可能去传递数据库连接对象，支持宝话费充值业务需要调用电信提供的接口，但电信的接口会要求提供数据库连接对象吗，这是绝对不可能的❗️ 对吧⁉️如果说，支付宝扣款成功了，但是话费充值失败（比如正好断网演练而发生异常等情况），那么电信的service层就会去判断，只要确保支付宝转的钱到账了，那应该是自己电信的业务出问题了，它们可能会先垫付这笔钱，再service生成核对的消息给人工审核，然后巴拉巴拉总之电信会通过自己的异常流程进行处理解决，是不可能电信去回滚支付宝的扣款的，想一想是不是这个逻辑。所以在实际业务中，数据库连接对象是无法传递的，因为数据库连接对象早就被close了，一旦被close，那这辈子都取不到该连接对象了，更不要说传递它进行回滚操作。所以我认为即使在service层处理了事务意义也不大（除非就是个单体项目）更多的应当靠service层的逻辑校验保护业务的正常的或异常的执行流程，而dao层只需要管好自己与数据库的交互，即保证dao中单个方法的回滚。
（这是博主自身的经验分享，可能和您认知的相悖，但博主依然认为应当通过分析，形成自己的理解，而不是别人说什么就是什么。在程序设计上没有对错，只有适合和更适合，若有问题请在评论区中指正，非常感谢）

本条虽为推荐，但在实际开发中非常重要，请务必多花时间理解应用分层的意义及作用

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

瑞：本条中提到了Web 层绝不应该继续往上抛异常，因为已经处于顶层，所以在Web层（常见是Controller），一定要对catch中的error_message进行转义处理后返回给前端。本条需结合本系列第二篇【异常日志】中的(二) 异常处理第4条：【强制】捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容，以及【异常日志】中的(一) 错误码第7条、第8条。错误码不能直接输出给用户作为提示信息使用、错误码之外的业务独特信息由 error_message 来承载，而不是让错误码本身涵盖过多具体业务属性。

【参考】分层领域模型规约：
• DO（Data Object）：此对象与数据库表结构一一对应，通过 DAO 层向上传输数据源对象。
• DTO（Data Transfer Object）：数据传输对象，Service 或 Manager 向外传输的对象。
• BO（Business Object）：业务对象，可以由 Service 层输出的封装业务逻辑的对象。
• Query：数据查询对象，各层接收上层的查询请求。注意超过 2 个参数的查询封装，禁止使用 Map 类来传输。
• VO（View Object）：显示层对象，通常是 Web 向模板渲染引擎层传输的对象。

瑞：一定要分清楚 [ 数据对象类 ] 和 [ 业务对象类 ] 的职责区别。数据对象类只负责数据的存储和传递，数据对象类内部不应该存在任何的业务逻辑的处理，通常情况下只有 setter/getter/toString ，如DTO数据传输对象。而业务对象类才是负责处理业务逻辑，不应该去维护非业务的成员属性，如Service层接口的具体实现类。

下图为博主的经验对应用分层的理解，可能有误，仅供学习参考（若需搬运下图请标明出处）

在这里插入图片描述

瑞：
1️⃣PO/DO（实体类）：根据阿里巴巴的开发手册中的定义，DO可以认为等同于PO也就是Entity实体类，与数据库表结构一一对应，用来增删改查
2️⃣BO（业务对象类）：BO是PO的需求结果组合，同一类别的业务就会有一个BO与之对应，除了get，set方法以外，还有业务逻辑的方法。如购物业务，需要从商品DO、用户余额DO等获取需要的数据
3️⃣:DTO（数据传输对象类）：DTO和BO、VO的区别主要是就是字段的删减，DTO在BO的基础上，获取需要的数据向上层传递。而VO是在DTO的基础上，删减一些数据向前端展示
4️⃣VO（展示对象类）：VO就是展示给前端用的数据，一般情况下是从DTO中获取要展示的信息。如博主信息简略展示，会从博主信息DTO中获取到名称、成就展示，而DTO中的头像等数据不需要在简略展示的前端界面中出现
5️⃣所以在一些简单的业务中（基础CRUD）可以把DTO和BO合并为DTO，VO也可以使用DTO代替，即PO（实体类）->DTO（Response）->前端

(二) 二方库依赖

【强制】定义 GAV 遵从以下规则：
1） GroupID 格式：com.{公司/BU }.业务线 [.子业务线]，最多 4 级。
说明：{公司/BU} 例如：alibaba/taobao/tmall/aliexpress 等 BU 一级；子业务线可选。
正例：com.taobao.jstorm 或 com.alibaba.dubbo.register
2） ArtifactID 格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
正例：dubbo-client / fastjson-api / jstorm-tool
3） Version：详细规定参考下方。
【强制】二方库版本号命名方式：主版本号.次版本号.修订号
1）主版本号：产品方向改变，或者大规模 API 不兼容，或者架构不兼容升级。
2）次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的 API 不兼容修改。
3）修订号：保持完全兼容性，修复 BUG、新增次要功能特性等。
说明：注意起始版本号必须为：1.0.0，而不是 0.0.1。
反例：仓库内某二方库版本号从 1.0.0.0 开始，一直默默“升级”成 1.0.0.64，完全失去版本的语义信息。

瑞：在Maven中使用<version>，如下所示：

<version>1.0.0</version>

【强制】线上应用不要依赖 SNAPSHOT 版本（安全包除外）；正式发布的类库必须先去中央仓库进行查证，使 RELEASE 版本号有延续性，且版本号不允许覆盖升级。
说明：不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。
【强制】二方库的新增或升级，保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变，必须明确评估和验证。
说明：在升级时，进行 dependency:resolve 前后信息比对，如果仲裁结果完全不一致，那么通过dependency:tree 命令，找出差异点，进行<exclude>排除 jar 包。
【强制】二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象。
【强制】依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。
说明：依赖 springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存版本：${spring.version}，定义依赖的时候，引用该版本。

瑞：在Maven中如下所示：

    <!-- 属性配置 --><properties><spring.version>版本</spring.version></properties><dependencies><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId><version>${spring.version}</version></dependency></dependencies>

【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId，相同的 ArtifactId，但是不同的Version。
说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个 war，只能有一个版本号出现在最后的lib 目录中。曾经出现过线下调试是正确的，发布到线上却出故障的先例。
【推荐】底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。
【推荐】所有 pom 文件中的依赖声明放在<dependencies>语句块中，所有版本仲裁放在<dependencyManagement>语句块中。
说明：<dependencyManagement>里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version 和 scope 都读取自父 pom。而<dependencies>所有声明在主 pom 的<dependencies>里的依赖都会自动引入，并默认被所有的子项目继承。

瑞：后续博主会专门写关于maven的使用博客，先预留位置

【推荐】二方库不要有配置项，最低限度不要再增加配置项。
【推荐】不要使用不稳定的工具包或者 Utils 类。
说明：不稳定指的是提供方无法做到向下兼容，在编译阶段正常，但在运行时产生异常，因此，尽量使用业界稳定的二方工具包。
【参考】为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则：
1）精简可控原则。移除一切不必要的 API 和依赖，只包含 Service API、必要的领域模型对象、Utils 类、
常量、枚举等。如果依赖其它二方库，尽量是 provided 引入，让二方库使用者去依赖具体版本号；无 log
具体实现，只依赖日志框架。
2）稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除
非用户主动升级版本，否则公共二方库的行为不应该发生变化。

(三) 服务器

【推荐】高并发服务器建议调小 TCP 协议的 time_wait 超时时间。
说明：操作系统默认 240 秒后，才会关闭处于 time_wait 状态的连接，在高并发访问下，服务器端会因为处于 time_wait 的连接数太多，可能无法建立新的连接，所以需要在服务器上调小此等待值。
正例：在 linux 服务器上请通过变更/etc/sysctl.conf 文件去修改该缺省值（秒）：
net.ipv4.tcp_fin_timeout = 30
【推荐】调大服务器所支持的最大文件句柄数（File Descriptor，简写为 fd）。
说明：主流操作系统的设计是将 TCP/UDP 连接采用与文件一样的方式去管理，即一个连接对应于一个 fd。主流的linux服务器默认所支持最大fd数量为1024，当并发连接数很大时很容易因为fd不足而出现“opentoo many files”错误，导致新的连接无法建立。建议将 linux 服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。
【推荐】给 JVM 环境参数设置-XX:+HeapDumpOnOutOfMemoryError 参数，让 JVM 碰到 OOM场景时输出 dump 信息。
说明：OOM 的发生是有概率的，甚至相隔数月才出现一例，出错时的堆内信息对解决问题非常有帮助。

瑞：jvm虚拟机参数模版如下

设置	说明
-Xms1g	初始堆内存大小
-Xmx1g	最大堆内存大小
-Xss256k	虚拟机栈内存大小
-XX:MaxMetaspaceSize=512m	最大元空间大小
-XX:+DisableExplicitGC	让System.gc()方法失效
-XX:+HeapDumpOnOutOfMemoryError	在OutOfMemoryError的时候保存堆内存快照
-XX:HeapDumpPath=/opt/logs/my-service.hprof	将堆内存快照保存到文件中
-XX:+PrintGCDetails	打印垃圾回收的详细信息
-XX:+PrintGCDateStamps	打印垃圾回收发生的时间
-Xloggc:文件路径	将垃圾回收信息保存保存到文件中

【推荐】在线上生产环境，JVM 的 Xms 和 Xmx 设置一样大小的内存容量，避免在 GC 后调整堆大小带来的压力。

瑞：建议将-Xms设置的和-Xmx一样大，有以下几点好处：
1️⃣运行时性能更好，堆的扩容是需要向操作系统申请内存的，这样会导致程序性能短期下降。
2️⃣可用性问题，如果在扩容时其他程序正在使用大量内存，很容易因为操作系统内存不足分配失败。
3️⃣启动速度更快，Oracle官方文档的原话：如果初始堆太小，Java 应用程序启动会变得很慢，因为 JVM 被迫频繁执行垃圾收集，直到堆增长到更合理的大小。