Optional原始碼決議與實踐

1 導讀

NullPointerException在開發程序中經常遇到，稍有不慎小BUG就出現了，如果避免這個問題呢，Optional就是專門解決這個問題的類，那么Optional如何使用呢？讓我們一起探索一下吧！

2 原始碼決議

2.1 Optional定義

Optional類是Java8為了解決null值判斷問題而創建的容器類，在java.util 下,使用Optional類可以避免顯式的null值判斷，避免null導致的NullPointerException，首先，Optional是一個容器，它可以保存型別T的值，也可以為null的容器物件，Optional容器只能存一個值，

2.2 Optional的屬性

1）原始碼：

1. /**
2. * Common instance for {@code empty()}.
3. */
4. private static final Optional<?> EMPTY = new Optional<>();
7. /**
8. * If non-null, the value; if null, indicates no value is present
9. */
10. private final T value;

根據原始碼可以看到Optional有兩個屬性，一個是為空值準備的EMPTY和泛型值value;

2.3 Optional的方法

Optional除toString()、hashCode() 、equals()等Object的方法外，還包含以下方法，

2.3.1 私有構造方法

1. /**
2. * Constructs an empty instance.
3. *
4. * @implNote Generally only one empty instance, {@link Optional#EMPTY},
5. * should exist per VM.
6. */
7. private Optional() {
8. this.value = null;
9. }
12. /**
13. * Constructs an instance with the value present.
14. *
15. * @param value the non-null value to be present
16. * @throws NullPointerException if value is null
17. */
18. private Optional(T value) {
19. this.value = Objects.requireNonNull(value);
20. }

分別是創建一個空實體和構造一個具有當前值的實體，

2.3.2 創建方法

1）原始碼

1. public static<T> Optional<T> empty() {
2. @SuppressWarnings("unchecked")
3. Optional<T> t = (Optional<T>) EMPTY;
4. return t;
5. }
6. public static <T> Optional<T> of(T value) {
7. return new Optional<>(value);
8. }
9. public static <T> Optional<T> ofNullable(T value) {
10. return value == null ? empty() : of(value);
11. }

2）方法說明

• empty(）: 創建一個空的 Optional 實體
• of(T t) : 創建一個 Optional 實體，當 t為null時拋出例外
• ofNullable(T t): 創建一個 Optional 實體，但當 t為null時不會拋出例外，而是回傳一個空的實體

3）測驗代碼

1. public static void main(String[] args) {
2. Integer value1 = null;
3. Integer value2 = 1;
4. try {
5. Optional<Integer> optional1 = Optional.empty();
6. System.out.println("optional1創建了");
7. }catch (Exception e){
8. System.out.println("optional1失敗了");
9. }
10. try {
11. Optional<Integer> optional2 = Optional.of(value1);
12. System.out.println("optional2創建了");
13. }catch (Exception e){
14. System.out.println("optional2失敗了");
15. }
16. try {
17. Optional<Integer> optional3 = Optional.ofNullable(value1);
18. System.out.println("optional3創建了");
19. }catch (Exception e){
20. System.out.println("optional3失敗了");
21. }
22. try {
23. Optional<Integer> optional4 = Optional.of(value2);
24. System.out.println("optional4創建了");
25. }catch (Exception e){
26. System.out.println("optional4失敗了");
27. }
28. try {
29. Optional<Integer> optional5 = Optional.ofNullable(value2);
30. System.out.println("optional5創建了");
31. }catch (Exception e){
32. System.out.println("optional5失敗了");
33. }
34. }

4）運行結果

2.3.3 值獲取方法

1）原始碼

1. public T get() {
2. if (value == null) {
3. throw new NoSuchElementException("No value present");
4. }
5. return value;
6. }

2）方法說明

get(): 如果Optional不為空，則回傳該Optional容器中的值，否則拋出NoSuchElementExceptio ，

3）測驗代碼

1. public static void main(String[] args) {
2. Integer value1 = null;
3. Integer value2 = 1;
4. Optional<Integer> optional1 = Optional.ofNullable(value1);
5. Optional<Integer> optional2 = Optional.of(value2);
6. try {
7. Integer result=optional1.get();
8. System.out.println("optional1的值是："+result);
9. }catch (Exception e){
10. System.out.println("optional1的值獲取失敗,原因:"+e.getMessage());
11. }
12. try {
13. Integer result=optional2.get();
14. System.out.println("optional2的值是："+result);
15. }catch (Exception e){
16. System.out.println("optional2的值獲取失敗,原因:"+e.getMessage());
17. }
18. }

4）運行結果

2.3.4 判斷方法

1）原始碼

1. public boolean isPresent() {
2. return value != null;
3. }
4. public void ifPresent(Consumer<? super T> consumer) {
5. if (value != null)
6. consumer.accept(value);
7. }
8. public T orElse(T other) {
9. return value != null ? value : other;
10. }
11. public T orElseGet(Supplier<? extends T> other) {
12. return value != null ? value : other.get();
13. }
14. public <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier) throws X {
15. if (value != null) {
16. return value;
17. } else {
18. throw exceptionSupplier.get();
19. }
20. }

2）方法說明

• isPresent(): 判斷optional是否為空，如果空則回傳false，否則回傳true
• ifPresent(Consumer c): 如果optional不為空，則將optional中的物件傳給Comsumer函式
• orElse(T other): 如果optional不為空，則回傳optional中的物件；如果為null，則回傳 other 這個物件，
• orElseGet(Supplier other): 如果optional不為空，則回傳optional中的物件；如果為null，否則呼叫其他函式并回傳呼叫的結果
• orElseThrow(Supplier exception): 如果optional不為空，則回傳optional中的物件；如果為null，則拋出Supplier函式生成的例外

3）測驗代碼

1. public static void main(String[] args) {
2. Integer value1 = null;
3. Integer value2 = 1;
4. Optional<Integer> optional1 = Optional.ofNullable(value1);
5. Optional<Integer> optional2 = Optional.of(value2);
6. try {
7. if(optional1.isPresent()){
8. System.out.println("optional1的isPresent結果不為空");
9. }else{
10. System.out.println("optional1的isPresent結果為空");
11. }
12. }catch (Exception e){
13. System.out.println("optional1的isPresent判空失敗,原因:"+e.getMessage());
14. }
15. try {
16. if(optional2.isPresent()){
17. System.out.println("optional2的isPresent結果不為空");
18. }else{
19. System.out.println("optional2的isPresent結果為空");
20. }
21. }catch (Exception e){
22. System.out.println("optional2的isPresent判空失敗,原因:"+e.getMessage());
23. }
26. optional1.ifPresent(t->{
27. int i =t+1;
28. System.out.println("optional1處理后的值是"+i);
29. });
30. optional2.ifPresent(t->{
31. int i =t+1;
32. System.out.println("optional2處理后的值是"+i);});
35. Integer value3 = 2;
36. Integer result = optional1.orElse(value3);
37. System.out.println("optional1執行orElse處理后的值是"+result);
40. result = optional2.orElse(value3);
41. System.out.println("optional2執行orElse處理后的值是"+result);
44. result = optional1.orElseGet(()-> new Integer(-1));
45. System.out.println("optional1執行orElseGet處理后的值是"+result);
48. result = optional2.orElseGet(()-> new Integer(-1));
49. System.out.println("optional2執行orElseGet處理后的值是"+result);
50. try {
51. result = optional1.orElseThrow (()-> new RuntimeException("值是空的"));
52. System.out.println("optional1執行orElseThrow處理后的值是"+result);
53. }catch (Exception e){
54. System.out.println("optional1的orElseThrow拋出例外:"+e.getMessage());
55. }
56. try {
57. result = optional2.orElseThrow (()-> new RuntimeException("值是空的"));
58. System.out.println("optional2執行orElseThrow處理后的值是"+result);
59. }catch (Exception e){
60. System.out.println("optional2的orElseThrow拋出例外:"+e.getMessage());

4）運行結果

2.3.5 過濾方法

1）原始碼

1. public Optional<T> filter(Predicate<? super T> predicate) {
2. Objects.requireNonNull(predicate);
3. if (!isPresent())
4. return this;
5. else
6. return predicate.test(value) ? this : empty();
7. }

2）方法說明

filter(Predicate p): 如果optional不為空，則執行Predicate p，如果p的結果為true，則回傳原本的optional，否則回傳空的optional

3）測驗代碼

1. public static void main(String[] args) {
2. Integer value1 = 5;
3. Integer value2 = 6;
4. Optional<Integer> optional1 = Optional.ofNullable(value1);
5. Optional<Integer> optional2 = Optional.of(value2);
8. Optional<Integer> result =optional1.filter(t->t > 5);
9. System.out.println("optional1的filter后的值:"+result);
10. result =optional2.filter(t->t > 5);
11. System.out.println("optional2的filter后的值:"+result);

4）運行結果

2.3.6 映射方法

1）原始碼

1. public<U> Optional<U> map(Function<? super T, ? extends U> mapper) {
2. Objects.requireNonNull(mapper);
3. if (!isPresent())
4. return empty();
5. else {
6. return Optional.ofNullable(mapper.apply(value));
7. }
8. }
9. public<U> Optional<U> flatMap(Function<? super T, Optional<U>> mapper) {
10. Objects.requireNonNull(mapper);
11. if (!isPresent())
12. return empty();
13. else {
14. return Objects.requireNonNull(mapper.apply(value));
15. }
16. }

2）方法說明

• map(Function<t, u=""> mapper): 如果存在一個值，則對其應用提供的映射函式，如果結果非空，則回傳描述結果的Optional， 否則回傳一個空的Optional，
• flatMap(Function< T,Optional> mapper): 如果有值，則對其應用提供的可選映射函式，回傳結果，否則回傳空的可選函式， 這個方法類似于map(Function)，但是提供的映射器的結果已經是一個可選的，如果呼叫，flatMap不會用額外的可選的包裝它，
• 區別：map會自動將u放到optional中，而flatMap則需要手動給u創建一個optional

3）測驗代碼

1. public static void main(String[] args) {
2. User user1 = null;
3. User user2 = new User("user2名字",19);
4. Optional<User> optional1 = Optional.ofNullable(user1);
5. Optional<User> optional2 = Optional.of(user2);
6. System.out.println("=========map==========");
7. System.out.println("optional1的map前的值:"+optional1);
8. Optional<String> result =optional1.map(t->t.getName());
9. System.out.println("optional1的map后的值:"+result);
12. System.out.println("optional2的map前的值:"+optional2);
13. result =optional2.map(t->t.getName());
14. System.out.println("optional2的map后的值:"+result);
17. System.out.println("===========flatMap========");
20. System.out.println("optional1的flatMap前的值:"+optional1);
21. Optional<Integer> result2 =optional1.flatMap(t->Optional.ofNullable(t.getAge()));
22. System.out.println("optional1的flatMap后的值:"+result2);
25. System.out.println("optional2的flatMap前的值:"+optional2);
26. result2 =optional2.flatMap(t->Optional.ofNullable(t.getAge()));
27. System.out.println("optional2的flatMap后的值:"+result2);
29. }
30. public class User {
31. String name;
32. Integer age;
33. public User(String name,Integer age){
34. this.name = name;
35. this.age=age;
36. }
39. public String getName() {
40. return name;
41. }
44. public Integer getAge() {
45. return age;

4）運行結果

3 應用實體

3.1 錯誤用法

• 由于Optional并沒有實作Serializable介面,所以不能作為類的屬性，
• 不要把Optional作為方法的引數，
• 把if(x!=null)直接換成Optional.ofNullable(x).isPresent(),這樣有過度編碼的嫌疑，
• 直接使用Optional.get()的回傳值進行操作，String result =Optional.ofNullable(null).get().toString()；這樣還是會拋出例外的，

3.2 建議用法

A類有屬性B類，B類有屬性C類,C類有name這個欄位，
使用Optional之前:

1. if(atest!=null){
2. Btest btest =atest.getBtest();
3. if(btest!=null){
4. Ctest ctest = btest.getCtest();
5. if (ctest != null) {
6. name =ctest.getName();
7. }
8. }
9. }

使用Optional之后:

1. name = Optional.ofNullable(atest).map(t->t.getBtest()).map(t->t.getCtest()).map(t->t.getName()).orElse("默認值");

代碼是不是看上去更整潔了呢？

4 總結

通過對Optional原始碼決議和用例測驗代碼的運行結果，可以看出使用Optional可以優化null值判斷代碼，讓代碼變得更加優雅和整潔，

自猿其說Tech-JDL京東物流技術與資料智能部

作者：陳昌浩

標籤：其他

上一篇：mapboxgl加載tiff

下一篇：JSON APIs and Ajax