阿里巴巴对Java编程【应用结构】的规约

转载自 阿里巴巴对Java编程【应用结构】的规约

应用分层



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

 

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

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

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

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

  Manager 层 层:通用业务处理层,它有如下特征:

1 ) 对第三方平台封装的层,预处理返回结果及转化异常信息 ;

2 ) 对 Service 层通用能力的下沉,如缓存方案、中间件通用处理 ;

3 ) 与 DAO 层交互,对多个 DAO 的组合复用。

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

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


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


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 类来传输。


二方库依赖



1. 【强制】定义 GAV 遵从以下规则:

1 ) G GroupID 格式: com .{公司/ BU }.业务线. [ 子业务线 ] ,最多 4 级。

说明:{公司/ BU } 例如: alibaba / taobao / tmall / aliexpress 等 BU 一级 ; 子业务线可选。

正例: com . taobao . jstorm 或  com.alibaba.dubbo.register

2 ) A ArtifactID 格式:产品线名-模块名。语义不重复不遗漏,先到中央仓库去查证一下。

正例: dubbo - client /  fastjson - api /  jstorm - tool

3 ) V Version :详细规定参考下方。


2. 【强制】二方库版本号命名方式:主版本号.次版本号.修订号

1 ) 主版本号 主版本号:产品方向改变,或者大规模 API 不兼容,或者架构不兼容升级。

2 ) 次版本号 次版本号:保持相对兼容性,增加主要功能特性,影响范围极小的 API 不兼容修改。

3 ) 修订号 修订号:保持完全兼容性,修复 BUG 、新增次要功能特性等。

说明:注意起始版本号必须为: 1.0.0 ,而不是 0.0.1 正式发布的类库必须先去中央仓库进行查证,使版本号有延续性,正式版本号不允许覆盖升级。如当前版本:1.3.3,那么下一个合理的版本号:1.3.4 或 1.4.0 或 2.0.0


3. 【强制】线上应用不要依赖 SNAPSHOT 版本 ( 安全包除外 )。

说明:不依赖 SNAPSHOT 版本是保证应用发布的幂等性。另外,也可以加快编译时的打包构建。


4. 【强制】二方库的新增或升级,保持除功能点之外的其它 jar 包仲裁结果不变。如果有改变,必须明确评估和验证,建议进行 dependency : resolve 前后信息比对,如果仲裁结果完全不一致,那么通过 dependency : tree 命令,找出差异点,进行< excludes >排除 jar 包。


5. 【强制】二方库里可以定义枚举类型,参数可以使用枚举类型,但是接口返回值不允许使用枚举类型或者包含枚举类型的 POJO 对象。


6. 【强制】依赖于一个二方库群时,必须定义一个统一的版本变量,避免版本号不一致。

说明:依赖 springframework - core ,- context ,- beans ,它们都是同一个版本,可以定义一个变量来保存版本:${ spring . version },定义依赖的时候,引用该版本。


7. 【强制】禁止在子项目的 pom 依赖中出现相同的 GroupId ,相同的 ArtifactId ,但是不同的Version 。

说明:在本地调试时会使用各子项目指定的版本号,但是合并成一个 war ,只能有一个版本号出现在最后的 lib 目录中。可能出现线下调试是正确的,发布到线上却出故障的问题。


8. 【推荐】所有 pom 文件中的依赖声明放在< dependencies >语句块中,所有版本仲裁放在< dependencyManagement >语句块中。

说明:< dependencyManagement >里只是声明版本,并不实现引入,因此子项目需要显式的声明依赖, version 和 scope 都读取自父 pom 。而< dependencies >所有声明在主 pom 的< dependencies >里的依赖都会自动引入,并默认被所有的子项目继承。


9. 【推荐】二方库不要有配置项,最低限度不要再增加配置项。


10. 【参考】为避免应用二方库的依赖冲突问题,二方库发布者应当遵循以下原则:

1 ) 精简可控原则。移除一切不必要的 API 和依赖,只包含  Service API 、必要的领域模型对象、 Utils 类、常量、枚举等。如果依赖其它二方库,尽量是 provided 引入,让二方库使用者去依赖具体版本号 ; 无 log 具体实现,只依赖日志框架。

2 ) 稳定可追溯原则。每个版本的变化应该被记录,二方库由谁维护,源码在哪里,都需要能方便查到。除非用户主动升级版本,否则公共二方库的行为不应该发生变化。


服务器



1. 【推荐】高并发服务器建议调小 TCP 协议的 time _ wait 超时时间。

说明:操作系统默认 240 秒后,才会关闭处于 time _ wait 状态的连接,在高并发访问下,服务器端会因为处于 time _ wait 的连接数太多,可能无法建立新的连接,所以需要在服务器上调小此等待值。

正例:在 linux 服务器上请通过变更/ etc / sysctl . conf 文件去修改该缺省值 ( 秒 ) :net . ipv 4. tcp _ fin _ timeout = 30


2. 【推荐】调大服务器所支持的最大文件句柄数 (File Descriptor ,简写为 fd) 。

说明:主流操作系统的设计是将 TCP / UDP 连接采用与文件一样的方式去管理,即一个连接对应于一个 fd 。主流的 linux 服务器默认所支持最大 fd 数量为 1024,当并发连接数很大时很容易因为 fd 不足而出现“ open too many files ”错误,导致新的连接无法建立。 建议将 linux服务器所支持的最大句柄数调高数倍 ( 与服务器的内存数量相关 ) 。


3. 【推荐】给 JVM 设置- XX :+ HeapDumpOnOutOfMemoryError 参数,让 JVM 碰到 OOM 场景时输出dump 信息。

说明: OOM 的发生是有概率的,甚至有规律地相隔数月才出现一例,出现时的现场信息对查错非常有价值。


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


5. 【参考】服务器内部重定向使用 forward; 外部重定向地址使用 URL 拼装工具类来生成,否则会带来 URL 维护不一致的问题和潜在的安全风险。


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/330654.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

spring注解注入IOC

1.创建Bean对象的注解 <1>配置自定义Bean对象注解 Component、Controller、Service、repository 用法&#xff1a;写在类上&#xff0c; 例如&#xff1a;Service 或者 Service(“userService”) 作用&#xff1a;将该类交给Spring创建对象保存到Spring容器中&#xff…

jstack命令:教你如何排查多线程问题

转载自 jstack命令&#xff1a;教你如何排查多线程问题这是之前的一个死锁案例&#xff1a;一个多线程死锁案例&#xff0c;如何避免及解决死锁问题&#xff1f;如程序中发生这样的死锁问题该如何排查呢&#xff1f;我们可以使用java自带的jstack命令进行排查。1、先在服务器运…

linux-basic(9)文件与文件系统的压缩与打包

【9.1】压缩文件的用途与技术【9.2】linux系统常见的压缩命令1&#xff09;压缩文件的扩展名大多是 tar, tar.gz, tgz, gz, Z, bz2 等&#xff1b;如下图所示&#xff1a;&#xff08;1&#xff09;Linux上常见的压缩命令就是 gzip 与 bzip2 &#xff0c;至於 compress 已经不再…

纯注解开发配置spring

1.纯注解开发【定义配置类的注解】 Confituration 表示该类是一个配置类 ComponentScan(“com.itheima”) 配置包扫描 PropertySource(“classpath:jdbc.properties”) 加载属性文件 Import(JdbcConfig.class) 加载其他配置类 2.spring整合mybatis【纯注解&#xff0c;3个…

阿里巴巴对Java编程【命名风格】的规约

转载自 阿里巴巴对Java编程【命名风格】的规约 命名风格 1. 【强制】代码中的命名均不能以下划线或美元符号开始&#xff0c;也不能以下划线或美元符号结束。 反例&#xff1a; _name / __name / $Object / name_ / name$ / Object$ 2. 【强制】代码中的命名严禁使用拼音与英文…

linux-basic(10)vim程序编辑器

【10.1】vi 与 vim【10.2】vi的使用1&#xff09;3种模式&#xff1a;模式1&#xff1a;一般模式&#xff0c; vim打开就是这种模式&#xff0c;编辑模式下 按 esc 回到一般模式&#xff1b;模式2&#xff1a;编辑模式&#xff0c;要等到你按下『i, I, o, O, a, A, r, R』等任何…

阿里巴巴对Java编程【代码格式】的规约

转载自 阿里巴巴对Java编程【代码格式】的规约 代码格式 1. 【强制】大括号的使用约定。如果是大括号内为空&#xff0c;则简洁地写成{}即可&#xff0c;不需要换行 &#xff1b; 如果是非空代码块则&#xff1a; 1 &#xff09; 左大括号前不换行。 2 &#xff09; 左大括号后…

自定义通配器导入bean对象

1.CustomerImportSelector工具类&#xff1a; /*** description : 自动导入器* author : wanYunBo* date : 2021-09-02 20:46**/ package com.itheima.config.selector;import org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider; import o…

linux-basic(11)认识和学习bash

【11.1】认识bash这个shell1&#xff09;介绍&#xff1a;其实壳程序的功能只是提供用户操作系统的一个接口&#xff0c;因此这个壳程序需要可以呼叫其他软件才好。命令&#xff0c;包括 man, chmod, chown, vi, fdisk, mkfs 等等命令&#xff0c;这些命令都是独立的应用程序&a…

阿里巴巴对Java编程【常量定义】的规约

转载自 阿里巴巴对Java编程【常量定义】的规约 常量定义 1. 【强制】不允许任何魔法值 &#xff08; 即未经定义的常量 &#xff09; 直接出现在代码中。 反例&#xff1a; String key " Id # taobao _" tradeId; cache . put(key , value); 2. 【强制】 long 或…

动态代理-AOP

1 什么是AOP&#xff1f; Aspect Oriented Programming的缩写&#xff0c;面向切面编程&#xff0c;切面指定就是动态代理的方法&#xff0c;作用是在不改变业务层方法源代码的基础上对方法进行增强&#xff0c;底层使用的是动态代理技术&#xff0c;面向切面编程也可以理解成…

linux-basic(12)正则表达式与文件格式化处理

【12.1.1】什么是正则表达式&#xff1f; 1&#xff09;简单说&#xff1a;正则表示法就是处理字串的方法&#xff0c;他是以行为单位来进行字串的处理行为&#xff0c; 正则表达式透过一些特殊符号的辅助&#xff0c;可以让使用者轻易的达到查找、删除、替换某特定字串的处理程…

阿里巴巴对Java编程【OOP规约】的规约

转载自 阿里巴巴对Java编程【OOP规约】的规约 OOP规约 1. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法&#xff0c;无谓增加编译器解析成本&#xff0c;直接用类名来访问即可。 2. 【强制】所有的覆写方法&#xff0c;必须加 Override 注解。 说明&#xff…

AOP切点表达式及通知类参数传递方式

1.切入点表达式的写法 execution( * com.itheima.service.impl.StudentServiceImpl.findAll(…)) //较少 execution( * com.itheima.service.impl.StudentServiceImpl.(…)) //较少 execution( * com.itheima.service.StudentService.(…)) //StudentService中的所有方法会被代…

linux-basic(13)学习shell script

【13.1】什么是shell script&#xff1f;1&#xff09;shell script 是利用 shell 的功能所写的一个『程序 (program)』&#xff0c;这个程序是使用纯文字档&#xff0c;将一些 shell 的语法与命令(含外部命令)写在里面&#xff0c; 搭配正规表示法、管线命令与数据流重导向等功…

阿里巴巴对Java编程【集合处理】的规约

转载自 阿里巴巴对Java编程【集合处理】的规约集合处理1. 【强制】关于 hashCode 和 equals 的处理&#xff0c;遵循如下规则&#xff1a; 1&#xff09; 只要重写 equals &#xff0c;就必须重写 hashCode 。 2&#xff09; 因为 Set 存储的是不重复的对象&#xff0c;依据 ha…

http请求状态码400的原因总结

会出现这个HTTP请求状态码400&#xff0c;说明这个请求是无效的&#xff0c;并没有进入后台服务器&#xff08;控制器&#xff09;里。 通常的原因&#xff1a; 前端提交的字段名称或者字段类型和后台的实体类不一样&#xff0c;或者前端提交的参数跟后台需要的参数个数不一致…

做一个完整的Java Web项目需要掌握的技能

转自&#xff1a; https://blog.csdn.net/JasonLiuLJX/article/details/51494048--------------------------------------------------------------------------------最近自己做了几个Java Web项目&#xff0c;有公司的商业项目&#xff0c;也有个人做着玩的小项目&#xff0…

阿里巴巴对Java编程【并发处理】的规约

转载自 阿里巴巴对Java编程【并发处理】的规约并发处理1. 【强制】获取单例对象需要保证线程安全&#xff0c;其中的方法也要保证线程安全。 说明&#xff1a;资源驱动类、工具类、单例工厂类都需要注意。2. 【强制】创建线程或线程池时请指定有意义的线程名称&#xff0c;方便…

查询sql打印日志配置

mybatis-plus:mapper-locations: classpath*:mapper/*.xml# 设置别名包扫描路径&#xff0c;通过该属性可以给包中的类注册别名type-aliases-package: com.heima.model.user.pojosconfiguration:log-impl: org.apache.ibatis.logging.stdout.StdOutImpl