[Effective Java] 아이템 82. 스레드 안정성 수준을 문서화하라

BE/Java

[Effective Java] 아이템 82. 스레드 안정성 수준을 문서화하라

멍목 2022. 12. 23. 23:41

이 포스팅에서 작성하는 내용은 EFFECTIVE JAVA(이펙티브자바) 에서 발췌하였습니다.

아이템 82. 스레드 안정성 수준을 문서화하라

한 메서드를 여러 메서드가 동시에 호출할 때 그 메서드가 어떻게 동작하는 지는 해당 클래스와 이를 사용하는 클라이언트 사이의 중요한 정보이다.
API 문서에서 아무런 언급도 없으면 그 클래스 사용자는 그 관계에 대해 추측해야하며, 추측이 틀리면 클라이언트 프로그램은 동기화를 충분히 하지 못하거나 지나치게 한 상태로 오류가 발생할 수 있다.

synchronized

API 문서에 synchronized 한정자가 있는 메서드는 안전하다고도 하는데, 몇 가지 이유로 틀렸다.
- JavaDoc이 기본 옵션에서 생성한 API 문서에는 synchronized 한정자가 포함되지 않는다.
- 메서드 선언에 synchronized 한정자를 선언할지는 구현 이슈일 뿐 API에 속하지 않는다.
- 따라서 이것만으로는 그 메서드가 스레드 안전하다고 믿기 어렵다.
synchronized 유무로 스레드 안정성을 알 수 있다는 주장은 ‘스레드 안정성은 모 아니면 도’라는 오해에 뿌리를 둔 것이다.
- 하지만, 스레드 안정성에도 수준이 나뉜다.
- 멀티스레드 환경에서도 API를 안전하게 사용하려면 클래스가 지원하는 스레드 안정성 수준을 정확히 명시해야 한다.

스레드 안정성 수준

다음 목록은 스레드 안정성이 높은 순으로 나열한 것이다. (일반적인 경우)

불변(immutable) [@Immutable]
- 이 클래스의 인스턴스는 마치 상수와 같아서 외부 동기화가 필요없다
- ex) String, Long, BigInteger
무조건적 스레드 안전(unconditionally thread-safe) [@ThreadSafe]
- 이 클래스의 인스턴스는 수정될 수 있으나, 내부에서 충실히 동기화하여 별도의 외부 동기화 없이 동시에 사용해도 안전하다.
- ex) AtomicLong, ConcurrentHashMap
조건부 스레드 안전(conditionally thread-safe) [@ThreadSafe]
- 무조건적 스레드 안전과 같으나, 일부 메서드는 동시에 사용하려면 외부 동기화가 필요하다.
- 이 클래스의 경우 주의해서 문서화해야한다.
- ex) Collections.synchronized 래퍼 메서드가 반환한 컬렉션들
스레드 안전하지 않음(not thread-safe) [@NotThreadSafe]
- 이 클래스의 인스턴스는 수정될 수 있다.
- 동시에 사용하려면 각각의 메서드 호출을 클라이언트가 선택한 외부 동기화 메커니즘으로 감싸야한다.
- ex) ArrayList, HashMap
스레드 적대적(thread-hostil)
- 이 클래스는 모든 메서드 호출을 외부 동기화로 감싸더라도 멀티스레드 환경에서 안전하지 않다.
- 이 수준의 클래스는 일반적으로 정적 데이터를 아무 동기화 없이 수정한다.
- 이런 클래스를 고의로 만드는 사람은 없겠지만, 동시성을 고려하지 않고 작성하다 보면 만들어질 수 있다.
- 스레드 적대적으로 밝혀진 클래스나 메서드는 일반적으로 문제를 고쳐 재배포하거나 사용자제 API로 지정한다.

조건부 스레드 안전한 클래스 문서화 주의점

어떤 순서로 호출할 때 외부 동기화가 필요한지, 그리고 그 순서로 호출하려면 어떤 락 혹은 락들을 얻어야 하는 지 알려줘야 한다.
일반적으로 인스턴스 자체를 락으로 얻지만 예외도 있다.

예를 들어 Collections.synchronizedMap의 API 문서에는 다음과 같이 써있다.

synchronizedMap이 반환한 맵의 컬렉션 뷰를 순회하려면 반드시 그 맵을 락으로 사용해 수동으로 동기화하라

Map<K, V> m = Collections.synchronizedMap(new HashMap<>());
Set<K> s = m.keySet();  // 동기화 블록 밖에 있어도 된다.

...

synchronzed(m) {   // s가 아닌 m을 사용해 동기화해야 한다.
    for(K key : s)
        key.f();
}

클래스의 스레드 안정성은 보통 클래스의 문서화 주석에 기재하지만, 독특한 특성의 메서드라면 해당 메서드의 주석에 기재하도록 하자.
열거 타입은 굳이 불변이라고 쓰지 않아도 된다.
반환 타입만으로는 명확히 알 수 없는 정적 팩터리라면 자신이 반환하는 객체의 스레드 안전성을 반드시 문서화해야 한다.

Lock 제공(비공개 락 객체 관용구)

클래스가 외부에서 사용할 수 있는 락을 제공하면 클라이언트에서 일련의 메서드 호출을 원자적으로 수행할 수 있지만 이 유연성엔 대가가 따른다.
내부에서 처리하는 고성능 동시성 제어 메커니즘과 혼용할 수 없게 되는 것이다.
위와 같은 이유로, ConcurrentHashMap 같은 동시성 컬렉션과는 함께 사용하지 못한다.
추가로, 클라이언트가 공개된 락을 오래 쥐고 놓지 않는 서비스 거부 공격을 수행할 수도 있다.
서비스 거부 공격을 막으려면 synchronized 메서드 대신 비공개 락 객체를 사용해야 한다.

private final Object lock = new Object();

public void foo() {
    synchronized(lock) { 
				...
		}
}

비공개 락 객체는 클래스 바깥에서는 볼 수 없으니 클라이언트가 그 객체의 동기화에 관여할 수 없다.
락 객체를 동기화 대상 객체 안으로 캡슐화 한 것이다.
비공개 락 객체 관용구는 무조건적 스레드 안전 클래스에서만 사용할 수 있다.
조건부 스레드 안전 클래스에서는 특정 호출 순서에 필요한 락이 무엇인지를 클라이언트에게 알려줘야 하므로 이 관용구를 사용할 수 없다.
비공개 락 객체 관용구는 상속용으로 설계한 클래스에 특히 잘 맞는다.
상속용 클래스에서 자신의 인스턴스를 락으로 사용한다면, 하위 클래스는 의도치 않게 기반 클래스의 동작을 방해할 수 있다.
같은 락을 다른 목적으로 사용하게 되어 하위 클래스와 기반 클래스는 '서로가 서로를 훼방놓는' 상태에 빠진다.

정리

모든 클래스가 자신의 스레드 안정성 정보를 명확히 문서화해야 한다.
정확한 언어로 명확히 설명하거나 스레드 안정성 애너테이션을 사용하자
synchronized 한정자는 문서화와 관련이 없다.
조건부 스레드 안전 클래스는 메서드를 어떤 순서로 호출할 때 외부 동기화가 요구되고, 그 때 어떤 락을 얻어야 하는지도 알려줘야 한다.
무조건적 스레드 안전 클래스를 작성할 때는 synchronized 메서드가 아닌 비공개 락 객체를 사용하자.
이렇게 해야 클라이언트나 하위 클래스에서 동기화 메커니즘을 깨는 걸 예방하고, 더 정교한 동시성 제어 메커니즘으로 재구현할 여지가 생긴다.