개인룸/도윤

Item55. 옵셔널 반환은 신중히 하라

UroJem 2023. 7. 21. 01:11

자바 8 전에는 메서드가 특정 조건에서 값을 반환할 수 없을 때

  1. 예외를 던지거나
    • 예외는 진짜 예외적인 상황에서만 사용해야 하며 예외를 생성할 때 스택 추적 전체를 캡쳐하므로 비용도 만만치 않다.
  2. 반환타입이 객체 참조라면 null을 반환하는 두가지 선택지가 있었다.
    • null을 반환할 수 있는 메서드를 호출할때는 null이 반환될 일이 절대 없다고 확신하지 않는 한 별도의 null 처리 코드를 추가해야 한다.
    • null 처리를 무시하고 반환된 null 값을 어딘가에 저장해두면 언젠가 실제 원인과 전혀 상관없는 코드에서 NullPointerException이 발생할 수 있다.

 

자바 8 버전으로 올라가면서 Optional 이라는 또 하나의 선택지가 생겼다.

  • Optional<T>는 null이 아닌 T 타입을 참조를 하나 담거나 혹은 아무것도 담지않을 수 있다.
  • 아무것도 담지 않은 옵셔널은 '비었다'고 말하고 반대로 어떤 값을 담은 옵셔널은 '비지 않았다'고 한다.
  • Optional은 원소를 최대 1개 가질 수 있는 불변 컬렉션이다.
  • 보통은 T를 반환해야 하지만 특정 조건에서는 아무것도 반환하지 않아야 할 때 T 대신 Optional<T>를 반환하도록 선언하면 유효한 반환값이 없을 때는 빈 결과를 반환하는 메서드가 만들어진다.
  • 옵셔널을 반환하는 메서드는 예외를 던지는 메서드보다 유연하고 사용하기 쉬우며, null을 반환하는 메서드보다 오류가능성이 작다.

 

max 메서드에 빈 컬렉션을 건네면 IllegalArgumentException을 던진다. 

 

빈 옵셔널은 Optional.empty()로 만들고, 값이 든 옵셔널은 Optional.of(value)로 생성했다.

Optional.of(value)에 null을 넣으면 NullPointerException을 던지니 주의하라.

null값도 허용하는 옵셔널을 만드려면 Optional.ofNullable(value)를 사용하면 된다.

옵셔널을 반환하는 메서드에서는 절대 null을 반환하지 말자.

 

 

스트림의 종단 연산 중 상당수가 옵셔널을 반환한다. 앞의 max 메서드를 스트림으로 다시 작성한다면 Stream의 max 연산이 비교자를 명시적으로 전달해야 하지만 우리에게 필요한 옵셔널을 생성해줄 것이다.

 

 

 

null을 반환하거나 예외를 던지는 대신 옵셔널 반환을 선택해야 하는 기준

옵셔널은 검사 예외와 취지가 비슷하다. 반환값이 없을 수도 있음을 API 사용자에게 명확히 알려준다.

비검사 예외를 던지거나 null을 반환한다면 API 사용자가 인지하지 못해 끔찍한 결과로 이어질 수 있다.

하지만 검사 예외를 던지면 클라이언트에서는 반드시 이에 대처하는 코드를 작성해넣어야 한다.

비슷하게 메서드가 옵셔널을 반환한다면 클라이언트는 값을 받지 못했을 때 취할 행동을 선택해야 한다.

 

옵셔널 활용

값을 받지 못했을 때 취할 행동

 

  1. 기본값 설정
    String lastWordInLexicon = max(words).orElse("단어 없음...");
  2. 상황에 맞는 예외를 던질 수 있다.
    Toy myToy = max(toys).orElseThrow(TemperTantrumException::new);
    실제 예외가 아니라 예외 팩터리를 건낸 것에 주목하자. 이렇게 하면 예외가 실제로 발생하지 않는 한 예외 생성 비용은 들지 않는다.

  3. 항상 값이 채워져 있다고 가정한다.
    Element lastNobleGas = max(elements.NOBLE_GASES).get();
    옵셔널에 항상 값이 채워져 있다고 확신한다면 그냥 곧바로 값을 꺼내 사용하는 선택지도 있다. 다만 잘못 판단한 것이라면 NoSuchElementException이 발생한다.

  4. 기본값을 설정하는 비용이 클 경우
    public static String orElseGetBenchmark() {
	return Optional.of("fruit").orElseGet(() - > getRandomName());
}
    Supplier<T>를 인수로 받는 orElseGet을 사용하면 값이 처음 필요할 때 Supplier<T>를 사용해 생성하므로 초기 설정 비용을 낮출 수 있다.

  5. 더 특별한 쓰임에 대비한 메서드도 준비되어 있다. 바로 filter, map, flatMap, ifPresent다. 앞서 기본 메서드로 처리하기 어려워 보인다면 API 문서를 참조해 이 고급 메서드들이 문제를 해결해줄 수 있을지 검토해보자

  6. isPresent 메서드
    안전 밸브 역할의 메서드로 옵셔널이 채워져 있으면 true를, 비어 있으면 false를 반환한다.
    실제 isPresent를 쓴 코드 중 상당수는 앞서 언급한 메서드들로 대체할 수 있으며, 더 짧고 명확하고 용법에 맞는 코드가 된다.

    스트림을 사용한다면 옵셔널들을 Stream<Optional<T>>로 받아서, 그중 채워진 옵셔널들에서 값을 뽑아 Stream<T>에 건네 담아 처리하는 경우가 드물지 않다.
    자바 8에서는 옵셔널에 값이 있다면(Optional::isPresent) 그 값을 꺼내(Optional::get) 스트림에 매핑한다.
    StreamOfOptionals.filter(Optional::isPresent).map(Optional::get)

    자바 9에서는 Optional에 stream() 메서드가 추가되었다. 이 메서드는 Optional을 Stream으로 변환해주는 어댑터다. 옵셔널에 값이 있으면 그 값을 원소로 담은 스트림으로, 값이 없다면 스트림으로 변환한다. 이를 Stream의 flatMap 메서드와 조합하면 앞의 코드를 명료하게 바꿀 수 있다.
    streamOfOptionals.flatMap(Optional::stream)

 

 

옵셔널을 사용하면 안되는 경우

  • 컬렉션, 스트림, 배열, 옵셔널 같은 컨테이너 타입은 옵셔널로 감싸면 안 된다.
    빈 Optional<List<T>>를 반환하기 보다 빈 List<T>를 반환하는게 좋다.
  • Optional도 엄연히 새로 할당하고 초기화해야 하는 객체이고, 그 안에서 값을 꺼내려면 메서드를 호출해야하니 한 단계를 더 거치는 셈이다. 성능이 중요한 상황에서는 옵셔널이 맞지 않을 수 있다.
  • 박싱된 기본 타입을 담은 옵셔널은 기본 타입 자체보다 무거울 수밖에 없다. 박싱된 기본 타입을 담은 옵셔널을 반환하는 일이 없도록 하자. (Boolean, Byte, Character, Short, Float 예외일 수 있다.)
  • 옵셔널을 맵의 값으로 사용하면 절대 안 된다. 맵 안에 키가 없다고 나타내는 방법 두가지 중 하나는 키 자체가 없는경우, 다른 하나는 키는 있지만 그 키가 속이 빈 옵셔널인 경우다. 쓸데없이 복잡성만 높여서 혼란과 오류 가능성을 키울뿐이다. 옵셔널을 컬렉션의 키, 값, 원소나 배열의 원소로 사용하는게 적절한 상황은 거의 없다.

 

옵셔널을 사용하면 좋은 경우

  • 결과가 없을 수 있으며 클라이언트가 이 상황을 특별하게 처리해야 한다면 Optional<T>를 반환한다.

 

핵심 정리

값을 반환하지 못할 가능성이 있고, 호출할 때마다 반환값이 없을 가능성을 염두에 둬야 하는 메서드라면 옵셔널을 반환해야 할 상황일 수 있다. 하지만 옵셔널 반환에는 성능 저하가 뒤따르니, 성능에 민감한 메서드라면 null을 반환하거나 예외를 던지는 편이 나을 수 있다. 그리고 옵셔널을 반환값 이외의 용도로 쓰는 경우는 매우 드물다.

 

 

참고

https://codingwell.tistory.com/137

 

저작자표시 비영리 변경금지