javadoc이 기본 옵션에서 생성한 API 문서에는 synchronized 한정자가 포함되지 않는다. 메서드 선언에 synchronized 한정자 선언할지는 구현 이슈일 뿐 API에 속하지 않는다.

→ 이것만으로 그 메서드가 스레드 안전하다고 믿기 어려움

스레드 안전성 수준

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

• 불변 (immutable) @Immutable

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

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

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

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

  • 무조건적 스레드 안전과 같으나 일부 메서드는 동시에 사용하려면 외부 동기화가 필요하다.

  • Collections.synchronized 래퍼 메서드가 반환한 컬렉션들이 여기에 속함

  • 주의해서 문서화 해야함

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

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

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

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

• 스레드 적대적 (thread-hostile)

  • 이 클래스는 모든 메서드 호출을 외부 동기화로 감싸도 멀티스레드 환경에서 안전하지 않다.
  • 이 수준의 클래스는 일반적으로 정적 데이터를 아무 동기화 없이 수정한다.
  • 동시성을 고려하지 않고 작성하다 보면 우연히 만들어질 수 있다.
  • 이런 클래스나 메서드는 일반적으로 문제를 고쳐 재배포하거나 사용 자제(deprecated) API로 지정한다.

규칙

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

비공개 락 객체