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

[youngkimi]

Chapter : 8. 메서드

Item : 51. 메서드 시그니처를 신중히 설계하라

Assignee : youngkimi

---

🍑 서론

🍑 본론

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

• 항상 표준 명명 규칙(item 68)을 따르자.
  • 이해할 수 있게 짓자.
  • 같은 패키지에 속한 다른 메서드 이름과 일관되게 짓자.
• 긴 이름은 피하자
  • FactoryBuilderAdapterDelegateImpl
  • 애매하면 자바 라이브러리의 API 가이드를 참조하라. 대부분은 납득할만 하다.

    2. 편의 메서드를 남발하지 말라.

• 클래스에 메서드를 너무 많이 만들면 사용, 테스트, 유지보수가 어렵다.
• 자주 쓰이는 경우에만 별도의 약칭 메서드를 두어라.

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

• 4개 이하가 좋다. 4개를 넘어가면 기억하기 쉽지 않다.
• 같은 타입의 매개변수가 연달아 나오는 경우가 특히 해롭다.
• 사용자가 매개변수 순서를 잘못 넣어도, 그대로 실행된다.
• 의도와 다르게 동작할 뿐이다.

해결책

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

• 쪼개진 메서드가 필요 메서드의 부분 집합을 받게 해라.
• 메서드가 많아질 수 있으나, 직교성(Orthogonality)을 높여 메서드가 줄어드는 효과도 있다.
• java.util.List 인터페이스를 보자.
  • 리스트에서 주어진 원소의 인덱스를 찾는데, 전체가 아니고 부분 리스트에서의 인덱스를 찾는 예시
  • 이를 하나의 메서드로 구현하려면 부분 리스트의 시작, 끝, 찾고자 하는 원소 3개의 매개변수라 필요하다.
  • 하지만 List의 subList() 메서드와 indexOf()를 사용하면 된다.

    직교성(Orthogonality)이 높다

    • 직교성이란 서로 직각을 이루며 교차한다는 뜻.
    • 두 벡터의 내적이 0이듯이, 서로 영향을 주는 성분이 없다는 이야기이다.
    • 소프트웨어에서 직교성이 높다란, 공통점이 있는 부분 없이 기능이 잘 분리되어 있다.를 의미한다.
    • 본문의 부분 리스트에서 인덱스 구하기를 살펴보자.
    • 부분 리스트를 구하는 과정과, 원하는 원소의 인덱스를 구하는 과정은 관련이 없다.
    • 따라서 이를 개별 메서드로 제공해야 직교성이 높다고 할 수 있다.
    • 직교성이 메서드의 개수를 오히려 줄여준다고 주장하는 이유는 무엇일까?
    • 고수준의 기능마다 개별적으로 메서드를 작성하는 상황을 생각해보자. 독립적이고 원자적인 메서드를 구현하여 이를 조합하는 것이 고수준의 메서드를 여러 번 작성하는 것보다 메서드 수도 적고, 중복이 줄고, 결합성이 낮아질 것이기 때문이다.
    • 이는 가볍고, 구현하기 쉽고, 유연하고, 강력하다.
    • 직교성은 소프트웨어 전반에 사용할 수 있는 용어이다.
    • Micro-Service는 Monolithic보다 직교성이 높을까 낮을까?
    • 물론 대체적인 경향성임을 잊지 말라 ...

2. 매개변수 여러 개를 받는 도우미 클래스를 만들어라.

• 일반적으로 이런 도우미 클래스는 정적 멤버 클래스로 둔다.
• 카드게임을 클래스로 만든다고 해보자.
• 숫자와 무늬, 두 매개변수를 항상 같은 순서로 전달할 것이다.
• 이를 하나의 매개변수로 주고 받으면 API, 클래스 내부 변수 모두 깔끔해질 것이다.

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

• 매개변수가 많은 경우, 특히 그 중 일부를 생략해도 괜찮은 경우 도움이 된다.
• 모든 매개변수를 하나로 추상화한 객체를 정의하고, 클라이언트가 setter를 호출해 필요한 값을 설정하게 하는 것이다.
• 이후 execute 메서드로 매개변수의 유효성을 검사한 후, 원하는 계산을 수행한다.
• 매개변수의 타입으로는 클래스보다는 인터페이스가 더 낫다.
  • 예를 들어 메서드에 HashMap을 넘길 일은 없다. Map을 사용해라.
• boolean 보다는 원소 2개짜리 열거 타입이 낫다.
  • 코드를 읽고 쓰기 더 쉽다. 나중에 선택지를 추가하기도 쉽다.
  • 온도계 예시를 들어보자. 온도계 단위를 주입받는 경우.
    • 섭씨인지 화씨인지 여부를 Enum으로 전달받는게 낫다.
    • boolean isCelcius를 받는다고 생각해봐라.
    • 이후 Kelvin 단위를 추가하고 싶을 때도 용이할 것이다.
    • 온도 단위 변환을 열거 타입 상수에 정의해둘 수도 있다.
  • boolean을 받아야 의미가 명확한 경우 제외

🍑 결론

• 유연하고 확장성 있는 설계를 위해 노력하자.

---

Referenced by

-