item 82 jihoon

[item82] 스레드 안전성 수준을 문서화하라

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

스레드 안전성 수준(안전성 높은 순서로 나열)

• 불변(immutable)
  • 이 클래스의 인스턴스는 마치 상수와 같아 외부 동기화도 필요 없다
  • E.g. String, Long, BigInteger
• 무조건적인 스레드 안전(unconditionally thread-safe)
  • 이 클래스의 인스턴스는 수정될 수 있지만 내부에서도 충실히 동기화하여 별도의 외부 동기화없이 동시에 사용해도 안전
  • E.g. AtomicLong, ConcurrentHashMap
• 조건부 스레드 안전(conditionally thread-safe)
  • 무조건적인 스레드 안전성과 같지만 일부 메서드는 동시에 사용하려면 외부 동기화가 필요합니다.
  • E.g. Collections.synchronized Wrapper 메서드가 리턴한 컬렉션(이 컬렉션들이 리턴한 반복자는 외부에서 동기화해야 한다)
• 스레드 안전하지 않음(not thread-safe)
  • 이 클래스의 인스턴스는 수정될 수 있고, 동시에 사용하려면 각각의 메서드 호출을 클라이언트가 선택한 외부 동기화 로직으로 감싸야 한다.
  • E.g. ArrayList, HashMap
• 스레드 적대적(thread-hostile)
  • 외부 동기화로 감싸더라도 멀티스레드 환경에서 안전하지 않다.
  • 이러한 클래스는 동시성을 고려하지 않고 만들다보면 우연히 만들어진다.

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

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

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

  // synchronizedMap이 반환한 맵의 콜렉션 뷰를 순회하려면, 뷰(인스턴스 자체)가 아닌 반드시 그 맵을 락으로 사용해 수동으로 동기화하라
  
  Map<K, V> m = Collections.synchronizedMap(new HashMap());
  Set<K> s = m.keySet();  // 동기화 블록 밖에 있어도 된다.
      ...
  synchronized (m) {  // s가 아닌 m을 사용해 동기화해야 한다.
      for (K key : s)
  	    key.f();
  }
  
  // 이대로 따르지 않으면 동작을 예측할 수 없다

• 클래스의 스레드 안전성은 보통 클래스의 문서화 주석에 기재

• 독특한 특성의 메서드라면 해당 메서드의 주석에 기재

• 열거타입은 굳이 불변이라고 쓸 필요 없음

• 리턴 타입만으로는 명확히 알 수 없는 정적 팩터리는 자신이 리턴하는 객체의 스레드 안전성을 반드시 문서화해야 한다(Collections.synchronizedMap이 좋은 예)

외부에서 사용할 수 있는 lock의 주의점

• 클래스가 외부에서 사용할 수 있는 lock을 제공하면 클라이언트에서 일련의 메서드 호출을 원자적으로 할 수 있다.
• 내부에서 처리하는 고성능 동시성 제어 메커니즘과 혼용할 수 없게 된다.
• 클라이언트가 공개된 lock 오래 쥐고 놓지 않는 서비스 거부 공격(denial-of-service attack)을 수행할 수 있다.
  • 이 공격을 막기 위해서는 공개된 lock이나 마찬가지인 synchronized 메서드 대신 비공개 lock 객체를 사용해야 한다.

비공개 lock 객체 관용구

private final Object lock = new Object();

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

• lock 필드를 항상 final로 선언하라
  • lock 객체가 우연히라도 교체되는 일 예방
  • 일반적인 감시 lock, java.util.concurrent.locks 패키지에서 가져온 lock 모두 해당
• 비공개 lock 객체 관용구는 무조건적 스레드 안전 클래스에서 사용할 수 있다
  • 조건부 스레드 안전 클래스에서는 특정 호출 순서에 필요한 락이 무엇인지를 클라이언트에게 알려줘야 하므로 이 관용구를 사용할 수 없다.