Java | 클래스와 멤버의 접근 권한을 최소화하라 (Effective Java 3/E - joshua bloch)

해당 글은 이펙티브 자바 (Effective Java 3/E - joshua bloch) 를 읽고 정리한 글입니다.

핵심

프로그램 요소의 접근성은 가능한 한 최소한으로 하라.

꼭 필요한 것만 골라 최소한의 public API를 설계하자.

그 외에는 클래스, 인터페이스, 멤버가 의도치 않게 API로 공개되는 일이 없도록 해야 한다.

public 클래스는 상수용 public static final 필드 외에는 어떠한 public 필드도 가져서는 안 된다.

public static final 필드가 참조하는 객체가 불변인지 확인하라.

이유

잘 설계된 컴포넌트는 다른 컴포넌트와 소통하며 내부 동작 방식에는 전혀 개의치 않는다.

• 즉, 정보 은닉, 캡슐화의 개념은 소프트웨어 설계의 근간이되는 원리다.

정보은닉의 장점

• 시스템 개발 속도를 높인다.
  • 여러 컴포넌트를 병렬로 개발할 수 있기 때문
• 시스템 관리 비용을 낮춘다.
  • 각 컴포넌트를 더 빨리 파악하려 디버깅할 수 있고, 다른 컴포넌트로 교체하는 부담도 적기 때문이다.
• 정보 은닉 자체가 성능을 높여주진 않지만, 성능 최적화에 도움을 준다.
  • 완성된 시스템을 프로파일링해 최적화할 컴포넌트를 정한 다음(item 67에서 다시 다룰 내용), 다른 컴포넌트에 영향을 주지 않고 해당 컴포넌트만 최적화할 수 있기 때문이다.
• 소프트웨어 재사용성을 높인다.
  • 외부에 거의 의존하지 않고 독자적으로 동작할 수 있는 컴포넌트라면 그 컴포넌트와 함께 개발되지 않은 낯선 환경에서도 유용하게 쓰일 가능성이 크기 때문이다.
• 큰 시스템을 제작하는 난이도를 낮춰준다.
  • 시스템 전체가 아직 완성되지 않은 상태에서도 개별 컴포넌트의 동작을 검증할 수 있기 때문이다.

고려 사항

자바의 정보은닉 장치

• 클래스, 인터페이스, 멤버의 접근성(접근 허용 범위)을 명시
• private, protected, public

원칙

• 모든 클래스와 멤버의 접근성을 가능한 한 좁혀야 한다.
• 소프트웨어가 올바로 동작하는 한 항상 가장 낮은 접근 수준을 부여해야 한다.

package-private로 선언된 경우

• 내부 구현이 되므로 언제든 수정할 수 있다.
• public은 API가 되므로 하위 호환을 위해 영원히 관리해줘야만 한다.
• default라고 생각하면된다.

한 클래스에서만 사용는 package-private 톱레벨 클래스나 인터베이스는 이를 사용하는 클래스 안에 private static으로 중첩시켜보자.

• 톱레벨로 두면 같은 패키지의 모든 클래스가 접근 가능
• private static으로 중첩시키면 바깥 클래스 하나에서만 접근할 수 있다.

public일 필요없는 클래스는 접근 수준을 package-private 톱레벨 클래스로 좁히는 것이 중요

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

private → pacakge-private 으로 권한을 풀 때

• 같은 패키지의 다른 클래스가 접근해야하는 경우 권한을 풀어줄 수 있지만, 자주 하게 되는 경우 시스템에서 컴포넌트를 더 분해해야 하는 것은 아닌지 고민해야한다.

public 클래스의 protected 멤버는 공개 API이므로 영원히 지원돼야 한다.

• 내부 동작 방식을 API 문서에 적어 사용자에게 공개해야 할 수도 있다.
• protected는 적을 수록 좋다.

리스코프 치환 원칙을 지키기 위한 제약

• 상위 클래스의 메서드를 재정의할 때는 그 접근 수준을 상위 클래스에서보다 좁게 설정할 수 없다.
• 상위 클래스의 인스턴스는 하위 클래스의 인스턴스로 대체해 사용할 수 있어야 한다는 규칙 즉, 리스코프 치환 원칙을 지키기 위해서이다.
• 이 규칙을 어기면 하위 클래스를 컴파일할 때 컴파일 오류가 생긴다.

테스트를 위한 권한 확장

• 코드를 테스트하는 목적이라면 private 멤버를 package-private까지 풀어주는 것은 허용된다.

public 클래스의 인스턴스 필드는 되도록 public이 아니어야 한다.

• final로 참조 객체 필드를 구성할 것.
  • 우리 spring에서 의존성을 주입할 때 생성자 주입을 하는 경우에 객체 필드에 final을 붙이듯 말이다.
• public 가변 필드를 갖는 클래스는 일반적으로 스레드 safe하지 않다.
  • 즉, 불변성을 보장할 수 없다.
• 예외적으로 상수의 경우 public static final 필드로 선언해도 되지만, 해당 객체는 불변 객체나 기본 타입 값을 참조해야한다. 가변 객체를 참조하게 되는 경우 수정되어버리는 끔직한 경우가 발생한다.

보안 허점을 없애보자

여기 보안 허점이 숨어 있는 배열 필드가 있다. 해결책 두 가지를 알아보자.

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

첫번째

앞 코드의 public 배열을 private으로 바꾸고 public 불편 리스드를 추가하는 것이다.

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

두번째

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

Java 9 모듈 시스템

• 모듈 시스템이라는 개념이 도입되면서 두가지 암묵적 접근 수준이 추가되었다.
• 패키지들의 묶음을 모듈이라 한다.
• 모듈은 자신에 속하는 패키지 중 공개할 것들(관례상 module-info.java 파일에) 선언한다.
• protected 혹은 public 멤버라도 해당 패키지를 공개하지 않았다면 모듈 외부에서 접근할 수 없다.
• 물론, 모듈 안에서는 exports로 선언했는지 여부는 아무런 영향도 받지 않는다.
• 모듈 시스템을 활용하면 클래스를 외부에 공개하지 않으면서도 같은 모듈을 이루는 패키지 사이에서는 자유롭게 공유 가능
• 즉, 두가지 암묵적 접근 수준이란 숨겨진 패키지 안에 있는 public 클래스의 public 또는 protected 멤버와 관련있다.
• 각각 public 수준과 protected 수준과 같으나, 그 효과가 모듈 내부로 한정되는 변종이기 때문이다.

🚨 주의 🚨 모듈에 적용되는 새로운 암묵적 접근 수준은 주의해서 사용해야한다.

• 모듈 JAR 파일을 자신의 모듈 경로가 아닌 애플리케이션의 클래스패스(classpath)에 두면 그 모듈 안의 모든 패키지는 마치 모듈이 없는 것처럼 행동한다.
  • 즉, 모듈이 공개했는지 여부와 상관없이 public 클래스가 선언한 모든 public 혹은 protected 멤버를 모듈 밖에서도 접근할 수 있게 된다.
• 자바 라이브러리에서 공개하지 않은 패키지들은 해당 모듈 밖에서는 절대 접근할 수 없다. 즉, JDK 자체가 대표적인 예시인 것이다.

모듈의 장점 활용법은 복잡하다.

• 패키지들을 모듈 단위로 묶고, 모듈 선언에 패키지들의 모든 의존성을 명시한다.
• 그 후, 소스 트리를 재배치하고, 모듈 안으로부터 (모듈 시스템을 적용하지 않는) 일반 패키지로의 모든 접근에 특별한 조치를 취해야 한다.
• JDK 외에도 모듈 개념이 널리 받아들여질지 예측하기는 아직 이르다.