《阿里巴巴Java开发手册》3-4之ORM规约

ORM 规约

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

  2. 【强制】 POJO 类的 boolean 属性不能加 is ,而数据库字段必须加 is _,要求在 resultMap 中
    进行字段与属性之间的映射。
    说明:参见定义 POJO 类以及数据库字段定义规定,在 sql . xml 增加映射,是必须的。

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

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



《阿里巴巴Java开发手册》3-3之SQL规约

SQL 规约

  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开发手册》3-2之索引规约

MySQL - 索引规约

  1. 【强制】业务上具有唯一特性的字段,即使是组合字段,也必须建成唯一索引。
    说明:不要以为唯一索引影响了 insert 速度,这个速度损耗可以忽略,但提高查找速度是明
    显的 ; 另外,即使在应用层做了非常完善的校验和控制,只要没有唯一索引,根据墨菲定律,
    必然有脏数据产生。

  2. 【强制】 超过三个表禁止 join 。需要 join 的字段,数据类型保持绝对一致 ; 多表关联查询
    时,保证被关联的字段需要有索引。
    说明:即使双表 join 也要注意表索引、 SQL 性能。



《阿里巴巴Java开发手册》3-1之建表规约

MySQL - 建表规约

  1. 【强制】表达是与否概念的字段,必须使用 is _ xxx 的方式命名,数据类型是 unsigned tinyint
    ( 1 表示是,0 表示否 ) ,此规则同样适用于 odps 建表。
    说明:任何字段如果为非负数,必须是 unsigned 。
  2. 【强制】表名、字段名必须使用小写字母或数字 ; 禁止出现数字开头,禁止两个下划线中间只
    出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称需要慎重考虑。
    正例: getter admin , task config , level 3_ name
    反例: GetterAdmin , taskConfig , level 3 name
  3. 【强制】表名不使用复数名词。
    说明:表名应该仅仅表示表里面的实体内容,不应该表示实体数量,对应于 DO 类名也是单数
    形式,符合表达习惯。
  4. 【强制】禁用保留字,如 desc 、 range 、 match 、 delayed 等,请参考 MySQL 官方保留字。


《阿里巴巴Java开发手册》2-2之日志规约

异常日志 - 日志规约

  1. 【强制】应用中不可直接使用日志系统 (Log 4 j 、 Logback) 中的 API ,而应依赖使用日志框架
    SLF 4 J 中的 API ,使用门面模式的日志框架,有利于维护和各个类的日志处理方式统一。

    1
    2
    3
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    private static final Logger logger = LoggerFactory.getLogger(Abc.class);
  2. 【强制】日志文件推荐至少保存 15 天,因为有些异常具备以“周”为频次发生的特点。



本站访问量   |   您是第 位.