不好的做法
在定义并实现一个方法时,如果返回值是一个引用类型的对象,那么这个对象的值是有可能为null的,而方法的调用者在调用的时候就需要考虑返回值为null的情况,进行单独处理。这样就常常会出现类似于如下的代码:
public static void main(String[] args) {
List<String> stringList = getList();
if(stringList != null){
System.out.println("Size of stringList :" + stringList.size());
}else{
System.out.println("Size of stringList :" + 0);
}
}
public static List<String> getList() {
return null;
}
可以看到对于方法的调用者而言,需要考虑返回值为null的情况,这样的设计不利于代码的整洁。
方法应尽量返回空集合或空对象,而非null
比较好的做法是,对于方法的定义和实现者而言,尽量保证方法的返回值不返回null值,而是返回相应的“空对象”来代替null值。比如下面的代码:
static List<String> getList2(){
List<String> stringList = null;
if(stringList == null){
return Collections.EMPTY_LIST;
}
return stringList;
}
static List<String> getList3(){
List<String> stringList = null;
return Optional.fromNullable(stringList).or(Collections.EMPTY_LIST);
}
public static void main(String[] args) {
List<String> stringList2 = getList2();
System.out.println("Size of stringList2 :" + stringList2.size());
List<String> stringList3 = getList3();
System.out.println("Size of stringList3 :" + stringList3.size());
}
这样的实现有两种方式:
- 如
getList2()
所示:直接判断返回值是否==null,如果是,则返回一个空集合。这样的做法很直观,但不推荐。在程序中应尽量避免对null值的直接判断。 - 如
getList3()
所示:通过使用Guava的Optional工具来对返回的对象进行处理。推荐这种做法
同样道理,对于返回值是String类型时,如果遇到null值,可以返回空串("")代替之。当然,同样可以使用通用的Guava库来返回默认值(String也是对象),也可以直接使用StringUtils来返回默认的字符串。如下面的例子:
public static void main(String[] args) {
String string1 = getString1();
System.out.println("string1 :" + string1);
}
static String getString1(){
String string = null;
return Optional.fromNullable(string).or(StringUtils.EMPTY);
// or ...
// return StringUtils.defaultString(string);
}
对于需要区分null值的和空值的方法,将返回值的类型用Optional包装,而非直接返回
对于有些场景,方法的调用者有可能需要区分null值和空值来进行不同的行为,那么也不要直接返回,而是通过Guava的Optional工具进行包装。如下面的例子所示:
public static void main(String[] args) {
List<String> stringList1 = getList1().or(Collections.EMPTY_LIST);
System.out.println("Size of stringList1 :" + stringList1.size());
}
static Optional<List<String>> getList1(){
// 从数据库里取到null值
List<String> stringList = null;
return Optional.fromNullable(stringList);
}
这样做的好处是,方法的调用者拿到的是返回值包装后的对象,它需要被解包后才能使用。这样可以迫使方法的调用者考虑对象缺失-absent(null值)的情况,而不是忘记处理后,在运行时再抛出NullPointerException。
其它好的实践
- 在对String进行操作的时候,尽量使用一些第三方的库(如:Apache commons-lang3)。因为这些库方法的实现中,处理了null值的情况。
- 在对字符串进行
String.equals()
方法进行两个字符串判等的时候,将已知的字符串放在前面,将未知的变量作为方法的参数,放在后面。
如下面的代码会抛出NullPointerException:
String knownStr = "123";
String unknownStr = null;
if(unknownStr.equals(knownStr)){
// ... do something
}
如果将knownStr放在前面,就可以避免这个异常:
String knownStr = "123";
String unknownStr = null;
if(knownStr.equals(unknownStr)){
// ... do something
}
- 在定义POJO的时候,将所有的域都初始化合理的默认值。
- 如果对于一个对象obj,要取其对应的字符串的值,那么尽量使用
String.valueOf(obj)
,而非obj.toString()
。
public static String valueOf(Object obj) {
return (obj == null) ? "null" : obj.toString();
}
源码可见,String.valueOf(obj)
进行了null值的判断,对于null值返回字符串"null"。这样虽然可以避免异常,但是未必符合业务需要。因此,推荐使用StringUtils的defaultString()
方法来处理,其专门用于处理String为null的情况的缺省值:
public static String defaultString(final String str) {
return str == null ? EMPTY : str;
}
public static String defaultString(final String str, final String defaultStr) {
return str == null ? defaultStr : str;
}