Optional是個好東西，你會用麼？（全面深度解析）

寫在前面

從 Java 8 引入的一個很有趣的特性是 Optional 類。Optional 類主要解決的問題是臭名昭著的空指針異常（NullPointerException）這個異常就不多說了，肯定是每個 Java 程序員都非常瞭解的異常。Optional 的完整路徑是 java.util.Optional，使用它是爲了避免代碼中的 if (obj != null) { } 這樣範式的代碼，可以採用鏈式編程的風格。而且通過 Optional 中提供的 filter 方法可以判斷對象是否符合條件，在符合條件的情況下才會返回，map 方法可以在返回對象前修改對象中的屬性。如果覺得有所收穫，記得點個關注和點個贊哦。

Optional用處

本質上，Optional是一個包含有可選值的包裝類，這意味着 Optional 類既可以含有對象也可以爲空。我們要知道，Optional 是 Java 實現函數式編程的強勁一步，並且幫助在範式中實現。但是 Optional 的意義顯然不止於此。我們知道，任何訪問對象方法或屬性的調用都可能導致 NullPointerException，在這裏，我舉個簡單的例子來說明一下

String result = test.getName().getTime().getNum().getAnswer();

在上面的這個代碼中，如果我們需要確保不觸發異常，就得在訪問每一個值之前對其進行明確地檢查，就是使用if else對test等值進行判斷是否爲null，這很容易就變得冗長，難以維護。爲了簡化這個過程，Google公司著名的Guava項目引入了Optional類，Guava通過使用檢查空值的方式來防止代碼污染，並鼓勵程序員寫更乾淨的代碼。Optional實際上是個容器：它可以保存類型T的值，或者僅僅保存null。Optional提供很多有用的方法，這樣我們就不用顯式進行空值檢測。

Optional的構造函數

Optional 的三種構造方式：Optional.of(obj)， Optional.ofNullable(obj) 和明確的 Optional.empty()

• Optional.of(obj)：它要求傳入的 obj 不能是 null 值的, 否則直接報NullPointerException 異常。
• Optional.ofNullable(obj)：它以一種智能的，寬容的方式來構造一個 Optional 實例。來者不拒，傳 null 進到就得到 Optional.empty()，非 null 就調用 Optional.of(obj).
• Optional.empty()：返回一個空的 Optional 對象

Optional的常用函數

• of：爲非null的值創建一個Optional。of方法通過工廠方法創建Optional類。需要注意的是，創建對象時傳入的參數不能爲null。如果傳入參數爲null，則拋出NullPointerException。因此不經常用。
• ofNullable：爲指定的值創建一個Optional，如果指定的值爲null，則返回一個空的Optional。
• isPresent：如果值存在返回true，否則返回false。
• ifPresent：如果Optional實例有值則爲其調用consumer，否則不做處理
• get：如果Optional有值則將其返回，否則拋出NoSuchElementException。因此也不經常用。
• orElse：如果有值則將其返回，否則返回指定的其它值。
• orElseGet：orElseGet與orElse方法類似，區別在於得到的默認值。orElse方法將傳入的字符串作爲默認值，orElseGet方法可以接受Supplier接口的實現用來生成默認值
• orElseThrow：如果有值則將其返回，否則拋出supplier接口創建的異常。
• filter：如果有值並且滿足斷言條件返回包含該值的Optional，否則返回空Optional。
• map：如果有值，則對其執行調用mapping函數得到返回值。如果返回值不爲null，則創建包含mapping返回值的Optional作爲map方法返回值，否則返回空Optional。
• flatMap：如果有值，爲其執行mapping函數返回Optional類型返回值，否則返回空Optional。

Optional 應該怎樣用

在使用 Optional 的時候需要考慮一些事情，以決定什麼時候怎樣使用它。重要的一點是 Optional 不是 Serializable。因此，它不應該用作類的字段。如果你需要序列化的對象包含 Optional 值，Jackson 庫支持把 Optional 當作普通對象。也就是說，Jackson 會把空對象看作 null，而有值的對象則把其值看作對應域的值。這個功能在 jackson-modules-java8 項目中。Optional 主要用作返回類型，在獲取到這個類型的實例後，如果它有值，你可以取得這個值，否則可以進行一些替代行爲。Optional 類可以將其與流或其它返回 Optional 的方法結合，以構建流暢的API。我們來看一個示例，我們不使用Optional寫代碼是這樣的

public String getName(User user){
	if(user == null){
		return "Unknown";
	}else return user.name();
}

接着我們來改造一下上面的代碼，使用Optional來改造，我們先來舉一個Optional濫用，沒有達到流暢的鏈式API，反而複雜的例子，如下

public String getName(User user){
	Optional<User> u = Optional.ofNullable(user);
	if(!u.isPresent()){
		return "Unknown";
	}else return u.get().name();
}

這樣改寫非但不簡潔，而且其操作還是和第一段代碼一樣。無非就是用isPresent方法來替代原先user==null。這樣的改寫並不是Optional正確的用法，我們再來改寫一次。

public String getName(User user){
	return Optional.ofNullable(user)
							.map(u -> u.name)
							.orElse("Unknown");
}

這樣纔是正確使用Optional的姿勢。那麼按照這種思路，我們可以安心的進行鏈式調用，而不是一層層判斷了。當然，我們還可以通過getter方式，對代碼進行進一步縮減（前提是User要有getter方法哦），如下

String result = Optional.ofNullable(user)
	.flatMap(User::getAddress)
	.flatMap(Address::getCountry)
	.map(Country::getIsocode)
	.orElse("default");

Optional最佳實踐

首先我們先上一張圖，來簡述一下Optional的使用時機

• 避免使用Optional.isPresent()來檢查實例是否存在（上面的舉例中提到過），因爲這種方式和null != obj沒有區別，這樣用就沒什麼意義了。
• 避免使用Optional.get()方式來獲取實例對象，因爲使用前需要使用Optional.isPresent()來檢查實例是否存在，否則會出現NoSuchElementException異常問題。所以使用orElse()，orElseGet()，orElseThrow()獲得你的結果

這裏要說明一下的是orElse(…)是急切計算，意味着類似下面代碼：

Optional<Dog> optionalDog = fetchOptionalDog();
optionalDog
 .map(this::printUserAndReturnUser)
 .orElse(this::printVoidAndReturnUser)

如果值存在則將執行兩個方法，如果值不存在，則僅執行最後一個方法。爲了處理這些情況，我們可以使用方法orElseGet（），它將supplier 作爲參數，並且是惰性計算的。

• 避免使用Optional作爲類或者實例的屬性，而應該在返回值中用來包裝返回實例對象。
• 避免使用Optional作爲方法的參數，原因同3。
• 不要將null賦給Optional
• 只有每當結果不確定時，使用Optional作爲返回類型，從某種意義上講，這是使用Optional的唯一好地方，用java官方的話講就是：我們的目的是爲庫方法的返回類型提供一種有限的機制，其中需要一種明確的方式來表示“無結果”，並且對於這樣的方法使用null 絕對可能導致錯誤。
• 不要害怕使用map和filter，有一些值得遵循的一般開發實踐稱爲SLA-p：Single Layer of Abstraction字母的第一個大寫。下面是需要被重構代碼到重構的代碼

示例一

Dog dog = fetchSomeVaraible();
String dogString = dogToString(dog);
public String dogToString(Dog dog){
 if(dog == null){
   return "DOG'd name is : " + dog.getName();
 } else { 
   return "CAT";
 }
}
//上面代碼重構到下面代碼
Optional<Dog> dog = fetchDogIfExists();
String dogsName = dog
 .map(this::convertToDog)
 .orElseGet(this::convertToCat)

public void convertToDog(Dog dog){
   return "DOG'd name is : " + dog.getName();
}

public void convertToCat(){
   return "CAT";
}

示例二

Dog dog = fetchDog();
if(optionalDog != null && optionalDog.isBigDog()){
  doBlaBlaBla(optionalDog);
}
//上面代碼重構到下面代碼
Optional<Dog> optionalDog = fetchOptionalDog();
optionalDog
 .filter(Dog::isBigDog)
 .ifPresent(this::doBlaBlaBla)

• 不要爲了鏈方法而使用optional。使用optional 時要注意的一件事是鏈式方法的誘惑。當我們像構建器模式一樣鏈接方法時，事情可能看起來很漂亮。但並不總是等於更具可讀性。所以不要這樣做，它對性能不利，對可讀性也不好。我們應儘可能避免使用null引用。

Optional
 .ofNullable(someVariable)
 .ifPresent(this::blablabla)

• 使所有表達式成爲單行lambda。這是更普遍的規則，我認爲也應該應用於流。但這篇文章是關於optional 。使用Optional 重要點是記住等式左邊和右邊一樣重要，這裏舉個例子

Optional
 .ofNullable(someVariable)
 .map(variable -> {
   try{
      return someREpozitory.findById(variable.getIdOfOtherObject());
   } catch (IOException e){
     LOGGER.error(e); 
     throw new RuntimeException(e); 
   }})
 .filter(variable -> { 
   if(variable.getSomeField1() != null){
     return true;
   } else if(variable.getSomeField2() != null){
     return false;   
   } else { 
     return true;
   }
  })
 .map((variable -> {
   try{
      return jsonMapper.toJson(variable);
   } catch (IOException e){
     LOGGER.error(e); 
     throw new RuntimeException(e); 
   }}))
 .map(String::trim)
 .orElseThrow(() -> new RuntimeException("something went horribly wrong."))

上面那麼冗長代碼塊可以使用方法替代：

Optional
 .ofNullable(someVariable)
 .map(this::findOtherObject)
 .filter(this::isThisOtherObjectStale)
 .map(this::convertToJson)
 .map(String::trim)
 .orElseThrow(() -> new RuntimeException("something went horribly wrong."));