在工作上,我最近对一个现有的Java项目代码进行了清理。完成之后,我发现了一些反复出现的不规范代码。所以,我把它们整理成了一个列表出来分享给我的同行希望能引起注意并改善代码的质量和可维护性。
这个列表不区分顺序,全部来自一些代码质量检查工具,如 CheckStyle, FindBugs 和 PMD。
在Eclipse中格式化源代码并管理import语句
Eclipse提供了自动格式化源代码和管理import语句的功能(并移除未使用的语句)。你可以使用下面的快捷键来使用这些功能。
Ctrl + Shift + F – 格式化源代码。
Ctrl + Shift + O – 管理import语句并移除未使用的语句。
除了手动执行这两个功能外,你还可以让Eclipse在保存文件的时候自动格式化源代码并自动管理import语句。要做到这个,在Eclipse中, 到 Window -> Preferences -> Java -> Editor -> Save Actions并启用 Perform the selected actions on save,选中 Format source code和 organize imports。
避免在方法中出现多个return语句(退出点):
在你的方法中,确保只有一个 退出点。不要在一个方法中使用多于一个return语句。
如,下面的代码是 不推荐的,因为它有多个退出点(return语句)。
private boolean isEligible(int age){
if(age > 18){
return true;
}else{
return false;
}
}
上面的代码可以这么写(当然,下面的代码还可以改进,后面再说)。
private boolean isEligible(int age){
boolean result;
if(age > 18){
result = true;
}else{
result = false;
}
return result;
}
简化if-else方法:
我们写了一些只要一个参数的工具方法,检查一些条件并根据条件返回一个值。如,在上面见到的 isEligible方法。
private boolean isEligible(int age){
boolean result;
if(age > 18){
result = true;
}else{
result = false;
}
return result;
}
可以只使用一个return语句来重写此方法。
private boolean isEligible(int age){
return age > 18;
} 不要为Boolean,Integer或String创建新的实例:
避免创建新的Boolean,Integer,String等实例。使用Boolean.valueOf(true)代替new Boolean(true)。两种写法效果差不多但却可以改善性能。
在代码块周围使用大括号:
永远不要忘记在块类型语句(如:if,for,while)周围使用大括号。这可以减少代码歧义并且避免在你修改代码块的时候产生新的bug。
不推荐
if(age > 18)
return true;
else
return false;
推荐
if(age > 18){
return true;
}else{
return false;
}
把方法的参数声明为final类型:
总是在所有兼容的地方把把方法的参数声明为final。这样做的话,当你无意中修改了参数的值,编译时会得到警告,并且编译生成的字节码也会得到优化。
推荐
private boolean isEligible(final int age){ ... }
用大写命名public static final类型成员变量:
总是使用大写命名用public static final类型变量。这样可以让你很容易区分常量和本地变量。
不推荐
public static final String testAccountNo = "12345678";
推荐
public static final String TEST_ACCOUNT_NO = "12345678";
把多个if语句合并成一个:
下面的代码
if(age > 18){
if( voted == false){
// eligible to vote.
}
}
可以使用一个if语句改写为:
if(age > 18 && !voted){
// eligible to vote
}
别忘了给switch添加default语句:
总是给switch添加一个default语句。
避免重复使用同样的字符串,创建一个常量吧:
如果你需要在多个地方使用同一个字符串,那就创建一个字符串常量来使用吧。
下面的代码:
private void someMethod(){
logger.log("My Application" + e);
....
....
logger.log("My Application" + f);
}
可以创建一个常量代替字符串"My Application":
public static final String MY_APP = "My Application";
private void someMethod(){
logger.log(MY_APP + e);
....
....
logger.log(MY_APP + f);
}
分享到:
相关推荐
### 8种常见的Java不规范代码 在日常的软件开发工作中,编写高质量、高效率的代码至关重要。良好的编码习惯不仅能提升个人技术素养,还能增强团队协作的效率与成果。本文将探讨八种常见的Java不规范代码,帮助...
Java代码规范文档中涉及的知识点涵盖了Java编程实践中的命名风格和代码组织方式,旨在为Java开发人员提供一份行业内部开发的准则,确保代码的可读性、一致性和维护性。以下是从提供的文档内容中提炼出的相关知识点:...
"java代码规范示例" Java 代码规范示例中,涵盖了 Java 项目中包、类、方法、注释等多个方面的规范。 首先,从文件头的注释部分可以看到,这个 Java 文件是一个 FTP 帮助类,负责实现 FTP 的上传和下载功能。这个...
Java代码规范是编程实践中至关重要的一个方面,它旨在确保代码的质量、可读性和维护性。以下是一些核心的Java代码规范要点: 1. **命名规范**: - 类名使用大驼峰命名法,所有单词首字母大写,例如`ClassName`。 ...
JAVA代码规范.docxJAVA代码规范.docxJAVA代码规范.docxJAVA代码规范.docx
本文将探讨一些常见的Java不规范代码,并提供相应的优化建议,帮助开发者写出更加规范、高效的Java代码。 #### 二、代码格式与组织 1. **使用Eclipse自动格式化代码和管理导入语句** - Eclipse提供了一套强大的...
JDK1.8 Java 代码开发规范 JDK1.8 Java 代码开发规范是指在 Java 开发过程中遵守的一系列编程规约和约定,以确保代码的可读性、可维护性和可靠性。该规范涵盖了编程规约、异常日志、命名风格、常量定义、代码格式、...
Java 代码规范指南 Java 代码规范是 Java 开发中极其重要的一部分,对于编写高质量、易维护的代码至关重要。在本指南中,我们将详细介绍 Java 代码规范的各个方面,包括命名规范、注释规范、代码格式、开发建议和...
Java程序员编写代码时应当遵循的一些基本规范
Code Review是一种用来确认方案设计和代码实现的质量保证机制,通过这个机制我们可以对代码、测试过程和注释进行检查。 Code Review主要用来在软件工程过程中改进代码质量,通过Code Review可以达到如下目的: .在...
Java代码设计规范是编程实践中非常重要的一个环节,它旨在提高代码质量、可读性和团队协作效率。本规范基于一系列安全可靠的原则,旨在帮助Java开发者编写出高效、稳定且易于维护的代码。 ### 1. 简介 良好的代码...
《阿里巴巴Java代码规范》是Java开发者们遵循的一套专业编程指南,旨在提高代码质量、可读性和维护性。这份规范由阿里巴巴集团内部的专家团队制定,经过多年的实践和完善,已经成为业界广泛参考的标准之一。以下是对...
JAVA代码规范及快捷键优化 在软件开发过程中,代码规范和快捷键优化是非常重要的两个方面。以下是关于JAVA代码规范和快捷键优化的知识点总结: 一、JAVA代码规范 1. 空格规范:在编写JAVA代码时,需要遵守统一的...
Java代码书写规范是Java软件开发中的重要组成部分,它旨在提升代码的质量、可读性和可维护性,从而提高开发效率和团队协作效果。遵循一套统一的编程标准,可以帮助开发者避免不必要的误解,减少错误,并使得代码更加...
在IntelliJ IDEA(简称Idea)中,开发者可以安装阿里巴巴的Java代码格式规范插件,以便在编写代码时实时检查并提示不符合规范的地方。安装该插件的过程如下: 1. 打开IntelliJ IDEA,进入“设置”(Settings) 或 ...
Java代码规范是为了保证代码的可读性、可维护性和团队协作的一致性。这份规范文档是基于SUN的标准Java代码规范,并结合了Google编码规范以及个人所在公司的具体需求。以下是一些关键点的详细说明: 1. **标识符命名...
Java代码检查工具是一种重要的开发辅助软件,主要用于确保代码符合特定的编程规范和最佳实践,从而提高代码质量和可维护性。这些工具通常作为集成开发环境(IDE)如MyEclipse的插件存在,允许开发者在编写代码的过程...
【Java代码编写规范】 编码规范在IT行业中,尤其是在Java编程领域,扮演着至关重要的角色。首先,一个软件的生命周期中,大部分成本在于维护阶段,因此,为了降低维护难度和提高效率,良好的编码规范必不可少。其次...
总结来说,理解和遵循编码规范、注释规范以及代码风格对于任何Java开发者都是至关重要的。华为的这些资源提供了一套完整的框架,旨在帮助开发团队产出高质量、易维护的代码。通过深入学习和应用这些规范,开发者不仅...