[EffectiveJava] item51 - 메서드 시그니처를 신중히 설계하라

이번 아이템에서는 API 설계 요령들을 정리한 회차이다. 이 요령들을 잘 활용하면 배우기 쉽고, 쓰기 쉬우며, 오류 가능성이 적은 API를 만들 수 있다.

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

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

그다음 목표는 개발자 커뮤니티에서 널리 받아들여지는 이름을 사용하는 것이다. 긴이름은 피하자. 애매하면 자바 라이브러리의 API 가이드를 참조하라.

자바 라이브러리가 워낙 방대하다 보니 일관적이지 않은 이름도 제법 많지만 대부분은 납득할 만한 수준이다.

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

모든 메서드는 각각 자신의 소임을 다해야 한다.

메서드가 너무 많은 클래스는 익히고, 사용하고, 문서화하고, 테스트하고 유지보수하기 어렵다. 인터페이스도 마찬가지다.

클래스나 인터페이스는 자신의 각 기능을 완벽히 수행하는 메서드로 제공해야 한다. 확신이 서지 않으면 만들지 말자

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

4개 이하가 좋다. 4개가 넘어가면 매개변수를 전부 기억하기가 쉽지 않다.

같은 타입의 매기변수 여러 개가 연달아 나오는 경우가 특히 해롭다. 사용자가 매개변수 순서를 기억하기 어려울뿐더러, 실수로 순서를 바꿔 입력해도 그대로 컴파일 되고 실행된다.
단지 의도와 다르게 동작할 뿐이다.

긴 매개변수 목록을 짧게 줄여주는 세가지 방법을 정리해 보자.

1. 여러 메서드로 쪼갠다.

쪼개진 메서드는 각각은 원래 매개변수 목록의 부분집합을 받는다. 잘못하면 메서드가 너무 만아질 수 있지만, 직교성(orthogonality)을 높여 오히려 메서드 수를 줄여주는 효과도 있다.

java.util.List

지정된 범위의 부분리스트에서의 인덱스를 찾을 경우 “부분리스트의 시작”, “부분리스트의 끝”, “찾을 원소”까지 총 3개의 매개변수가 필요하다.

그런데 List는 그대신 부분리스트를 반환하는 subList 메서드와 주어진 원소의 인덱스를 알려주는 indexOf 메서드를 별개로 제공한다. subList가 반환한 부분리스트 역시 완벼간 List이므로 두 메서ㅗ드를 조합하면 원하는 목적을 이룰 수있다.

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

일반적으로 이런 도우미 클래스는 정적 멤버 클래스(아이템 24)로 둔다. 특히 잇따른 매개변수 몇 개를 독립된 하나의 개념으로 볼 수 있을 때 추천하는 기법이다.

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

3. 객체 생성에 사용한 빌더 패턴을 메소드 호출에 응용하자.

이 기법은 매개변수가 많을 때, 특히 그중 일부는 생략해도 괜찮을 때 도움이 된다.

먼저 모든 매개변수를 하나로 추상화한 객체를 정의하고, 클라이언트에서 이 객체의 세터(setter) 메서드를 호출해 필요한 값을 설정하게 하는 것이다.

이때 각 세터 메서드는 매개변수 하나 혹은 서로 연관된 몇 개만 설정하게 한다. 클라이언트는 먼저 필요한 매개변수를 다 설정한 다음, execute 메서드를 호출해 앞서 설정한 매개변수들의 유효성을 검사한다.

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

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

예를 들어 메서드에 HashMap을 넘길 일은 전혀 없다. 대신 Map을 사용하자. 그러면 HashMap뿐 아니라 TreeMap, ConcurrentHashMap, TreeMap의 부분맵 등 어떤 Map 구현체도 인수로 건넬 수 있다.

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

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

열거 타입을 사용하면 코드를 읽고 쓰기가 더 쉬워진다. 나중에 선택지를 추가하기도 쉽다.

예를 들면 다음은 화씨온도와 섭씨온도를 원소로 정의한 열거 타입이다.

public enum TemperatureScale { FAHRENHEIT, CELSIUS }

확실히 Thermometer.newInstance(true) 보다는 Thermometer.newInstance(TemperatureScale.CELSIUS)가 하는 일을 훤씬 명확히 알려준다.