item 44 : 표준 함수형 인터페이스를 사용하라

자바에서 람다 지원이 추가되면서 API 작성 방식에도 큰 변화가 생겼다. 특히, 과거의 템플릿 메서드 패턴 대신 함수형 인터페이스를 활용하는 방식이 주목받고 있다.

이로 인해 함수 객체를 매개변수로 받는 생성자와 메서드를 더 많이 작성하게 되었으며, 올바른 함수형 인터페이스 타입을 선택하는 것이 중요해졌다. 즉, 함수형 매개변수 타입을 올바르게 선택해야 한다.

자바의 표준 라이브러리에서는 이미 다양한 용도의 표준 함수형 인터페이스가 제공되고 있으며, 이들을 활용하면 불필요하게 새로운 인터페이스를 작성하지 않고도 필요한 기능을 구현할 수 있다. 특히 java.util.function 패키지에는 함수형 프로그래밍을 지원하기 위해 총 43개의 함수형 인터페이스가 준비되어 있다.

1. 템플릿 메서드 패턴에서 함수형 인터페이스로 전환

과거에는 상위 클래스의 기본 메서드를 재정의하여 동작을 맞춤 설정하는 템플릿 메서드 패턴을 많이 사용했다. 하지만 함수형 인터페이스와 람다를 이용하면 이보다 간결하고 유지보수하기 좋은 API를 만들 수 있다.

아래 예제는 템플릿 메서드 패턴을 사용한 전통적인 방식과 함수형 인터페이스를 활용한 현대적인 방식의 비교이다.

// 템플릿 메서드 패턴 방식
class CustomCache<K, V> extends LinkedHashMap<K, V> {
    @Override
    protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
        return size() > 100;
    }
}

위 코드는 LinkedHashMap을 확장해 removeEldestEntry 메서드를 재정의하여 캐시 기능을 추가한 것이다. 맵에 새로운 키를 추가하는 put 메서드는 이 메서드를 호출하여 true가 반환되면 맵에서 가장 오래된 원소를 제 거한다. 예컨대 removeEldestEntry를 다음처럼 재정의하면 맵에 원소가 100개 가 될 때까지 커지다가, 그 이상이 되면 새로운 키가 더해질 때마다 가장 오래 된 원소를 하나씩 제거한다.

즉, 가장 최근 원소 100개를 유지한다.

잘 동작하지만 람다를 사용하면 훨씬 잘 해낼 수 있다. removeEldestEntry 선언을 보면 이 함수 객체는 Map.Entry<K, V>를 받아 boolean 을 반환해야 할 것 같지만, 꼭 그렇지는 않다.「emoveEldestEntry는 size()를 호 출해 맵 안의 원소 수를 알아내는데, removeEldestEntry가 인스턴스 메서드라서 가능한 방식이다. 하지만 생성자에 넘기는 함수 객체는 이 맵의 인스턴스 메서드가 아니다.

팩터리나 생성자를 호출할 때는 맵의 인스턴스가 존재하지 않기 때문이다. 따라서 맵은 자기 자신도 함수 객체에 건네줘야 한다.

이를 반영하여 함수형 인터페이스로 전환하면 다음과 같이 구현할 수 있다.

// 함수형 인터페이스 BiPredicate를 사용하여 캐시의 동작을 유연하게 설정하는 방식
import java.util.function.BiPredicate;
import java.util.LinkedHashMap;
import java.util.Map;

class CustomCache<K, V> extends LinkedHashMap<K, V> {
    // 제거 기준을 정의하는 BiPredicate 인터페이스를 사용하여 조건을 저장
    private final BiPredicate<Map<K, V>, Map.Entry<K, V>> removalCriteria;

    // 생성자에서 제거 기준을 받음
    public CustomCache(BiPredicate<Map<K, V>, Map.Entry<K, V>> removalCriteria) {
        this.removalCriteria = removalCriteria;
    }

    // LinkedHashMap의 removeEldestEntry 메서드를 재정의하여
    // 설정한 조건에 따라 오래된 항목을 제거할지 결정
    @Override
    protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
        // BiPredicate를 사용하여 조건에 따라 true/false 반환
        return removalCriteria.test(this, eldest);
    }
}

// 사용 예: 캐시 객체 생성
// 캐시 객체를 생성하면서 map의 크기가 100을 초과하면 가장 오래된 항목을 제거하도록 설정
CustomCache<String, String> cache = new CustomCache<>((map, entry) -> map.size() > 100);

1. BiPredicate 사용: BiPredicate<Map<K, V>, Map.Entry<K, V>>를 사용하여 맵과 엔트리를 인수로 받아 boolean 값을 반환하는 조건을 설정한다. 이 조건을 removalCriteria라는 변수에 저장한다.

2. 생성자: CustomCache 클래스의 생성자에서 removalCriteria라는 BiPredicate를 인수로 받아, 캐시의 항목 제거 기준을 설정한다. 이는 동적으로 조건을 지정할 수 있게 한다.

3. removeEldestEntry 메서드: LinkedHashMap의 removeEldestEntry 메서드를 재정의하여, removalCriteria에 따라 오래된 항목을 제거할지 결정한다. 이때 this(맵 자체)와 eldest(가장 오래된 항목)를 인수로 test 메서드를 호출하여 기준을 확인한다.

4. 사용 예: CustomCache 객체를 생성할 때 람다식 (map, entry) -> map.size() > 100을 전달하여, 맵의 크기가 100을 초과할 경우 가장 오래된 항목을 제거하도록 설정한다.

이 코드 구조는 캐시의 항목 제거 기준을 동적으로 설정할 수 있어 유연성을 높이며, 기존 템플릿 메서드 패턴보다 간결하고 모듈화된 방식으로 구현할 수 있게 해준다.

람다를 활용한 이 방식은 더 유연하며, removeEldestEntry를 재정의할 필요 없이 다른 조건으로 쉽게 맞춤 설정할 수 있다.

2. 표준 함수형 인터페이스 활용

자바의 java.util.function 패키지에는 다양한 표준 함수형 인터페이스가 제공되며, 이를 활용하면 API 설계가 단순하고 일관되게 유지된다.

필요한 용도에 맞는 게 있다면, 직접 구현하지 말고 표준 함수형 인터페이스를 활용하라. 그러면 API가 다루는 개념의 수가 줄어들어 익히기 더 쉬워 진다.

예컨대 Predicate 인터페이스는 프레디키트(predicate)들을 조합하는 메서드를 제공한다. 앞의 LinkedHashMap 예에서는 직접 만든 EldestEntryRemovalFunction 대신 표준 인터페이스인 BiPredicate<Map<K,V>, Map.Entry<K,V>를 사용할 수 있다.

1) 주요 표준 함수형 인터페이스

표준 함수형 인터페이스는 크게 다음과 같은 유형이 있다.

기본적으로 자바의 함수형 인터페이스는 다음과 같은 유형으로 나뉩니다. 이 인터페이스들은 객체 참조 타입을 위한 기본 인터페이스들로, 실무에서 자주 활용됩니다.

인터페이스	함수 시그니처	설명	사용 예시
UnaryOperator<T>	T apply(T t)	인수를 하나 받아 같은 타입을 반환합니다.	String::toLowerCase
BinaryOperator<T>	T apply(T t1, T t2)	인수를 두 개 받아 같은 타입을 반환합니다.	BigInteger::add
Predicate<T>	boolean test(T t)	인수를 하나 받아 boolean을 반환합니다.	Collection::isEmpty
Function<T, R>	R apply(T t)	인수와 반환 타입이 다를 때 사용합니다.	Arrays::asList
Supplier<T>	T get()	인수를 받지 않고 값을 반환합니다.	Instant::now
Consumer<T>	void accept(T t)	인수를 하나 받고 반환값이 없습니다.	System.out::println

예시 - Predicate와 BiPredicate 활용

Predicate와 BiPredicate는 조건을 표현하는 데 사용되며, 각각 하나 또는 두 개의 인수를 받아 boolean을 반환한다. 예를 들어, 특정 크기 이상일 때 캐시 항목을 삭제하도록 조건을 설정할 수 있다.

import java.util.LinkedHashMap;
import java.util.Map;
import java.util.function.BiPredicate;

class CustomCache<K, V> extends LinkedHashMap<K, V> {
    private final BiPredicate<Map<K, V>, Map.Entry<K, V>> removalCriteria;

    public CustomCache(BiPredicate<Map<K, V>, Map.Entry<K, V>> removalCriteria) {
        this.removalCriteria = removalCriteria;
    }

    @Override
    protected boolean removeEldestEntry(Map.Entry<K, V> eldest) {
        return removalCriteria.test(this, eldest);
    }
}

// 사용 예: 캐시 크기가 100을 초과하면 오래된 항목 제거
CustomCache<String, String> cache = new CustomCache<>((map, entry) -> map.size() > 100);

위 코드는 BiPredicate를 사용해 특정 크기를 넘을 때 캐시 항목을 제거하도록 설정한 예시이다.

예제

1. Predicate - 조건 검사

   Predicate<String> isEmpty = String::isEmpty;
   System.out.println(isEmpty.test(""));   // true
   System.out.println(isEmpty.test("abc")); // false

2. Function - 타입 변환

   Function<String, Integer> toLength = String::length;
   System.out.println(toLength.apply("Hello")); // 5

3. Supplier - 값 생성

   Supplier<Double> randomSupplier = Math::random;
   System.out.println(randomSupplier.get()); // 0.12345 (임의의 값)

4. Consumer - 값 소비

   Consumer<String> print = System.out::println;
   print.accept("Hello, world!"); // Hello, world!

5. UnaryOperator - 값 변환

   UnaryOperator<String> toLowerCase = String::toLowerCase;
   System.out.println(toLowerCase.apply("HELLO")); // hello

2) 표준 함수형 인터페이스 활용의 이점

기존에는 커스텀 인터페이스를 작성하여 기능을 구현하는 경우가 많았지만, 표준 함수형 인터페이스를 사용하면 다음과 같은 이점을 누릴 수 있다:

• 코드의 간결성: 중복되는 인터페이스 생성을 피할 수 있다.

• API의 일관성: 자바 개발자들이 이미 익숙한 표준 인터페이스를 사용하므로, 새로운 개념을 익힐 필요가 줄어든다.

• 디폴트 메서드의 활용: 표준 인터페이스는 필요한 경우 메서드를 조합하거나 변형할 수 있는 유용한 디폴트 메서드를 제공하여 다른 코드와 쉽게 상호 운용이 가능하다.

예를 들어, Predicate 인터페이스는 조건을 조합할 수 있는 and, or, negate 메서드를 제공하여 복잡한 조건을 간편하게 표현할 수 있다.

3. 기본 타입용 함수형 인터페이스

기본 타입을 위해 java.util.function 패키지에서는 기본 타입용 함수형 인터페이스도 제공한다. 박싱을 피하고 성능을 높이기 위해 기본 타입을 위한 함수형 인터페이스 변형도 제공한다. 예를 들어, IntPredicate, LongFunction, DoubleConsumer 등이다. 기본 타입을 지원하는 인터페이스를 사용하면 박싱 오버헤드를 피할 수 있어 성능이 개선된다.

예제

IntPredicate isEven = x -> x % 2 == 0;
System.out.println(isEven.test(4)); // true
System.out.println(isEven.test(5)); // false

자바 기본 타입을 위한 변형은 다음과 같은 규칙에 따라 네이밍된다.

1. 타입 접두어: Int, Long, Double을 사용하여 기본 타입을 명시

2. 기능: Predicate, Function, Consumer 등 주요 기능을 반영

3. 변형 예시:

   • IntPredicate: boolean test(int value) 형태로 int 타입을 받는다.

   • LongToIntFunction: int applyAsInt(long value) 형태로 long 타입의 인수를 받고 int를 반환한다.

예시 - 기본 타입용 함수형 인터페이스

기본 타입을 사용하여 특정 조건을 검사하는 예제

import java.util.function.IntPredicate;

public class BasicTypePredicateExample {
    public static void main(String[] args) {
        IntPredicate isEven = value -> value % 2 == 0;
        
        System.out.println(isEven.test(4)); // true
        System.out.println(isEven.test(5)); // false
    }
}

위 예제에서는 IntPredicate를 사용하여 숫자가 짝수인지 여부를 검사한다.

4. 직접 작성해야 하는 경우

표준 함수형 인터페이스가 거의 대부분의 경우를 커버하지만, 다음과 같은 경우에는 직접 작성하는 것이 더 나을 수 있다.

• 특정 규약을 따라야 할 경우: 예를 들어, Comparator는 ToIntBiFunction과 구조가 비슷하지만, 비교 기능을 명확히 나타내고 있으며 특정 규약(순서 비교)을 따르도록 설계되어 있다.

• 자주 사용되며 이름만으로 용도가 명확한 경우: 자주 사용되며 명확한 이름을 가지면 코드 가독성이 높아진다.

• 추가적인 디폴트 메서드가 필요한 경우: 인터페이스 내에서 메서드를 조합하거나 변형하는 디폴트 메서드가 필요한 경우가 있다.

예시 - 3개의 매개변수를 받는 함수형 인터페이스

java.util.function 패키지에는 매개변수 3개를 받는 함수형 인터페이스가 없으므로, 직접 작성할 수 있다.

@FunctionalInterface
interface TriFunction<T, U, V, R> {
    R apply(T t, U u, V v);
}

// 사용 예시
TriFunction<Integer, Integer, Integer, Integer> sumThree = (a, b, c) -> a + b + c;
System.out.println(sumThree.apply(1, 2, 3)); // 6

5. 주의사항: 함수형 인터페이스를 다중 정의하지 않기

서로 다른 함수형 인터페이스를 같은 위치의 인수로 받는 메서드를 다중 정의하는 것은 피해야 한다. 예를 들어, ExecutorService의 submit 메서드는 Callable과 Runnable을 다중 정의하는데, 이를 사용할 때 형변환이 필요한 경우가 생긴다. 이는 불필요한 혼란을 초래할 수 있다.

따라서, 같은 위치의 인수로 서로 다른 함수형 인터페이스를 받지 않도록 주의하는 것이 좋다.

이는 API 설계에서 모호함을 줄이고, 사용자가 코드의 의도를 명확하게 이해할 수 있도록 도와준다.

안 좋은 예시

아래는 서로 다른 함수형 인터페이스(Callable과 Runnable)를 같은 위치에서 받도록 다중 정의된 메서드

import java.util.concurrent.Callable;

public class ExecutorServiceExample {
    // Runnable을 인수로 받는 메서드
    public void submit(Runnable task) {
        System.out.println("Runnable version called");
        task.run();
    }

    // Callable을 인수로 받는 메서드
    public <T> T submit(Callable<T> task) throws Exception {
        System.out.println("Callable version called");
        return task.call();
    }

    public static void main(String[] args) throws Exception {
        ExecutorServiceExample service = new ExecutorServiceExample();

        // Runnable을 사용한 경우
        service.submit(() -> System.out.println("Running task..."));

        // Callable을 사용한 경우
        String result = service.submit(() -> {
            System.out.println("Calling task...");
            return "Task result";
        });
        System.out.println("Result: " + result);

        // 혼란을 일으킬 수 있는 모호한 상황
        service.submit((Callable<Void>) () -> {
            System.out.println("Ambiguous task...");
            return null;
        });
    }
}

• submit(Runnable task): Runnable 인터페이스를 받는 submit 메서드이다.

• submit(Callable<T> task): Callable 인터페이스를 받는 제네릭 submit 메서드이다.

• 두 메서드는 모두 같은 이름의 submit 메서드지만, 인수의 타입만 다르게 정의되어 있다.

문제점

이 다중 정의된 메서드는 Runnable과 Callable 중 어떤 것을 호출할지 모호한 경우가 발생할 수 있다. 특히 람다 표현식으로 전달할 때 문제를 일으킬 수 있습니다. Runnable과 Callable은 둘 다 인수가 없으므로 람다식으로는 명확히 구분되지 않는다. 예를 들어, 다음과 같이 호출할 때 문제가 된다.

service.submit(() -> {
    System.out.println("Ambiguous task...");
    return null;
});

위 코드는 Runnable인지 Callable인지 컴파일러가 구분하지 못하여 오류를 발생시킨다. 이를 해결하려면 명시적인 형변환이 필요하다.

service.submit((Callable<Void>) () -> {
    System.out.println("Callable task...");
    return null;
});

명시적 형변환을 통해 Callable이라는 의도를 명확히 했지만, 이는 코드를 더 복잡하게 만들고 실수할 가능성을 높인다.

해결 방법: 함수형 인터페이스 다중 정의를 피하기

이 문제를 피하려면 서로 다른 함수형 인터페이스를 같은 위치의 인수로 받는 다중 정의를 피하는 것이 좋다. 예를 들어, submit 메서드를 하나로 통일하고, Runnable이나 Callable이 필요할 경우 래퍼 메서드로 구분하는 방식이 가능하다.

public class ExecutorServiceExample {
    public <T> T submitTask(Callable<T> task) throws Exception {
        System.out.println("Callable version called");
        return task.call();
    }

    public void submitTask(Runnable task) {
        System.out.println("Runnable version called");
        task.run();
    }

    public static void main(String[] args) throws Exception {
        ExecutorServiceExample service = new ExecutorServiceExample();

        // Runnable로 전달
        service.submitTask(() -> System.out.println("Running task..."));

        // Callable로 전달
        String result = service.submitTask(() -> {
            System.out.println("Calling task...");
            return "Task result";
        });
        System.out.println("Result: " + result);
    }
}

이렇게 메서드 이름을 명확히 나누어 각 메서드가 어떤 인터페이스를 받는지 명확히 하면 혼란을 줄일 수 있다.

핵심 요약

1. 함수형 인터페이스를 통해 람다 표현식을 활용하면 코드가 간결해지고 유연성이 높아진다.

2. 표준 함수형 인터페이스를 적극적으로 활용하고, 필요할 때만 커스텀 인터페이스를 정의하는 것이 좋다.

Predicate, Function, Supplier, Consumer 등의 주요 함수형 인터페이스는 대부분의 경우를 커버할 수 있어, 표준 인터페이스 사용을 우선적으로 고려해야 한다.

1. 커스텀 함수형 인터페이스를 정의할 때는 반드시 따라야 할 규약이나 유용한 디폴트 메서드가 필요한지 고민해보아야 한다.

2. 함수형 인터페이스를 다중 정의하는 것을 피하여 모호함을 방지한다.

3. 자바에서 표준 함수형 인터페이스를 적극 활용하면 불필요한 인터페이스 작성을 줄일 수 있으며, API가 더 일관성 있고 간결해진다.

4. 기본 타입용 인터페이스를 사용하여 성능을 최적화할 수 있습니다. 박싱된 타입 대신 IntPredicate, LongFunction 등 기본 타입을 위한 인터페이스를 사용하는 것이 좋다.

자바에서도 함수형 프로그래밍의 장점을 활용할 수 있으므로, API 설계 시 함수형 인터페이스의 활용을 염두에 두는 것이 좋다.