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

 

이펙티브 자바 아이템1 요약

정적 팩터리 메서드의 장점은 다음과 같습니다.

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

 

정적 팩터리 메서드의 단점은 다음과 같습니다.

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

 

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

• from : 매개변수를 하나 받아서 해당 타입의 인스턴스를 반환하는 형변환 메서드
  • Date d = Date.from(instant);
• of : 여러 매개변수를 받아 적합한 타입의 인스턴스를 반환하는 집계 메서드
  • Set<Rank> faceCards = EnumSet.of(JACK, QUEEN, KING);
  • List<Integer> numbers = List.of(1, 2, 3);
• 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);
• newType : newInstance 와 같으나, 생성할 클래스가 아닌 다른 클래스에 팩터리 메서드를 정의할 때 쓴다. "Type"은 팩터리 메서드가 반환할 객체의 타입이다.
  • BufferedReader br = Files.newBufferedReader(path);
• type : getType 과 newType 의 간결한 버전
  • List<Complaint> litany = Collections.list(legacyLitany);

 

실제로 적용해보기

아래는 가격 값 객체인 Price 객체입니다.

public record Price(long price) {
    private static final Price EMPTY_PRICE = new Price(0);

    public Price {
        validateNegativePrice(price);
    }

    public static Price empty() {
        return EMPTY_PRICE;
    }

    public static Price from(long price) {
        if (price == 0) {
            return empty();
        }

        return new Price(price);
    }

    private void validateNegativePrice(final long price) {
        if (price < 0) {
            throw GlobalException.from(ErrorMessage.INVALID_PRICE);
        }
    }
    
    ...
}

 

두 개의 정적 팩터리 메서드를 사용했습니다.

empty 메서드와 from 메서드를 작성했습니다.

 

empty 메서드는 미리 생성한 0원 가격을 반환합니다.

두 번째 장점인, 매 번 인스턴스를 새로 생성하지 않고 미리 생성한 객체를 반환한다, 를 실천했습니다.

 

from 메서드는 하나의 기본 long 자료형을 받아 가격 객체로 변환시켜줍니다.

0원인 경우 미리 생성한 0원 가격을 반환합니다.

그 외에 새로운 가격 인스턴스를 생성합니다.

 

record 로 만든 데이터 클래스다 보니 생성자가 public 입니다.

일반 클래스에서 이름이 있는 정적 팩터리 메서드로만 제한하기 위해, 생성자를 private 으로 제한하는 경우도 있습니다.

그러나 여러 정적 팩터리 메서드로 여러 하위타입들을 대신 생성하는 케이스는 아니기에, 따로 생성자 접근에 제한을 두지 않았습니다.

 

from 과 empty 메소드를 생성한 다음, new 키워드로 생성한 코드를 리팩터링했습니다.

// Before
new Price(10_000L)

// After
Price.from(10_000L)

 

언젠가 다른 분의 정적 팩터리 메서드를 봤을 때는 다음과 같았다.

기본 생성자를 private 접근 제한으로 막고, create 정적 팩터리 메서드로 인스턴스를 생성해주는 코드였다.

new 연산자를 해도 새로 인스턴스를 생성한다는 의미가 있어, create 메서드로 생성을 제한하는 이유를 그 때는 크게 와닿지 않았다.

 

이번에 from 메서드를 만들어보면서

new 연산자로 빈 공백으로 클래스명과 떨어져 있는 것과 정적 팩터리 메서드 호출로 붙어 있는 것의 차이를 느꼈다.

한 덩어리로 읽을 수 있어 가독성에 향상되고, 생성한다는 행위에 의도를 알 수 있는 이름을 붙인다는 건 시간 절약에 큰 도움이 된다는 걸 깨달았다.

 

생성할 수 있는 경로가 많아진다면, 정적 팩터리 메서드로 따로 만든 이점이 늘어난다.

생성자에 어떤 매개변수가 들어가는지 직접 코드를 들어가서 안 봐도 된다. 시간 절약 효과가 있다.

이름으로 어느정도 파악이 가능하다보니 가독성에 도움이 된다.

Book effectiveJavaBook = Book.createByIsbn(9788966262281L);
Book otherEffectiveJavaBook = Book.createByTitle("이펙티브 자바 3판");

 

또한 자주 쓰는 컬렉션에서도 from, of, valueOf 등의 메소드명이 많아 익숙하다.

누가 봐도 정적 팩터리 메서드인 메서드를 사용하는 데 전혀 심리적인 거부감이나 알아야 할 메서드가 많다는 부담감은 크지 않을 것 이다.

 

책에서도 정적 팩터리 메서드를 일단 사용해보는 걸 추천한다.

생성 행위에 명백한 이름이 있다는 건, 처음 의도보다 큰 효과를 가져온다.

겉으로 보기에 큰 효과가 없어보여도 사용해 보는 건 어떨까 싶다.