`

8种常见的Java不规范代码

    博客分类:
  • java
阅读更多
在工作上,我最近对一个现有的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); 
}
分享到:
评论

相关推荐

    常见的Java不规范代码

    ### 常见的Java不规范代码及其优化 #### 一、引言 在软件开发过程中,编写高质量的代码对于提升程序的可读性、可维护性和性能至关重要。本文将探讨一些常见的Java不规范代码,并提供相应的优化建议,帮助开发者写...

    Java代码规范.pdf

    Java代码规范文档中涉及的知识点涵盖了Java编程实践中的命名风格和代码组织方式,旨在为Java开发人员提供一份行业内部开发的准则,确保代码的可读性、一致性和维护性。以下是从提供的文档内容中提炼出的相关知识点:...

    java代码规范示例

    "java代码规范示例" Java 代码规范示例中,涵盖了 Java 项目中包、类、方法、注释等多个方面的规范。 首先,从文件头的注释部分可以看到,这个 Java 文件是一个 FTP 帮助类,负责实现 FTP 的上传和下载功能。这个...

    JAVA代码规范 JAVA规范 代码规范

    Java代码规范是编程实践中至关重要的一个方面,它旨在确保代码的质量、可读性和维护性。以下是一些核心的Java代码规范要点: 1. **命名规范**: - 类名使用大驼峰命名法,所有单词首字母大写,例如`ClassName`。 ...

    JAVA代码规范.docx

    JAVA代码规范.docxJAVA代码规范.docxJAVA代码规范.docxJAVA代码规范.docx

    阿里巴巴Java代码规范PDF.zip

    《阿里巴巴Java代码规范》是Java开发者们遵循的一套专业编程指南,旨在提高代码质量、可读性和维护性。这份规范由阿里巴巴集团内部的专家团队制定,经过多年的实践和完善,已经成为业界广泛参考的标准之一。以下是对...

    Java代码规范2020.docx

    Java 代码规范指南 Java 代码规范是 Java 开发中极其重要的一部分,对于编写高质量、易维护的代码至关重要。在本指南中,我们将详细介绍 Java 代码规范的各个方面,包括命名规范、注释规范、代码格式、开发建议和...

    JAVA代码规范及快捷键优化.docx

    JAVA代码规范及快捷键优化 在软件开发过程中,代码规范和快捷键优化是非常重要的两个方面。以下是关于JAVA代码规范和快捷键优化的知识点总结: 一、JAVA代码规范 1. 空格规范:在编写JAVA代码时,需要遵守统一的...

    Java虚拟机规范.Java SE 8版.zip

    《Java核心技术系列:Java虚拟机规范(Java SE 8版)》由Oracle官方发布,Java虚拟机技术创建人撰写,国内资深Java技术专家翻译。书中基于全新Java SE 8,完整且准确地阐述Java虚拟机规范,是深度了解Java虚拟机和...

    Java代码规范文档

    Java代码规范是为了保证代码的可读性、可维护性和团队协作的一致性。这份规范文档是基于SUN的标准Java代码规范,并结合了Google编码规范以及个人所在公司的具体需求。以下是一些关键点的详细说明: 1. **标识符命名...

    官方java8规范-jls8.rar

    《Java语言规范,Java SE 8版》是Java开发者的重要参考文档,它详细定义了Java 8编程语言的语法、语义以及程序执行规则。这份规范,也被称为JLS(Java Language Specification)8,是理解Java 8特性和变化的关键。 ...

    编码规范 注释规范 代码风格 JAVA

    在IT行业中,编程规范、注释规范以及代码风格是软件开发中的重要组成部分,尤其是在大型企业如华为这样的公司中,它们被视为保证代码质量、提高团队协作效率的关键准则。这些规范不仅有助于提升代码的可读性和可维护...

    java代码编写规范

    Java程序员编写代码时应当遵循的一些基本规范

    代码规范.rar 阿里巴巴java代码规范

    **阿里巴巴Java代码规范** 在软件开发领域,代码规范起着至关重要的作用,它不仅可以提高代码的可读性和可维护性,还能确保团队之间的代码风格一致性,从而提升开发效率。阿里巴巴作为国内知名的互联网企业,有着...

    检查代码规范插件 检查代码规范插件

    Java作为一种广泛使用的编程语言,同样强调代码规范。本篇文章将详细介绍Java检查代码规范插件的使用、功能以及其在开发流程中的作用。 首先,让我们了解一下什么是Java检查代码规范插件。这类插件主要用于静态代码...

    java案例代码规范

    Java代码规范是编程实践中非常重要的一个方面,它不仅有助于提高代码的可读性和可维护性,还能提升团队协作效率。以下是一些关于Java代码规范的关键点: 1. **版权信息**:每个Java文件的开头都应该包含版权信息,...

    java代码规范——很经典的一本书

    Java代码规范是编程界的一本重要著作,它旨在提高代码质量、增强可读性和可维护性,从而使得软件开发团队能够更加高效地协作。这本书详细阐述了如何编写整洁、一致且易于理解的Java代码,是Java开发者提升编码技能的...

    JDK1.8Java代码开发规范

    JDK1.8 Java 代码开发规范 JDK1.8 Java 代码开发规范是指在 Java 开发过程中遵守的一系列编程规约和约定,以确保代码的可读性、可维护性和可靠性。该规范涵盖了编程规约、异常日志、命名风格、常量定义、代码格式、...

Global site tag (gtag.js) - Google Analytics