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

■ 상속을 고려한 문서화와 설계

우선 메서드를 재정의하면 어떤 일이 일어나는지를 정확히 정리하여 문서로 남겨야 한다. 즉, 상속용 클래스는 재정의할 수 있는 메서드들을 내부적으로 어떻게 이용하는지(자기사용) 문서로 남겨야한다.

 

클래스의 API로 공개된 메서드에서 클래스 자신의 또 다른 메서드를 호출할 수도 있다.(전 장의 addAll 예시) 그런데 재정의가 가능한 메서드라면 그 사실을 api 명세에 적시해야 한다.

 

API문서의 메서드 설명 끝에서 종종 "Implementation Requiredments"로 시작하는 절을 볼 수 있다. 그 메서드 내부 동작 방식을 설명하는 곳이다. 이 절을 메서드 주석에 @implSpec 태그를 붙여주면 자바독 도구가 생성해준다.

 

public boolean remove(Object o)

주어진 원소가 이 컬렉션 안에 있다면 그 인스턴스를 하나 제거한다(선택적 동의). 더 정확하게 말하면, 이 컬렉션 안에 'Object.equals(o, e)가 참인 원소' e가 하나 이상 있다면 그중 하나를 제거한다. 주어진 원소가 컬렉션 안에 있었다면(즉, 호출 결과 이 컬렉션이 변경됐다면) true를 반환한다.
Implementation Requirements: 이 메서드는 컬렉션을 순회하며 주어진 원소를 찾도록 구현되었다. 주어진 원소를 찾으면 반복자의 remove 메서드를 사용해 컬렉션에서 제거한다. 이 컬렉션이 주어진 객체를 갖고 있으나, 이 컬렉션의 iterator 메서드가 반환한 반복자가 remove 메서드를 구현하지 않았다면 UnsupportedOperationException을 던지니 주의하자.

 

위의 설명에 따르면 iterator 메서드를 재정의하면 remove 메서드의 동작에 영향을 줌을 확실히 알 수 있다. 아이템 18에서 add를 재정의한 것이 addAll에까지 영향을 준다는 사실을 알 수 없었는대 아주 대조적이다.

 

자바 doc 문서를 작성하는 방법은 아래 블로그를 참고하자.

• jaehun2841.github.io/2019/02/24/effective-java-item56/#%EB%AC%B8%EC%84%9C%ED%99%94-%ED%83%9C%EA%B7%B8

인텔리제이에서 javaDoc 문서를 생성하는 방법은 아래 포스팅을 참고하자

• insight-bgh.tistory.com/403

 

■ hook 선별

내부 메커니즘을 문서로 남기는 것만이 상속을 위한 설계의 전부는 아니다. 효율적인 하위 클래스를 큰 어려움 없이 만들기 위해서 클래스의 내부 동작 과정 중간에 끼어들 수 있는 훅을 잘 선별하여 protected 메서드 형태로 공개해야할 수도 있다.

 

위와 같이 AbstractList clear 메서드는 removeRange를 내부에서 호출하고 있다. 이유는 하위 클래스에서 리스트 구현 내부 구조의 이점을 잘 활용하여 removeRange 메서드를 활용한다면 clear 메서드의 성능을 향상 시킬 수 있기 때문이다.

 

이때 유의할 점은 removeRange의 접근 제한자가 protected로 설정되어있다는 것이다. 하위 클래스를 만들 때 전혀 쓰이지 않는 메서드는 private로 만들면 된다. 하위 클래스에서 사용할 일이 있다면 protected로 만들어준다. 상속용으로 설계한 클래슨느 배포 전에 반드시 하위 클래스를 만들어 검증해야 한다.

 

 

■ 상속용 클래스의 생성자는 재정의 가능한 메서드를 호출해서는 안된다.

Super클래스에서 하위 클래스에서 재정의가 가능한 overrideMe 메서드를 호출한다.

public class Super {
    public Super() {
        overrideMe();
    }

    public void overrideMe() {
        System.out.println("super method");
    }
}

Sub 클래스에서 부모 클래스의 overrideMe를 재정의하고 Sub 클래스를 생성하면 상위 클래스의 생성자가 하위 클래스의 생성자보다 먼저 동작하므로 null이 출력된다.

public class Sub extends Super{
    private String str;
    public Sub() {
        str = "Sub String";
    }

    @Override
    public void overrideMe() {
        System.out.println(str);
    }

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

 

■ 상속용으로 설계하지 않은 클래스는 상속을 금지해라

부모 클래스의 내부를 수정했음에도 이를 확장한 자식 클래스에서 문제가 생겼다는 버그 리포트를 받는 일이 드물지 않다. 상속을 금지하는 방법은 다음과 같다.

• 클래스를 final로 선언
• 모든 생성자를 private or package private로 지정

 

다음은 클래스의 동작을 유지하면서 재정의 가능한 메서드를 사용하는 코드를 제거할 수 있는 방법이다. 각각의 재정의 가능한 메서드는 자신의 본문 코드를 private '도우미 메서드'로 옮기고 이 도우미 메서드를 호출하도록 수정 한다. 그런 다음 재정의 가능 메서드를 호출하는 다른 코드들도 모두 이 도우미 메서드를 직접 호출하도록 수정한다.

public class Super {
    public Super() {
        //overrideMe();
    	helperMethod();
    }

    public void overrideMe() {
    	helperMethod();
    }
    
    private void helperMethod() {
    	System.out.println("super method");
    }
}

public class Sub extends Super{
    private String str;
    public Sub() {
        str = "Sub String";
    }

    @Override
    public void overrideMe() {
        System.out.println(str);
    }

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