zoukankan      html  css  js  c++  java
  • 开发中的编程约束

    Java代码

    正则表达式要用final static修饰,利用好预编译功能,可以加速正则匹配速度。

    final static Pattern p = Pattern.compile("^-?\d+");

    Service / DAO 层方法命名规约

    1 ) 获取单个对象的方法用 get 作前缀。
    2 ) 获取多个对象的方法用 list 作前缀。
    3 ) 获取统计值的方法用 count 作前缀。
    4 ) 插入的方法用 save/insert 作前缀。
    5 ) 删除的方法用 remove/delete 作前缀。
    6 ) 修改的方法用 update 作前缀。

    枚举类名建议带上 Enum 后缀 

    对于 Service 和 DAO 类,基于 SOA 的理念,暴露出来的服务一定是接口,内部的实现类用 Impl 的后缀与接口区别。

    正例: CacheServiceImpl 实现 CacheService 接口

    接口类中的方法和属性不要加任何修饰符号 (public 也不要加 )

    正例:接口方法签名 void f();
    接口基础常量 String COMPANY = " alibaba "

    模块、接口、类、方法使用了设计模式,在命名时体现出具体模式

    正例: public class OrderFactory;
    public class LoginProxy;
    public class ResourceObserver;

    如果变量值仅在一个固定范围内变化用 enum 类型来定义

    正例:
    public enum SeasonEnum {
      SPRING(1), SUMMER(2), AUTUMN(3), WINTER(4);
      int seq;
      SeasonEnum(int seq){
        this.seq = seq;
      }
    }

    左右小括号和字符之间不出现空格

    反例: if (空格 a == b 空格)

     if / for / while / switch / do 等保留字与括号之间都必须加空格

    采用 4 个空格缩进,禁止使用 tab 字符

    如果使用 tab 缩进,必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时,请勿勾选 Use tab character ;而在 eclipse 中,必须勾选 insert spaces for tabs 。

    正例:public static void main(String[] args) {
      // 缩进 4 个空格
      String say = "hello";
      // 运算符的左右必须有一个空格
      int flag = 0;
      // 关键词 if 与括号之间必须有一个空格,括号内的 f 与左括号,0 与右括号不需要空格
      if (flag == 0) {
        System.out.println(say);
      }
      // 左大括号前加空格且不换行;左大括号后换行
      if (flag == 1) {
        System.out.println("world");
        // 右大括号前换行,右大括号后有 else,不用换行
      } else {
        System.out.println("ok");
        // 在右大括号后直接结束,则必须换行
      }
    }

    注释的双斜线与注释内容之间有且仅有一个空格

    正例:
    // 这是示例注释,请注意在双斜线之后有一个空格
    String ygb = new String();

    单行字符数限制不超过 120 个,超出需要换行,换行时遵循如下原则:

    1) 第二行相对第一行缩进 4 个空格,从第三行开始,不再继续缩进。
    2 ) 运算符与下文一起换行。
    3 ) 方法调用的点符号与下文一起换行。
    4 ) 方法调用时,多个参数,需要换行时,在逗号后进行。
    5 ) 在括号前不要换行。

    正例:
    StringBuffer sb = new StringBuffer();
        // 超过 120 个字符的情况下,换行缩进 4 个空格,点号和方法名称一起换行
        sb.append("zi").append("xin")...
            .append("huang")...
            .append("huang")...
            .append("huang");        

    反例:

    StringBuffer sb = new StringBuffer();
    // 超过 120 个字符的情况下,不要在括号前换行
    sb.append("zi").append("xin")...append
    ("huang");
    // 参数很多的方法调用可能超过 120 个字符,不要在逗号前换行
    method(args1, args2, args3, ...
    , argsX);

     方法参数在定义和传入时,多个参数逗号后边必须加空格

    正例:

    下例中实参的" a ",后边必须要有一个空格。
    method("a", "b", "c");

    IDE 的 text file encoding 设置为 UTF -8 ; IDE 中文件的换行符使用 Unix 格式,不要使用 Windows 格式

    不同逻辑、不同语义、不同业务的代码之间插入一个空行分隔开来以提升可读性

    说明:没有必要插入多个空行进行隔开。

    数据库 

    表达是与否概念的字段,必须使用 is _ xxx 的方式命名,数据类型是 unsigned tinyint( 1 表示是,0 表示否 ) 。

    说明:任何字段如果为非负数,必须是 unsigned 。

    表名、字段名必须使用小写字母或数字 , 禁止出现数字开头,禁止两个下划线中间只出现数字。数据库字段名的修改代价很大,因为无法进行预发布,所以字段名称需要慎重考虑。

    正例: aliyun _ admin , rdc _ config , level 3_ name
    反例: AliyunAdmin , rdcConfig , level _3_ name

    表名不使用复数名词

    说明:表名应该仅仅表示表里面的实体内容,不应该表示实体数量,对应于 DO 类名也是单数形式,符合表达习惯。

    禁用保留字

    如 desc 、 range 、 match 、 delayed 等,请参考 MySQL 官方保留字。

    小数类型为 decimal ,禁止使用 float 和 double 

    说明: float 和 double 在存储的时候,存在精度损失的问题,很可能在值的比较时,得到不正确的结果。如果存储的数据范围超过 decimal 的范围,建议将数据拆成整数和小数分开存储。

    如果存储的字符串长度几乎相等,使用 char 定长字符串类型

    varchar 是可变长字符串,不预先分配存储空间,长度不要超过 5000,如果存储长度大于此值,定义字段类型为 text ,独立出来一张表,用主键来对应,避免影响其它字段索引效率。

    表必备三字段: id ,  gmt _ create ,  gmt _ modified 

    说明:其中 id 必为主键,类型为 unsigned bigint 、单表时自增、步长为 1。 gmt_create,gmt_modified 的类型均为 datetime 类型,前者现在时表示主动创建,后者过去分词表示被动更新。

    表的命名最好是加上“业务名称_表的作用”

    正例: alipay _ task /  force _ project /  trade _ config

    库名与应用名称尽量一致

    字段允许适当冗余,以提高查询性能,但必须考虑数据一致

    冗余字段应遵循:
    1 ) 不是频繁修改的字段。
    2 ) 不是 varchar 超长字段,更不能是 text 字段。

    单表行数超过 500 万行或者单表容量超过 2 GB ,才推荐进行分库分表

    说明:如果预计三年后的数据量根本达不到这个级别,请不要在创建表时就分库分表。

    合适的字符存储长度,不但节约数据库表空间、节约索引存储,更重要的是提升检索速度

    业务上具有唯一特性的字段,即使是多个字段的组合,也必须建成唯一索引

    不要以为唯一索引影响了 insert 速度,这个速度损耗可以忽略,但提高查找速度是明显的 ; 另外,即使在应用层做了非常完善的校验控制,只要没有唯一索引,根据墨菲定律,必然有脏数据产生。

    超过三个表禁止 join

    需要 join 的字段,数据类型必须绝对一致 ;

    多表关联查询时,保证被关联的字段需要有索引;

    即使双表 join 也要注意表索引、 SQL 性能。

    在 varchar 字段上建立索引时,必须指定索引长度,没必要对全字段建立索引,根据实际文本区分度决定索引长度即可

    索引的长度与区分度是一对矛盾体,一般对字符串类型数据,长度为 20 的索引,区分度会高达 90%以上,可以使用 count(distinct left( 列名, 索引长度 )) / count( * ) 的区分度来确定。

    页面搜索严禁左模糊或者全模糊,如果需要请走搜索引擎来解决

    索引文件具有 B - Tree 的最左前缀匹配特性,如果左边的值未确定,那么无法使用此索引。

  • 相关阅读:
    long和Long的区别
    C语言的变量的内存分配
    Java蓝桥杯 算法提高 九宫格
    Java实现 蓝桥杯算法提高金明的预算方案
    Java实现 蓝桥杯 算法提高 新建Microsoft world文档
    Java实现 蓝桥杯 算法提高 快乐司机
    Java实现 蓝桥杯 算法提高 三角形
    Java实现 蓝桥杯 算法提高 三角形
    Java实现 蓝桥杯 算法提高 三角形
    Java实现 蓝桥杯 算法提高 三角形
  • 原文地址:https://www.cnblogs.com/aeolian/p/9554941.html
Copyright © 2011-2022 走看看