API 설계 요령

메소드 이름을 신중히 짓자

  • 이해할 수 있고 같은 패키지에 속한 다른 이름들과 일관되게 짓는게 최우선이다.
  • 개바자 커뮤니티에서 널리 받아들여지는 이름을 사용
  • 긴 이름은 피하라
  • 애매하면 자바 API 가이드를 보자

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

  • 익히고 사용하고 문서화하고 테스트하고 유지보수하기 어렵기 때문이다.
  • 인터페이스도 마찬가지다

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

  • 4개 이하가 좋다.
  • 같은 타입의 매개변수 여러개가 나오는 경우는 해로운 경우다
  • 과하게 긴 매개변수 목록을 짧게 줄이는 방법
    • 여러 메소드로 쪼갠다.
    • 매개변수 여러개를 묶어주는 도우미 클래스를 만들어라
      • 일반적으로 이런 도우미 클래스는 정적 멤버 클래스로 둔다.
    • 객체 생성에 사용한 빌더 패턴을 메소드 호출에 응용하는 방법이다.
      • 매개변수가 많고 일부 생략가능 할때 사용

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

  • 매개변수로 적합한 인터페이스가 있다면 그 인터페이스를 직접 사용하자
    • 예를 들어 메소드에 HashMap을 넘길일은 없다, Map으로 넘기자

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

  • 코드를 읽고 쓰기가 편해지기 때문이다.

+ Recent posts