工程结构

其它相关文章
Java 编码规范1(编程规约-命名风格)
Java 编码规范2(编程规约-常量定义)
Java 编码规范3(编程规约-代码格式)
Java 编码规范4(编程规约-OOP规约)
Java 编码规范5(编程规约-集合处理)
Java 编码规范6(编程规约-并发处理)
Java 编码规范7(编程规约-控制语句)
Java 编码规范8(编程规约-注释规约与其它)
Java 编码规范9(异常日志)
Java 编码规范10(单元测试)
Java 编码规范11(安全规约)
Java 编码规范12(MySQL-建表规约)
Java 编码规范13(MySQL-索引规约)
Java 编码规范14(MySQL-SQL语句与ORM映射)
Java 编码规范15(工程结构)

包含应用分层、二方库依赖、服务器

一. 应用分层

[推荐] 图中默认上层依赖于下层，箭头关系表示可直接依赖，如：开放接口层可以依赖于Web层，也可以直接依赖于Service层，依此类推：
- 开放接口层：可直接封装Service方法暴露成RPC接口；通过Web封装成http接口；进行网关安全控制、流量控制等。
- 终端显示层：各个端的模板渲染并执行显示的层。当前主要是velocity渲染，JS渲染，JSP渲染，移动端展示等。
- Web层：主要是对访问控制进行转发，各类基本参数校验，或者不复用的业务简单处理等。
- Service层：相对具体的业务逻辑服务层。
- Manager层：通用业务处理层，它有如下特征：
  - 对第三方平台封装的层，预处理返回结果及转化异常信息；
  - 对Service层通用能力的下沉，如缓存方案、中间件通用处理；
  - 与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层输出的封装业务逻辑的对象。
- AO（Application Object）：应用对象。在Web层与Service层之间抽象的复用对象模型，极为贴近展示层，复用度不高。
- VO（View Object）：显示层对象，通常是Web向模板渲染引擎层传输的对象。
- Query：数据查询对象，各层接收上层的查询请求。注意超过2个参数的查询封装，禁止使用Map类来传输。

二. 二方库依赖

[强制] 定义GAV遵从以下规则：
- GroupID格式：com.{公司/BU }.业务线.[子业务线]，最多4级。
  - 说明：{公司/BU} 例如：alibaba/taobao/tmall/aliexpress等BU一级。子业务线可选。
  - 正例：com.taobao.jstorm 或 com.alibaba.dubbo.register
- ArtifactID格式：产品线名-模块名。语义不重复不遗漏，先到中央仓库去查证一下。
  - 正例：dubbo-client / fastjson-api / jstorm-tool
- Version：详细规定参考下方。
[强制] 二方库版本号命名方式：主版本号.次版本号.修订号
- 主版本号：产品方向改变，或者大规模API不兼容，或者架构不兼容升级。
- 次版本号：保持相对兼容性，增加主要功能特性，影响范围极小的API不兼容修改。
- 修订号：保持完全兼容性，修复BUG、新增次要功能特性等。
- 注意起始版本号必须为： 1.0.0，而不是，而不是，而不是 0.0.1
- 正式发布的类库必须先去中央仓库进行查证，使版本号有延续性，正式版本号不允许覆盖升级。如当前版本：1.3.3，那么下一个合理的版本号：1.3.4 或 1.4.0 或 2.0.0
[强制] 线上应用不要依赖SNAPSHOT版本（安全包除外）。
- 说明：不依赖SNAPSHOT版本是保证应用发布的幂等性。另外，也可以加快编译时的打包构建。
[强制] 二方库的新增或升级，保持除功能点之外的其它jar包仲裁结果不变。如果有改变，必须明确评估和验证，建议进行dependency:resolve前后信息比对，如果仲裁结果完全不一致，那么通过dependency:tree命令，找出差异点，进行排除jar包。
[强制] 二方库里可以定义枚举类型，参数可以使用枚举类型，但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。
[强制] 依赖于一个二方库群时，必须定义一个统一的版本变量，避免版本号不一致。
- 说明：依赖springframework-core,-context,-beans，它们都是同一个版本，可以定义一个变量来保存版本：${spring.version}，定义依赖的时候，引用该版本。
[强制] 禁止在子项目的pom依赖中出现相同的GroupId，相同的ArtifactId，但是不同的Version。
- 说明：在本地调试时会使用各子项目指定的版本号，但是合并成一个war，只能有一个版本号出现在最后的lib目录中。可能出现线下调试是正确的，发布到线上却出故障的问题。
[推荐] 所有pom文件中的依赖声明放在语句块中，所有版本仲裁放在语句块中
- 说明：里只是声明版本，并不实现引入，因此子项目需要显式的声明依赖，version和scope都读取自父pom。而所有声明在主pom的里的依赖都会自动引入，并默认被所有的子项目继承。
[推荐] 二方库不要有配置项，最低限度不要再增加配置项。
[参考] 为避免应用二方库的依赖冲突问题，二方库发布者应当遵循以下原则：
- 精简可控原则。移除一切不必要的API和依赖，只包含 Service API、必要的领域模型对象、Utils类、常量、枚举等。如果依赖其它二方库，尽量是provided引入，让二方库使用者去依赖具体版本号；无log具体实现，只依赖日志框架。
- 稳定可追溯原则。每个版本的变化应该被记录，二方库由谁维护，源码在哪里，都需要能方便查到。除非用户主动升级版本，否则公共二方库的行为不应该发生变化。

三. 服务器

[推荐] 高并发服务器建议调小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不足而出现“open too many files”错误，导致新的连接无法建立。
- 建议将linux服务器所支持的最大句柄数调高数倍（与服务器的内存数量相关）。
[推荐] 给JVM设置-XX:+HeapDumpOnOutOfMemoryError参数，让JVM碰到OOM场景时输出dump信息。
- 说明：OOM的发生是有概率的，甚至有规律地相隔数月才出现一例，出现时的现场信息对查错非常有价值。
[推荐] 在线上生产环境，JVM的Xms和Xmx设置一样大小的内存容量，避免在GC 后调整堆大小带来的压力。
[参考] 服务器内部重定向使用forward；外部重定向地址使用URL拼装工具类来生成，否则会带来URL维护不一致的问题和潜在的安全风险。

Java 编码规范15(工程结构)相关推荐

Java 编码规范1(编程规约-命名风格)
编程规约-命名风格其它相关文章 Java 编码规范1(编程规约-命名风格) Java 编码规范2(编程规约-常量定义) Java 编码规范3(编程规约-代码格式) Java 编码规范4(编程规约-O ...
公司让我编写一套自己的【Java 编码规范】作为员工季度考核标准？！参照Alibaba
目录一.编码规范 (一)命名风格 (二)常量定义 (三)代码格式 (四)OOP规范 (五)集合处理 (六)并发处理 (七)控制语句 (八)注释规范 (九)其它二.SVN操作规范三.异常日志 (一 ...
阿里巴巴 Java 编码规范最佳实践
概述最近在实际项目中使用 p3c for eclipse 插件进行检测,发现项目中有不少不符合 "阿里巴巴 Java 编码规范" 的代码,现在已经由之前的 2000+ 个优化到 ...
Java编码规范V1.0
Java编码规范V1.0 1 代码总体原则 1. 清晰第一清晰性是易于维护.易于重构的程序必需具备的特征.代码首先是给人读的,其次才给机器用来执行. 目前软件维护期成本占整个生命周期成本的 40 ...
java编码ppt_[2018年最新整理]Java编码规范.ppt
[2018年最新整理]Java编码规范制定编码规范的最主要的目的是为了对产出代码的长期维护.通常负责维护代码的人大多都不是开发者本人,如果有一个统一的代码格式以及说明就可以减少混淆提高理解速度. ...
规定自己的Java编码规范
给自己规定了Java编码规范.编写Java代码严格依照自己规定的格式.欢迎大家指出问题. /* *COPYRIGHT */package com.triangle23.projectabbreviat ...
Java编码规范,在您进行编码之前应该阅读的规范
为什么80%的码农都做不了架构师?>>> 本文转载于:http://www.web3d.com.cn/new/teach/java3d/2006/11/13/363276161 ...
掌握Java编码规范
掌握Java编码规范
Java基础学习总结（92）——Java编码规范之排版、注释及命名
为使开发人员养成良好的开发习惯,编写可读性强.易维护的程序,结合以往资料,现整理Java编码规范,将之作为开发人员的参照依据. 一.排版 1.相对独立的程序块之间必须加空行

Java 编码规范15(工程结构)

工程结构

一. 应用分层

二. 二方库依赖

三. 服务器

Java 编码规范15(工程结构)相关推荐

最新文章

热门文章