编程的规范写法02

汽油——先森

已于 2023-03-03 22:22:06 修改

阅读量983

点赞数 2

文章标签： java jvm 开发语言

于 2023-03-03 22:10:57 首次发布

本文链接：https://blog.csdn.net/weixin_52163350/article/details/129327710

版权

六、并发处理

有关创建

1.获取单例对象需要保证线程安全，其中的方法也要保证线程安全。
说明：资源驱动类、工具类、单例工厂类都需要注意。

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

正例：

public class TimerTaskThread extends Thread {
public TimerTaskThread() {
    super.setName("TimerTaskThread");
    ...
}

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

4.线程池禁止用Executors去创建，而是通过ThreadPoolExecutor的方式，这会更加明确线程池的运行规则。
说明：Executors返回的线程池对象的弊端：

FixedThreadPool和SingleThreadPool：允许的请求队列长度为Integer.MAX_VALUE，可能会堆积大量的请求而导致OOM。
CachedThreadPool：允许的创建线程数量为Integer.MAX_VALUE，可能会创建大量的线程而导致OOM。

有关加锁

5. SimpleDateFormat 是线程不安全的类，一般不要定义为 static 变量，如果定义为static ，必须加锁，或者使用 DateUtils 工具类。
正例：注意线程安全，使用 DateUtils 。亦推荐如下处理：

private static final ThreadLocal<DateFormat> df = new ThreadLocal<DateFormat>() {
    @ Override
    protected DateFormat initialValue() {
        return new SimpleDateFormat("yyyy-MM-dd");
    }
};

说明：如果是 JDK 8 的应用，可以使用 Instant 代替 Date ， LocalDateTime 代替 Calendar ，
DateTimeFormatter 代替 SimpleDateFormat ，官方给出的解释： simple beautiful strong
immutable thread - safe 。

6.高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
说明：尽可能使加锁的代码块工作量尽可能的小，避免在锁代码块中调用 RPC 方法。

7.对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
例：线程一需要对表 A 、 B 、 C 依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是 A 、 B 、 C ，否则可能出现死锁。

8.并发修改同一记录时，避免更新丢失，需要加锁。要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用 version 作为更新依据。
说明：如果每次访问冲突概率小于 20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于 3 次。

线程安全

1.避免 Random 实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed 导致的性能下降。

2.HashMap 在容量不够进行 resize 时由于高并发可能出现死链，导致 CPU 飙升，在开发过程中可以使用其它数据结构或加锁来规避此风险。

七、控制语句

1.在一个 switch 块内，每个 case 要么通过 break / return 等来终止，要么注释说明程序将继续执行到哪一个 case 为止；在一个 switch 块内，都必须包含一个 default 语句并且放在最后，即使它什么代码也没有。

2.在 if / else / for / while / do 语句中必须使用大括号。即使只有一行代码，避免采用单行的编码方式： if (condition) statements;

3.循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的 try - catch 操作（这个 try - catch 是否可以移至循环体外）。

八、注释规约

1.类、类属性、类方法的注释必须使用 Javadoc 规范，使用/**内容*/格式，不得使用
// xxx 方式。
说明：在 IDE 编辑窗口中， Javadoc 方式会提示相关注释，生成 Javadoc 可以正确输出相应注
释；在 IDE 中，工程调用方法时，不进入方法即可悬浮提示方法、参数、返回值的意义，提高
阅读效率。

2.所有的抽象方法（包括接口中的方法）必须要用 Javadoc 注释、除了返回值、参数、异常说明外，还必须指出该方法做什么事情，实现什么功能。
说明：对子类的实现要求，或者调用注意事项，请一并说明。

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

4.方法内部单行注释，在被注释语句上方另起一行，使用//注释。方法内部多行注释使用/* */注释，注意与代码对齐。

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

6.代码与注释要同步更新。

九、其他

1.在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
说明：不要在方法体内定义： Pattern pattern = Pattern . compile( 规则 );

2. velocity 调用 POJO 类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用 POJO 的 getXxx() ，如果是 boolean 基本数据类型变量（boolean 命名不需要加 is前缀），会自动调用 isXxx() 方法。
说明：注意如果是 Boolean 包装类对象，优先调用 getXxx() 的方法。

3.后台输送给页面的变量必须加 $!{var} ——中间的感叹号。
说明：如果 var = null 或者不存在，那么 ${var} 会直接显示在页面上。

4.注意 Math . random() 这个方法返回是 double 类型，注意取值的范围 0≤ x <1 （能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将 x 放大 10 的若干倍然后
取整，直接使用 Random 对象的 nextInt 或者 nextLong 方法。

5.获取当前毫秒数 System . currentTimeMillis(); 而不是 new Date() . getTime();
说明：如果想获取更加精确的纳秒级时间值，使用 System . nanoTime()的方式。在 JDK 8 中，针对统计时间等场景，推荐使用 Instant 类。

引用：阿里java开发手册