[Effective Java] Item 82. 스레드 안전성 수준을 문서화하라

한 메서드를 여러 스레드가 동시에 호출할 때 그 메서드가 어떻게 동작하느냐는 해당 클래스와 이를 사용하는 클라이언트 사이의 중요한 계약과 같다.

API 문서에 아무런 언급이 없다면 사용자가 나름의 가정을 해야 하고, 그 가정이 틀리다면 심각한 오류로 이어질 수 있다.

 

• 자바독 기본 옵션에서 생성한 API 문서에는 synchronized 한정자가 포함되지 않는다.
• 메서드 선언에 synchronized 한정자를 선언할지는 규현 이슈일 뿐 API에 속하지 않는다.
• 따라서 API 문서에 synchronized 한정자가 보이더라도 스레드 안전하다고 믿기 어렵다.

 

스레드 안정성 수준

 

멀티스레드 환경에서도 API를 안전하게 사용하게 하려면 클래스가 지원하는 스레드 안전성 수준을 정확히 명시해야 한다.

 

스레드 안전성이 높은순으로 나열

 

불변 (immutable)

• 이 클래스의 인스턴스는 마치 상수와 같아서 외부 동기화도 필요 없다.
• String, Long, BigInteger

 

무조건적 스레드 안전 (unconditionally thread-safe)

• 이 클래스의 인스턴스는 수정될 수 있으나, 내부에서 충실히 동기화하여 별도의 외부 동기화 없이 동시에 사용해도 안전하다.
• AtomicLong, ConcurrentHashMap

 

조건부 스레드 안전 (conditionally thread-safe)

• 무조건적 스레드 안전과 같으나, 일부 메서드는 동시에 사용하려면 외부 동기화가 필요하다.
• Collections.synchronized 래퍼 메서드가 반환한 컬렉션들이 속한다.

 

스레드 안전하지 않음 (not thread-safe)

• 이 클래스의 인스턴스는 수정될 수 있다. 동시에 사용하려면 각각의 메서드 호출을 클라이언트가 선택한 외부 동기화 메커니즘으로 감싸야한다.
• ArrayList, HashMap 같은 기본 컬렉션이 속한다.

 

스레드 적대적 (thread-hostile)

• 이 클래스는 모든 메서드 호출을 외부 동기화로 감싸더라도 멀티 스레드 환경에서 안전하지 않다.
• 이 수준의 클래스는 일반적으로 정적 데이터를 아무 동기화 없이 수정한다.

 

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

 

조건부 스레드 안전한 클래스는 주의해서 문서화해야 한다.

어떤 순서로 호출할 때 외부 동기화가 필요한지, 그 순서로 호출하려면 어떤 락을 얻어야 하는지 알려줘야 한다.

일반적으로 인스턴스 자체를 락으로 얻지만 예외도 있다.

 

Collections.synchronizedMap의 API 문서

 

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

Map<K, V> m = Collections.synchronizedMap(new HashMap<>());
Set<K> s = m.keySet(); // 동기화 블록 밖에 있어도 된다.
    ...
synchronized(m) { // s가 아닌 m을 사용해 동기화해야 한다!
    for (K key : s)
        key.f();
}

이대로 따르지 않으면 동작을 예측할 수 없다.

• 클래스의 스레드 안전성은 보통 클래스의 문서화 주석에 기재하지만, 독특한 특성의 메서드라면 해당 메서드의 주석에 기재하자.

 

 

외부에서 사용할 수 있는 락

 

클래스가 외부에서 사용할 수 있는 락을 제공하면 클라이언트에서 일련의 메서드 호출을 원자적으로 수행할 수 있다

 

• 내부에서 처리하는 고성능 동시성 제어 메커니즘과 혼용이 안된다. (CurrentHashMap과는 함께 사용할 수 없다.)
• 클라이언트가 공개된 락을 오래 쥐고 놓지 않는 서비스 거부 공격 (denail-of-service attack)을 수행할 수도 있다.
• synchronized 메서드도 공개된 락에 속한다.
• 비공개 락 객체를 사용해야한다.

 

비공개 락 객체 관용구 - 서비스 거부 공격을 막아준다

 

private final Object lock = new Object();

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

 

• 비공개 락 객체는 클래스 바깥에서는 볼 수 없으니 클라이언트가 그 객체의 동기화에 관여할 수 없다.
• 락 객체를 동기화 대상 객체 안으로 캡슐화한 것이다.
• lock 필드를 final로 선언하면 우연히 락 객체가 교체되는 일을 예방해 준다. 락 필드는 항상 final로 선언하자.
• 비공개 락 객체 관용구는 무조건적 스레드 안전 클래스에서만 사용할 수 있다.
• 조건부 스레드 안전 클래스에서는 특정 호출 순서에 필요한 락이 무엇인지 클라이언트에 알려줘야 하므로 사용할 수 없다.

 

 

결론

 

• 모든 클래스가 자신의 스레드 안전성 정보를 명확히 문서화해야 한다.
• 정확한 언어로 설명하거나 스레드 안전성 애너테이션을 사용할 수 있다.
• synchronized 한정자는 문서화와 관련이 없다.
• 조건부 스레드 안전 클래스는 메서드를 어떤 순서로 호출할 때 외부 동기화가 요구되고, 그때 어떤 락을 얻어야 하는지도 알려줘야 한다.
• 무조건적 스레드 안전 클래스를 작성할 때는 synchronized 메서드가 아닌 비공개 락 객체를 사용하자.