[JAVA] ThreadLocal

ThreadLocal이란?

Thread-safe 하다와 하지 않다의 차이

class Data{

		int a= 1;
		
}

만약 Data 클래스가 Bean 혹은 싱글톤으로 관리되어서 멀티 쓰레드 환경에서 
공유되는 객체라면 위와 같은 멤버 변수는 멀티 쓰레드 환경에서 경쟁조건이 발생하는 영역이다.

여기서 thread-safe란 멀티 스레드 환경에서 즉 여러 곳에서 동시에 함수나 변수 등에 접근 가능할 때 서로 다른 스레드들이 동시에 같은 것에 접근해서 이용해도 문제가 생기지 않는다는 것을 의미한다.

= 서로 다른 곳에서 동시에 접근해 작업을 수행해도 결과에는 문제가 없다는 것을 의미한다.

 위 Data 클래스의 변수 a 는 thread-safe 하지 않다.

ThreadLocal 이란?

위와 같이 thread-safe하지 않은 상황에서 사용한다.

위에 문제가 생기는 이유는 멀티 쓰레드 환경에서 공유하는 영역에 데이터를 접근해서 발생한다.

ThreadLocal을 이용하면 쓰레드 영역에 변수를 설정할 수 있기 때문에, 특정 쓰레드가 모든 코드에서 그 쓰레드에 설정된 변수 값을 사용할 수 있게 된다.

-> 즉 각 쓰레드마다 고유한 영역에 변수를 저장한다

 

ThreadLocal 예시 (Spring Security)

ThreadLocal 을 사용하는 대표적인 프레임워크인 SpringSecurity 의 예시이다.

위에 이미지 처럼 ThreadLocal<ThreadLocal이 필요한 클래스>를 생성한다. 

.set
.get
.remove

를 통해서 CRD를 수행한다.

 

ThreadLocal 동작원리

public class ThreadLocal<T> {
		private final int threadLocalHashCode = nextHashCode();
    private T get(Thread t) {
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            if (map == ThreadLocalMap.NOT_SUPPORTED) {
                return initialValue();
            } else {
                ThreadLocalMap.Entry e = map.getEntry(this);
                if (e != null) {
                    @SuppressWarnings("unchecked")
                    T result = (T) e.value;
                    return result;
                }
            }
        }
        return setInitialValue(t);
    }
    private void set(Thread t, T value) {
        ThreadLocalMap map = getMap(t);
        if (map == ThreadLocalMap.NOT_SUPPORTED) {
            throw new UnsupportedOperationException();
        }
        if (map != null) {
            map.set(this, value);
        } else {
            createMap(t, value);
        }
    }

   private void remove(Thread t) {
       ThreadLocalMap m = getMap(t);
       if (m != null && m != ThreadLocalMap.NOT_SUPPORTED) {
           m.remove(this);
       }
   }
  static class ThreadLocalMap {
        ThreadLocalMap(ThreadLocal<?> firstKey, Object firstValue) {
            table = new Entry[INITIAL_CAPACITY];
            int i = firstKey.threadLocalHashCode & (INITIAL_CAPACITY - 1);
            table[i] = new Entry(firstKey, firstValue);
            size = 1;
            setThreshold(INITIAL_CAPACITY);
        }
	}
	
}

핵심 코드만 가져왔다.

ThreadLocal의 코드를 뜯어보면 멤버로 Thread의 고유 HashCode를 가지고 있다.
그리고 내장 클래스로 ThreadLocalMap 을 가지고 있는데 

Thread 고유 HashCode로 생성을 한다.

그리고 ThreadLocal의 get 함수 set함수 remove 함수를 보면 
ThreadLocalMap에 저장,조회,삭제 연산을 수행한다.

 

ThreadLocal 의 활용 예시

• 사용자 인증정보 전파 - Spring Security에서는 ThreadLocal을 이용해서 사용자 인증 정보를 전파한다.
• 트랜잭션 컨텍스트 전파 - 트랜잭션 매니저는 트랜잭션 컨텍스트를 전파하는 데 ThreadLocal을 사용한다.
• 쓰레드에 안전해야 하는 데이터 보관

ThreadLocal 사용시 주의 사항

위에서 봤듯이 모든 요청에 쓰레드를 반환하는 RestAPI에서 공유되는 데이터에 유용하게
사용할 수 있다.

하지만 ThreadLocal에 코드를 보면 요청당 배정이 아닌 쓰레드 당 배정이다
그래서 쓰레드 풀을 사용하는 백엔드 서버 상황에서 ThreadLocal을 잘못 사용하면 문제가 발생한다.

이런 상황에서는 ThreadLocal안에 Data를 초기화 해주어야 한다.

 

참고 문헌

ThreadLocal이란? (tistory.com)

ThreadLocal 사용법과 활용 :: 자바캔(Java Can Do IT) (tistory.com)