9种常见的Java不规范代码

转自： http://www.oschina.net/question/100267_70351

在工作上，我最近对一个现有的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。

1.避免在方法中出现多个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;  
} 

2.简化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;  
} 

3.不要为Boolean，Integer或String创建新的实例：

避免创建新的Boolean，Integer，String等实例。使用Boolean.valueOf(true)代替new Boolean(true)。两种写法效果差不多但却可以改善性能。

4.在代码块周围使用大括号:

永远不要忘记在块类型语句（如：if,for,while）周围使用大括号。这可以减少代码歧义并且避免在你修改代码块的时候产生新的bug。

不推荐

  
  
if(age > 18)  
  return true;  
else 
  return false; 

推荐

  
  
if(age > 18){  
  return true;  
}else{  
  return false;  
} 

5.把方法的参数声明为final类型:

总是在所有兼容的地方把把方法的参数声明为final。这样做的话，当你无意中修改了参数的值，编译时会得到警告，并且编译生成的字节码也会得到优化。

推荐

  
  
private boolean isEligible(final int age){ ... } 

6.用大写命名public static final类型成员变量：

总是使用大写命名用public static final类型变量。这样可以让你很容易区分常量和本地变量。

不推荐

  
  
public static final String testAccountNo = "12345678"; 

推荐

  
  
public static final String TEST_ACCOUNT_NO = "12345678"; 

7.把多个if语句合并成一个：

下面的代码

  
  
if(age > 18){  
  if( voted == false){  
    // eligible to vote.  
  }  
} 

可以使用一个if语句改写为：

  
  
if(age > 18 && !voted){  
  // eligible to vote  
} 

8.别忘了给switch添加default语句：

总是给switch添加一个default语句。

9.避免 重复 使用同样的字符串，创建一个常量吧：

如果你需要在多个地方使用同一个字符串，那就创建一个字符串常量来使用吧。

下面的代码：

  
  
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编程中写出好代码的建议

最近在做应用的性能优化，在review代码的过程中积累了一些规则和经验。做到这些规则的目的很简单，就是写出“优美”的代码来。

1、注释尽可能全面

对于方法的注释应该包含详细的入参和结果说明，有异常抛出的情况也要详细叙述；类的注释应该包含类的功能说明、作者和修改者。

2、多次使用的相同变量最好归纳成常量

多处使用的相同值的变量应该尽量归纳为一个常量，方便日后的维护。

3、尽量少的在循环中执行方法调用

尽量在循环中少做一些可避免的方法调用，这样可以节省方法栈的创建。例如：

  
  
for(int i=0;i System.out.println(i);  
}  

可以修改为：

  
  
for(int i=0,size=list.size();i System.out.println(i);  
}  

4、常量的定义可以放到接口中

在Java中，接口里只允许存在常量，因此把常量放到接口中声明就可以省去public static final这几个关键词。

5、ArrayList和LinkedList的选择

这个问题比较常见。通常程序员最好能够对list的使用场景做出评估，然后根据特性作出选择。ArrayList底层是使用数组实现的，因此随机读取数据会比LinkedList快很多，而LinkedList是使用链表实现的，新增和删除数据的速度比ArrayList快不少。

6、String，StringBuffer和StringBuilder

这个问题也比较常见。在进行字符串拼接处理的时候，String通常会产生多个对象，而且将多个值缓存到常量池中。例如：

  
  
String a=”a”;  
String b=”b”;  
a=a+b;  

这种情况下jvm会产生”a”,”b”,”ab”三个对象。而且字符串拼接的性能也很低。因此通常需要做字符串处理的时候尽量采用StringBuffer和StringBuilder来。

7、包装类和基本类型的选择

在代码中，如果可以使用基本数据类型来做局部变量类型的话尽量使用基本数据类型，因为基本类型的变量是存放在栈中的，包装类的变量是在堆中，栈的操作速度比堆快很多。

8、尽早的将不再使用的变量引用赋给null

这样做可以帮助jvm更快的进行内存回收。当然很多人其实对这种做法并不感冒。

9、在finally块中对资源进行释放

典型的场景是使用io流的时候，不论是否出现异常最后都应该在finally中对流进行关闭。

10、在HashMap中使用一个Object作为key时要注意如何区分Object是否相同

在jdk的HashMap实现中，判断两个Object类型的key是否相同的标准是hashcode是否相同和equals方法的返回值。如果业务上需要对两个数据相同的内存对象当作不同的key存储到hashmap中就要对hashcode和equals方法进行覆盖。

原文链接：http://hp.dewen.org/?p=1397