[Effective Java] Item 51. 메서드 시그니처를 신중히 설계하라

API 설계 요령

 

 

메서드 이름을 신중히 짓자.

 

• 표준 명명 규칙을 따라야 한다.
• 이해할 수 있고, 같은 패키지에 속한 다른 이름들과 일관되게 짓는 게 최우선 목표다.
• 긴 이름은 피하자.

 

편의 메서드를 너무 많이 만들지 말자.

 

• 메서드가 너무 많은 클래스는 익히고, 사용하고, 문서화하고, 테스트하고, 유지보수하기 어렵다.
• 인터페이스도 마찬가지다. 메서드가 너무 많으면 이를 구현하는 사람과 사용하는 사람 모두 힘들다.
• 클래스나 인터페이스는 자신의 각 기능을 완벽히 수행하는 메서드로 제공해야 한다.
• 아주 자주 쓰일 경우에만 별도의 약칭 메서드를 두고 확신이 서지 않으면 만들지 말자.

 

매개변수 목록은 짧게 유지하자.

 

• 4개 이하가 좋다. 
• 4개가 넘어가면 매개변수를 전부 기억하기 쉽지 않다. 
• 같은 타입의 매개변수가 여러 개가 연달아 나오는 경우가 특히 해롭다.
• 사용자가 매개변수 순서를 기억하기 어려울뿐더러, 실수로 순서를 바꿔 입력해도 그대로 컴파일되고 실행된다.

 

 

과하게 긴 매개변수 목록을 짧게 줄여주는 기술 3가지

 

 

1. 여러 메서드로 쪼개자

 

• 쪼개진 메서드 각각은 원래 매개변수 목록의 부분집합을 받는다.
• 잘못하면 메서드가 너무 많아질 수 있지만, 직교성을 높여 (공통점이 없는 기능들이 잘 분리되어 있다.) 오히려 메서드 수를 줄여주는 효과도 있다.

 

ex) java.util.List 인터페이스 

리스트에서 주어진 원소의 인덱스를 찾아야 하는데, 전체 리스트가 아니라 지정된 범위의 부분리스트에서의 인덱스를 찾는다고 해보자.
메서드로 구현하려면 부분리스트의 시작, 부분리스트의 끝, 찾을 원소 까지 3개의 매개변수가 필요하다.
하지만 List는 그 대신 부분리스트를 반환하는 subList 메서드와 주어진 원소의 인덱스를 알려주는 indexOf 메서드를 별개로 제공한다.
subList가 반환한 부분리스트 역시 완벽한 List이므로 두 메서드를 조합하면 원하는 목적을 이룰 수 있다.

 

 

2. 매개변수 여러 개를 묶어주는 도우미 클래스를 만들자

 

• 일반적으로 이런 도우미 클래스는 정적 멤버 클래스로 둔다.
• 특히 잇따른 매개변수 몇 개를 독립된 하나의 개념으로 볼 수 있을 때 좋다. 

 

ex)  카드게임을 클래스로 만든다고 해보자.

메서드를 호출할 때 카드의 숫자(rank)와 무늬(suit)를 뜻하는 두 매개변수를 항상 같은 순서로 전달할 해야 한다.
이때 이 둘을 묶는 도우미 클래스를 만들어 하나의 매개변수로 주고받으면 API는 물론 클래스 내부 구현 깔끔해진다.

 

 

3. 앞서의 두 기법을 혼합하자

 

• 객체 생성에 사용한 빌더 패턴을 메서드 호출에 응용한다.
• 매개변수가 많을 때, 특히 그중 일부는 생략해도 괜찮을 때 도움이 된다.

 

ex) 빌더 패턴

1. 모든 매개변수를 하나로 추상화한 객체를 정의하고, 클라이언트에서 이 객체의 setter 메서드를 호출해 필요한 값을 설정하게 한다.
2. 이때 각 setter 메서드는 매개변수 하나 혹은 서로 연관된 몇 개만 설정하게 한다.
3. 클라이언트는 먼저 필요한 매개변수를 다 설정 한다음, execute 메서드를 호출해 앞서 설정한 매개변수들의 유효성을 검사한다.
4. 마지막으로 설정이 완료된 객체를 넘긴다.

 

 

매개변수의 타입으로는 클래스보다는 인터페이스가 더 낫다.

 

매개변수로 적합한 인터페이스가 있다면 이를 구현한 클래스가 아닌 그 인터페이스를 직접 사용하자.

(스프링의 UserService를 구현한 JpaUserService 말고 UserService를 직접 사용하자.)

 

ex) 메서드에 HashMap을 넘기지 말고 Map을 사용하자.

HashMap 뿐 아니라 TreeMap, ConcurrentHashMap, TreeMap의 부분맵 등 어떤 Map 구현체도 인수로 건넬 수 있다.

 

인터페이스 대신 클래스를 사용하면 클라이언트에게 특정 구현체만 사용하도록 제한하는 꼴이며, 혹시라도 입력 데이터가 다른 형태로 존재한다면 명시한 특정 구현체의 객체로 옮겨 담느라 비싼 복사 비용을 치러야 한다.

 

 

boolean 보다는 원소 2개짜리 열거 타입이 낫다.

 

• 메서드 이름상 boolean을 받아야 의미가 더 명확할 때는 예외다.
• 열거 타입을 사용하면 코드를 읽고 쓰기가 더 쉬워진다.
• 나중에 선택지를 추가하기도 쉽다.