阿里巴巴Java开发规范手册

Posted 2021-02-09 yvette-hathaway

（六）并发处理

　　1、获取单例对象须要保证线程安全，其中的方法也要保证线程安全

　　2、创建线程或线程池时 请指定有意义的线程名称，方便出错时回溯

　　3、线程资源必须通过线程池提供，不允许在应用中自行显示创建线程

　　4、线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，

　　　   这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险

　　　　(1)、FixedThreadPool 和SingleThreadPool

　　　　　　允许的请求队列长度为Integer.MAX_VALUE,可能会堆积大量的请求，从而导致OOM

　　　　(2)、CachedThreadPool和ScheduleThreadPool

　　　　　　允许的创建线程数量为Integer.MAX_VALUE,可能会创建大量的线程，从而导致OOM

　　5、SimpleDateFormat是线程不安全的类，一般不要定义为static变量，

　　　　如果定义为static必须加锁，或者使用DateUtils工具类

　　6、高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁

　　　　能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁

　　7、对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，

　　　　否则可能会造成死锁

　　8、并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，

　　　　要么在数据库层使用乐观锁，使用version作为更新依据

　　9、多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的

　　　　异常，其他任务便会自动终止运行，使用ScheduledExecutorService则没有这个问题

　　10、使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，

　　　　线程执行代码注意catch异常，确保countDown方法被执行到，避免主线程无法执行至

　　　　await方法，直到超时才返回结果

　　11、避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一个

　　　　seed导致的性能下降

　　12、在并发场景下，通过双重检查锁(double-checked locking)实现延迟初始化的优化问题

　　　　隐患，将目标属性声明为volatile

　　13、volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是

　　　　如果多写，同样无法解决线程安全问题。如果是 count++操作，使用如下类实现：

　　　　AtomicInteger count = new AtomicInteger(); count.addAndGet(1); 如果是 JDK8，推
　　　　荐使用 LongAdder 对象，比 AtomicLong 性能更好（减少乐观锁的重试次数）。
　　14、HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在
　　　　  开发过程中可以使用其它数据结构或加锁来规避此风险。
　　15、ThreadLocal 无法解决共享对象的更新问题，ThreadLocal 对象建议使用 static修饰。

　　　　这个变量是针对一个线程内所有操作共享的，所以设置为静态变量，所有此类实例共享
　　　　此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对

　　　　象(只要是这个线程内定义的)都可以操控这个变量。

（七）、控制语句

　　1、在一个switch块内，每一个case要么通过break/return等来终止，要么注释说明程序将

　　　 继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在

　　　 最后，即使它什么代码都没有

　　2、在 if/else/for/while/do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码

　　　 方式：if (condition) statements

　　3、表达异常的分支时，少用 if-else 方式，这种方式可以改写成：

　　　　　if (condition) { 

　　　　　　　　... 

　　　　　　　　return obj;
　　　　　　} 
　　　　　　// 接着写 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;
                         }

　　4、除常用方法（如 getXxx/isXxx）等外，不要在条件判断中执行其它复杂的语句，将复

　　　　杂逻辑判断的结果赋值给一个有意义的布尔变量名，以提高可读性。

　　　　说明：很多 if 语句内的逻辑相当复杂，阅读者需要分析条件表达式的最终结果，

　　　　才能明确什么样的条件执行什么样的语句，那么，如果阅读者分析逻辑表达式错误呢？

　　　　正例：
　　　　　　// 伪代码如下
　　　　　　final boolean existed = (file.open(fileName, "w") != null) && (...) || (...);
　　　　　　if (existed) {
　　　　　　　　...
　　　　　　}

　　5、循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、

　　　　获取数据库连接，进行不必要的 try-catch 操作（这个 try-catch 是否可以移至循环体外）

　　6、接口入参保护，这种场景常见的是用于做批量操作的接口

　　7、下列情形，需要进行参数校验：

　　　　(1) 调用频次低的方法。
　　　　(2) 执行时间开销很大的方法。此情形中，参数校验时间几乎可以忽略不计，但如果因为

　　　　　　参数错误导致中间执行回退，或者错误，那得不偿失。

　　　　(3) 需要极高稳定性和可用性的方法。
　　　　(4) 对外提供的开放接口，不管是 RPC/API/HTTP 接口。
　　　　(5) 敏感权限入口。

　　8、下列情形，不需要进行参数校验：

　　　　(1) 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查要求。
　　　　(2) 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道，参数错误不太可能到

　　　　　　底层才会暴露问题。一般 DAO 层与 Service 层都在同一个应用中，部署在同一台

　　　　　　服务器中，所以 DAO 的参数校验，可以省略。
　　　　(3) 被声明成 private 只会被自己代码所调用的方法，如果能够确定调用方法的代码传入

　　　　　　参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

（八）注释规则

　　1、类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用

　　　　// xxx 方式。

　　2、所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、

　　　　异常说明外，还必须指出该方法做什么事情，实现什么功能

　　3、所有的类都必须添加创建者和创建日期。

　　4、方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释

　　　　使用/* */注释，注意与代码对齐。

　　5、所有的枚举类型字段必须要有注释，说明每个数据项的用途

　　6、与其“半吊子”英文来注释，不如用中文注释把问题说清楚。

　　　 专有名词与关键字保持英文原文即可

　　7、代码修改的同时，注释也要进行相应的修改，尤其是参数、返回值、异常、

　　　　核心逻辑等的修改

　　8、谨慎注释掉代码。在上方详细说明，而不是简单地注释掉。如果无用，则删除

　　9、对于注释的要求：第一、能够准确反应设计思想和代码逻辑；

　　　　第二、能够描述业务含义，使别的程序员能够迅速了解到代码背后的信息。完全没有注释

　　　　的大段代码对于阅读者形同天书，注释是给自己看的，即使隔很长时间，也能清晰理解当

　　　　时的思路；注释也是给继任者看的，使其能够快速接替自己的工作

　　10、好的命名、代码结构是自解释的，注释力求精简准确、表达到位。避免出现注释的

　　　　一个极端：过多过滥的注释，代码的逻辑一旦修改，修改注释是相当大的负担

　　11、特殊注释标记，请注明标记人与标记时间。注意及时处理这些标记，通过标记扫描，

　　　　经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

　　　　(1) 待办事宜（TODO）:（ 标记人，标记时间，[预计处理时间]）

　　　　　 表示需要实现，但目前还未实现的功能。这实际上是一个 Javadoc 的标签，

　　　　　 目前的 Javadoc还没有实现，但已经被广泛使用。只能应用于类，接口和方法

　　　　　（因为它是一个 Javadoc 标签）。
　　　　(2) 错误，不能工作（FIXME）:（标记人，标记时间，[预计处理时间]）

　　　　　  在注释中用 FIXME 标记某代码是错误的，而且不能工作，需要及时纠正的情况。

（九）其它

　　1、在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。

　　2、velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按

　　　 规范调用 POJO 的 getXxx()，如果是 boolean 基本数据类型变量（boolean 命名不需要加 　　　 is前缀），会自动调用 isXxx()方法

　　3、后台输送给页面的变量必须加$!{var}——中间的感叹号

　　4、注意 Math.random() 这个方法返回是 double 类型，注意取值的范围 0≤x<1

　　　（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的

　　　　若干倍然后取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法

　　5、获取当前毫秒数 System.currentTimeMillis(); 而不是 new Date().getTime();

　　　　说明：如果想获取更加精确的纳秒级时间值，使用 System.nanoTime()的方式。

　　　　在 JDK8 中，针对统计时间等场景，推荐使用 Instant 类

　　6、不要在视图模板中加入任何复杂的逻辑。

　　7、任何数据结构的构造或初始化，都应指定大小，避免数据结构无限增长吃光内存

　　8、及时清理不再使用的代码段或配置信息。

 

---

出自《阿里巴巴Java开发手册》 喜欢请支持正版