[Effective-Java] Chapter5 #30. 이왕이면 제네릭 메서드로 만들라

✒️ 핵심 정리

제네릭 타입과 마찬가지로, 클라이언트에서 입력 매개변수와 반환값을 명시적으로 형변환해야 하는 메서드보다 제네릭 메서드가 더 안전하며 사용하기도 쉽다.
타입과 마찬가지로 메서드도 형변환 없이 사용할 수 있는 편이 좋다. 그럴려면 제네릭 메서드가 되어야 한다.

[Java] 제네릭 메소드(Generic Method)란?

내가 참고하려고 복붙

 

📌 제네릭 메서드 작성법

클래스와 마찬가지로, 메서드도 제네릭으로 만들 수 있다.

대표적인 예로 매개변수를 받는 정적 유틸리티 메서드(Collections의 알고리즘 메서드 binarySearch, sort 등)이 보통 제네릭 메서드에 속한다.

public static <T extends Comparable<? super T>> void sort(List<T> list) {
    list.sort(null);
}

public static <T> int binarySearch(List<? extends Comparable<? super T>> list, T key) {
    if (list instanceof RandomAccess || list.size()<BINARYSEARCH_THRESHOLD)
        return Collections.indexedBinarySearch(list, key);
    else
        return Collections.iteratorBinarySearch(list, key);
}

 

1️⃣ As-is

다음은 두 집합의 합집합을 반환하는 메서드이다.

public static Set union(Set s1, Set s2) {
    Set result = new HashSet(s1);
    result.addAll(s2);
    return result;
}

컴파일은 되지만 2, 4번 째 줄에서 경고가 발생한다.

 

 

2️⃣ To-be

어떻게 고쳐야 하는가?

• 메서드 선언에서의 세 집합(입력 2개, 반환 1개)의 원소 타입을 타입 매개변수로 명시한다.
• 메서드 안에서 이 타입 매개변수만 사용하게 수정하면 된다.
• 타입 매개변수의 명명 규칙은 제네릭 메서드나 제네릭 타입이나 똑같다.

(타입 매개변수들을 선언하는) 타입 매개변수 목록은 메서드의 제한자와 반환 타입 사이에 온다.

public static <E> set<E> union(Set<E> s1, Set<E> s2) {
    Set<E> result = new HashSet<>(s1);
    result.addAll(s2);
    return result;
}

위 코드는 3개의 Set이 모두 타입이 같아야 한다.

아이템 31에서 설명한 한정적 와일드 카드 타입을 사용하면 더 유연하게 만들 수도 있다.

 

정리하자면, 제네릭 메서드의 정의는 다음과 같이 하면된다.

public static <T> Foo<T> getFoo(T o) { ... }

 

📌 제네릭 싱글턴 메서드

• 때때로 불변 객체를 여러 타입으로 활용할 수 있게 만들어야 할 때가 있다.
• 제네릭은 런타임에 타입 정보가 소거(Item 28)되므로 하나의 객체를 어떤 타입으로든 매개변수화 할 수 있어야 한다.
  • 요청한 타입 매개변수에 맞게 매번 그 객체의 타입을 바꿔주는 정적 팩터리를 만들어야 한다.
• Collections.reverseOrder 같은 함수 객체(Item 42)나 이따금 Collections.emptySet 같은 컬렉션용으로 사용한다.

 

💻 항등 함수 (identity function) 만들기

 

가장 쉬운 방법은 Function.identity(Item 59)를 사용하면 되지만, 직접 구현해보자.

항등함수 객체는 상태가 없으니 요청할 때마다 새로 생성하는 것은 낭비다. 싱글턴으로 만드는 것이 좋다.

자바의 제네릭이 실체화된다면 항등 함수를 타입 별로 만들어야 하지만, 소거가 되므로 제네릭 싱글턴 하나면 충분하다.

public static UnaryOperator<Object> IDENTITY_FN = (t) -> t;

@SuppressWarnings("unchecked") // 비검사 형변환 경고 방지
public static <T> UnaryOperator<T> identiyFunction() {
    return (UnaryOperator<T>) IDENTITY_FN;

• IDENTITY_FN을 UnaryOperator<T>로 형변환하면 비검사 형변환 경고가 발생한다.
  • T가 어떤 타입이든 UnaryOperator<Object>는 UnaryOperator<T>가 아니기 때문 
• 하지만 항등함수 특성 상, T가 어떤 타입이든 UnaryOperator<T>를 사용해도 type-safe하다.
  • 입력 값을 수정하지 않고 그대로 반환하기 때문
• 메서드가 내보내는 비검사 형변환 경고는 숨겨도 된다.

 

📌 재귀적 타입 한정 (recursive type bound)

드문 경우지만, 자기 자신이 들어간 표현식을 사용하여 타입 매개변수의 허용 범위를 한정할 수도 있다.

이는 주로 타입의 자연적 순서를 정하는 Comparable 인터페이스와 같이 사용된다.

public interface Comparable<T> {
    int compareTo(T o);
}

• 실제로 거의 모든 타입은 자신과 같은 타입의 원소와만 비교할 수 있다.
  • String은 Comparable<String>, Integer는 Comparable<Integer>를 구현하는 식
• Comparable을 구현한 원소의 컬렉션을 입력받는 메서드들은 주로 그 원소들의 정렬, 검색, 최솟값/최댓값 구하는 식으로 사용한다.
  • 이 기능을 수행하려면 컬렉션에 담긴 모든 원소가 상호 비교될 수 있어야 한다.

public static <E extends Comparable<E>> E max(Collection<E> c);

위 제약을 코드로 표현한 재귀적 타입 한정 스니펫이다.

타입 한정인 <E extends Comparable<E>>는 "모든 타입 E는 자신과 비교할 수 있다"라고 읽을 수 있다.

상소 비교 가능하다는 뜻을 아주 정확하게 표현했다.

 

이를 기반으로 컬렉션 원소의 자연적 순서를 기준으로 최댓값을 계산할 수 있다.

public static <E extends Comparable<E>> Optional<E> max(Collection<E> collection) {
    if (collection.isEmpty())
        return Optional.empty();

    E result = null;

    for (E e : collection)
        if (result == null || e.compareTo(result) > 0)
            result = Objects.requireNonNull(e);

    return Optional.of(result);
}

public static void main(String[] args) {
    List<Integer> list = List.of(2, 14, 5, 11, 3);
    int result = max(list).orElseGet(null);
    System.out.println("result = " + result);
}

✅ 이 메서드에 빈 컬렉션을 건네면 IllegalArgumentException을 던지니, Optional<E>를 반환하도록 고치는 편이 좋다. (Item 55)

재귀적 타입 한정은 훨씬 복잡해질 가능성이 있긴 하나, 다행히 그런 일은 잘 일어나지 않는다.

 

참고로 이 패턴은 Item2의 빌더 패턴에서도 쓰였었다.

public abstract class Allnco {
  public enum ApiType { ADD_ITEM, UPDATE_ITEM, UPDATE_IMAGE, UPDATE_PRC }
  final Set<ApiType> apiTypes;

  abstract static class Builder<T extends Builder<T>> {
    EnumSet<ApiType> apiTypes = EnumSet.noneOf(ApiType.class);

    public T addApiType(ApiType apiType){
      apiTypes.add(Objects.requireNonNull(apiType));
      return self();
    }

    abstract Allnco build();

    // 하위 클래스는 이 메서드를 overriding해 "this"를 반환하도록 구현해야함.
    protected abstract T self();
  }

  Allnco(Builder<?> builder){
    apiTypes = builder.apiTypes.clone();
  }
}