《阿里巴巴Java开发手册(终结版)》6-1之应用分层

————字数统计 822 字 | 阅读时长 3 分钟————

工程规约 - 应用分层

修改项:第 1、3 项

  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 接口。

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

  2. 【参考】分层领域模型规约:

    • DO(Data Object) :与数据库表结构一一对应,通过 DAO 层向上传输数据源对象。
    • DTO(Data Transfer Object) :数据传输对象, Service 和 Manager 向外传输的对象。
    • BO(Business Object) :业务对象。可以由 Service 层输出的封装业务逻辑的对象。
    • AO(Application Object) :应用对象。在 Web 层与 Service 层之间抽象的复用对象模型,
      极为贴近展示层,复用度不高。
    • QUERY :数据查询对象,各层接收上层的查询请求。注:超过 2 个参数的查询封装,禁止
      使用 Map 类来传输。
    • VO(View Object) :显示层对象,通常是 Web 向模板渲染引擎层传输的对象。

以上内容均整理自《阿里巴巴Java开发手册(终结版)》

下载

提供Gitbook在线阅读和pdf下载:查看福利

《阿里巴巴Java开发手册(终结版)》5-4之ORM映射

ORM 规约

修改项:第 3 项、第 4 项、第 5 项、第 6 项

  1. 【强制】在表查询中,一律不要使用 * 作为查询的字段列表,需要哪些字段必须明确写明。
    说明:1 ) 增加查询分析器解析成本。2 ) 增减字段容易与 resultMap 配置不一致。

  2. 【强制】 POJO 类的 boolean 属性不能加 is ,而数据库字段必须加 is _,要求在 resultMap 中
    进行字段与属性之间的映射。

    说明:参见定义 POJO 类以及数据库字段定义规定,在 中 增加映射,是必须的。
    在 MyBatis Generator 生成的代码中,需要进行对应的修改。

  3. 【强制】不要用 resultClass 当返回参数,即使所有类属性名与数据库字段一一对应,也需
    要定义 ; 反过来,每一个表也必然有一个与之对应。
    说明:配置映射关系,使字段与 DO 类解耦,方便维护。

  4. 【强制】sql. xml 配置参数使用:#{},# param # 不要使用${} 此种方式容易出现 SQL 注入。

《阿里巴巴Java开发手册(终结版)》5-3之SQL语句

SQL 规约

修改项:第 4 项

  1. 【强制】不要使用 count( 列名 ) 或 count( 常量 ) 来替代 count( ) , count( ) 就是 SQL 92 定义
    的标准统计行数的语法,跟数据库无关,跟 NULL 和非 NULL 无关。
    说明: count( * ) 会统计值为 NULL 的行,而 count( 列名 ) 不会统计此列为 NULL 值的行。
  2. 【强制】 count(distinct col) 计算该列除 NULL 之外的不重复数量。注意 count(distinct
    col 1, col 2 ) 如果其中一列全为 NULL ,那么即使另一列有不同的值,也返回为 0。
  3. 【强制】当某一列的值全是 NULL 时, count(col) 的返回结果为 0,但 sum(col) 的返回结果为
    NULL ,因此使用 sum() 时需注意 NPE 问题。
    正例:可以使用如下方式来避免 sum 的 NPE 问题: SELECT IF(ISNULL(SUM(g)) ,0, SUM(g))
    FROM table;

《阿里巴巴Java开发手册(终结版)》5-2之索引规约

MySQL - 索引规约

修改项:第 1 项、 第 11 项

新增项:第10 项

  1. 【强制】业务上具有唯一特性的字段,即使是组合字段,也必须建成唯一索引。
    说明:不要以为唯一索引影响了 insert 速度,这个速度损耗可以忽略,但提高查找速度是明
    显的 ; 另外,即使在应用层做了非常完善的校验控制,只要没有唯一索引,根据墨菲定律,必
    然有脏数据产生。
  2. 【强制】 超过三个表禁止 join 。需要 join 的字段,数据类型保持绝对一致 ; 多表关联查询
    时,保证被关联的字段需要有索引。
    说明:即使双表 join 也要注意表索引、 SQL 性能。

《阿里巴巴Java开发手册(终结版)》5-1之建表规约

MySQL - 建表规约

修改项:第 1 项、 第 9 项、第 15 项

  1. 【强制】表达是与否概念的字段,必须使用 is _ xxx 的方式命名,数据类型是 unsigned tinyint
    ( 1 表示是,0 表示否 ) 。
    说明:任何字段如果为非负数,必须是 unsigned 。
    正例:表达逻辑删除的字段名 is_deleted ,1 表示删除,0 表示未删除。
  2. 【强制】表名、字段名必须使用小写字母或数字 , 禁止出现数字开头,禁止两个下划线中间只
    出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称需要慎重考虑。
    说明:MySQL 在 Windows 下不区分大小写,但在 Linux 下默认是区分大小写。因此,数据库
    名、表名、字段名,都不允许出现任何大写字母,避免节外生枝。
    正例: aliyun admin , rdc config , level 3_ name
    反例: AliyunAdmin , rdcConfig , level 3 name
  3. 【强制】表名不使用复数名词。
    说明:表名应该仅仅表示表里面的实体内容,不应该表示实体数量,对应于 DO 类名也是单数
    形式,符合表达习惯。
  4. 【强制】禁用保留字,如 desc 、 range 、 match 、 delayed 等,请参考 MySQL 官方保留字。
| | 总字数统计:89.5k