阿里巴巴对Java编程【控制语句】的规约

转载自 阿里巴巴对Java编程【控制语句】的规约

控制语句



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) {

...

}

反例

if ((file.open(fileName, "w") != null) && (...) || (...)) {

...

}


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


6. 【推荐】接口入参保护,这种场景常见的是用于做批量操作的接口。


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

1 ) 调用频次低的方法。

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

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

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

5) 敏感权限入口。


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

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

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

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


本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/330631.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

RabbitMQ消息

如何确保RabbitMQ消息的可靠性? 开启生产者确认机制,确保生产者的消息能到达队列开启持久化功能,确保消息未消费前在队列中不会丢失开启消费者确认机制为auto,由spring确认消息处理成功后完成ack开启消费者失败重试机制&#xff…

阿里巴巴对Java编程【注释规约】的规约

转载自 阿里巴巴对Java编程【注释规约】的规约注释规约1. 【强制】类、类属性、类方法的注释必须使用 Javadoc 规范,使用/**内容*/格式,不得使用// xxx 方式。 说明:在 IDE 编辑窗口中, Javadoc 方式会提示相关注释,生…

动态创建标记+css_dom+js动态效果

【7】动态创建标记【7.1】一些传统方法【7.1.1】document.write方法&#xff0c;不推荐使用 &#xff08;1&#xff09;<!DOCTYPE html> <html lang"en"> <head><meta http-equiv"content-type" content"text/html; charsetutf-…

orcle安装及用户初始化

1.orcle资源 orlce安装包点击下载 2.首次安装 参照: https://jingyan.baidu.com/article/f79b7cb32095f79144023eae.html 3.卸载后安装 先卸载清除本地的orcle服务 参照: https://jingyan.baidu.com/article/6b18230943e9d7fb59e1590f.html再重新下载资源解压安装’’ 注意…

JDK8新特性之Lambda表达式

转载自 JDK8新特性之Lambda表达式 什么是Lambda表达式 Java 8的一个大亮点是引入Lambda表达式&#xff0c;使用它设计的代码会更加简洁。当开发者在编写Lambda表达式时&#xff0c;也会随之被编译成一个函数式接口。 Lambda语法 一行执行语句的写法&#xff1a; (paramete…

eclipse发布web项目到tomcat服务器

README: 使用eclipse发布web项目到tomcat有很多坑儿的。下面依依道来。 step1&#xff09;eclipse建立web 项目&#xff1a;step2&#xff09;在tomcat服务器上为该web项目配置的虚拟目录&#xff0c;即把该web项目发布到tomcat&#xff1a; tomcat的server.xml 增加如下语句&…

springboot设置默认端口访问界面

1.项目结构 2.配置方法 <1>配置类默认加载 Configuration public class WebConfigurer implements WebMvcConfigurer {Overridepublic void addViewControllers(ViewControllerRegistry registry) {//默认地址&#xff08;可以是页面或后台请求接口&#xff09;registr…

Java BigDecimal和double区别

转自&#xff1a; https://www.cnblogs.com/mingforyou/p/3344489.htmlBigDecimal类 对于不需要任何准确计算精度的数字可以直接使用float或double&#xff0c;但是如果需要精确计算的结果&#xff0c;则必须使用BigDecimal类&#xff0c;而且使用BigDecimal类也可以进行大数的…

JDK8新特性之接口默认方法与静态方法

转载自 JDK8新特性之接口默认方法与静态方法 接口默认方法与静态方法 有这样一些场景&#xff0c;如果一个接口要添加一个方法&#xff0c;那所有的接口实现类都要去实现&#xff0c;而某些实现类根本就不需要实现这个方法也要写一个空实现&#xff0c;所以接口默认方法就是为…

mybatis generator Unknown system variable 'query_cache_size' 的解决方法

出现这种错误&#xff0c;很显然是数据库驱动程序 与 数据库版本不对应&#xff1b;如 mybatis使用 mysql-5.1.10的驱动程序&#xff0c;而mybatis配置的数据源连接的是 mysql-8.0.11 &#xff0c;修改 pom文件即可&#xff0c;如下&#xff1a; <dependency><groupId…

Java NoSuchElementException: No value present 问题解决

1 问题描述 java.util.NoSuchElementException: No value 2 问题分析 2.1 Java 1、使用stream()流里面的max().get()、min().get()、findFirst().get()方法&#xff0c;由于max()、min()、findFirst()方法会返回Optional对象&#xff0c;如果Optional对象里面没有数据&#xf…

JDK8新特性之Optional

转载自 JDK8新特性之Optional Optional是什么 java.util.Optional Jdk8提供 Optional&#xff0c;一个可以包含null值的容器对象&#xff0c;可以用来代替xx ! null的判断。 Optional常用方法 of public static <T> Optional<T> of(T value) {return new Opti…

使用maven聚合安装多个maven工程到本地仓库报错的解决方法:child module pom.xml does not exist

转自&#xff1a; https://stackoverflow.com/questions/26021141/maven-child-module-does-not-exist 1&#xff09;在maven项目Parent中的 pom.xml 中 使用聚合安装多个 maven工程到本地仓库&#xff0c;pom配置如下&#xff1a; <project xmlns"http://maven.apache…

JDK8新特性之重复注解

转载自 JDK8新特性之重复注解 什么是重复注解 下面是JDK8中的重复注解&#xff08; java.lang.annotation.Repeatable&#xff09;定义的源码。 Documented Retention(RetentionPolicy.RUNTIME) Target(ElementType.ANNOTATION_TYPE) public interface Repeatable {Class<…

JDK8之新特性扩展篇

转载自 JDK8之新特性扩展篇 BASE64 base64编码解码已经被加入到了jdk8中了。 import java.nio.charset.StandardCharsets; import java.util.Base64;public class Base64Test {public static void main(String[] args) {String text "hello javastack";String en…

eclipse maven 项目发布到tomcat 报错 Failed to scan JAR [file:/C:/xxxxx.jar] from WEB-INF/lib

报错信息如下&#xff1a; 警告: Failed to scan JAR [file:/D:/Development/Tomcat/apache-tomcat-7.0.35-64bit/webapps/Monday2/WEB-INF/lib/com.springsource.net.sf.cglib-2.2.0.jar] from WEB-INF/lib java.util.zip.ZipException: error in opening zip fileat java.uti…

SpringCloud配置中心高可用搭建

转载自 SpringCloud配置中心高可用搭建 本文通过config server连接git仓库来实现配置中心&#xff0c;除了git还可以使用svn或者系统本地目录都行。 引入依赖 <dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId…

maven项目 报错 java.lang.ClassNotFoundException: org.springframework.web.filter.HiddenHttpMethodFilter

报错信息如下&#xff1a; 严重: Exception starting filter hiddenHttpMethodFilter java.lang.ClassNotFoundException: org.springframework.web.filter.HiddenHttpMethodFilterat org.apache.catalina.loader.WebappClassLoader.loadClass(WebappClassLoader.java:1714)at …

SpringCloud配置中心客户端读取配置

转载自 SpringCloud配置中心客户端读取配置 微服务连接配置中心来实现外部配置的读取。 引入依赖 <dependencies><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-eureka</artifactId></d…

奇技淫巧:在spring官网上下载历史版本的spring插件,springsource-tool-suite

转自&#xff1a;https://blog.csdn.net/u010203767/article/details/69211072目前spring官网(http://spring.io/tools/sts/all)上可下载的spring插件只有&#xff1a;springsource-tool-suite-3.8.4(sts-3.8.4)。但这只针对指定的eclipse版本适用。 如何为自己的eclipse下载历…