2. 阿里巴巴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层绝不应该继续往上抛异常,因为已经处于顶层,如果意识到这个异常将导致页面无法正常渲染,那么就应该直接跳转到友好错误页面,加上用户容易理解的错误提示信息。
        • 开放接口层要将异常处理成错误码和错误信息方式返回。
          • 经验:可以有通用的异常处理filter,转换各种异常到合适的错误信息
      • 分层领域模型规约
        • DO(Data Object):此对象与数据库表结构一一对应,通过DAO层向上传输数据源对象。
          • 经验:相当于PO?
        • DTO(Data Transfer Object):数据传输对象,Service或Manager向外传输的对象。
        • BO(Business Object):业务对象,由Service层输出的封装业务逻辑的对象。
        • AO(Application Object):应用对象,在Web层与Service层之间抽象的复用对象模型,极为贴近展示层,复用度不高。
        • VO(View Object):显示层对象,通常是Web向模板渲染引擎层传输的对象。
        • Query:数据查询对象,各层接收上层的查询请求。注意超过2个参数的查询封装,禁止使用Map类来传输。
  • 二方库依赖
    • 二方库,即公司内部的依赖库,一般指公司内部的其他项目发布的jar包
    • 强制
      • 定义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.3.3,那么下一个合理的版本号:1.3.4 或 1.4.0 或 2.0.0
          • 经验:如果版本号允许升级的话,对于使用者来说会奇怪,他依赖的版本号没变,但是逻辑或者接口变了,导致了意料之外的bug或问题。
      • 线上应用不要依赖SNAPSHOT版本(安全包除外)。
        • 说明:不依赖SNAPSHOT版本是保证应用发布的幂等性。另外,也可以加快编译时的打包构建。
          • 经验:保证幂等性,即一次和多次处理(对于HTTP来说就是请求)某一个资源对于资源本身应该具有同样的结果。
          • 经验:SNAPSHOT版本号不变,但代码可能会更新。
            • 同一个SNAPSHOT版本的依赖可以多次发布(deploy)到仓库中,也就是说同一个SNAPSHOT版本的依赖可以在仓库中存在多份,每一份都是代码在某一个特定时间的快照,这也是SNAPSHOT的含义。SNAPSHOT不是一个特定的版本,而是一系列的版本的集合,其中HEAD总是指向最新的快照,对外界可见的一般也是最新版,这种给人的假象是新的覆盖了老的,从而使得使用SNAPSHOT依赖的客户端总是通过重新构建(有时候需要-U强制更新)就可以拿到最新的代码。
            • 因此和RELEASE版本相比,使用者必须明白其中的区别,避免SNAPSHOT版本更新后导致不必要的问题。
      • 二方库的新增或升级,保持除功能点之外的其它jar包仲裁结果不变。如果有改变,必须明确评估和验证。
        • 说明:在升级时,进行dependency:resolve前后信息比对,如果仲裁结果完全不一致,那么通过dependency:tree命令,找出差异点,进行<exclude>排除jar包。
          • 经验:maven仲裁机制(依赖解决)通常采用短路径优先原则。
            • 1、在工程的依赖树上,深度越浅,越被有限选择。
            • 2、若两个依赖包处于依赖树上的同一层,则谁在前选择谁。
      • 二方库里可以定义枚举类型,参数可以使用枚举类型,但是接口返回值不允许使用枚举类型或者包含枚举类型的POJO对象。
        • 经验:会导致调用方难以理解吧?
      • 依赖于一个二方库群时,必须定义一个统一的版本变量,避免版本号不一致。
        • 说明:依赖springframework-core,-context,-beans,它们都是同一个版本,可以定义一个变量来保存版本:${spring.version},定义依赖的时候,引用该版本。
      • 禁止在子项目的pom依赖中出现相同的GroupId,相同的ArtifactId,但是不同的Version。
        • 说明:在本地调试时会使用各子项目指定的版本号,但是合并成一个war,只能有一个版本号出现在最后的lib目录中。可能出现线下调试是正确的,发布到线上却出故障的问题。
    • 推荐
      • 底层基础技术框架、核心数据管理平台、或近硬件端系统谨慎引入第三方实现。
      • 所有pom文件中的依赖声明放在<dependencies>语句块中,所有版本仲裁放在<dependencyManagement>语句块中。
        • 说明:<dependencyManagement>里只是声明版本,并不实现引入,因此子项目需要显式的声明依赖,version和scope都读取自父pom。而<dependencies>所有声明在主pom的<dependencies>里的依赖都会自动引入,并默认被所有的子项目继承。
        • 经验:
          • dependencies即使在子项目中不写该依赖项,那么子项目仍然会从父项目中继承该依赖项(全部继承)
          • dependencyManagement里只是声明依赖,并不实现引入,因此子项目需要显示的声明需要用的依赖。如果不在子项目中声明依赖,是不会从父项目中继承下来的;只有在子项目中写了该依赖项,并且没有指定具体版本,才会从父项目中继承该项,并且version和scope都读取自父pom;另外如果子项目中指定了版本号,那么会使用子项目中指定的jar版本。
      • 二方库不要有配置项,最低限度不要再增加配置项。
    • 参考
      • 为避免应用二方库的依赖冲突问题,二方库发布者应当遵循以下原则:
        • 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不足而出现“open too many files”错误,导致新的连接无法建立。建议将linux服务器所支持的最大句柄数调高数倍(与服务器的内存数量相关)。
      • 给JVM环境参数设置-XX:+HeapDumpOnOutOfMemoryError参数,让JVM碰到OOM场景时输出dump信息。
        • 说明:OOM的发生是有概率的,甚至相隔数月才出现一例,出错时的堆内信息对解决问题非常有帮助。
      • 在线上生产环境,JVM的Xms和Xmx设置一样大小的内存容量,避免在GC 后调整堆大小带来的压力。
    • 参考
      • 服务器内部重定向使用forward;外部重定向地址使用URL拼装工具类来生成,否则会带来URL维护不一致的问题和潜在的安全风险。

posted on 2019-11-28 11:30  碎羽love星谊  阅读(436)  评论(0编辑  收藏  举报

导航