文档介绍：Java十大低级错误
为了规范大家的编程行为,借鉴前人的编程经验,避免低级错误的不断发生,特发布 Java十大低级错误,供所有Java开发人员学****br/>1、方法和变量命名随意而不规范,没有类注释、方法注释或注释不规范,代码修改后,不同步修改注释,导致注释与代码不符。
2、数据类不重载toString()方法(说明:编程规范要求“所有的数据类必须重载toString() 方法,返回该类有意义的内容”)。
3、对方法的调用不进行空指针判断而造成空指针异常。
4、数据库操作、IO操作的资源没有及时释放,数据库结果集和连接释放顺序不正确,或者使用没有必要的预处理。
5、循环体内包含了大量没有必要在循环中处理的语句,循环体内循环获取数据库连接,循环体内进行不必要的try-catch操作。(说明:编程规范中建议“不要在循环体内调用同步方法和使用 try-catch 块”)
6、嵌套使用try-catch,或者try-catch后面没有必要的finally操作(说明:数据库操作、IO操作等需要使用结束close()的对象必须在try -catch-finally 的finally中close())。
7、不对数组下标作范围校验。
8、equals操作时没有将常量放在equals操作符的左边(说明:字符串变量与常量比较时,先写常量,这样可以避免空指针异常)。
9、字符串转化为数字时没有做异常处理。
10、没有在异常分支记录日志导致问题定位困难。
代码案例(说明:所有样例都是错误的代码):
1、方法和变量命名随意而不规范,没有类注释、方法注释或注释不规范,代码修改后,不同步修改注释,导致注释与代码不符。
public class MethodName
{
//错误:没有类的注释
//错误:方法的注释不规范、方法名不规范
public void a( int i )
{
//错误:变量名称太短
String b = "";
//错误:变量名称太长,超过40个字符
String longVariableLongVariableLongVariableLongVariable = "";
}
/**
* <一句话功能简述>方法命名约定:应以小写字母开头、同时命名不应含有下划线字符。
* <功能详细描述>
* ***@param i
* ***@see [类、类#方法、类#成员]
*/
public void Check_Method( int i )
{
// 错误:方法名称不规范
//错误:变量名称不规范
String b = "";
}
/**
* <一句话功能简述>变量、方法名、类名、接口名避免出现美元字符$。
* <功能详细描述>
* ***@param i
* ***@see [类、类#方法、类#成员]
*/
public void Fo$o ()
{
// 错误:方法名称不规范
}
/**
* <一句话功能简述>注意hashCode方法大小写。此规则用于推测作者可能是要实现hashCode方法,但大小写错了。
* <功能详细描述>
* ***@return
* ***@see [类、类#方法、类#成员]
*/
public int hashcode()
{
// 错误:方法名称不规范
int temp = 0;
// oops, this probably was supposed to be hashCode
return temp;
}
/**
*
* ***@param o 只有参数类型和返回值类型不一致,方法名equals完全相同(包括大小写也相同),推测可能是想实现equals方法。
* ***@return
*/
public int equals(Object o)
{
// 错误:方法名称不规范
// oops, this probably was supposed to be boolean equals
int temp = 0;
return temp;
}
/**
* <一句话功能简述>只有参数类型和返回值类型不一致,方法名equals完全相同(包括大小写也相同),推测可能是想实现equals方法。
* <功能详细描述>
* ***@param s
* ***@return
* ***@see [类、类#方法、类#成员]
*/
public boolean equals(String s)
{
// 错误:方法名称不规范
// oops, this probably was supposed to be e