[Effective Java] 아이템1 생성자 대신 정적 팩토리 메서드를 고려하라

https://book.naver.com/bookdb/book_detail.nhn?bid=14097515 

이펙티브 자바

이 글은 이펙티브 자바 Effective Java를 읽고 희미한 기억을 또렷한 기록으로 바꾸기 위해 작성했습니다

이해가 안 되는 부분은 좀 더 명확하게 알고자 백기선님의 이펙티브 자바 유튜브를 통해 이해했습니다

 

 

들어가기 전에

이 책의 규칙은 명료성과 단순성이다.

• 코드는 복사되는 게 아니라 재사용되어야 한다.
• 컴포넌트 사이의 의존성은 최소로 유지해야 한다.
• 오류는 만들어지자 마자 가능한 한 빨리 잡아야 한다.

생성자 대신 정적 팩토리 메서드를 고려하라

클라이언트가 인스턴스를 얻는 수단

• 전통적인 수단은 public 생성자
• 생성자와 별도로 정적 팩토리 메서드를 제공
  -> 클래스의 인스턴스를 반환하는 단순한 정적 메서드 

이 코드는 boolean 기본 타입의 박싱 클래스인 Boolean에서 발췌한 간단한 예다.

이 메서드는 기본 타입인 boolean을 받아 Boolean객체 참조로 변환해준다.

!!잠시만요!!

!! 디자인 패턴에서의 팩토리 메서드와 다릅니다!!

 

정적 팩토리 메서드의 장점

1. 이름을 가질 수 있다.

이름을 통해 반환될 객체의 특징을 쉽게 표현할 수 있다.

생성자의 시그니처가 중복되는 경우 고려한다! 

public class Delivery {

    private List<OrderItem> orderItems;
    private boolean normal;
    private boolean express;

    public Delivery(List<OrderItem> orderItems, boolean normal) {
        this.orderItems = orderItems;
        this.normal = normal;
    }

    public Delivery(List<OrderItem> orderItems, boolean express) {
        this.orderItems = orderItems;
        this.normal = express;
    }
    
//    //순서를 바꿀 수 있긴 하지만.........
//    public Delivery(boolean express, List<OrderItem> orderItems) {
//        this.orderItems = orderItems;
//        this.normal = express;
//    }


}

이처럼 생성자의 시그니처가 중복되어 컴파일러 에러가 발생한다.

이럴 때 정적 팩토리 메서드의 장점인 이름을 통해 표현할 수 있다.

public class Delivery {

    private List<OrderItem> orderItems;
    private boolean normal;
    private boolean express;
    
    public static Delivery normalDeliver(List<OrderItem> orderItems) {
        Delivery delivery = new Delivery();
        delivery.orderItems = orderItems;
        delivery.normal = true;
        return delivery;
    }

    public static Delivery expressDeliver(List<OrderItem> orderItems) {
        Delivery delivery = new Delivery();
        delivery.orderItems = orderItems;
        delivery.express = true;
        return delivery;
    }

}

이처럼 생성자에서 넘기는 매개변수와 생성자 자체만으로는 반환될 객체의 특성을 제대로 설명하지 못한다.

하지만, 이름만 잘 지으면 반환될 객체의 특성을 쉽게 알 수 있다.

 

2. 호출될 때마다 인스턴스를 새로 생성하지 않아도 된다.

같은 객체가 자주 요청되는 상황이라면 성능을 상당히 끌어올려준다!

이 덕분에 불변 클래스는 인스턴스를 미리 만들어 놓거나

새로 생성한 인스턴스를 캐싱하여 재활용하는 식으로 불필요한 객체 생성을 필요할 수 있다.

대표적인 예인 맨 처음 이미지에 본 것처럼 Boolean.valueOf(Boolean)이다. 

 

그럼 반복되는 요청에 같은 객체를 반환하는 식으로 정적 팩토리 방식의 클래스를 작성해보겠습니다.

public class Theme {

    public boolean dark;

    private Theme() {

    }

    private static final Theme THEME = new Theme();

    public static Theme getInstance() {
        return THEME;
    }

}

생성자를 private로 해서 객체 생성은 팩토리 내부에서 하게 한다.

전통적인 public 생성자로 했을 경우 매번 다른 인스턴스가 만들어진다.

하지만, 정적 팩토리 방식의 클래스는 언제 어느 인스턴스를 살아 있게 할지를 철저히 통제할 수 있다. 

그래서 인스턴스가 동일하게 나타난다.

 

이 책에서는 플라이웨이트 패턴도 이와 비슷한 기법이라고 할 수 있다고 한다.

또한 철저히 통제할 수 있는 클래스를 인스턴스 통제(instance-controlled) 클래스라고 한다. 

 

인스턴스를 통제하는 이유는 아래와 같다.

• 싱글턴 (singleton)
• 인스턴스화 불가(noninstantiable)
• 불변 값 클래스에서 인스턴스가 단 하나뿐임을 보장

 

3. 반환 타입의 하위 타입 객체를 반환할 수 있는 능력이 있다.

public interface HelloService {

    String hello();

    static HelloService of(String lang) {
        if(lang.equals("ko")) {
            return new KoreanHelloService();
        } else {
            return new EnglishHelloService();
        }
    }

}

• 반환할 객체의 클래스를 자유롭게 선택할 수 있는 '엄청난 유연성을 선물한다'
• 인터페이스를 정적 팩토리 메서드의 반환 타입으로 사용하는 인터페이스 기반 프레임워크를 만드는 핵심 기술
• 이 유연성을 응용하면 구현 클래스를 공개하지 않고도 그 객체를 반환할 수 있다.

 

4. 입력 매개변수에 따라 매번 다른 클래스의 객체를 반환할 수 있다

반환 타입의 하위 타입이기만 하면 어떤 클래스의 객체를 반환하든 상관없다!

public static <E extends Enum<E>> EnumSet<E> noneOf(Class<E> elementType) {

    ...
    if (universe.length <= 64)
        return new RegularEnumSet<E>(elementType, universe);
    else
        return new JumboEnumSet<E>(elementType, universe);
}

 

(3번째 예제도 매개변수에 따라 다른 인스턴스의 객체를 반환할 수 있다)

EnumSet클래스는 public 생성자 없이 오직 정적 팩토리만 제공한다.

OpenJDK에서는 원수의 수에 따라 두 가지 하위 클래스 중 하나의 인스턴스를 반환한다!

그래서 클라이언트는 팩토리가 건네주는 객체가 어느 클래스의 인스턴스인지 알 수도 없고, 알 필요도 없다

즉, 반환 타입이 하위 타입이기만 하면 어떤  클래스의 객체를 반환해도 상관없다는 의미!

 

5. 정적 팩토리 메서드를 작성하는 시점에는 반환할 객체의 클래스가 존재하지 않아도 된다.

• 이런 유연함은 서비스 제공자 프레임워크를 만드는 근간이 된다.
• 클라이언트를 구현체로부터 분리해주고 인터페이스만 신경 쓰면 되기 때문에 어떤 구현체가 오든 상관없다! 

이 책에서는 서비스 제공자 프레임워크는 3개의 핵심 컴포넌트로 이뤄진다고 말해준다.

• 구현체의 동작을 정의하는 서비스 인터페이스(service interface)
• 제공자가 구현체를 등록할 때 사용하는 제공자 등록 API (provider registration API)
• 클라이언트가 서비스의 인스턴스를 얻을 때 사용하는 서비스 접근 API (service access API)

이 중 서비스 접근 API가 정적 팩토리 메서드를 작성하는 시점에 원하는 구현체의 조건을 명시할 수 있고,

조건을 명시하지 않으면 기본 구현체를 반환하거나 지원하는 구현체들을 하나씩 돌아가며 반환한다.

이 서비스 접근 API가 바로 서비스 제공자 프레임워크의 근간이라고 한 '유연한 정적 팩토리'의 실체다.

 

그러면 간단한 예로 확인해보겠습니다 

ServiceLoader<ByeService> loader = ServiceLoader.load(ByeService.class);
Optional<ByeService> byeServiceOptional = loader.findFirst();
byeServiceOptional.ifPresent(h -> {
    h.bye();
});

ByeService byeService = new KoreanByeService();

어떤 구현체가 올지 모르겠는 코드와 명확하게 구현체 올지 아는 코드입니다.

이처럼 어떤 구현체가 올지 모르지만 구현체가 따르고 있는 인터페이스 기반 코딩을 하면 될 때이다.

 

대표적인 서비스 제공자 프레임워크로는 JDBC가 있다

예) 어떠한 데이터베이스를 사용할지 모르지만~자바에서 데이터 베이스에 접속할 수 있게 해 줄게!

 

ServiceLoader는 자바 5부터 제공된 범용 서비스 제공자 프레임워크다. 

그래서 프레임워크를 직접 만들 필요가 거의 없어졌지만.. JDBC는 자바 5전에 등장한 개념이라 ServiceLoader를 사용하지 않는다 😂

 

 

정적 메서드의 단점

1. 상속을 하려면 public이나 protected 생성자가 필요하니 정적 팩토리 메서드만 제공하면 하위 클래스를 만들 수 없다.

• 이 제약은 상속보다 컴포지션을 사용하도록 유도하고 불변으로 만들려면 이 제약을 지켜야 한다는 점에서 오히려 장점으로 받아들일 수 있다.

스태틱 정적 메서드도 허용하고 생성자를 허용하는 경우가 있을 수 있다.

대표적인 예로는 List이다. 

List list = new ArrayList<>(); //new도 허용 
List.of("ttt", "222"); //정적 팩터리 메서드

 

2. 정적 팩토리 메서드는 프로그래머가 찾기 어렵다

생성자처럼 API 설명에 명확히 드러나지 않으니 사용자는 정적 팩토리 메서드 방식 클래스를 인스턴스 화할 방법을 알아야 한다.

그러면 어떻게 해야 할까?

• 자바독 API 문서에 잘 써놓는다

/**
 * 이 클래스의 인스턴스는 #getInstance()를 통해 사용된다
 * @see #getInstance()
 */
public class Theme {

    private Theme() {

    }

    private static final Theme THEME = new Theme();

    public static Theme getInstance() {
        return THEME;
    }
}

• 널리 알려진 규약을 따라 짓는 식으로 문제를 완화한다 

다음은 정적 팩토리 메서드에 흔히 사용하는 명명 방식들이다

 

from	매개변수를 하나 받아서 해당 타입의 인스턴스를 반환하는 형변환 메서드 예) Date d = Date.from(instant);
of	여러 매개변수를 받아 적합한 타입의 인스턴스를 반환하는 집계 메서드 예) Set<Rank> faceCards = EnumSet.of(JACK, QUEEN, KING);
valueOf	from과 of의 더 자세한 버전 예) BigInteger prime = BigInteger.valueOf(Integer.MAX_VALUE);
instance 혹은 getInstance	(매개변수를 받는다면) 매개변수로 명시한 인스턴스를 반환하지만, 같은 인스턴스임을 보장하지는 않는다. 예) StackWalker luke = StackWalker.getInstance(options);
create 혹은 newInstance	instance 혹은 getInstance와 같지만, 매번 새로운 인스턴스를 생성해 반환함을 보장한다. 예) Object new Array = Array.newInstance(classObject, arrayLen);
getType	getInstance와 같으나, 생성할 클래스가 아닌 다른 클래스에 팩터리 메서드를 정의할 때 쓴다. "Type"은 팩터리 메서드가 반환할 객체의 타입 예) FileStore fs = Files.getFileStore(path)
newType	newInstance와 같으나, 생성할 클래스가 아닌 다른 클래스에 팩터리 메서드를 정의할 때 쓴다. "Type"은 팩터리 메서드가 반환할 객체의 타입이다. 예) BufferedReader br = Files.newBufferedReader(path);
type	getType과 newType의 간결한 버전 예) List<Complaint> litany = Collections.list(legacyLitany);

 

핵심 정리

정적 팩토리 메서드와 public 생성자는 각자의 쓰임새가 있으니
상대적인 장단점을 이해하고 사용하는 것이 좋다.
그렇다고 하더라도 정적 팩토리를 사용하는 게 유리한 경우가 더 많으므로
무작정 public 생성자를 제공하던 습관이 있다면 고치자