Study/Effective Java

Item15. 클래스와 멤버의 접근 권한을 최소화하라

voider 2021. 7. 3. 11:50

클래스와 멤버의 접근 권한을 최소화하라

어설프게 설계도니 컴포넌트와 잘 설계된 컴포넌트의 가장 큰 차이는 클래스 내부 데이터와 내부 구현 정보를 외부 컴포넌트로부터 얼마나 잘 숨겼느냐다. 잘 설계된 컴포넌트는 모두 내부 구현을 완벽히 숨겨, 구현과 API를 깔끔히 분리한다. 오직 API를 통해서 다른 컴포넌트와 소통하고 서로의 내부 방식은 전혀 개의치 않는다. 소위 캡슐화라고 부르는 이 개념은 소프트웨어 설계의 근간이 되는 원다.

캡슐화의 장점 중 대부분은 시스템 컴포넌트를 독립적으로 만들어서 개발, 테스트, 최적화, 적용, 분석, 수정을 개별적으로 할 수 있게 하는 것과 연관이 있다.

  • 컴포넌트를 병렬로 개발하는 것이 가능하므로 개발 속도 향상
  • 컴포넌트를 더 빨리 파악하여 디버깅할 수 있고, 다른 컴포넌트로 교체하는 데 부담도 적기 때문에 관리 비용을 낮출 수 있음
  • 캡슐화 자체가 성능을 높이지 않지만, 최적화에 도움을 준다. 완성된 시스템을 프로파일링해 최적화할 컴포넌트를 정한 다음, 다른 컴포넌트에 영향을 주지 않고 해당 컴포넌트만 최적화할 수 있기 때문.
  • 소프트웨어 재사용성을 높인다. 외부에 거의 의존하지 않고 독자적으로 동작할 수 있는 컴포넌트라면 그 컴포넌트와 함께 개발되지 않은 낯선 환경에서도 유용하게 쓰일 가능성이 크기 때문.
  • 큰 시스템을 제작하느 난이도를 낮춘다. 시스템 전체가 아직 완성되지 않은 상태에서 개별 컴포넌트의 동작을 검증할 수 있기 때문. 한 클래스에서만 사용하는 package-private은 톱 레벨 클래스나 인터페이스는 이를 사용하는 클래스 안에 private static으로 중첩시켜보자. 톱 레벨로 두면 같은 패키지의 모든 클래스가 접근할 수 있지만, private static으로 중첩시키면 바깥 클래스 하나에서만 접근할 수 있다. 한편 이보다 훨씬 중요한 일은 바로 public일 필요가 없는 클래스의 접근 수준을 package-private 톱 레벨 클래스로 좁히는 일이다. public 클래스는 그 패키지의 API인 반면, package-private 톱 레벨 클래스는 내부 구현에 속하기 때문이다.
  • 모든 클래스/멤버의 접근성을 가능한 한 좁혀야 한다는 것이 캡슐화의 기본 원칙이다. 톱레벨 클래스와 인터페이스에 부여할 수 있는 접근 수준은 package-privatepublic 두 가지다. 톱레벨 클래스나 인터페이스를 public으로 선언하면 공개 API가 되고, package-private으로 선언하면 해당 패키지 내에서만 사용할 수 있다. 외부에서 쓸 이유가 없다면 package-private으로 선언해야 한다. 그러면 이들은 API가 아닌 내부 구현이 되어 언제든 수정할 수 있다. 즉, 클라이언트에 아무런 피해 없이 다음 릴리스에서 수정, 교체, 제거할 수 있다. 반면 public이라면 API가 되므로 하위 호환을 위해 영원히 관리해야 한다.

멤버(필드, 메서드, 중첩 클래스, 중첩 인터페이스)에 부여할 수 있는 접근 수준은 네 가지다. 접근 범위가 좁은 것부터 순서대로 살펴본다.

  1. private: 멤버를 선언한 톱레벨 클래스에서만 접근할 수 있다.
  2. package-private: 멤버가 소속된 패키지 안의 모든 클래스에서 접근할 수 있다. 접근 제한자를 명시하지 않았을 때 적용되는 패키지 접근 수준이다.(인터페이스는 기본이 public)
  3. protected: package-private의 접근 범위를 포함하며, 이 멤버를 선언한 클래스의 하위 클래스에서도 접근할 수 있다.
  4. public: 모든 곳

클래스의 공개 API를 세심히 설계한 후, 그 외의 모든 멤버는 private으로 만든다. 그 다음, 오직 같은 패키지의 다른 클래스가 접근해야 하는 멤버에 한하여 package-private으로 제한을 완화한다. 권한을 푸는 일이 잦다면 컴포넌트를 더 분해해야 하는 것은 아닌지 고민해 볼 필요가 있다. private과 pacakge-private 멤버는 모두 해당 클래스의 구현에 해당하므로, 보통은 공개 API에 영향을 주지 않는다. 단, Serializable을 구현한 클래스에서는 그 필드들도 의도치 않게 공개 API가 될 수도 있다.

public 클래스에서는 멤버의 접근 수준을 package-private에서 protected로 바꾸는 순간 그 멤버에 접근할 수 있는 대상 범위가 넓어진다. public클래스의 protected 멤버는 공개 API이므로 영원히 지원되어야 한다. 또한 내부 동작 방식을 문서로 공개해야 할 수도 있다. 따라서 protected는 적을수록 좋다.

멤버 접근성을 좁히지 못하는 제약이 하나 있다. 상위 클래스의 메서드를 재정의할 때는 그 접근 수준을 상위 클래스보다 좁게 설정할 수 없다. 이 제약은 상위 클래스의 인스턴스는 하위 클래스의 인스턴스로 대체해 사용할 수 있어야 한다는 규칙(리스코프 치환 원칙)을 지키기 위해 필요하다. 이 규칙을 어기면 하위 클래스를 컴파일할 때 오류가 발생한다. 클래스가 인터페이스를 구현하는 건 이 규칙의 특별한 예로 볼 수 있고, 이때 클래스는 인터페이스가 정의한 모든 메서드를 public으로 선언해야 한다.

단지 코드를 테스트 하려는 목적으로 클래스, 인터페이스, 멤버의 접근 범위를 넓히려 할 때가 있다. 이를 테면 private멤버를 package-private까지 푸는 것은 괜찮지만 그 이상은 안 된다. 즉, 테스트만을 위해 인터페이스, 멤버를 공개 API로 만들어서는 안 된다는 뜻이다. 이렇게 할 필요도 없는 게, 테스트를 대상과 같은 패키지에 두면 package-private요소에 접근할 수 있기 때문이다.

public 클래스의 인스턴스 필드는 되도록 public이 아니어야 한다. 필드가 가변 객체를 참조하거나, final이 아닌 인스턴스 필드를 public으로 선언하면, 그 필드에 담을 수 있는 값을 제한할 힘을 잃게 된다. 그 필드와 관련된 모든 것은 불변식을 보장할 수 없게 된다는 뜻이다. 여기에 더해 필드가 수정될 때(락 획득 같은) 다른 작업을 할 수 없게 되므로 public 가변 필드를 갖는 클래스는 일반적으로 스레드 세이프하지 않다. 심지어 필드가 final이면 불변 객체를 참조하더라도 문제는 여전히 남는다. 내부 구현을 바꾸고 싶어도 그 public 필드를 없애는 방식으로 리팩터링 할 수 없게 된다.

이런 문제는 정적 필드에서도 마찬가지지만, 예외가 있다. 해당 클래스가 표현하는 추상 개념을 완성하는 데 꼭 필요한 구성요소로, 상수라면 public static final 필드로 공개해도 좋다. 관례상 이런 상수의 이름은 대문자 알파벳으로 쓰며, 각 단어 사이에 밑줄_을 넣는다. 이런 필드는 반드시 기본 타입 값이거나 불변 객체를 참조해야 한다. 가변 객체를 참조한다면 final이 아닌 필드에 적용되는 모든 불이익이 그대로 적용된다. 다른 객체를 참조하지는 못하지만 참조된 객체 자체는 수정될 수 있으니 끔찍한 결과를 초래할 수도 있다.

길이가 0이 아닌 배열은 모두 변경 가능하니 주의해야 한다. 따라서 클래스에서 public static final 배열 필드를 두거나, 이 필드를 반환하는 접근자 메서드를 제공해서는 안 된다. 이런 필드나 접근자를 제공한다면 클라이언트에서 그 배열의 내용을 수정할 수 있다. 예컨대 다음 코드에는 보안 허점이 있다.

public static final Ting[] VALUES = { ... };

어떤 IDE가 생성하는 접근자는 private 배열 필드의 참조를 반환하여 이 같은 문제를 똑같이 일으키니 주의해야 한다. 해결책은 두 가지다. 첫 번째 방법ㅇ은 앞 코드의 public 배열을 private으로 만들고 public 불변 리스트를 추가하는 것이다.

private static final Thing[] PRIVATE_VALUES = { ... };
public static final List<Thing> VALUES =
    Collections.unmodifiableList(Arrays.asList(PRIVATE_VALUES));

두 번째는 배열을 private으로 만들고 그 복사본을 반환하는 public 메서드를 추가하는 방법이다. (방어적 복사)

private static final Thing[] PRIVATE_VALUES = { ... };
public static final Thing[] values() {
    return PRIVATE_VALUES.clone();
}

클라이언트가 무엇을 원하느냐를 판단해 둘 중 하나를 선택하면 된다. 어느 반환 타입이 더 쓰기 편할 지, 성능은 어느 쪽이 나을지를 고민해 정한다.

자바 9에서는 모듈 시스템이 도입되면서 두 가지 암묵적 접근 수준이 추가되었다. 패키지가 클래스의 묶음이듯, 모듈은 패키지의 묶음이다. 모듈은 자신에 속하는 패키지 중 공개(export)할 것을(관례상 moudel-info.java파일에) 선언한다. protected 혹은 public 멤버라도 해당 패키지를 공개하지 않았다면 모듈 외부에서는 접근할 수 없다. 물론 모듈 안에서 exports로 선언했는지 여부에 아무런 영향도 받지 않는다. 모듈 시스템을 활용하면 클래스를 외부에 공개하지 않으면서 같은 모듈을 이루는 패키지 사이에서는 자유롭게 공유할 수 있다. 앞서 말한 두 가지 암묵적 접근 수준은 바로 이 숨겨진 패키지 안에 있는 public 클래스의 public 혹은 protected 멤버와 관련이 있다. 이 암묵적 접근 수준들은 각각 public 수준과 protected 수준과 같으나, 그 효과가 모듈 내부로 한정되는 변종인 것이다. 이런 형태로 공유해야 하는 상황은 흔하지 않다. 그래야 하는 상황이 벌어지더라도 패키지 사이에서 클래스를 재배치하면 대부분 해결된다.

앞서 다룬 4가지 접근 수준과 달리, 모듈에 적용되는 새로운 두 접근 수준은 상당히 주의해야 한다. 우리 모듈의 JAR파일을 자신의 모듈 경로가 아닌, 애플리케이션의 클래스 패스에 두면 그 모듈 안의 모든 패키지는 마치 모듈이 없는 것처럼 행동한다. 즉, 모듈이 공개했는지 여부와 상관없이 public 클래스가 선언한 모든 public 혹은 protected 멤버를 모듈 밖에서도 접근할 수 있게 된다. 자바 9에서 등장한 이 접근 수준을 적극 활용한 대표적인 예가 JDK 자체다. 자바 라이브러리에서 공개하지 않은 패키지는 해당 모듈 밖에서는 절대로 접근할 수 없다.

접근 보호 방식이 추가된 것 말고도, 모듈은 여러 면에서 자바 프로그래밍에 영향을 준다. 사실 모듈의 장점을 제대로 누리려면 해야 할 일이 많다. 먼저 패키지를 모듈 단위로 묶고, 모듈 선언에 패키지들의 모든 의존성을 명시한다. 그런 다음 소스 트리를 재배치하고, 모듈 안으로부터 (모듈 시스템을 적용하지 않는) 일반 패키지로 모든 접근에 특별한 조취를 취해야 한다.