Optional

[korjun1993]

Optional이란?

• Java8에서는 Optional 클래스를 사용해 NPE를 방지할 수 있도록 도와준다.
• Optional는 null이 올 수 있는 값을 감싸는 Wrapper 클래스로, 참조하더라도 NPE가 발생하지 않도록 도와준다.
• 스트림 최종 연산의 결과를 그냥 반환하는게 아니라 Optional 객체에 담아서 반환한다.
• Optional 클래스는 아래와 같은 value에 값을 저장하기 때문에 값이 null이더라도 바로 NPE가 발생하지 않으며, 클래스이기 때문에 각종 메소드를 제공해준다.

public final class Optional<T> {

  // If non-null, the value; if null, indicates no value is present
  private final T value;

  ...
}

객체 생성하기

• 참조변수의 값이 null일 가능성이 있으면, ofNullable()을 사용해야한다.

  Optional<String> optVal1 = Optional.ofNullable(null);

• of(매개변수)는 NullPointerException이 발생한다.

  Optional<String> optVal2 = Optional.of(null); //NullPointerException 발생

• Optional타입의 참조변수를 기본값으로 초기화할 때는 empty()를 사용한다.
• Optional.empty()는 EMPTY라는 상수값(new Optional<>(null))을 반환한다.

  Optional<String> optVal3 = Optional.empty();

객체의 값 가져오기

• Optional 객체에 저장된 값을 가져올 때는 get()을 사용한다.

• 값이 Null일 때는 NoSuchElementException이 발생한다.

  String str = optVal.get();

• 값이 Null일 때를 대비하여 orElse()로 대체할 값을 지정

  String str = optVal.orElse("empty");

• 값이 Null일 때를 대비하여, Null을 대체할 값을 반환하는 람다식을 지정

  String str = optVal.orElseGet(() -> "DEFAULT");

• 값이 Null일 때를 대비하여, 지정된 예외를 발생

  String str = optVal.orElseThrow(NullPointerException::new);

• 값이 존재하는지 확인

  optVal.isPresent();

• filter, map, flatMap 사용하기

  optVal.filter(x -> x.length() > 0).map(Integer::parseInt).orElse(-1)

• 값이 존재할 때 사용하기

  optVal.ifPresent(System.out::println)

orElse(), orElseGet()의 차이점

준비코드 - getUserEmail()

private static String getUserEmail() {
    System.out.println("getUserEmail() called");
    return "korjun1993@tistory.com";
}

orElse() 사용

String userEmail = "Empty";
String result = Optional.ofNullable(userEmail).orElse(getUserEmail());

실행결과

getUserEmail() called

1. getUserEmail()을 호출
2. 결과값을 orElse()의 매개변수로 전달
3. orElse실행, value가 null이 아니므로 userEmail값 반환

orElseGet() 사용

String userEmail = "Empty";
String result = Optional.ofNullable(userEmail).orElseGet(() -> getUserEmail());

실행결과

1. getUserEmail 함수형 인터페이스를 orElseGet()로 전달
2. orElseGet실행, value가 null이 아니므로 userEmail값 반환

발생할 수 있는 장애 예시

public void findByUserEmail(String userEmail) {
    // orElse에 의해 userEmail이 이미 존재해도 유저 생성 함수가 호출되어 에러 발생
    return userRepository.findByUserEmail(userEmail)
            .orElse(createUserWithEmail(userEmail));
}

private String createUserWithEmail(String userEmail) {
    User newUser = new User(userEmail);
    return userRepository.save(newUser);
}

• 위의 예제는 Optional의 단말 연산으로 orElse를 사용하고 있기 때문에, 조회 결과와 무관하게 createUserWithEmail 함수가 반드시 실행된다.
• 하지만 Database에서는 userEmail이 Unique로 설정되어 있기 때문에 오류가 발생할 것이다.
• 그렇기 때문에 위와 같은 경우에는 해당 코드를 orElseGet으로 수정해야 한다.

기본형 Optional

• IntStream과 같은 기본형 스트림에는 Optional도 기본형을 값으로 하는 OptionalInt, OptionalLong, OptionalDouble을 반환한다. 아래의 목록은 IntStream에 정의된 메서드들이다.

OptionalInt findAny()
OptionalInt findFirst()
OptionalInt reduce(IntBinaryOperator op)
OptionalInt max()
OptionalInt min()
OptionalInt average()

• 기본형 Optional에 저장된 값을 꺼낼 때 사용하는 메서드의 이름이 기존과 다르다는 것에 주의하자.

Optional 클래스	값을 반환하는 클래스
Optional	T get()
OptionalInt	int getAsInt()
OptionalLong	long getAsLong()
OptionalDouble	double getAsDouble()

Reference

• https://mangkyu.tistory.com/70
• Java의 정석, 남궁성