第六章 工程结构

本文参考《阿里巴巴Java开发手册》

1 应用分层

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

2 二方库依赖

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

3 服务器

    (1)【推荐】高并发服务器建议调小 TCP 协议的 time_wait 超时时间。

    (2)【推荐】调大服务器所支持的最大文件句柄数。

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

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

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,332评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,508评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,812评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,607评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,728评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,919评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,071评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,802评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,256评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,576评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,712评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,389评论 4 332
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,032评论 3 316
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,798评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,026评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,473评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,606评论 2 350

推荐阅读更多精彩内容

  • 一、编程规约 (一)命名规约 【强制】 代码中的命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束。反...
    喝咖啡的蚂蚁阅读 1,490评论 0 2
  • 阿里巴巴 JAVA 开发手册 1 / 32 Java 开发手册 版本号 制定团队 更新日期 备 注 1.0.0 阿...
    糖宝_阅读 7,524评论 0 5
  • 平行的一个宇宙空间里做了这样一个实验,将一个人的信息通过惠勒泡沫传输到我们所在的这个时空里的也是这个人的身上,借助...
    船三郎阅读 185评论 0 1
  • 碎形,Fractal,指无论扩大到何种程度,仍保持原有形状的几何图形。 这是很多年前我在《侏罗纪公园》中看到的一段...
    安静婕阅读 644评论 0 0
  • 上帝给我一个任务 叫我牵一只蜗牛去散步。 我不能走太快,蜗牛已经尽力爬, 为何每次总是那么一点点? 我催它,我唬它...
    雪兰忆香阅读 883评论 0 0