클래스와 멤버의 접근 권한을 최소화 하자
어설프게 설계된 컴포넌트와 잘 설계된 컴포넌트의 큰 차이는 바로 클래스 내부 데이터와 내부 구현 정보를 외부 컴포넌트로부터 얼마나 잘 숨겼느냐다. 잘 설계된 컴포넌트는 모든 내부 구현을 완벽히 숨겨, 구현과 API를 깔끔히 분리한다. 오직 API를 통해서만 다른 컴포넌트와 소통하며 서로 내부 동작 방식에는 전혀 개의치 않는다. 정보 은닉, 혹은 캡슐화라고 하는 이 개념은 소프트웨어 설계의 근간이 되는 원리다.
정보은닉의 장점
- 시스템 개발 속도를 높인다. 여러 컴포넌트를 병렬로 개발할 수 있기 때문이다.
- 시스템 관리 비용을 낮춘다. 각 컴포넌트를 더 빨리 파악하여 디버깅할 수 있고, 다른 컴포넌트로 교체하는 부담도 적기 때문이다.
- 정보 은닉 자체가 성능을 높여주지는 않지만, 성능 최적화에 도움을 준다. 완성된 시스템을 프로파일링해 최적화할 컴포넌트를 정한 다음 다른 컴포넌트에 영향을 주지 않고 해당 컴포넌트만 최적화할 수 있기 때문이다.
- 소프트웨어 재사용성을 높인다. 외부에 거의 의존하지 않고 독자적으로 동작할 수 있는 컴포넌트라면 그 컴포넌트와 함께 개발되지 않은 낯선 환경에서도 유용하게 쓰일 가능성이 크기 때문이다.
- 큰 시스템을 제작하는 난이도를 낮춰준다. 시스템 전체가 아직 완성되지 않은 상태에서도 개별 컴포넌트의 동작을 검즞ㅇ할 수 있기 때문이다.
방법
기본 원칙은 간단하다. 모든 클래스와 멤버의 접근성을 가능한 한 좁혀야 한다.
클래스
탑 레벨에 있는 클래스와 인터페이스에 부여할 수 있는 접근 수준은 package-private(default)와 public 두 가지다. 탑레벨 클래스나 인터페이스를 public으로 선언하면 공개 API가 되며, package-private으로 선언하면 해당 패키지 안에서만 이용할 수 있다. 패키지 외부에서 쓸 이유가 없다면 package-private으로 선언하자. 그러면 이들은 API가 아닌 내부 구현이 되어 언제든지 수정할 수 있다. 즉 클라이언트에 아무런 피해 없이 다음 릴리스에서 수정,교체,제거할 수 있다. 반면 public으로 선언한다면 API가 되므로 하위 호환을 위해 영원히 관리해줘야 한다.
한 클래스에서만 사용하는 package-private 탑레벨 클래스나 인터페이스는 이를 사용하는 클래스안에 private static으로 중쳡시켜보자. 탑레벨로 두면 같은 패키지의 모든 클래스가 접근할 수 있지만, private static으로 중첩시키면 바깥 클래스 하나에서만 접근할 수 있다. 한편, 이보다 훨씬 중요한 일이 있다. 바로 public 일 필요가 없는 클래스의 접근 수준을 package-private 탑레벨 클래스로 좁히는 일이다. public 클래스는 그 패키지의 API인 반면, packagepirvate 탑레벨 클래스는 내부 구현에 속하기 때문이다.
멤버 변수
클래스의 공개 API를 세심히 설계한 후, 그 외의 모든 멤버는 private으로 만들자. 그런 다음 오직 같은 패키지의 다른 클래스가 접근해야 하는 멤버에 한하여 private 제한자를 제거해 package-private으로 풀어주자. 권한을 풀어주는 일을 자주 하게 된다면 시스템에서 컴포넌트를 더 분해해야 하는 것은 아닌지 고민해보자. private과 package-private 멤버는 모두 해당 클래스의 구현에 해당하므로 보통은 공개 API에 영향을 주지 않는다. 단, Serializable을 구현한 클래스에서는 그 필드들도 의도치 않게 공개 API가 될 수도 있다.
그런데 멤버 접근성을 좁히지 못하게 방해하는 제약이 하나 있다. 상위 클래스의 메서드를 재정의할 때는 그 접근 수준을 상위 클래스에서보다 좁게 설정할 수 없다. 이 제약은 상위 클래스의 인스턴스는 하위 클래스의 인스턴스로 대체해 사용할 수 있어야 한다는 규칙인 리스코프 치환 원칙을 지키기 위해 필요하다. 이 규칙을 어기면 하위 클래스를 컴파일 할 때 컴파일 오류가 난다. 클래스가 인터페이스를 구현하는 건 이 규칙의 특별한 예로 볼 수 있고, 이 때 클래스는 인터페이스가 정의한 모든 메서드를 public으로 선언해야 한다.
테스트
단지 코드를 테스트하려는 목적으로 클래스, 인터페이스, 멤버의 접근 범위를 넓히려고 할 때가 있다. 적당한 수준까지는 넓혀도 괜찮다. 예를 들어, public 클래스의 멤버를 package-private 까지 풀어주는 것은 허용할 수 있지만, 그 이상은 안 된다. 즉 테스트만을 위해 클래스, 인터페이스, 멤버를 공개 API로 만들어서는 안 된다.
인스턴스 필드
public 클래스의 인스턴스 필드는 되도록 public이 아니어야 한다. 필드가 가변 객체를 참조하거나, final이 아닌 인스턴스 필드를 public으로 선언하면 그 필드에 담을 수 있는 값을 제한할 힘을 잃게 된다. 그 필드와 관련된 모든 것은 불변식을 보장할 수 없게 된다는 뜻이다. 여기에 더해, 필드가 수정될 때 lock 흭득 같은 다른 작업을 할 수 없게 되므로 public 가변 필드를 갖는 클래스는 일반적으로 스레드 안전하지 않다. 심지어 필드가 final 이면서 불변 객체를 참조하더라도 문제는 여전히 남는다. 내부 구현을 바꾸고 싶어도 그 public 필드를 없애는 방식으로는 리팩터링할 수 없게 된다.
클래스 필드 , 정적 필드
이러한 문제는 정적 필드에서도 마찬가지이나, 예외가 하나 있다. 해당 클래스가 표현하는 추상 개념을 완성하는데 꼳 필요한 구성요소로써의 상수라면 public static final 필드를 공개해도 좋다. 이런 필드는 반드시 기본 타입 값이나 불변 객체를 참조해야 한다. 가변 객체를 참조한다면 final이 아닌 필드에 적용되는 모든 불이익이 그대로 적용된다. 다른 객체를 참조하지는 못하지만, 참조된 객체 자체는 수정될 수 있으니 끔찍한 결과를 초래할 수도 있다.
멤버 필드 , 인스턴스 필드
Class A { //멤버 필드 : 인스턴스 필드 + static 필드 int a; // 인스턴스 필드 , non-static한 필드들 static int b; //static 필드 , 클래스 필드 }
final을 붙여준다고 불변하다는게 보장되는 것일까?
배열에 final을 붙인 VALUES 변수
// 보안 허점이 숨어 있다.
public static final Thing[] VALUES = {...};
위에 코드는 보안 허점이 존재한다. 당연히 개발자는 final이 붙었으니 VALUES는 절대 변경되지 않을거라고 생각하지만, 사실은 변한다.
VALUES[0] = new Thing();
이렇게 하게 되면 VALUES의 0번째 값이 변경이 된다.
해결책은 다음과 같다.
방법 1) public 배열을 private으로 만들고 public 불변 리스트 추가하기
private static final Thing[] PRIVATE_VALUES = {...};
public static final List<Thing> VALUES =
Collections.unmodifiableList(Arrays.asList(PRIVATE_VALUES));
방법 2) 배열을 private으로 만들고 그 복사본을 반환하는 public 메서드를 추가
private static final Thing[] PRIVATE_VALUES = {...};
public static final Thing[] values() {
return PRIVATE_VALUES.clone();
}
정리
프로그램 요소의 접근성은 가능한 한 최소한으로 하라. 꼭 필요한 것만 골라 최소한의 public API를 설계하자. 그 외에는 클래스, 인터페이스, 멤버가 의도치 않게 API로 공개되는 일이 없도록 해야 한다. public 클래스는 상수용 public static final 필드 외에는 어떠한 public 필드도 가져서는 안 된다. public static final 필드가 참조하는 객체가 불변인지 확인하라.