[이펙티브 자바] 아이템 19. 상속을 고려해 설계하고 문서화하라. 그러지 않았다면 상속을 금지하라.

[tonykang22]

아이템 19. 상속을 고려해 설계하고 문서화하라. 그러지 않았다면 상속을 금지하라.

핵심 정리

• 상속용 클래스는 내부 구현을 문서로 남겨야 한다.
  • @implSpec을 사용할 수 있다.
    • 애노테이션은 아니고, Java 8 부터 사용할 수 있는 Javadoc Tag 이다.
  • 좋은 문서는 해당 하는 부분의 역할이 설명되어 있어야 한다.
    • 구현 방식 등에 대한 정보가 문서화되어 있다면 구현이 국한된다.
• 내부 동작 중간에 끼어들 수 있는 훅을 잘 선별하여 protected 메서드로 공개해야 한다.
• 상속용으로 설계한 클래스는 배포 전에 반드시 하위 클래스를 만들어 검증해야 한다.
  • 최소한 3 개를 만들어 볼 것을 권장한다.
  • 외부에서 검증하면 좋다.
    • 작성자가 검증하게 되면 본인의 의도대로만 사용하게 되기 때문이다.
• 상속용 클래스의 생성자는 재정의 가능한 메서드를 호출해서는 안된다.
  • Cloneable(아이템 13)과 Serializable(아이템 86)을 구현할 때 조심해야 한다.
• 상속용으로 설계한 클래스가 아니라면 상속을 금지한다.
  • final 클래스 또는 private 생성자

Javadoc 생성

• @implSpec을 모른다.
  • -tag <name>:<locations>:<header>사용으로 정의해준다.

오류 발생: Tag 정보를 모르기 때문에 발생한 오류

javadoc -d target/apidoc src/main/java/me/whiteship/chapter04/item19/impespec/* -tag "implSpec:a:Implementation Requirements:"

Tag 명시

올바르게 적용됨을 확인

• 상속은 객체 지향의 특징 중 하나.
  • 어떻게 해야 상속을 잘 사용할 수 있을까 에 대한 아이템
• 인터페이스 등의 문서
  • 해당하는 녀석의 역할을 설명하는 것이 좋은 문서
  • 동작 구현에 대한 내용이 있는 것은 좋은 문서는 아니야.

재정의 가능 메서드를 호출하는 생성자

• 재정의 가능한 메서드를 호출하는 Super의 생성자 존재
  • Sub를 보았을 때 아무런 문제가 되지 않는 것으로 보이지만,
  • Sub 생성자 내에서는 이미 super();를 호출하기 때문에 문제 발생
    • 상위 클래스의 생성자가 먼저 호출된다: overrideMe()
    • 하위 클래스에서 이미 재정의됨: null을 콘솔에 찍게 되는 셈

public class Super {
    // 잘못된 예 - 생성자가 재정의 가능 메서드를 호출한다.
    public Super() {
        overrideMe();
    }

    public void overrideMe() {
    }
}

public final class Sub extends Super {
    // 초기화되지 않은 final 필드. 생성자에서 초기화한다.
    private final Instant instant;

    Sub() {
        instant = Instant.now();
    }

    // 재정의 가능 메서드. 상위 클래스의 생성자가 호출한다.
    @Override public void overrideMe() {
        System.out.println(instant);
    }

    public static void main(String[] args) {
        Sub sub = new Sub();
        sub.overrideMe();
    }
}