阿里巴巴Java开发规范手册(三)

(六)并发处理

  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开发手册》 喜欢请支持正版

原文地址:https://www.cnblogs.com/yvette-hathaway/p/10396031.html

时间: 2024-07-31 12:15:02

阿里巴巴Java开发规范手册(三)的相关文章

eclipse安装阿里巴巴java开发规范插件

阿里巴巴java开发规范插件 作为JAVA开发人员,始终没有一个明确的规范,何为好代码,何为坏代码,造成不同人的代码风格不同,接手别人代码后改造起来相当困难.前不久,阿里巴巴发布了<阿里巴巴Java开发手册>得到了业界一致好评,于是,阿里再次发力,完成了基于<阿里巴巴Java开发手册>的插件.有IDEA.Eclipse两个版本,并且支持中英双语,使用起来非常简单高效.官方[Github仓库]:https://github.com/alibaba/p3c 插件安装环境:JDK1.8,

阿里巴巴java开发规范

一.编程规约 (一) 命名规约 1. [强制]所有编程相关命名均不能以下划线或美元符号开始,也不能以下划线或美元符号结束. 反例: _name / __name / $Object / name_ / name$ / Object$ 凡是以两个或一个下划线开始,后面紧跟着一个大写字母的标识符,不管它出现在哪里,都是保留给编译程序或标准库函数使用的. 此外,凡是以一个下划线开始,后面不管跟着什么内容的标识符,如果它出现在文件范围内(即它不是出现在一个函数内),那么它也是被保留的. 如果你用一个保留

阿里巴巴Java开发手册正确学习姿势是怎样的?刷新代码规范认知

很多人都知道,阿里巴巴在2017发布了<阿里巴巴Java开发手册>,前后推出了很多个版本,并在后续推出了与之配套的IDEA插件和书籍. 相信很多Java开发都或多或少看过这份手册,这份手册有7个章节,覆盖了编程规约.异常日志.单元测试.安全规约.MySQL数据库.工程结构以及设计规约等方面. 这份规约可以说是覆盖了Java开发的方方面面,如果还有人没看的话,强烈建议大家好好看看,并且仔细研读. 手册中,有那么一些规则,是比较容易理解的.比如一些变量命名规范,有另外一些规则,是不太容易理解的,背

《阿里巴巴Java开发手册(正式版》读记

前几天,阿里巴巴发布了<阿里巴巴Java开发手册(正式版>,第一时间下载阅读了一番. 不同于一般大厂内部的代码规范,阿里巴巴的这本Java开发手册,可谓包罗万象,几乎日常Java开发中方方面面都有所涉及. 在知乎上,也有关于这本开发手册的讨论十分热烈的帖子. 由于里面涉及的内容比较多,下面重点罗列下一些我读过之后十分赞同与持保留意见的条目: (一)编码规范 (一)命名规约 8. [强制]POJO 类中布尔类型的变量,都不要加 is,否则部分框架解析会引起序列化错误. 反例:定义为基本数据类型b

阿里巴巴Java开发手册———个人追加的见解和补充(一)

先上干货,<阿里巴巴Java开发手册>的下载地址 https://yq.aliyun.com/articles/69327?spm=5176.100239.blogcont69327.158.xUUgiz 下面分几个部分对这个手册进行说明,都是个人的见解,本人技术一般,如果有错误或者不妥,请评论指出,虚心接受,提前感谢了. 建议边看手册,边食用以下说明,效果比较好. 前言 首先当我第一次看见这个的手册的时候或许和和你们是一样激动的,因为在java行业内我还没有看见有中文的规范,也可能是我读书少

读阿里巴巴Java开发手册v1.2.0之编程规约有感【架构篇】

 不为过去蹉跎,改变当下. 为什么开篇就送这么一句话给大家,我相信很多处于1-3年码龄的哥们儿们,在平时的编码历程中编码的个性可能是多彩的,每个人都有每个人特定的风格,但是我们现在这么随意写,以后这么随意写,好没问题,但是等你离开这个公司了或者是去开发别的项目了,再等别人过来接手维护你一手写出来的这段个性十足的代码时,那么你的右眼皮时不时地就会跳,因果我就不说了~~ 所以我建议看到这篇博文的朋友们,或许你稍微改变一下你的编码风格,遵从一套好的编码规约对己对人都是有好处的.可能朋友的公司也有专门的

阿里巴巴Java开发手册———总结

前言 阿里巴巴Java开发手册———个人追加的见解和补充(一) 阿里巴巴Java开发手册———个人追加的见解和补充(二) 阿里巴巴Java开发手册———个人追加的见解和补充(三) 阿里巴巴Java开发手册———个人追加的见解和补充(四) 阿里巴巴Java开发手册———个人追加的见解和补充(五) 总结 其实,已经有很多大神级别的人物都已经多多少少对这份手册有了很多的评论,我也看了很多的评论,我这里上面给出的只是我自己个人的看法.对于手册本身来说参考价值因人而异,对于有的人来说如获至宝,对于有的人来

《阿里巴巴 Java开发手册》读后感

前言 只有光头才能变强 前一阵子一直在学Redis,结果在黄金段位被虐了,暂时升不了段位了,每天都拿不到首胜(好烦). 趁着学校校运会,合理地给自己放了一个小长假,然后就回家了.回到家才发现当时618买了一堆书,这堆书还有没撕包装的呢....于是我翻出了最薄的一本<阿里巴巴 Java开发手册> 这本书一共就90多页,一天就可以通读完了,看完之后我又来水博文了. 注意: 书上很多的规范是可以用IDE来避免的,也有很多之前已经知道的了. 所以,这篇文章只记录我认为比较重要,或者说是我之前开发时没有

阿里巴巴Java开发手册1.4.0

转自官网 前言 <阿里巴巴Java开发手册>是阿里巴巴集团技术团队的集体智慧结晶和经验总结,经历了多次大规模一线实战的检验及不断完善,系统化地整理成册,回馈给广大开发者.现代软件行业的高速发展对开发者的综合素质要求越来越高,因为不仅是编程知识点,其它维度的知识点也会影响到软件的最终交付质量.比如:数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险:工程结构混乱导致后续维护艰难:没有鉴权的漏洞代码易被黑客攻击等等.所以本手册以Java开发者为中心视角,划分为编程规约.异常日志.单元测