【Java后台开发规范】--- Null值处理

前言

做Java开发的，大多数可能都有看过阿里的Java后台开发手册，里面有关于Java后台开发规范的一些内容，基本覆盖了一些通用、普适的规范，但大多数都讲的比较简洁，本文主要会用更多的案例来对一些规范进行解释，以及结合自己的经验做补充！

其他类型的规范

【Java后台开发规范】— 不简单的命名
【Java后台开发规范】— 日志的输出
【Java后台开发规范】— 线程与并发
【Java后台开发规范】— 长函数、长参数
【Java后台开发规范】— 设计原则
【Java后台开发规范】— 圈复杂度
【Java后台开发规范】— 异常的处理

常见的Null值处理

字符串

很多工具包中都有对字符串空值的处理。

// guava包
if(Strings.isNullOrEmpty(str)){
    
}

// apache.commons.lang包，空格也算空
if(StringUtils.isBlank(str)){
    
}

// apache.commons.lang，空格不算空
if(StringUtils.isEmpty(str)){
    
}

guava中还有对Null与Empty的转换

// null转换为""
Strings.nullToEmpty(str);
// ""转换为null
Strings.emptyToNull(str);

有些方法的默认对null值得处理也要注意，比如String.valueOf(null)默认就会返回"null"字符串。

String.valueOf(null); // 结果 "null"

Objects

JDK1.7开始提供的Objects类，处理Object中的一些方法，尤其是对于Null值得处理

equals方法不用再担心null值得问题了。

// 可能会遇到java.lang.NullPointerException异常
if(str.equals("abc")){
    
}
// 完全不用担心
Objects.equals(str,"abc");

// 已经对空值做了处理
public static boolean equals(Object a, Object b) {
    return (a == b) || (a != null && a.equals(b));
}

hashCode方法也一样

String str = null;
// NullPointerException异常
str.hashCode();
// 返回0
int i = Objects.hashCode(str);

public static int hashCode(Object o) {
    return o != null ? o.hashCode() : 0;
}

toString方法

A a = null;
// NullPointerException异常
a.toString();
// 返回"null"
Objects.toString(a);
// 还可以指定替代值，返回"abc"
Objects.toString(a, "abc");

各种null值得检查、处理

Object obj = null;
// NullPointerException异常
Objects.requireNonNull(obj);
// NullPointerException异常，异常message可以自定义
Objects.requireNonNull(obj,"obj is null");
// 返回true
System.out.println(Objects.isNull(obj));
// 返回false
System.out.println(Objects.nonNull(obj));

集合的处理

Map

每次从Map中根据Key值获取Value值时，总要注意Null值的情况。

一种简单的通过Map来计数的功能

Map<String, Integer> map = new HashMap<>();
if (map.containsKey("a")) {
    int i = map.get("a");
    map.put("a", i + 1);
} else {
    map.put("a", 1);
}

使用getOrDefault替换后，一行代码，更加简洁。

map.put("a", map.getOrDefault("a", 0) + 1);

在与Json格式做转换时

Map<String, Object> map = new HashMap<>();
map.put("a",null);
String jsonString = JSON.toJSONString(map, SerializerFeature.WRITE_MAP_NULL_FEATURES, SerializerFeature.QuoteFieldNames);
System.out.println(JSON.toJSONString(map));// 返回：{}
System.out.println(jsonString);// 返回：{"a":null}

返回空集合

List<User> users = getUsers();
if(users != null){
    for(User user : users){
        // ...
    }
}

如果返回对象是一个集合，那么不要返回null，请使用空集合来替代

Collections.emptyList();
Collections.emptyMap();
// 现在可以放心使用了
List<User> users = getUsers();
for(User user : users){
    // ...
}

避免传递Null值

传递Null值和返回Null值一样，都需要做额外的处理，很容易导致NEP异常的产生。

// 用户null做业务逻辑区分，那么代码就会变成下面这样，不但增加了复杂度，如果入参在多处地方使用，还很容易遗漏
public void test(User user, Address address){
    
	if(user == null){
        // ...
    }else{
        
    }
    
    if(address == null){
        // ...
    }else{
        
    }
}

// 如果方法不支持null值，还需要做额外的校验处理，并产生异常
public void test(User user, Address address){
    assert user != null : "user should not be null";
    assert address != null : "user should not be null";
}

Optional

Optional是一个容器对象，可以存储各种类型的值，包括Null，Optional针对对象为Null值的情况做了很多处理，一起来看看吧！

先看看构建Optional对象的方法

Optional<String> optional = Optional.of("abc");
System.out.println(optional);// 输出：Optional[abc]

of方法构建一个泛型Optional对象

public static <T> Optional<T> of(T value) {
    return new Optional<>(value);
}

如果对象为Null，of方法会抛出异常

public static <T> Optional<T> of(T value) {
    return new Optional<>(value);
}

private Optional(T value) {
    this.value = Objects.requireNonNull(value);
}

public static <T> T requireNonNull(T obj) {
    if (obj == null)
        throw new NullPointerException();
    return obj;
}

当然Optional也支持通过ofNullable方法构建Null对象

Optional<String> optional = Optional.ofNullable(null);
System.out.println(optional);// 输出：Optional.empty

拿到对象

然过get方法可以得到泛型对象

Optional<String> optional = Optional.of("abc");
System.out.println(optional.get()); // 输出 abc

如果对象为Null，get方法会抛出异常

get方法

public T get() {
    if (value == null) {
        throw new NoSuchElementException("No value present");
    }
    return value;
}

Null值判断

通过isPresent方法判断对象是否为Null

public boolean isPresent() {
    return value != null;
}

System.out.println(Optional.ofNullable("abc").isPresent()); // 输出：true
System.out.println(Optional.ofNullable(null).isPresent()); // 输出：false
// ifPresent可以接收Consumer<? super T>类型
Optional.of("abc").ifPresent(sb -> System.out.println(sb.toUpperCase()));// 输出：ABC

针对Null值处理的方法

orElse方法，提供了对Null值对象的处理

System.out.println(Optional.ofNullable(null).orElse("abc"));// 输出：abc
System.out.println(Optional.empty().orElse("abc"));/// 输出：abc

orElseGet方法，支持传入Supplier<? extends T>类型

System.out.println(Optional.ofNullable(null).orElseGet(() -> "null"));// 输出："null"

或者使用orElseThrow方法抛出异常

Optional.empty().orElseThrow(() -> new Exception("test exception"));

JDK14改进

对于下面这段代码，如果a为null，则会抛出NEP异常，并且通过异常堆栈信息，能够准确的定位的具体的代码行数，以此来确定是a对象为null导致的NEP异常。

a.i = 0;

但假设是下面这段逻辑呢？如果异常堆栈信息只能精确到具体的行数，那就无法确定到底是a、b、c中哪一个对象为null导致的异常。

a.b.c = 0;

类似的场景还有很多

a.i = b.i;
a().b().i = 0;
arr[a][b] = 0;

JDK14对此做了改进，可以明确的输出导致NEP异常的对象，就像如下这样。

Exception in thread "main" java.lang.NullPointerException: 
        Cannot read field "c" because "a.b" is null
    at Prog.main(Prog.java:5)