【优雅代码】03-optional杜绝空指针异常

【优雅代码】03-optional杜绝空指针异常

欢迎关注b站账号/公众号【六边形战士夏宁】，一个要把各项指标拉满的男人。该文章已在github目录收录。

屏幕前的大帅比和大漂亮如果有帮助到你的话请顺手点个赞、加个收藏这对我真的很重要。别下次一定了，都不关注上哪下次一定。

• 可直接运行的完整代码
• 视频讲解

1.背景介绍

在日常开发中总会遇到NPE问题，但是java提供了optional，可以让我们流畅写代码的同时避免NPE

2.建立Child、Parent、GrandParent的层级

建立如下结构的类GrandParent->Parent->List

• Child

@Data
@AllArgsConstructor
@ToString(callSuper = true)
@NoArgsConstructor
@Accessors(chain = true)
public class Child {
    private List<String> list;
    private String str;
}

• GrandParent

@Data
@AllArgsConstructor
@ToString(callSuper = true)
@NoArgsConstructor
@Accessors(chain = true)
public class GrandParent {
    private Parent parent;
}

• Parent

@Data
@AllArgsConstructor
@ToString(callSuper = true)
@NoArgsConstructor
@Accessors(chain = true)
public class Parent {
    private Child child;
}

• 测试类

GrandParent opt1 = null;
// 获取最底层数据。此时最顶层是null，不会报NPE
String opt1Str = Optional.ofNullable(opt1).map(o1 -> o1.getParent())
                .map(o2 -> o2.getChild()).map(l -> l.getStr()).orElse(null);
System.out.println(String.format("%s:%s", "opt1Object", opt1Str));

// 获取最底层数据。此时第二层是null，不会报NPE
GrandParent opt2 = null;
List<String> opt2list = Optional.ofNullable(opt2).map(o1 -> o1.getParent())
                .map(o2 -> o2.getChild()).map(l -> l.getList()).orElse(null);
System.out.println(String.format("%s:%s", "opt2list", opt2list));

// 获取最底层数据。此时所有数据都是全的，无论是list还是string都没有问题
GrandParent opt3 = new GrandParent().setParent(new Parent().setChild(new Child().setStr("ssss").setList(Stream.of("1", "2").collect(Collectors.toList()))));
List<String> opt3list = Optional.ofNullable(opt3).map(o1 -> o1.getParent())
                .map(o2 -> o2.getChild()).map(l -> l.getList()).orElse(null);
String opt3Str = Optional.ofNullable(opt3).map(o1 -> o1.getParent())
                .map(o2 -> o2.getChild()).map(l -> l.getStr()).orElse(null);
System.out.println(String.format("%s:%s", "opt3list", opt3list));
System.out.println(String.format("%s:%s", "opt3Str", opt3Str));

• 输出结果

opt1Object:null
opt2list:null
opt3list:[1, 2]
opt3Str:ssss

可以发现嵌套类无论是string还是list，中间任何一个类为null都会直接返回null，而不用去多层嵌套if这种很蠢的做法

3.非常规复杂optional用法

当然平常时候总会遇到一些奇奇怪怪的结果，例如查询数据库会返回List<Map<String, String>>这样的结构，也是可以用Optinoal做的

// 获取list嵌map并随机返回一个key，此时list为null的获取不会NPE
List<Map<String, String>> listR = null;
String result = Optional.ofNullable(listR).flatMap(l -> l.stream().findAny())
        .flatMap(l -> l.keySet().stream().findAny()).orElse(null);
System.out.println(result);

// 获取list嵌map并随机返回一个key，此时list无元素的获取不会NPE
listR = new ArrayList<Map<String, String>>();
result = Optional.ofNullable(listR).flatMap(l -> l.stream().findAny())
        .flatMap(l -> l.keySet().stream().findAny()).orElse(null);
System.out.println(result);

// 获取list嵌map并随机返回一个key，此时有1个HashMap，但HashMap无元素的获取不会NPE
listR = new ArrayList<Map<String, String>>() {{
    add(new HashMap<String, String>());
}};
result = Optional.ofNullable(listR).flatMap(l -> l.stream().findAny())
        .flatMap(l -> l.keySet().stream().findAny()).orElse(null);
System.out.println(result);

// 获取list嵌map并随机返回一个key，此时所有结构完全
listR = new ArrayList<Map<String, String>>() {{
    add(new HashMap<String, String>() {{
        put("C", "0");
    }});
}};
result = Optional.ofNullable(listR).flatMap(l -> l.stream().findAny())
        .flatMap(l -> l.keySet().stream().findAny()).orElse(null);
System.out.println(result);

输出结果如下：

null
null
null
C

4.其它优秀杜绝空指针异常的优秀方法

首先是lombok的@NonNull，这个可以作用于方法参数上，如果传入空则直接抛异常，并在日志精准打印出异常位置及情况，非常适合校验参数，增加代码简洁性。非空指针的校验方式可以看优雅和前端交互

当然刚才写的类还是返回了null，但是没关系，可以用以下工具类，在各种情况下都可以抛出自定义异常或直接return出去

 // 常规对象的判空不会NPE
System.out.println(String.format("%s:%s", "StringUtils", StringUtils.isBlank(null)));
System.out.println(String.format("%s:%s", "defaultIfNull", ObjectUtils.defaultIfNull(null, "defaultIfNull")));
List list = null;
Map map = null;
Set set = null;
String[] arr = null;
// 常规collection的判空不会NPE
System.out.println(String.format("%s:%s", "list", CollectionUtils.isEmpty(list)));
System.out.println(String.format("%s:%s", "map", CollectionUtils.isEmpty(map)));
System.out.println(String.format("%s:%s", "set", CollectionUtils.isEmpty(set)));
System.out.println(String.format("%s:%s", "arr", ArrayUtils.isEmpty(arr)));

输出结果如下：

StringUtils:true
defaultIfNull:defaultIfNull
list:true
map:true
set:true
arr:true