Java 8 Optional 類用法

1、Optional 用法

/**
 * Optional 用法
 *
 * @author xuweizhi
 * @since 2019-08-20
 */
public class OptionTest {

    /**
     * Optional.of()  Optional.ofNullAble() Optional.empty()
     */
    @Test
    public void test() {

        OptionDemo optionDemo = new OptionDemo();
        optionDemo.setName("張三");

        // of 方法不能傳入空值，否則要報錯
        Optional<OptionDemo> optional = Optional.of(optionDemo);

        OptionDemo optionDemoNull = null;
        // 這個可以傳入 null 值，不會拋出異常，而只是返回一個空的Optional對象，如同我們用Optional.empty API:
        Optional<OptionDemo> optional1 = Optional.ofNullable(optionDemoNull);

    }

    /**
     * isPresent() isPresent(() -> {}) 檢查一個Optional對象中是否有值，只有值非空才返回true
     */
    @Test
    public void testIsPresent() {

        OptionDemo optionDemo = new OptionDemo();
        optionDemo.setName("張三");

        // of 方法不能傳入空值，否則要報錯
        Optional<OptionDemo> optional = Optional.of(optionDemo);

        // 檢查一個Optional對象中是否有值，只有值非空才返回true
        System.out.println(optional.isPresent());

        // 適當使用這個 api
        optional.ifPresent(print -> System.out.println(print));

        OptionDemo optionDemoNull = null;
        // 這個可以傳入 null 值，不會拋出異常，而只是返回一個空的Optional對象，如同我們用Optional.empty API:
        Optional<OptionDemo> optional1 = Optional.ofNullable(optionDemoNull);
        System.out.println(optional1.isPresent());

    }

    /**
     * orElse() 這個API被用來檢索Optional對象中的值，它被傳入一個“默認參數‘。如果對象中存在一個值，則返回它，否則返回傳入的“默認參數”
     */
    @Test
    public void testOrElse() {

        OptionDemo optionDemo = new OptionDemo();
        optionDemo.setName("張三");

        Optional<OptionDemo> optional = Optional.of(optionDemo);
        System.out.println(optional.orElse(new OptionDemo("默認值不會被打印")));

        OptionDemo optionDemoNull = null;
        Optional<OptionDemo> optional1 = Optional.ofNullable(optionDemoNull);

        System.out.println(optional1.orElse(new OptionDemo("默認值會被打印")));
    }

    /**
     * orElseGet() 與 orElse 類似，但是這個函數不接收一個“默認參數”，而是一個函數接口
     * <p>
     * 其值爲那啥，那啥，那啥？就是函數式接口的返回值
     */
    @Test
    public void testOrElseGet() {
        Optional<OptionDemo> option = Optional.ofNullable(null);
        System.out.println(option.orElseGet(() -> new OptionDemo("測試 orElseGet 函數式接口")));
    }

    @Test
    public void whenOrElseGetAndOrElseOverlap_thenCorrect() {
        String text = null;

        System.out.println("Using orElseGet:");
        String defaultText = Optional.ofNullable(text).orElseGet(this::getMyDefault);
        System.out.println(defaultText);

        System.out.println("Using orElse:");
        defaultText = Optional.ofNullable(text).orElse(getMyDefault());
        System.out.println(defaultText);
    }

    /**
     * 可以看到，當使用orElseGet去檢索值時，getMyDefault並不執行，因爲Optional中含有值，而使用orElse時則照常執行。
     * 所以可以看到，當值存在時，orElse相比於orElseGet，多創建了一個對象，可能從這個實例中你感受不到影響有多大，但考
     * 慮當getDefalut不僅僅是個簡單函數，而是一個web service之類的，則多創建一個代價是比較大的。
     */
    @Test
    public void whenOrElseGetAndOrElseDiffer_thenCorrect() {
        String text = "Text present";

        System.out.println("Using orElseGet:");
        String defaultText
                = Optional.ofNullable(text).orElseGet(this::getMyDefault);
        System.out.println(defaultText);

        System.out.println("Using orElse:");
        defaultText = Optional.ofNullable(text).orElse(getMyDefault());
        System.out.println(defaultText);
    }

    public String getMyDefault() {
        System.out.println("Getting Default Value");
        return "Default Value";
    }

    /**
     * orElseThrow當遇到一個不存在的值的時候，並不返回一個默認值，而是拋出異常
     */
    @Test/*(expected = IllegalArgumentException.class)*/
    public void whenOrElseThrowWorks_thenCorrect() {
        String nullName = null;
        String name = Optional.ofNullable(nullName).orElseThrow(
                IllegalArgumentException::new);
        System.out.println(name);
    }

    /**
     * 使用get() API 也可以返回被包裹着的值。但是必須是值存在時，當值不存在時，它會拋出一個NoSuchElementException異常
     * <p>
     * 因爲這個方法與我們使用Optional的目的相違背，所以可以預見在不久將來它或許會被拋棄，建議還是使用其他的方法
     */
    @Test/*(expected = NoSuchElementException.class)*/
    public void givenOptionalWithNull_whenGetThrowsException_thenCorrect() {
        Optional<String> opt = Optional.ofNullable(null);
        String name = opt.get();
    }

    /**
     * filter() 接收一個函數式接口，當符合接口時，則返回一個Optional對象，否則返回一個空的Optional對象。
     */
    @Test
    public void whenOptionalFilterWorks_thenCorrect() {
        Integer year = 2016;
        Optional<Integer> yearOptional = Optional.of(year);
        boolean is2016 = yearOptional.filter(y -> y == 2016).isPresent();
        System.out.println(is2016);
        boolean is2017 = yearOptional.filter(y -> y == 2017).isPresent();
        System.out.println(is2017);
    }

    /**
     * map() flatmap()
     */
    @Test
    public void testMap() {
        boolean present = Optional.ofNullable(new OptionDemo("我們")).map(OptionDemo::getName)/*.filter(String::isEmpty)*/.map(s -> s.equals("我們")).isPresent();
        System.out.println(present);
    }
}

@Data
@Slf4j
@ToString
class OptionDemo {

    private String name;

    @Contract(pure = true)
    public OptionDemo() {
    }

    @Contract(pure = true)
    public OptionDemo(String name) {
        this.name = name;
    }
}