阿里巴巴代码规范

【推荐】方法的返回值可以为 null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回 null 值。调用方需要进行 null 判断防止 NPE 问题。
说明：本手册明确防止 NPE 是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败、序列化失败、运行时异常等场景返回 null 的情况。

【推荐】防止 NPE，是程序员的基本修养，注意 NPE 产生的场景

1）返回类型为基本数据类型，return 包装数据类型的对象时，自动拆箱有可能产生 NPE。反例：public int f() { return Integer 对象}，如果为 null，
2）数据库的查询结果可能为 null。
3）集合里的元素即使 isNotEmpty，取出的数据元素也可能为 null。
4）远程调用返回对象时，一律要求进行空指针判断，防止 NPE。
5）对于 Session 中获取的数据，建议 NPE 检查，避免空指针。
6）级联调用 obj.getA().getB().getC()；一连串调用，易产生 NPE。

正例：使用 JDK8 的 Optional 类来防止 NPE 问题。

NPE(Null Pointer Exception)

一直是我们最头疼的问题，也是最容易忽视的地方，先总结几条不同场景的解决方案，望后续补充。
1.RPC调用某个规定好的接口，如获取某一范围内查询结果，返回结果我们约定好是List。
若没有结果，我们是返回null还是Collections.emptyList() ？虽然NPE问题大部分是调用者问题，但是我们可以从源头解决，比如我们不允许null值，必须返回对应类型（当然实际业务可能不一样）。

public List<String> getLists(Map<String, Object> condition) {
    List<String> records = getRecords(condition);
    if (records != null && records.size() > 0) {
      return records;
    }
    return Collections.emptyList();
  }

2.foreach遍历循环时候要做集合null值判断，以前我们这么写

if (records != null && records.size() > 0) {
    for (String record : records) {
        //some codes
    }
}
//next step

我们可以直接使用org.springframework.util.CollectionUtils;

if (!CollectionUtils.isEmpty(records)) {
    for (String record : records) {
        //some codes
    }
}
//next step

3.与2对应的jdk8提供了一些“工具”类java.util.Objects对对象进行非空判断：

if (Objects.nonNull(str)) { // 等价于 str != null
    // some codes
}
// next step

if (Objects.equals(a, b)) { // 等价于 (a == b) || (a != null && a.equals(b));
    // some codes
}
// next step

1 2	// 等价于 String str = a == null ? null : a.toString(); String str = Objects.toString(a, null);

4.还有一些pojo里面的类型尽量使用包装类（之前《java中包装类与基本类型的运用对比》提到过），这会导致null值出现，根据不同场景进行处理，但是不建议在pojo里面处理，要保证pojo的完整干净。

// 反例：
public void setCreateTime(Date createTime) {
    if (Objects.isNull(createTime)) {
        this.createTime = new Date();
    } else {
        this.createTime = createTime;
    }
}

5.spring注解@NonNull @Nullable
如果可以传入NULL值，则标记为@Nullable，如果不可以，则标注为@NonNull。如果违反了这些协定，IntelliJ IDEA 将出现警告。

private List<Person> query(@NonNull PersonQueryBean queryBean) {
     // to do some codes...
    Sort sort = queryBean.getSort();
    ....
}

...

00:00

java NPE问题

防止 NPE，是程序员的基本修养。

阿里巴巴代码规范

NPE(Null Pointer Exception)

...

FEATURED TAGS

FRIENDS