팩토리 함수 이름짓기

최근에 이펙티브 코틀린(링크)을 재미있게 읽고 있다.

코틀린 기초가 빈약해서 조금 어려운 감은 있지만, 코틀린 외에도 개발 전반에 대한 이야기가 종종 나와 유용하다.

 

읽던 도중, 팩토리 함수에 대한 언급이 나와 정리해본다.

출처: 마르친 모스칼라, 『이펙티브 코틀린』 (인사이트, 2022), 206~211pp. (아이템 33 생성자 대신 팩토리 함수를 사용하라)

팩토리 함수

팩토리 함수는 생성자의 역할을 대신 해주는 함수를 뜻한다.

팩토리 함수를 생성자 대신 사용할 경우, 아래와 같은 장점이 생긴다.

• 생성자와 달리, 이름을 붙여 특별한 객체를 생성하는 경우에 대한 의미를 전달할 수 있다.
• 함수가 원하는 형태의 타입을 리턴할 수 있다.
  • 예를 들어, listOf는 List 인터페이스 중 적절한 클래스(예: ArrayList)를 반환한다.
• 호출할 때마다 새 객체를 만들 필요가 없다.
  • 싱글턴 패턴을 사용할 경우, 호출시 미리 생성된 객체를 반환할 수 있다.
• 아직 존재하지 않는 객체를 반환할 수 있다.
  • 프로젝트 빌드 후 만들어지는 객체를 사용하거나, 프록시를 통해 만들어지는 객체를 사용할 수 있다.
• 객체 외부에 팩토리 함수를 만들어, 가시성을 원하는대로 제어할 수 있다.
  • 코틀린의 경우 탑레벨 함수를 지원하므로, 이러한 방식의 응용이 간편하다.
• 생성자로 만들기 복잡한 객체도 만들 수 있다.

팩토리 함수 이름짓기

팩토리 함수를 활용할 경우 자주 사용하는 이름들이 존재하는데, 정리하면 아래와 같다.

(예시는 kotlin으로 작성되었다)

from: 파라미터를 하나 받고, 같은 타입의 인스턴스 하나를 반환한다.

// from 예시
val date: Date = Date.from(instance)

of: 파라미터를 여러 개 받고, 이를 통합해서 인스턴스를 만들어 준다.

val faceCards: Set<Rank> = EnumSet.of(JACK, QUEEN, KING)

valueOf: from 또는 of와 비슷하면서도, 의미를 조금 더 쉽게 이해하도록 이름을 붙인다.

// valueOf 예시
val prime: BigInteger = BigInteger.valueOf(Integer.MAX_VALUE)

instance 또는 getInstance: 싱글턴으로 인스턴스 하나를 반환한다. 

• 파라미터가 있을 경우, 해당 아규먼트를 기반으로 하는 인스턴스를 리턴한다. 
• 같은 파라미터를 전달하면, 같은 인스턴스를 반환한다.

// instance / getInstance 예시
val luke: StackWalker = StackWalker.getInstance(options)

createInstance 또는 newInstance: getInstance처럼 동작하지만, 싱글턴이 적용되지 않는다.

• 호출할 때마다 새로운 인스턴스를 생성해 반환한다.

// createInstance / newInstance 예시
val newArray = array.newInstance(classObject, arrayLength)

getType: getInstance처럼 동작하지만, 팩토리 함수가 다른 클래스에 있을 때 사용한다.

• 타입은 팩토리 함수에서 리턴하는 타입이다.

// getType 예시
val fs: FileStore = Files.getFileStore(path)

마무리

팩토리 함수는 여러 모로 유용한 디자인 패턴 중 하나이다.

다만 이름을 지을 때마다 어려움이 있었는데, 관습적인 이름을 참고해 어려움을 극복할 수 있었다.

이 글을 보시는 분들도 참조해서 잘 쓰시면 좋을 것 같다.

 

잘못되거나 개선할 내용이 있다면 댓글 부탁드립니다.