不能用"=="比较两个字符串内容相等。java
对list作foreach循环时,循环代码中不能修改list的结构。数据库
日志和实际状况不一致;捕获异常后没有在日志中记录异常栈。数组
魔鬼数字。app
空指针异常。性能
数组下标越界。this
将字符串转换为数字时没有捕获NumberFormatException异常。编码
对文件、IO、数据库等资源进行操做后没有及时、正确进行释放。spa
循环体编码时不考虑性能,循环体中包含不须要的重复逻辑。debug
数据类没有重载toString()方法。指针
两个字符串在比较内容是否相等的时候,若是使用"==",当两个字符串不是指向内存中同一地址,那么即便这两个字符串内容同样,可是用"=="比较出来的结果也是false。因此两个字符串在比较内容是否相等的时候必定要使用"equals"方法。
下面就是一个字符串比较的例子:
public class Test { public static void main(String[] args) { String a = new String("a"); String a2 = "a"; if(a == a2) { System.out.println("a == a2 return true."); } else { System.out.println("a == a2 return false."); } if(a.equals(a2)) { System.out.println("a.equals(a2) return true."); } else { System.out.println("a.equals(a2) return false."); } } }
最终输出的结果为:
a == a2 return false.
a.equals(a2) return true.
在jdk1.5版以上的foreach循环写法中,不能在循环代码中对正在循环的list的结构进行修改,即对list作add、remove等操做,若是作了这些操做,必须当即退出循环,不然会抛出异常。
public class Test { public static void main(String[] args) { List<Person> list = new ArrayList<Person>(); Person p1 = new Person("张三", 23); Person p2 = new Person("李四", 26); Person p3 = new Person("王五", 34); Person p4 = new Person("刘二", 15); Person p5 = new Person("朱六", 40); list.add(p1); list.add(p2); list.add(p3); list.add(p4); list.add(p5); for(Person p : list) { if("王五".equals(p.getName())) { list.remove(p); // 不能在此时删除对象。 } else if("李四".equals(p.getName())) { list.remove(p); // 不能在此时删除对象。 } } System.out.println(list.size()); } } class Person { private String name; private int age; public Person(String name, int age) { this.name = name; this.age = age; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } }
解决上面代码红色部分的问题,能够经过循环取出对象,而后再循环结束后再进行删除。
List<Person> list = new ArrayList<Person>(); Person p1 = new Person(new String("张三"), 23); Person p2 = new Person(new String("李四"), 26); Person p3 = new Person(new String("王五"), 34); Person p4 = new Person(new String("刘二"), 15); Person p5 = new Person(new String("朱六"), 40); list.add(p1); list.add(p2); list.add(p3); list.add(p4); list.add(p5); Person wangwu = null; Person lisi = null; for(Person p : list) { if("王五".equals(p.getName())) { wangwu = p; } else if("李四".equals(p.getName())) { lisi = p; } } list.remove(wangwu); list.remove(lisi);
日志是定位问题时最重要的依据,业务流程中缺乏必要的日志会给定位问题带来不少麻烦,甚至可能形成问题彻底没法定位。
异常产生后,必须在日志中以ERROR或以上级别记录异常栈,不然会致使异常栈丢失,没法确认异常产生的位置。并不须要在每次捕获异常时都记录异常日志,这样可能致使异常被屡次重复记录,影响问题的定位。但异常发生后其异常栈必须至少被记录一次。
和注释同样,日志也不是越多越好。无用的冗余日志不但不能帮助定位问题,还会干扰问题的定位。而错误的日志更是会误导问题,必须杜绝。
下面的例子虽然打印了不少日志,但基本上都是无用的日志,难以帮助定位问题。甚至还有错误的日志会干扰问题的定位:
public void saveProduct1(ProductServiceStruct product) { log.debug("enter method: addProduct()"); log.debug("check product status"); if (product.getProduct().getProductStatus() != ProductFieldEnum.ProductStatus.RELEASE) { throw new PMSException(PMSErrorCode.Product.ADD_ERROR); } log.debug("check tariff"); BooleanResult result = checkTariff(product.getTariffs()); if (!result.getResult()) { throw new PMSException(PMSErrorCode.Product.ADD_ERROR); } log.debug("before add product"); ProductService prodSrv = (ProductService) ServiceLocator.findService(ProductService.class); try { prodSrv.addProduct(product); } catch (BMEException e) { // 未记录异常栈,没法定位问题根源 } log.debug("after add product"); log.debug("exit method: updateProduct()"); // 错误的日志 }
而下面的例子日志打印的很少,但都是关键信息,能够很好的帮助定位问题:
public void saveProduct2(ProductServiceStruct product) { if (product.getProduct().getProductStatus() != ProductFieldEnum.ProductStatus.RELEASE) { log.error( "product status " + product.getProduct().getProductStatus() + " error, expect " + ProductFieldEnum.ProductStatus.RELEASE); throw new PMSException(PMSErrorCode.Product.ADD_ERROR); } BooleanResult result = checkTariff(product.getTariffs()); if (!result.getResult()) { log.error( "check product tariff error " + result.getResultCode() + ": " + result.getResultDesc()); throw new PMSException(PMSErrorCode.Product.ADD_ERROR); } ProductService prodSrv = (ProductService) ServiceLocator.findService(ProductService.class); try { prodSrv.addProduct(product); } catch (BMEException e) { log.error("add product error", e); throw new PMSException(PMSErrorCode.Product.ADD_ERROR, e); } }
在代码中使用魔鬼数字(没有具体含义的数字、字符串等)将会致使代码难以理解,应该将数字定义为名称有意义的常量。
将数字定义为常量的最终目的是为了使代码更容易理解,因此并非只要将数字定义为常量就不是魔鬼数字了。若是常量的名称没有意义,没法帮助理解代码,一样是一种魔鬼数字。
在个别特殊状况下,将数字定义为常量反而会致使代码更难以理解,此时就不该该强求将数字定义为常量。
public void addProduct(ProductServiceStruct product) { // 魔鬼数字,没法理解3具体表明产品的什么状态 if (product.getProduct().getProductStatus() != 3) { throw new PMSException(PMSErrorCode.Product.ADD_ERROR); } BooleanResult result = checkTariff(product.getTariffs()); if (!result.getResult()) { throw new PMSException(PMSErrorCode.Product.ADD_ERROR); } }
修改后
/** *产品未激活状态 */ private static final int UNACTIVATED = 0; /** *产品已激活状态 */ private static final int ACTIVATED = 1; public void addProduct2(ProductServiceStruct product) { if (product.getProduct().getProductStatus() != ACTIVATED) { throw new PMSException(PMSErrorCode.Product.ADD_ERROR); } BooleanResult result = checkTariff(product.getTariffs()); if (!result.getResult()) { throw new PMSException(PMSErrorCode.Product.ADD_ERROR); } }
空指针异常是编码过程当中最多见的异常,在使用一个对象的时候,若是对象可能为空,而且使用次对象可能会形成空指针异常,那么须要先判断对象是否为空,再使用这个对象。
在进行常量和变量的相等判断时,建议将常量定义为Java对象封装类型(如将int类型的常量定义为Integer类型),这样在比较时能够将常量放在左边,调用equals方法进行比较,能够省去没必要要的判空。
public class NullPointer { static final Integer RESULT_CODE_OK = 0; static final Result RESULT_OK = new Result(); public void printResult(Integer resultCode) { Result result = getResult(resultCode); // result可能为null,形成空指针异常 if (result.isValid()) { print(result); } } public Result getResult(Integer resultCode) { // 即便resultCode为null,仍然能够正确执行,减小额外的判空语句 if (RESULT_CODE_OK.equals(resultCode)) { return RESULT_OK; } return null; } public void print(Result result) { ... } }
访问数组、List等容器内的元素时,必须首先检查下标是否越界,杜绝下标越界异常的发生。
public class ArrayOver { public void checkArray(String name) { // 获取一个数组对象 String[] cIds = ContentService.queryByName(name); if (null != cIds) { // 只是考虑到cids有可能为null的状况,可是cids彻底有多是个0长度的数组,所以cIds[0]有可能数组下标越界 String cid = cIds[0]; cid.toCharArray(); } } }
调用Java方法将字符串转换为数字时,若是字符串的格式非法,会抛出运行时异常NumberFormatException。
错误例子:
public Integer getInteger1(String number) { // 若是number格式非法,会抛出NumberFormatException return Integer.valueOf(number); }
正确的处理方法以下:
public Integer getInteger2(String number) { try { return Integer.valueOf(number); } catch (NumberFormatException e) { ... //记录日志异常信息 return null; } }
注意:在捕获异常后必定要记录日志。
在使用文件、IO流、数据库链接等不会自动释放的资源时,应该在使用完毕后立刻将其关闭。关闭资源的代码应该在try...catch...finally的finally内执行,不然可能形成资源没法释放。
错误案例以下:
public void writeProduct1(ProductServiceStruct product) { try { FileWriter fileWriter = new FileWriter(""); fileWriter.append(product.toString()); // 若是append()抛出异常,close()方法就不会执行,形成IO流长时间没法释放 fileWriter.close(); } catch (IOException e) { ... } }
关闭IO流的正确方法以下:
public void writeProduct2(ProductServiceStruct product) { FileWriter fileWriter = null; try { fileWriter = new FileWriter(""); fileWriter.append(product.toString()); } catch (IOException e) { ... // 记录日志 } finally { // 无论前面是否发生异常,finally中的代码必定会执行 if (fileWriter != null) { try { fileWriter.close(); } catch (IOException e) { ... // 记录日志 } } } }
注意:在捕获异常后必定要记录日志。
循环体是软件中最容易形成性能问题的地方,因此在进行循环体编码时务必考虑性能问题。
在循环体内重复使用且不会变化的资源(如变量、文件对象、数据库链接等),应该在循环体开始前构造并初始化,避免在循环体内重复和构造初始化形成CPU资源的浪费。
除非业务场景须要,避免在循环体内构造try...catch块,由于每次进入、退出try...catch块都会消耗必定的CPU资源,将try...catch块放在循环体以外能够节省大量的执行时间。
public void addProducts(List<ProductServiceStruct> prodList) { for (ProductServiceStruct product : prodList) { // prodSrv在每次循环时都会从新获取,形成没必要要的资源消耗 ProductService prodSrv = (ProductService) ServiceLocator.findService(ProductService.class); // 避免在循环体内try...catch,放在循环体以外能够节省执行时间 try { prodSrv.addProduct(product); } catch (BMEException e) { ... //记录日志 } } }
在循环体中遇到字符串相加,必定要使用StringBuffer这个类。
数据类若是没有重载toString()方法,在记录日志的时候会没法记录数据对象的属性值,给定位问题带来困难。
public class MdspProductExt { private String key; private String value; public String getKey() { return key; } public void setKey(String key) { this.key = key; } public String getValue() { return value; } public void setValue(String value) { this.value = value; } } class BusinessProcess { private DebugLog log = LogFactory.getDebugLog(BusinessProcess.class); public void doBusiness(MdspProductExt prodExt) { try { ... } catch (PMSException e) { // MdspProductExt未重载toString()方法,日志中没法记录对象内属性的值,只能记录对象地址 log.error("error while process prodExt " + prodExt); } } }