代碼優(yōu)雅之道——消滅空指針，Optional來幫忙！
一、前言
我們在開發(fā)中最常見的異常就是NullPointerException，防不勝防啊，相信大家肯定被坑過！
這種基本出現(xiàn)在獲取數(shù)據(jù)庫信息中、三方接口，獲取的對象為空，再去get出現(xiàn)！
解決方案當(dāng)然簡單，只需要判斷一下，不是空在去后續(xù)操作，為空返回！
所有在JDK8時出現(xiàn)了專門處理的方案，出來很早了，但是小編慚愧一直沒有去使用它！
最近在看《Java開發(fā)手冊》，一直想著提高自己的代碼水平，文中就指出了使用Optional來解決NullPointerException！
二、Java開發(fā)手冊規(guī)范
小編使用的是2022版的黃山版，29頁寫到：
【推薦】防止 NPE，是程序員的基本修養(yǎng)，注意 NPE 產(chǎn)生的場景：
- 返回類型為基本數(shù)據(jù)類型，return 包裝數(shù)據(jù)類型的對象時，自動拆箱有可能產(chǎn)生 NPE
反例：public int method() { return Integer 對象; }，如果為 null，自動解箱拋 NPE。
- 數(shù)據(jù)庫的查詢結(jié)果可能為 null。
- 集合里的元素即使 isNotEmpty，取出的數(shù)據(jù)元素也可能為 null。
- 遠程調(diào)用返回對象時，一律要求進行空指針判斷，防止 NPE。
- 對于 Session 中獲取的數(shù)據(jù)，建議進行 NPE 檢查，避免空指針。
- 級聯(lián)調(diào)用 obj.getA().getB().getC()；一連串調(diào)用，易產(chǎn)生 NPE。
正例：使用 JDK8 的 Optional 類來防止 NPE 問題。
這份手冊還是不錯的，推薦反復(fù)閱讀，雖然進不去大廠，也要自覺約束自己的代碼風(fēng)格，努力向大廠靠！
大家現(xiàn)在不知道哪里找的可以下載一下：
《Java開發(fā)手冊》:https://github.com/alibaba/p3c
三、Optional常用方法
小編帶大家一起從api文檔中的方法，一個個帶大家慢慢去了解它！
1、empty()
返回一個空的Optional實例：Optional.empty
Optional<Object> empty = Optional.empty();
log.info("empty值：{}",empty);
2、of(T value)
傳入一個參數(shù)，返回一個Optional對象，如果參數(shù)為空，報NullPointerException！
Test testNew = new Test();
Test test = null;
Optional<Test> optionalNew = Optional.of(testNew);
log.info(" optional對象：{}",optionalNew);
Optional<Test> optional = Optional.of(test);
源碼查看：
我們看到參數(shù)為空會報NullPointerException，我們?nèi)シ椒▋?nèi)部看一下就明白了：
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;
}我們發(fā)現(xiàn)是在Objects類中的requireNonNull方法中判斷了是否為空！
這個還會出現(xiàn)NullPointerException，所以我們一般使用下面的這個方法！
3、ofNullable(T value)
參數(shù)傳入一個對象，返回一個Optional對象，如果為空，將返回一個空的Optional對象，就等于Optional.empty。
Test testNew = new Test();
Test test = null;
Optional<Test> optionalNew = Optional.of(testNew);
log.info(" optional對象：{}",optionalNew);
Optional<Test> optionalTest = Optional.ofNullable(test);
log.info(" optional對象中的ofNullable方法返回值：{}",optionalTest);
Optional<Test> optionalTestNew = Optional.ofNullable(testNew);
log.info(" optional對象中的ofNullable方法new返回值：{}",optionalTestNew);
源碼查看：
我們發(fā)現(xiàn)是在方法開始進行非空判斷，再去調(diào)用上面的of(T value)方法。
public static <T> Optional<T> ofNullable(T value) {
return value == null ? empty() : of(value);
}4、get()
如果此Optional中存在值，則返回該值，否則拋出NoSuchElementException。
Test testNew = new Test();
Test test = null;
Optional<Test> optionalNew = Optional.of(testNew);
log.info(" optional對象：{}",optionalNew);
// Optional<Test> optional = Optional.of(test);
Optional<Test> optionalTest = Optional.ofNullable(test);
log.info(" optional對象中的ofNullable方法返回值：{}",optionalTest);
Optional<Test> optionalTestNew = Optional.ofNullable(testNew);
log.info(" optional對象中的ofNullable方法new返回值：{}",optionalTestNew);
Test test2 = optionalTestNew.get();
log.info("原來有值的：經(jīng)過Optional包裝后get后得到原來的值：{}",test2);
Test test1 = optionalTest.get();
log.info("原來沒有值的：經(jīng)過Optional包裝后get后得到原來的值：{}",test1);
源碼查看：
調(diào)用開始會進行值判斷，如果為空則拋異常！
public T get() {
if (value == null) {
throw new NoSuchElementException("No value present");
}
return value;
}5、isPresent()
如果存在值，則返回true，否則返回false。
這里代碼就不加上面的，大家參考上面的獲取一個Optional對象。
boolean present = optionalTestNew.isPresent();
log.info("optionalTestNew調(diào)用是否為空：{}",present);
boolean present1 = optionalTest.isPresent();
log.info("optionalTest調(diào)用是否為空：{}",present1);
源碼查看：
這就比較簡單了!
public boolean isPresent() {
return value != null;
}6、ifPresent(Consumer<? super T> consumer)
如果存在值，則使用該值調(diào)用指定的使用者，否則不執(zhí)行任何操作。
主要的就是入?yún)?shù)一個函數(shù)式接口，有值就會去執(zhí)行，為空則不進行任何操作！
小技巧：
開始對lambda不了解時，可以先按照上面這種方式進行寫，
大家可以看到Idea給置灰了，就是可以優(yōu)化，我們Alt+Enter然后再次Enter就會變成后面的lambda！
optionalTest.ifPresent(new Consumer<Test>() {
@Override
public void accept(Test test) {
log.info("我是調(diào)用ifPresent執(zhí)行后的打印=====");
}
});
optionalTestNew.ifPresent(testInner -> log.info("我是調(diào)用ifPresent執(zhí)行后的打印"));
源碼查看：
還是先判斷不為空才去執(zhí)行函數(shù)式接口！
public void ifPresent(Consumer<? super T> consumer) {
if (value != null)
consumer.accept(value);
}7、filter(Predicate<? super T> predicate)
如果存在值，并且該值符合規(guī)則，則返回描述該值的Optional，否則返回空Optional。
是一個Predicate函數(shù)接口，可以傳入實現(xiàn)了Predicate接口的lambda表達式！ 如果不符合條件就會返回一個Optional.empty。
testNew.setName("蕭炎");
testNew.setAge(33);
Optional<Test> optionalTest1 = optionalTestNew.filter(test1 -> test1.getAge() > 30);
log.info("過濾后的結(jié)果：{}",optionalTest1.get());
源碼查看：
就是判斷一下表達式和值是否為空，然后就是根據(jù)規(guī)則判斷。
public Optional<T> filter(Predicate<? super T> predicate) {
Objects.requireNonNull(predicate);
if (!isPresent())
return this;
else
return predicate.test(value) ? this : empty();
}8、map(Function<? super T,? extends U> mapper)
如果存在值，則將提供的映射函數(shù)應(yīng)用于該值，如果結(jié)果為非空，則返回描述結(jié)果的Optional。否則，返回空的Optional。
也是一個函數(shù)式接口！
Optional<String> stringOptional = optionalTestNew.map(Test::getName);
log.info("map后獲得字段值：{}",stringOptional.get());
源碼查看：
也是進行非空判斷，然后執(zhí)行l(wèi)ambda得到字段后放到ofNullable方法中！
public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent())
return empty();
else {
return Optional.ofNullable(mapper.apply(value));
}
}9、flatMap(Function<? super T,Optional<U>> mapper)
如果存在值，則將提供的Optional方位映射函數(shù)應(yīng)用于該值，返回該結(jié)果，否則返回空的Optional。此方法類似于map，但提供的映射器的結(jié)果已經(jīng)是可選的，并且如果調(diào)用，flatMap不會不會在最后進行任何包裝。
Optional<String> optional = optionalTestNew.flatMap(OptionalTest::getFlatMap);
log.info("flatMap后得到的字段：{}",optional.get());
private static Optional<String> getFlatMap(Test test){
return Optional.ofNullable(test).map(Test::getName);
}
源碼查看：
也是進行非空判斷，然后和map不同的是不執(zhí)行ofNullable方法
public<U> Optional<U> flatMap(Function<? super T, Optional<U>> mapper) {
Objects.requireNonNull(mapper);
if (!isPresent())
return empty();
else {
return Objects.requireNonNull(mapper.apply(value));
}
}10、orElse(T other)
如果有值則將其返回，否則返回指定的其它值。
如果你是一個對象，orElse()也要是相同對象！
String message = null;
String messageNew = "關(guān)注公眾號：小王博客基地";
String nullString = Optional.ofNullable(message).orElse("這是一個空字符串！");
log.info("這是空字符串打印的：{}",nullString);
String string = Optional.ofNullable(messageNew).orElse("=====這是一個空字符串！");
log.info("這是字符串打印的：{}",string);
源碼查看：
簡單的為空返回自己定義的，不為空直接返回！
public T orElse(T other) {
return value != null ? value : other;
}11、orElseGet(Supplier<? extends T> other)
返回值（如果存在），否則調(diào)用other并返回該調(diào)用的結(jié)果。
區(qū)別： orElse方法將傳入的參數(shù)作為默認(rèn)值，orElseGet方法可以接受Supplier接口的實現(xiàn)用來生成默認(rèn)值
如果沒有復(fù)雜操作，Idea也會提醒我們不要使用這個，使用orElse即可！
String message = null;
String messageNew = "關(guān)注公眾號：小王博客基地";
String orElseGet = Optional.ofNullable(message).orElseGet(() -> "這還是一個空的字符串");
log.info("orElseGet調(diào)用：這是空字符串打印的：{}",orElseGet);
String orElseGetString = Optional.ofNullable(messageNew).orElseGet(() -> "這還是一個空的字符串");
log.info("orElseGet調(diào)用：這是字符串打印的：{}",orElseGetString);
源碼查看：
和orElse一樣，只不過為空調(diào)用lambda執(zhí)行！
public T orElseGet(Supplier<? extends T> other) {
return value != null ? value : other.get();
}12、orElseThrow(Supplier<? extends X> exceptionSupplier)
返回包含的值（如果存在），否則拋出由提供的供應(yīng)商創(chuàng)建的異常。
String message = null;
String messageNew = "關(guān)注公眾號：小王博客基地";
Optional.ofNullable(messageNew).orElseThrow(() -> new RuntimeException("為空了，還不看看！"));
Optional.ofNullable(message).orElseThrow(() -> new RuntimeException("為空了，還不看看！"));我們可以自定義異常，然后來引用！
源碼查看：
為空則走自己寫的異常！
public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X {
if (value != null) {
return value;
} else {
throw exceptionSupplier.get();
}
}13、例子匯總
/**
* @author wangzhenjun
* @date 2023/2/27 10:22
*/
@Slf4j
public class OptionalTest {
public static void main(String[] args) {
Optional<Object> empty = Optional.empty();
log.info("empty值：{}",empty);
Test testNew = new Test();
Test test = null;
Optional<Test> optionalNew = Optional.of(testNew);
log.info(" optional對象：{}",optionalNew);
// Optional<Test> optional = Optional.of(test);
Optional<Test> optionalTest = Optional.ofNullable(test);
log.info(" optional對象中的ofNullable方法返回值：{}",optionalTest);
Optional<Test> optionalTestNew = Optional.ofNullable(testNew);
log.info(" optional對象中的ofNullable方法new返回值：{}",optionalTestNew);
Test test2 = optionalTestNew.get();
log.info("原來有值的：經(jīng)過Optional包裝后get后得到原來的值：{}",test2);
// Test test1 = optionalTest.get();
// log.info("原來沒有值的：經(jīng)過Optional包裝后get后得到原來的值：{}",test1);
boolean present = optionalTestNew.isPresent();
log.info("optionalTestNew調(diào)用是否為空：{}",present);
boolean present1 = optionalTest.isPresent();
log.info("optionalTest調(diào)用是否為空：{}",present1);
optionalTest.ifPresent(new Consumer<Test>() {
@Override
public void accept(Test test) {
log.info("我是調(diào)用ifPresent執(zhí)行后的打印=====");
}
});
optionalTestNew.ifPresent(testInner -> log.info("我是調(diào)用ifPresent執(zhí)行后的打印"));
testNew.setName("蕭炎");
testNew.setAge(33);
Optional<Test> optionalTest1 = optionalTestNew.filter(test1 -> test1.getAge() > 30);
log.info("過濾后的結(jié)果：{}",optionalTest1.get());
Optional<String> stringOptional = optionalTestNew.map(Test::getName);
log.info("map后獲得字段值：{}",stringOptional.get());
Optional<String> optional = optionalTestNew.flatMap(OptionalTest::getFlatMap);
log.info("flatMap后得到的字段：{}",optional.get());
String message = null;
String messageNew = "關(guān)注公眾號：小王博客基地";
String nullString = Optional.ofNullable(message).orElse("這是一個空字符串！");
log.info("這是空字符串打印的：{}",nullString);
String string = Optional.ofNullable(messageNew).orElse("=====這是一個空字符串！");
log.info("這是字符串打印的：{}",string);
String orElseGet = Optional.ofNullable(message).orElseGet(() -> "這還是一個空的字符串");
log.info("orElseGet調(diào)用：這是空字符串打印的：{}",orElseGet);
String orElseGetString = Optional.ofNullable(messageNew).orElseGet(() -> "這還是一個空的字符串");
log.info("orElseGet調(diào)用：這是字符串打印的：{}",orElseGetString);
Optional.ofNullable(messageNew).orElseThrow(() -> new RuntimeException("為空了，還不看看！"));
Optional.ofNullable(message).orElseThrow(() -> new RuntimeException("為空了，還不看看！"));
}
private static Optional<String> getFlatMap(Test test){
return Optional.ofNullable(test).map(Test::getName);
}
}四、總結(jié)
這里就不在演示實戰(zhàn)了，基本上組合使用：
Optional.ofNullable(需要判斷的對象).ifPresent(具體操作)。
其實和if相比就是顯得優(yōu)雅一些，主要是防止某處沒考慮到，忘記if判斷，那么后續(xù)可能會導(dǎo)致空指針，如果使用Optional的話，那么這個問題能夠得到避免。
就像多使用設(shè)計模式一樣，讓自己的代碼更加健壯優(yōu)雅，還是要多使用一些的！當(dāng)然不能過渡使用??！
