Java8 Optional 学习

Java8 Optional学习

• Optional是Java8提供的为了解决null安全问题的一个API。
• Optional 类是一个可以为null的容器对象。如果值存在则isPresent()方法会返回true，调用get()方法会返回该对象。
• Optional 是个容器：它可以保存类型T的值，或者仅仅保存null。Optional提供很多有用的方法，这样我们就不用显式进行空值检测。
• 类的声明：
  
  • 
public final class Optional<T>
extends Object
• 方法说明：
  
  • static <T> Optional<T> empty()
    
    • 返回空的 Optional 实例。
  • static <T> Optional<T> empty()
    
    • 返回空的 Optional 实例。
  • Optional<T> filter(Predicate<? super <T> predicate)
    
    • 如果值存在，并且这个值匹配给定的 predicate，返回一个Optional用以描述这个值，否则返回一个空的Optional。
  • <U> Optional<U> flatMap(Function<? super T,Optional<U>> mapper)
    
    • 如果值存在，返回基于Optional包含的映射方法的值，否则返回一个空的Optional
  • T get()
    
    • 如果在这个Optional中包含这个值，返回值，否则抛出异常：NoSuchElementException
  • int hashCode()
    
    • 返回存在值的哈希码，如果值不存在 返回 0。
  • void ifPresent(Consumer<? super T> consumer)
    
    • 如果值存在则使用该值调用 consumer , 否则不做任何事情。
  • boolean isPresent()
    
    • 如果值存在则方法会返回true，否则返回 false。
  • <U>Optional<U> map(Function<? super T,? extends U> mapper)
    
    • 如果存在该值，提供的映射方法，如果返回非null，返回一个Optional描述结果。
  • static <T> Optional<T> of(T value)
    
    • 返回一个指定非null值的Optional。
  • static <T> Optional<T> ofNullable(T value)
    
    • 如果为非空，返回 Optional 描述的指定值，否则返回空的 Optional。
  • T orElse(T other)
    
    • 如果存在该值，返回值， 否则返回 other。
  • T orElseGet(Supplier<? extends T> other)
    
    • 如果存在该值，返回值， 否则触发 other，并返回 other 调用的结果。
  • <X extends Throwable> T orElseThrow(Supplier<? extends X> exceptionSupplier)
    
    • 如果存在该值，返回包含的值，否则抛出由 Supplier 继承的异常
  • String toString()
    
    • 返回一个Optional的非空字符串，用来调试
• 例子：

public class OptionalDemo {

    public static void main(String[] args) {
        OptionalDemo optionalDemo = new OptionalDemo();
        Integer value1 = null;
        Integer value2 = new Integer(10);

        Optional<Integer> a = Optional.ofNullable(value1);
        Optional<Integer> b = Optional.ofNullable(value2);
        System.out.println(optionalDemo.sum(a,b));
    }

    private Integer sum(Optional<Integer> a,Optional<Integer> b){
        System.out.println("第一个参数值存在: " + a.isPresent());
        System.out.println("第二个参数值存在: " + b.isPresent());
        // Optional.orElse - 如果值存在，返回它，否则返回默认值
        Integer value1 = a.orElse(new Integer(0));
        //Optional.get - 获取值，值需要存在
        Integer value2 = b.get();
        return value1 + value2;
    }
}

如何优雅的使用Optional

• 善用Optional可以使我们代码中很多繁琐、丑陋的设计变得十分优雅。
• 例一：

public class OptionalDemo {

    public static void main(String[] args) {
        Student stu1 = null;
        Student stu2 = new Student("hyman");
        System.out.println("stu1: "+getName(stu1));
        System.out.println("stu2: "+getName(stu2));
    }
    private static String getName(Student stu) {
        return Optional.ofNullable(stu) //  如果为非空，返回 Optional 描述的指定值，否则返回空的 Optional。
                .map(s->s.name)   //如果存在该值，提供的映射方法，如果返回非null，返回一个Optional描述结果。
                .orElse("Unknown");// 如果存在该值，返回值， 否则返回 other。
    }
    private static class Student {
        private String name;

        private Student(String name) {
            this.name = name;
        }
    }
}

• 例二:
  
  • 这样才是正确使用Optional的姿势。那么按照这种思路，我们可以安心的进行链式调用，而不是一层层判断了。
• 传统方式：

/**
     * 传统
     * @param comp comp
     * @return String
     * @throws IllegalArgumentException
     */
    public static String getChampionName(Competition comp) throws IllegalArgumentException {
        if (comp != null) {
            CompResult result = comp.getResult();
            if (result != null) {
                Student champion = result.getChampion();
                if (champion != null) {
                    return champion.getName();
                }
            }
        }
        throw new IllegalArgumentException("The value of param comp isn't available.");
    }

• 优雅方式：

public class OptionalDemo {

    public static void main(String[] args) {
        Student stu1 = null;
        Student stu2 = new Student("hyman");
        CompResult compR1 = new CompResult(stu1);
        CompResult compR2 = new CompResult(stu2);
        Competition compeT1 = new Competition(compR1);
        Competition compeT2 = new Competition(compR2);
        System.out.println("stu1: " + getChampionName(compeT1));
        System.out.println("stu2: " + getChampionName(compeT2));
    }

    public static String getChampionName(Competition comp) throws IllegalArgumentException {
        return Optional.ofNullable(comp)
                .map(c -> c.getResult())
                .map(r -> r.getChampion())
                .map(u -> u.getName()) //如果存在该值，提供的映射方法，如果返回非null，返回一个Optional描述结果。
                // 如果存在该值，返回包含的值，否则抛出由 Supplier 继承的异常
                .orElseThrow(() -> new IllegalArgumentException("The value of param comp isn't available."));
    }

    private static class Competition {
        private CompResult result;

        public Competition(CompResult result) {
            this.result = result;
        }

        public CompResult getResult() {
            return result;
        }

        public void setResult(CompResult result) {
            this.result = result;
        }
    }

    private static class CompResult {
        private Student champion;

        public CompResult(Student champion) {
            this.champion = champion;
        }

        public Student getChampion() {
            return champion;
        }

        public void setChampion(Student champion) {
            this.champion = champion;
        }
    }

    private static class Student {
        private String name;

        public Student(String name) {
            this.name = name;
        }

        public String getName() {
            return name;
        }

        public void setName(String name) {
            this.name = name;
        }
    }
}

• 比如为空则不打印可以这么写：

public static void main(String[] args) {
        Optional<String> str = Optional.ofNullable("sdfadfs");
        str.ifPresent(System.out::println);
    }

• Optional还有一些神奇的用法，比如Optional可以用来检验参数的合法性。

public void setName(String name) throws IllegalArgumentException {
    this.name = Optional.ofNullable(name).filter(Student::isNameValid)
                        .orElseThrow(()->new IllegalArgumentException("Invalid username."));
}