软件开发

当前位置:首页 > 软件开发

阿里Java开发手册(续)

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

11.【推荐】避免采用取反逻辑运算符。 

说明:取反逻辑不利于快速理解,并且取反逻辑写法一般都存在对应的正向逻辑写法。

正例:使用 if (x < 628) 来表达 x 小于 628。 反例:使用 if (!(x >= 628)) 来表达 x 小于 628。

12.【推荐】公开接口需要进行入参保护,尤其是批量操作的接口。

反例:某业务系统,提供一个用户批量查询的接口,API 文档上有说最多查多少个,但接口实现上没做任何 保护,导致调用方传了一个 1000 的用户 id 数组过来后,查询信息后,内存爆了。

13.【参考】下列情形,需要进行参数校验: 

1) 调用频次低的方法。

2) 执行时间开销很大的方法。此情形中,参数校验时间几乎可以忽略不计,但如果因为参数错误导致  中间执行回退,或者错误,那得不偿失。 

3) 需要极高稳定性和可用性的方法。

4) 对外提供的开放接口,不管是 RPC/API/HTTP 接口。

5) 敏感权限入口。

14.【参考】下列情形,不需要进行参数校验:

1) 极有可能被循环调用的方法。但在方法说明里必须注明外部参数检查。

2) 底层调用频度比较高的方法。毕竟是像纯净水过滤的最后一道,参数错误不太可能到底层才会暴露 问题。一般 DAO 层与 Service 层都在同一个应用中,部署在同一台服务器中,所以 DAO 的参数校验,可 以省略

3) 被声明成 private 只会被自己代码所调用的方法,如果能够确定调用方法的代码传入参数已经做过检 查或者肯定不会有问题,此时可以不校验参数。

(九) 注释规约 

1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/**内容*/格式,不得使用 // xxx 方式。

说明:在 IDE 编辑窗口中,Javadoc 方式会提示相关注释,生成 Javadoc 可以正确输出相应注释;在 IDE 中,工程调用方法时,不进入方法即可悬浮提示方法、参数、返回值的意义,提高阅读效率。

2. 【强制】所有的抽象方法包括接口中的方法必须要用 Javadoc 注释、除了返回值、参数、 异常说明外,还必须指出该方法做什么事情,实现什么功能。 

说明:对子类的实现要求,或者调用注意事项,请一并说明。 

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

说明:在设置模板时,注意 IDEA 的@author 为`${USER}`,而 eclipse 的@author 为`${user}`,大小写有 区别,而日期的设置统一为 yyyy/MM/dd 的格式

正例:

/** 
* @author yangguanbao 
* @date 2016/10/31 
*/

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

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

6. 【推荐】与其“半吊子”英文来注释,不如用中文注释把问题说清楚。专有名词与关键字保持 英文原文即可。 

反例:“TCP 连接超时”解释成“传输控制协议连接超时”,理解反而费脑筋。

7. 【推荐】代码修改的同时,注释也要进行相应的修改,尤其是参数、返回值、异常、核心逻辑 等的修改。

说明:代码与注释更新不同步,就像路网与导航软件更新不同步一样,如果导航软件严重滞后,就失去了 导航的意义。

8. 【推荐】在类中删除未使用的任何字段、方法、内部类;在方法中删除未使用的任何参数声明 与内部变量。

9. 【参考】谨慎注释掉代码。在上方详细说明,而不是简单地注释掉。如果无用,则删除。 说明:代码被注释掉有两种可能性:

1)后续会恢复此段代码逻辑。

2)永久不用。前者如果没有备注信息, 难以知晓注释动机。后者建议直接删掉即可,假如需要查阅历史代码,登录代码仓库即可。

10.【参考】对于注释的要求:第一、能够准确反映设计思想和代码逻辑第二、能够描述业务含 义,使别的程序员能够迅速了解到代码背后的信息。完全没有注释的大段代码对于阅读者形同 天书,注释是给自己看的,即使隔很长时间,也能清晰理解当时的思路注释也是给继任者看 的,使其能够快速接替自己的工作。 

11.【参考】好的命名、代码结构是自解释的,注释力求精简准确、表达到位。避免出现注释的一 个极端:过多过滥的注释,代码的逻辑一旦修改,修改注释又是相当大的负担。

反例: 

// put elephant into fridge  
put
(
elephant
, 
fridge
);


方法名 put,加上两个有意义的变量名 elephant 和 fridge,已经说明了这是在干什么,语义清晰的代码不 需要额外的注释。

12.【参考】特殊注释标记,请注明标记人与标记时间。注意及时处理这些标记,通过标记扫描, 经常清理此类标记。线上故障有时候就是来源于这些标记处的代码。

1) 待办事宜(TODO):(标记人,标记时间,[预计处理时间]) 表示需要实现,但目前还未实现的功能。这实际上是一个 Javadoc 的标签,目前的 Javadoc 还没 有实现,但已经被广泛使用。只能应用于类,接口和方法(因为它是一个 Javadoc 标签)。

2) 错误,不能工作(FIXME):(标记人,标记时间,[预计处理时间]) 在注释中用 FIXME 标记某代码是错误的,而且不能工作,需要及时纠正的情况。


相关内容

文章评论

表情

共 0 条评论,查看全部
  • 这篇文章还没有收到评论,赶紧来抢沙发吧~