码出高效系列（一）之编程规约

叁歲伎倆 2022-01-30 08:39 239阅读 0赞

### 码出高效系列（一）之编程规约 ###

1.  命名风格

*  代码中不能以下划线或者美元符号开始或者结尾
 *  **严禁拼音与英文混合，不允许使用中文。尽量不要使用纯拼音的方式**
 *  类名使用大驼峰。
 *  方法名，参数名，成员变量，局部变量使用小驼峰。
 *  常量全部大写，单词间用下划线隔开，语义完整清楚，不要嫌名字长。
 *  **抽象类使用Abstract或Base开头；异常类使用Exception结尾。测试类以测试类的类名开始，以Test结尾**
 *  数组定义：类型与中括号之间无空格
 *  **POJO类中布尔类型的变量都不要加is前缀，否则部分框架解析会引起序列化错误。**
 *  **杜绝不规范的缩写，避免词不达意。**
 *  包名统一用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一用单数形式，类名如果有复数含义，则类名可以使用复数形式！
 *  在命名变量时要尽量使用完整的单词组合来表达意思，不要随意命名。
 *  **如果模块、接口、类、方法使用设计模式，应该在命令时体现出具体的模式。**
 *  接口类中的方法和属性不要加任何修饰符号（public也不要加），保持代码的简洁性
 *  对于Service和DAO类，暴露出来的服务一定是接口，内部的实现类用Impl后缀与接口区别
 *  如果是形容能力的接口名称，取对应的形容词为接口名（通常是-able形式）
 *  **枚举类型建议带上Enum后缀，枚举成员要全部大写，单词间要使用下划线隔开。**
 *  Service/DA0层方法命名规约  
    1）获取单个对象的方法用get做前缀。  
    2）获取多个对象的方法用list做前缀。  
    3）获取统计值的方法用count做前缀。  
    4）插入的方法用save/insert做前缀。  
    5）删除的方法用remove/delete做前缀。  
    6）修改的方法用update做前缀。
 *  领域模型命名规约  
    1）数据对象：xxxDO，xxx即为数据表名。  
    2）数据传输对象：xxxDTO，xxx为业务领域相关的名称。  
    3）展示对象：xxxVo，xxx一般为网页名称。  
    4）P0J0是Do/DTO/B0/vo的统称，禁止命名成xxxP0J0。

#### 2. 常量定义 ####

1.  不允许任何魔法值（即未经预先定义的常量)直接出现在代码中
2.  long或者Long初始赋值时，使用L，不使用小写的l。小写的l容易和数字1混淆，造成误解。
3.  不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。  
    说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。
4.  常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。  
    1）跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。  
    2）应用内共享常量：放置在一方库中，通常是modules中的constant目录下。  
    3）子工程内部共享常量：即在当前子工程的constant目录下。  
    4）包内共享常量：即在当前包下单独的constant目录下。  
    5）类内共享常量：直接在类内部private static final定义。
5.  如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。

#### 3. 代码格式 ####

*  if/for/while/switch/do等保留字与括号之间都必须加空格。
 *  左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格。
 *  任何二目、三目运算符的左右两边都需要加一个空格。
 *  采用4个空格缩进，禁止使用tab字符。
 *  注释的双斜线与注释内容之间有且仅有一个空格。
 *  单行字符数限制不超过120个，超出需要换行，换行时遵循如下原则：  
    1）第二行相对第一行缩进4个空格，从第三行开始，不再继续缩进。  
    2）运算符与下文一起换行。  
    3）方法调用的点符号与下文一起换行。  
    4）方法调用时，多个参数，需要换行时，在逗号后进行。  
    5）在括号前不要换行。
 *  方法参数在定义和传入时，多个参数逗号后边必须加空格。
 *  IDE的text file encoding设置为UTF-8；IDE中文件的换行符使用Unix格式，不要使用Windows格式。
 *  没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
 *  方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。

#### 4. java 面向对象的相关规约（OOP） ####

*  避免通过一个类的对象引用访问此类的静态变量或静态方法，造成无谓增加编译器的解析成本，直接用类名来访问。
 *  所有的复写方法，必须加@Override注解
 *  相同参数类型，相同业务含义，才可以使用java可变参数，避免使用Object。
 *  Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals.
 *  所有相同类型的包装类对象之间的比较，全部使用equals方法。
 *  关于基本数据类型与包装数据类型的使用标准如下：  
    1）【强制】所有的PoJo类属性必须使用包装数据类型。  
    2）【强制】RPC方法的返回值和参数必须使用包装数据类型。  
    3）【推荐】所有的局部变量使用基本数据类型。
 *  定义DO/DTo/vo等POJO类时，不要设定任何属性默认值。
 *  构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。
 *  poJo类必须写tostring方法。使用IDE的中工具：source>generate tostring时，如果继承了另一个PoJo类，注意在前面加一下super.tostring。
 *  使用索引访问用string的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexoutofBoundsException的风险。
 *  当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。
 *  类内方法定义顺序依次是：公有方法或保护方法>私有方法>getter/setter方法。
 *  setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在getter/setter方法中，不要增加业务逻辑，增加排查问题的难度。
 *  循环体内，字符串的连接方式，使用StringBuilder的append方法进行扩展。
 *  final可以声明类、成员变量、方法、以及本地变量，下列情况使用final关键字：  
    1）不允许被继承的类，如：String类。  
    2）不允许修改引用的域对象，如：PoJ0类的域变量。  
    3）不允许被重写的方法，如：PoJ0类的setter方法。  
    4）不允许运行过程中重新赋值的局部变量。  
    5）避免上下文重复使用一个变量，使用final描述可以强制重新定义一个变量，方便更好也进行重构。
 *  慎用object的clone方法来拷贝对象。说明：对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法实现属性对象的拷贝。
 *  类成员与方法控制从严  
    1)允许外部直接通过new来创建对象，那么构造方法必须是private。  
    2）工具类不允许有public或default构造方法。  
    3）类非static成员变量并且与子类共享，必须是protected。  
    4）类非static成员变量并且仅在本类使用，必须是private。  
    5）类static成员变量如果仅在本类使用，必须是private。  
    6）若是static 成员变量，必须考虑是否为final。  
    7）类成员方法只供类内部调用，必须是private。  
    8）类成员方法只对继承类公开，那么限制为protected。

#### 5. 集合处理 ####

*  关于hashcode和equals的处理，遵循如下规则：  
    1）只要重写equals，就必须重写hashCode。  
    2）因为Set存储的是不重复的对象，依据hashcode和equals进行判断，所以Set存储的对象必须重写这两个方法。  
    3）如果自定义对象做为Map的键，那么必须重写hashcode和equals。
 *  ArrayList的sublist结果不可强转成ArrayList，则会抛出ClasscastException异常，sublist返回的是Arraylist的内部类Sublist，并不是Arraylist，而是ArrayList的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。
 *  在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均会产生ConcurrentModificatiohException异常。
 *  使用集合转数组的方法，必须使用集合的toArray（T\[\]array），传入的是类型完全一样的数组，大小就是list.size（）。 说明：使用toArray 带参方法，入参分配的数组空间不够大时，toArray方法内部将重新分配内存空间，并返回新数组地址；如果数组元素大于实际所需，下标为\[list.size（）\]的数组元素将被置为nul1，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。
 *  使用工具类Arrays.asList（）把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedoperationException异常。说明：asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。Arrays.asList体现的是适配器模式，只是转换接口，后台的数据仍是数组。
 *  泛型通配符<？extends T>来接收返回的数据，此写法的泛型集合不能使用add方法，而<？superT>不能使用get方法，做为接口调用赋值时易出错。说明：扩展说一下PECS（Producer Extends Consumer Super）原则：第一、频繁往外读取内容的，适合用<？extendsT>。第二、经常往里插入的，适合用<？superT>。
 *  不要在foreach循环里进行元素的remove/add操作。remove 元素请使用Iterator方式，如果并发操作，需要对Iterator对象加锁。
 *  在JdK7版本及以上，Comparator 要满足如下三个条件，不然Arrays.sort，Collections.sort会报IllegalArgumentException异常。  
    说明：三个条件如下  
    1）x，y的比较结果和y，x的比较结果相反。  
    2）x>y，y>z，则x>z。  
    3）x=y，则x，z比较结果和y，z比较结果相同。
 *  集合初始化时，指定集合初始值大小。
 *  使用entrySet遍历Map类集合KV，而不是keySet方式进行遍历。说明：keyset 其实是遍历了2次，一次是转为Iterator对象，另一次是从hashMap中取出key所对应的value。而entryset只是遍历了一次就把key和value都放到了entry中，效率更高。如果是JDK8，使用Map.foreach方法。
 *  map 的values（）方法返回的是V值集合，是一个list集合对象；keyset（）返回的是K值集合，是一个set集合对象；entryset（）返回的是K-V值组合集合。
 *  高度注意Map类集合K/v能不能存储null值的情况，如下表格：

![20190511141732.png][]

*  合理利用好集合的有序性（sort）和稳定性（order），避免集合的无序性（unsort）和不稳定性（unorder）带来的负面影响。说明：有序性是指遍历的结果是按某种比较规则依次排列的。稳定性指集合每次遍历的元素次序是一定的。如：ArrayList是order/unsort；HashMap是unorder/unsort；TreeSet是order/sort。
 *  利用Set元素唯一的特性，可以快速对一个集合进行去重操作，避免使用List的contains方法进行遍历、对比、去重操作。

#### 6. 并发处理 ####

*  获取单例对象需要保证线程安全，其中的方法也要保证线程安全。说明：资源驱动类、工具类、单例工厂类都需要注意。
 *  创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。
 *  线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。  
    说明：使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
 *  线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。  
    说明：Executors返回的线程池对象的弊端如下：  
    1）FixedThreadPool 和SingleThreadPool：允许的请求队列长度为Integer.MAX\_VALUE，可能会堆积大量的请求，从而导致ooM。  
    2）CachedThreadPool和ScheduledThreadPool：允许的创建线程数量为Integer.MAX\_VALUE，可能会创建大量的线程，从而导致ooM。
 *  simpleDateFormat是线程不安全的类，一般不要定义为static变量，如果定义为static，必须加锁，或者使用Dateutils工具类。说明：如果是JDK8的应用，可以使用Instant代替Date，LocalDateTime代替Calendar，DateTimeFormatter代替simpleDateFormat
 *  高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。说明：尽可能使加锁的代码块工作量尽可能的小，**避免在锁代码块中调用RPC方法**。
 *  对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。说明：线程一需要对表A、B、C依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。
 *  并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。说明：如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次。
 *  多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorservice则没有这个问题。
 *  使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法被执行到，避免主线程无法执行至await方法，直到超时才返回结果。说明：注意，子线程抛出异常堆栈，不能在主线程try-catch到。
 *  避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed 导致的性能下降。  
    说明：Random实例包括java.util.Random的实例或者Math.random（）的方式。在JDK7之后，可以直接使用API ThreadLocalRandom，而在JDK7之前，需要编码保证每个线程持有一个实例。
 *  HashMap在容量不够进行resize时由于高并发可能出现死链，导致CPU飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。

#### 7. 条件控制语句 ####

*  在一个switch块内，每个case要么通过break/return等来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。
 *  在if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式：if（condition）statements；
 *  表达异常的分支时，少用if-else方式，这种方式可以改写成：  
    说明：如果非得使用if（）…else if（）…else…方式表达逻辑，**避免后续代码维护困难，请勿超过3层。**
 *  正例：超过3层的if-else的逻辑判断代码可以使用卫语句、策略模式、状态模式等来实其中卫语句示例如下：
    
        public void today（）{
        if（isBusy（））{
        System.out.println（"change time."）；return；
        }
        if（isFree（））{
        System.out.println（"go to travel."）；return；
        }
        System.out.println（"stay at home to learn Alibaba Java Coding Guidelines."）；
        return；
        }
    
    卫语句就是把复杂的条件表达式拆分成多个条件表达式，条件为真是，立刻从方法体重返回给调用方，卫语句的好处是条件表达式之间相互独立，不会互绕。
 *  除常用方法（如getxxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。  
    说明：很多f语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？
 *  在高并发场景中，避免使用“等于”判读作为中断或者退出的条件。如果并发控制没有处理好，容易产生等值判断被击穿的情况，应使用大于或小于的区间判断条件来代替。
 *  循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch操作（这个try-catch是否可以移至循环体外）。
 *  避免使用取反操作符。取反逻辑不利于快速理解，取反逻辑语句必然存在对应的正向逻辑。
 *  下列情形，需要进行参数校验：  
    1）调用频次低的方法。  
    2）执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。  
    3）需要极高稳定性和可用性的方法。  
    4）对外提供的开放接口，不管是RPC/API/HTTP接口。  
    5）敏感权限入口。
 *  下列情形，不需要进行参数校验：  
    1）极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。  
    2）底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DA0层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。  
    3）被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

#### 8. 注释规约 ####

*  所有的抽象方法（包括接口中的方法）必须要用Javadoc注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。说明：对子类的实现要求，或者调用注意事项，请一并说明。
 *  所有的类都必须添加创建者和创建日期。
 *  方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/\*\*/注释，注意与代码对齐。
 *  所有的枚举类型字段必须要有注释，说明每个数据项的用途。
 *  与其“半吊子”英文来注释，不如用中文注释把问题说清楚。专有名词与关键字保持英文原文即可。
 *  代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、核心逻辑等的修改。
 *  谨慎注释掉代码。在上方详细说明，而不是简单的注释掉。如果无用，则删除。  
    说明：代码被注释掉有两种可能性：1）后续会恢复此段代码逻辑。2）永久不用。前者如果没有备注信息，难以知晓注释动机。后者建议直接删掉（代码仓库保存了历史代码）。
 *  特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。  
    1）待办事宜（TOD0）：（标记人，标记时间，\[预计处理时间\]）表示需要实现，但目前还未实现的功能。这实际上是一个Javadoc的标签，目前的Javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法（因为它是一个Javadoc标签）。  
    2）错误，不能工作（FIXME）：（标记人，标记时间，\[预计处理时间\]）在注释中用FIXME标记某代码是错误的，而且不能工作，需要及时纠正的情况。、

#### 9. 其他 ####

*  在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。  
    说明：不要在方法体内定义：Pattern pattern=Pattern.compile（规则）；
 *  velocity调用PoJo类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用PoJo的getxxx（），如果是boolean基本数据类型变量（boolean命名不需要加is前缀），会自动调用isxxx（）方法。
 *  注意Math.random（）这个方法返回是double类型，注意取值的范围0sx<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。
 *  获取当前毫秒数system.currentTimeMillis（）；而不是new Date().getTime（）；说明：如果想获取更加精确的纳秒级时间值，使用system.nanoTime（）的方式。在JDK8中，针对统计时间等场景，推荐使用Instant类。
 *  不要在视图模板中加入任何复杂的逻辑。  
    说明：根据MVC理论，视图的职责是展示，不要抢模型和控制器的活。
 *  任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存。
 *  及时清理不再使用的代码段或配置信息。  
    说明：对于垃圾代码或过时配置，坚决清理干净，避免程序过度臃肿，代码冗余。  
    正例：对于暂时被注释掉，后续可能恢复使用的代码片断，在注释代码上方，统一规定使用三个斜杠（///）来说明注释掉代码的理由。

[20190511141732.png]: /images/20220130/dd19ab9ec7544460b05591c555dd489c.png