본문 바로가기
이펙티브 자바

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

by 에드박 2021. 4. 17.

클라이언트(API를 호출하는 곳)가 클래스의 인스턴스를 얻는 정통적인 수단은 public 생성자입니다.

 

하지만 모든 프로그래머가 알아야 하는 기법이 하나 더 있습니다.

 

바로 클래스의 생성자와는 별도로 정적 팩터리 메서드(static factory method)를 제공하는 것입니다.

대표적인 정적 팩터리 메서드로 Java 기본 타입의 박싱 클래스(boxed class) 에서 기본 타입을 인자로 받아서 박싱 클래스를 생성해주는 클래스가 있습니다.

예를들어 다음과 같은 박싱 클래스의 valueOf() 메서드가 있습니다.

  • Boolean.valueOf(true);
  • Integer.valueOf(1);
  • Double.valueOf(3.0d);
  • Character.valueOf('a');
  • String.valueOf(10);

 

즉, 정적 팩터리 메서드는 public 생성자가 아닌 메서드를 사용해서 객체의 인스턴스를 제공해줍니다.

다음은 박싱 클래스가 아닌 일반 클래스에서의 예제입니다.

 


정적 팩터리 메서드의 장점과 단점

 

클래스는 클라이언트에 public 생성자 대신 (혹은 생성자와 함께) 정적 팩터리 메서드를 제공할 수 있습니다.

하지만 정적 팩터리 메서드 방식에도 장점과 단점이 존재합니다.

 

장점

  1. 이름을 가질 수 있다.
  2. 호출될 때마다 인스턴스를 새로 생성하지는 않아도 된다.
  3. 반환 타입의 하위 타입 객체를 반환할 수 있는 능력이 있다.
  4. 입력 매개변수에 따라 매번 다른 클래스의 객체를 반환할 수 있다.
  5. 정적 팩터리 메서드를 작성하는 시점에는 반환할 객체의 클래스가 존재하지 않아도 된다.

단점

  1. 상속을 하려면 public이나 protected 생성자가 필요하니 정적 팩터리 메서드만 제공하면 하위 클래스를 만들 수 없다.
  2. 정적 팩터리 메서드는 프로그래머가 찾기 어렵다.

정적 팩터리 메서드의 장점

첫번째. 생성자가 이름을 가질 수 있다.

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

 

반면 정적 팩터리는 이름만 잘 지으면 반환될 객체의 특성을 쉽게 설명할 수 있습니다.

 

new BigInteger(int, int, Random)BigInteger.probablePrime(int, int, Random) 둘 중 어느 쪽이 '값이 소수인 BigInteger를 반환한다' 라는 의미를 잘 설명하는지 생각해보면 정적 팩토리 메서드가 가지는 이름의 장점을 느낄 수 있습니다.

 

또한 하나의 시그니쳐로는 하나의 생성자만 만들 수 있습니다.

(인자의 순서를 바꿔서 이런 제한을 풀어볼 수 있지만 좋지 않은 방법입니다. API를 사용하는 개발자가 각 생성자의 역할을 정확히 기억하기 어려워서 이상한 생성자를 호출하는 실수를 할 수 있습니다.)

public MyClass(String name) { this.name = name; }

 

이름을 가질 수 있는 정적 팩터리 메서드에는 이런 제약이 없습니다. (메서드 이름이 다르면 시그니쳐가 다르기 때문에)

한 클래스에 여러개의 생성자가 필요하다면 생성자를 정적 팩터리 메서드로 바꾸고 각각의 차이를 잘 드러내는 이름을 지어주는 것이 좋습니다.

 

만약 인자를 그대로 필드에 저장하는 생성자라면 정적 팩터리 메서드의 장점은 취할 수 없습니다.
인자를 그대로 필드에 저장하는 생성자라면 기본적은 public 생성자를 사용하는 것이 더욱 좋습니다.
class Student {
    
    private String name;
    private String className;

    public Student(String name, String className) {
        this.name = name;
        this.className = className;
    }
}

 

두 번째, 호출될 때마다 인스턴스를 새로 생성하지는 않아도 된다.

 

인스턴스를 미리 만들어 놓거나 새로 생성한 인스턴스를 캐싱하여 재활용 하는 식으로 불필요한 객체 생성을 피할 수 있습니다.

아래는 Person 클래스의 인스턴스를 미리 만들어 놓고 getInstance() 를 호출하면 미리 만들어둔 Person 인스턴스 INSTANCE 를 반환해줍니다.

public class StaticFactoryMethodEx3 {

    public static void main(String[] args) {
        Person person = Person.getInstance();
        System.out.println(person.name());
    }
}

class Person {
    private static final Person INSTANCE = new Person("항상 있어야하는 사람");

    private String name;

    private Person(String name) {
        this.name = name;
    }

    public static Person getInstance() {
        return INSTANCE;
    }

    public String name() {
        return this.name;
    }

 

따라서 같은(상태를 가진) 객체가 자주 요청되는 상황이라면 성능을 상당히 끌여올려 줍니다.

반복되는 요청에 같은 객체(이미 만들어진 객체)를 반환하는 식으로 정적 팩터리 방식의 클래스는 언제 어느 인스턴스를 살아 있게 할지를 철저히 통제할 수 있습니다. 이런 클래스를 인스턴스 통제(instance-controlled) 클래스 라고 합니다.

 

인스턴스를 통제하는 이유?

인스턴스를 통제하면 클래스를 싱글턴(singleton, item3) 으로 만들 수도, 인스턴스화 불가(noninstance, item4)로 만들 수도 있다.
또한 불변 값 클래스(immutable class, item17)에서 동치인 인스턴스가 단 하나뿐임을 보장할 수 있습니다.(a == b 일 때만 a.equals(b)가 성립)

인스턴스 통제는 플라이웨이트 패턴[Gamma 95]의 근간이 되며 열거 타입(item34)은 인스턴스가 하나만 만들어짐을 보장합니다.

 

세번째, 반환 타입의 하위 타입 객체를 반환할 수 있는 능력이 있다.

 

이 장점은 반환(return)할 객체의 클래스를 자유롭게 선택할 수 있게하는 '엄청난 유연성'을 말합니다.

 

API를 만들 때 이런 유연성을 응용하면 구현 클래스를 공개하지 않고도 그 객체를 반환할 수 있어 API를 작게 유지할 수 있습니다.

자바 8 전에는 인터페이스에 static 메서드를 선언할 수 없었습니다. 그렇기 때문에 이름이 "Type"인 인터페이스를 반환하는 정적 팩터리 메서드가 필요하면, "Types"라는 (인스턴스화 불가인) 동반 클래스(companion class)를 만들어 그 안에 정의하는 것이 관례였습니다.

 

자바 컬렉션 프레임워크는 45개의 유틸리티 구현체를 제공했습니다. 이 구현체 대부분을 단 하나의 인스턴스화 불가 클래스인 java.util.Collections 에서 정적 팩터리 메서드를 통해 얻도록 했습니다.

 

컬렉션 프레임워크는 이 45개 클래스를 공개하지 않기 때문에 API외견을 훨씬 작게 만들 수 있었습니다.

API가 작아진것은 물론 개념적인 무게, 즉 프로그래머가 API를 사용하기 위해 익혀야하는 개념의 수와 난이도도 낮출 수 있었습니다.

 

나아가 정적 팩터리 메서드를 사용하는 클라이언트는 얻은 객체를 (그 구현 클래스가 아닌) 인터페이스만으로 다루게 됩니다.

이것은 일반적으로 좋은 습관입니다.

 

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

대표적으로 Java의 EnumSet 이 있습니다.

 

 

EnumSet 의 정적 팩터리 메서드를 보면 다음과 같은 구현체를 반환합니다.

  • 요소의 개수가 64개 이하면 RegulatEnumSet 의 인스턴스를 반환
  • 요소의 개수가 64개를 초과하면 JumboEnumSet 의 인스턴스를 반환합니다.

이런 경우에 EnumSet을 사용하는 입장에서는 요소의 개수에 따라 어떤 구현체가 적합한지 신경쓰지 않아도 됩니다.

또한, EnumSet 을 유지보수 하는 과정에서 요소의 개수 뿐만 아니라 다른 경우를 대비하는 구현 클래스가 추가된다 해도 내부에 감춰져 있기 때문에 EnumSet을 사용하던 기존의 코드는 전혀 변경이 발생하지 않습니다.

 

다섯 번째. 정적 팩터리 메서드를 작성하는 시점에는 반환할 객체의 클래스가 존재하지 않아도 됩니다.

 

이런 유연함은 서비스 제공자 프레임워크(service provider framework)를 만드는 근간이 됩니다.

대표적인 서비스 제공자 프레임워크로는 JDBC(Java Database Connectivity)가 있습니다.

 

서비스 제공자 프레임워크에서의 제공자(provider)는 서비스의 구현체 입니다.

그리고 이 구현체들은 클라이언트에 제공하는 역할을 프레임워크가 통제하여, 클라이언트를 구현체로부터 분리해줍니다.

 

서비스 제공자 프레임워크는 3개의 핵심 컴포넌트로 이뤄집니다.

  • 구현체의 동작을 정의하는 서비스 인터페이스(service interface)
  • 제공자가 구현체를 등록할 때 사용하는 제공자 등록 API(provider registration API)
  • 클라이언트가 서비스의 인스턴스를 얻을 때 사용하는 서비스 접근 API(service access API)
  • [추가적인 네번째 컴포넌트] 서비스 제공자 인터페이스(service provider interface) => 서비스 인터페이스의 인스턴스를 생성하는 팩터리 객체를 설명

JDBC에서 3개의 핵심 컴포넌트

  • 서비스 인터페이스 -> Connection
  • 제공자 등록 API -> DriverManager.registrationDriver
  • 서비스 접근 API -> DriverManager.getConnection
  • [추가] 서비스 제공자 인터페이스 -> Driver

 

정적 팩터리 메서드의 단점

 

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

이 단점은 상속보다 컴포지션(item18)을 사용하도록 유도하고 불변 타입(item17)으로 만들려면 이 제약을 지켜야한다는 점에서 오히려 장점이 될 수 있습니다.

 

두번째, 정적 팩터리 메서드는 프로그래머가 찾기 어렵다

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

이런 단점을 완화할 방법으로

  • API 문서를 잘 써놓는다.
  • 메서드 이름을 널리 알려진 규약을 따라 짓는 방법을 사용

정적 팩터리 메서드에 흔히 사용하는 명명 방식들

  • from : 매개변수를 하나 받아서 해당 타입의 인스턴스를 반환하는 형변환 메서드
    • 예시) Date d = Date.from(instance);
  • 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 newArray = Array.newInstance(classObject, arrayLen);
  • getType : getInstance와 같으나, 생성할 클래스가 아닌 다른 클래스에 팩터리 메서드를 정의할 때 씁니다. "Type"은 팩터리 메서드가 반환할 객체의 타입입니다.
    • 예시) FileStore fs = Files.getFileStore(path)
  • newTyle : newInstance와 같으나, 생성할 클래스가 아닌 다른 클래스에 팩트리 메서드를 정의할 때 씁니다. "Type"은 팩터리 메서드가 반환할 객체의 타입입니다.
    • 예시) BufferedReader br = Files.newBufferedReader(path);
  • type : getType과 newType의 간결한 버전
    • 예시) List<Complaint> litany = Collections.list(legacyLitany);

댓글