[effective java] item 15. 클래스와 멤버의 접근 권한을 최소화하라

결론

프로그램 요소의 접근성은 가능한 한 최소한으로 하라.
꼭 필요한 것만 골라 최소한의 public API를 설계하자.
그 외에는 클래스, 인터페이스, 멤버가 의도치 않게 API로 공개되는 일이 없도록 해야 한다.
public 클래스는 상수용 public static final 필드 외에는 어떠한 public 필드도 가져서는 안 된다.
단, public static final 필드가 참조하는 객체가 불변인지 확인해야 한다. 

 

 

설명

잘 설계된 컴포넌트는 모든 내부 구현을 완벽히 숨겨, 구현과  API를 깔끔히 분리합니다. 

정보 은닉, 혹은 캡슐화라고 하는 이 개념은 소프트웨어 설계의 근간이 되는 원리입니다. 

 

자바는 접근 제한자(private, protected, public)를 제공하고 이것을 제대로 활용하는 것이 정보 은닉의 핵심입니다. 

기본 원칙은 간단합니다. 모든 클래스와 멤버의 접근성을 가능한 한 좁혀야 합니다. 

 

 

클래스와 인터페이스: public, package-private

공개 API 는 public, 이외는 모두 package-private

톱 레벨 클래스(가장 바깥이라는 의미)와 인터페이스를 public으로 선언하면 공개 API가 되며,

package-private으로 선언하면 해당 패키지 안에서만 이용할 수 있습니다. 

 

패키지 외부에서 쓸 이유가 없다면 package-private으로 선언해야 합니다. 

public으로 선언하면 이를 사용하는 클라이언트가 생기므로 수정이 용이하지 못합니다. 

 

 

참고 API를 작성할 때 Controller 클래스는 무조건 public
Controller 클래스는 API의 엔드포인트를 정의하고 클라이언트의 요청을 처리하는 역할을 담당하는 부분입니다.
이 클래스는 클라이언트와 상호작용을 처리하므로 일반적으로 public으로 선언해야 합니다. 

Controller를 private으로 선언하면 외부에서 해당 클래스에 직접 접근할 수 없으므로 API 엔드포인트에 접근이 불가능해지고 Controller 클래스에 접근할 수 없기 때문에 API가 기능하지 않는 상태가 됩니다. 

 

 

한 클래스에서만 사용: private static 중첩 클래스

한 클래스에서만 사용하는 package-private 톱레벨 클래스나 인터페이스는 이를 사용하는 클래스 안에 private static으로 중첩시킬 수 있습니다. 

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

 

 

멤버: private, package-private, protected, public

멤버(필드, 메서드, 중첩 클래스, 중첩 인터페이스)에 부여할 수 잇는 접근 수준은 네 가지입니다.

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

 

참고  인터페이스의 멤버는 기본적으로 public인 이유
인터페이스는 다형성(polymorphism)을 지원합니다.
즉, 인터페이스 타입으로 선언된 변수는 해당 인터페이스를 구현한 어떤 클래스와 인스턴스의 인스턴스도 참조할 수 있습니다. 이렇게 하면 클라이언트 코드가 구체적인 구현 클래스와 강하게 결합되지 않고, 더 유연하고 확장 가능한 코드를 작성할 수 있습니다. 

인터페이스 Shape와 Shape 구현체 Circle로 예를 들어보겠습니다.

Shape shape1 = new Circle();​

Shape 인터페이스를 사용하여 Circle 클래스의 인스턴스를 참조하고 있습니다. 
인터페이스를 통해 해당 클래스의 기능을 사용하고 있으므로, 인터페이스에서 정의한 메서드는 반드시 public()으로 선언되어야 합니다. 만약, 구현 클래스에서 인터페이스의 메서드를 public이 아닌 다른 접근 제한자로 선언하면, 해당 메서드를 인터페이스 타입으로 선언된 변수를 통해 호출할 수 없게 되어 다형성을 사용하는 장점이 사라지게 됩니다.

따라서, 인터페이스를 구현한 클래스에서 모든 메서드를 public으로 선언하여, 인터페이스를 통한 다형성과 호환성을 유지하는 것이 중요합니다. 

 

 

멤버의 접근 제한자 설정 순서

1. 클래스의 공개 API를 설계한 후, 그 외의 모든 멤버는 private으로 만든다.
2. 오직 같은 패키지의 다른 클래스가 접근해야 하는 멤버에 한하여 private 제한자를 제거해 package-private으로 풀어준다.
3. 권한을 풀어주는 일을 자주 하게 된다면, 시스템에서 컴포넌트를 더 분해해야 하는 것은 아닌지 다시 고민해보자.

 

참고 serializable
private와 package-private 멤버는 모두 해당 클래스의 구현에 해당하므로 보통은 공개 API에 영향을 주지 않지만, Serializable을 구현한 클래스에서는 그 필드들도 의도치 않게 공개 API가 될 수도 있습니다. 

 

참고 테스트의 접근제한자
단지 코드를 테스트하려는 목적으로 접근 범위를 넓히려 할 때가 있습니다.
적당한 수준까지는 넓혀도 괜찮습니다. 
예를들어, public 클래스의 private 멤버를 package-private까지 풀어주는 것은 허용할 수 있지만, 그 이상은 안됩니다. 
즉, 테스트만을 위해 클래스, 인터페이스, 멤버를 공개 API로 만들어서는 안 됩니다. 
테스트 코드를 테스트 대상과 같은 패키지에 두면 package-private 요소에 접근할 수 있기 때문에 그렇게 할 이유도 없습니다.

 

 

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

• 필드가 가변 객체를 참조하거나, final이 아닌 인스턴스 필드를 public으로 선언하면 불변식을 보장할 수 없게 됩니다. 
• 필드에 바로 접근하여 수정한다면, 다른 로직을 수행할 수 없습니다. (ex) 락 획득)
  따라서, public 가변 필드를 갖는 클래스는 일반적으로 스레드 안전하지 않습니다. 

 

public class MyClass {
    private int myField;

    public int getMyField() {
        return myField;
    }

    public void setMyField(int newValue) {
        // 필드 수정 전에 다른 작업 수행
        // 락 획득 등 필요한 로직 추가 가능

        myField = newValue;

        // 필드 수정 후에 다른 작업 수행
        // 락 해제 등 필요한 로직 추가 가능
    }
}

• 심지어 필드가 final이면서 불변 객체를 참조하더라도, 다른 곳에서 해당 필드들 참조하면 내부 구현을 바꾸고 싶어도 그 public 필드를 없애는 방식으로 리팩터링 할 수 없기 때문에 public으로 두지 않는 것이 좋습니다. 

 

예외: public static final 필드 (상수)

해당 클래스를 표현하는 추상 개념을 완성하는 데 꼭 필요한 구성요소로써의 상수라면 public static final 필드로 공개해도 좋습니다. 

이런 필드는 반드시 기본 타입 값이나 불변 객체를 참조해야 합니다. 

만약 불변이 아닌 가변 객체를 참조하게 된다면 다른 객체를 참조하지는 못하지만, 참조된 객체 자체는 수정이 될 수 있으니 끔찍한 결과를 초래할 수도 있습니다.

 

주의: static final 배열 필드 - 변경 가능

길이가 0이 아닌 static final 배열은 변경이 가능하므로 주의해야 합니다.

클래스에서 public static final 배열 필드를 두거나 이 필드를 반환하는 접근자 메서드를 제공해서는 안 됩니다. 

이런 필드나 접근자를 제공하면 클라이언트에서 그 배열을 수정할 수 있게 됩니다.

 

보안 허점이 숨어 있다.

class Thing {
	int value;
	
	Thing(int value) {
		this.value = value;
	}
}

class Test {
	public static final Thing[] VALUES = {new Thing(0), new Thing(1)}; 
}


public static void main(String[] args) {
    System.out.println(Test.VALUES[0].value);	//0
    Test.VALUES[0].value = 1;					//1로 변경 (final이지만 변경 가능)
    System.out.println(Test.VALUES[0].value);	//1
}

 

또한, 어떤 IDE가 생성하는 접근자는 private 배열 필드의 참조를 반환하여 이 같은 문제를 똑같이 일으키니 주의해야 합니다.

 

해결책 1: 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();
}

 

• 클라이언트가 어느 타입이 더 쓰기 편할지, 성능은 어느 쪽이 나을지를 고민해 선택하면 됩니다.

 

모듈

패키지가 클래스들의 묶음이듯, 모듈은 패키지들의 묶음입니다.

모듈은 자신에 속하는 패키지 중 공개(export)할 것들을 (관례상 module-info.java 파일에) 선언합니다.

protected 혹은 public 멤버라도 해당 패키지를 공개하지 않았다면, 모듈 외부에서는 접근할 수 없습니다.

모듈 시스템을 활용하면 클래스를 외부에 공개하지 않으면서도 같은 모듈을 이루는 패키지 사이에서는 자유롭게 공유할 수 있습니다. 즉, 이 숨겨진 패키지 안에 있는 public 클래스의 public 혹은 protected 멤버는 각각 public 수준과 protected 수준과 같으나, 그 효과가 모듈 내부로 한정되는 변종인 것입니다.

이런 형태로 공유해야 하는 상황은 흔하지 않습니다. 이런 상황이 벌어지더라도 패키지들 사이에서 클래스들을 재배치하면 대부분 해결됩니다.

 

모듈을 적극적으로 활용한 대표적인 예가 바로 JDK자체입니다.

하지만 JDK 외에도 모듈 개념이 널리 받아들여질지 예측하기는 아직 이른 감이 있어 꼭 필요한 경우가 아니라면 당분간은 사용하지 않는 게 좋을 것 같습니다. 

 

---

출처

https://www.yes24.com/Product/Goods/65551284

이펙티브 자바 Effective Java 3/E - 예스24