ThreadLocal과 ThreadLocalUtil

 

 

|ThreadLocal이란

ThreadLocal은 Java의 스레드 로컬 변수를 관리할 수 있도록 하는 기능이다. 지금까지 변수들은 클래스, 메서드 레벨에서 관리되었는데 스레드별로 저장되고 관리할 수 있는 것이다.

 

즉, 한 스레드에서 설정한 ThreadLocal 변수의 값은 다른 스레드와 공유되지 않으며, 각 스레드는 해당 변수의 자신만의 독

립적인 값을 유지하게 된다. 이를 통해 스레드 간 데이터 격리가 이루어져 스레드 안전성(thread-safety)을 확보할 수 있다.

 

더 간단히 설명하자면 threadLocal변수를 선언하면 멀티 스레드 환경에서 각 스레드마다 독립적인 변수를 가지게 되고 각 값은 get(), set() 메서드를 통해 접근할 수 있게 된다. 

**thread-safety

멀티 스레딩 환경에서 여러 스레드가 동시에 같은 인스턴스의 메소드를 호출하거나 같은 자원에 접근해도 프로그램의 실행 결과가 올바르게 나오는 것을 의미한다. 즉, 코드가 예상한 대로 동작하여 데이터의 정확성과 일관성을 유지하며, 예기치 않은 문제가 발생하지 않는 상태를 말한다.

 

 

 

|ThreadLocal 예시

public class ThreadLocalExample {

    // ThreadLocal 변수 정의
    private static ThreadLocal<String> threadLocal1 = new ThreadLocal<>();
    private static ThreadLocal<String> threadLocal2 = new ThreadLocal<>();

    public static void main(String[] args) {
        // 첫 번째 스레드에서 ThreadLocal 변수에 값 할당
        Thread thread1 = new Thread(() -> {
            threadLocal1.set("Value 1 from Thread 1");
            threadLocal2.set("Value 2 from Thread 1");

            System.out.println("Thread 1 - ThreadLocal1: " + threadLocal1.get());
            System.out.println("Thread 1 - ThreadLocal2: " + threadLocal2.get());
        });

        // 두 번째 스레드에서 ThreadLocal 변수에 값 할당
        Thread thread2 = new Thread(() -> {
            threadLocal1.set("Value 1 from Thread 2");
            threadLocal2.set("Value 2 from Thread 2");

            // 잠시 대기하여 첫 번째 스레드가 값을 출력하고 나서 출력하도록 함
            try {
                Thread.sleep(100); // 100ms 대기
            } catch (InterruptedException e) {
                e.printStackTrace();
            }

            System.out.println("Thread 2 - ThreadLocal1: " + threadLocal1.get());
            System.out.println("Thread 2 - ThreadLocal2: " + threadLocal2.get());
        });

        // 스레드 시작
        thread1.start();
        thread2.start();
    }
}

 

각 쓰레드의 동일한 변수명에(threadLocal1, threadLocal2) 값을 지정했다. 출력 결과는 다음과 같다.

(스레드 스케쥴러에 따라 실제는 약간의 차이가 있을 수 있다.)

 

 

이 출력 결과는 thread1과 thread2가 각각 ThreadLocal1과 ThreadLocal2에 서로 다른 값을 저장하고, 이 값들이 스레드 간에 독립적임을 보여준다. 각 스레드는 자신이 설정한 ThreadLocal 변수의 값을 출력하며, 다른 스레드의 값에 영향을 받지 않는다.

 

 

 

 

|ThreadLocal 작동원리 - set(), get()

ThreadLocal의 set() 구현원리는 다음 코드와 같다.

    public void set(T value) {
        Thread currentThread = Thread.currentThread();
        ThreadLocalMap map = getMap(currentThread);
        if (map != null) {
            map.set(this, value);
        } else {
            createMap(currentThread, value);
        }
    }
    
    public T get() {
        Thread t = Thread.currentThread();
        ThreadLocalMap map = getMap(t);
        if (map != null) {
            ThreadLocalMap.Entry e = map.getEntry(this);
            if (e != null) {
                @SuppressWarnings("unchecked")
                T result = (T)e.value;
                return result;
            }
        }
        return setInitialValue();
}

 

> set () 구현원리

1. 현재 스레드의 ThreadLocalMap을 얻는다. ThreadLocalMap은 ThreadLocal 변수들의 값을 저장하기 위해 각 스레드에 할당된 맵이다. 만약 현재 스레드에 ThreadLocalMap이 아직 없으면, 새로운 ThreadLocalMap을 생성하고 현재 스레드에 할당한다.
2. 얻어진 ThreadLocalMap에 현재 ThreadLocal 인스턴스를 키로 하여, set 메소드에 전달된 값을 저장한다. 만약 이 키에 해당하는 값이 이미 맵에 존재한다면, 새로운 값으로 대체된다.

 

> get() 구현원리

 

1. 현재 스레드 획득: Thread.currentThread()를 호출하여 현재 실행 중인 스레드 객체를 획득한다.
2. 스레드별 저장소 조회: getMap(t)를 통해 현재 스레드에 할당된 ThreadLocalMap 인스턴스를 조회한다. 
3. 값 조회:
   • ThreadLocalMap이 존재한다면, map.getEntry(this)를 호출하여 현재 ThreadLocal 객체(this)에 대한 저장된 값을 포함하는 Entry 객체를 조회한다. 이때, this는 현재 ThreadLocal 인스턴스를 참조한다.
   • Entry 객체가 존재한다면, 이 객체의 value 필드에서 실제 저장된 값을 조회한다. Entry 객체는 ThreadLocalMap 내부에서 ThreadLocal 인스턴스와 연결된 값을 관리하기 위해 사용되는 내부 클래스.
4. 값 반환:
   • 조회한 값이 존재하면, 이 값을 캐스팅하여 반환한다. 여기서 @SuppressWarnings("unchecked") 애너테이션은 이 캐스팅 과정에서 발생할 수 있는 타입 안정성 경고를 억제한다.
   • 만약 ThreadLocalMap이 존재하지 않거나, 현재 ThreadLocal 객체에 대한 Entry가 없는 경우(null인 경우), setInitialValue() 메소드를 호출한다. 이 메소드는 ThreadLocal 변수의 초기값을 설정하고 이 값을 반환하는 역할을 하는데, 이 초기값은 ThreadLocal의 initialValue() 메소드를 오버라이딩하여 제공할 수 있으며, 기본 구현은 null을 반환다.

 

 

|ThreadLocalUtil이란

ThreadLocalUtil은 자바에서 사용되는 사용자 정의 유틸리티 클래스이름으로. threadlocal을 사용하여 스레드별로 데이터를 저장하고 관리하는 기능을 제공한다. 앞 서 설명한 것처럼 threadlocal은 각 스레드가 그 스레드 내부에서 전역적으로 사용할 수 있는 데이터를 가지게 해주므로 데이터의 안정성을 보장할 수 있다.

ThreadLocalUtil의 주요기능은 다음과 같다.

• 스레드별 데이터 저장과 접근: ThreadLocalUtil을 통해 각 스레드에서만 접근 가능한 데이터를 저장하고, 필요할 때 해당 데이터를 안전하게 조회할 수 있다. 이는 스레드 간의 데이터 충돌을 방지하고 스레드 안전성을 높인다.
• 사용자 세션 관리: 웹 애플리케이션에서는 사용자의 세션 정보나 인증 정보와 같은 중요한 정보를 ThreadLocal을 사용하여 관리할 수 있다. 이를 통해 현재 요청을 처리하는 스레드에서 사용자의 세션 정보를 쉽게 접근하고 관리할 수 있다.
• 임시 데이터 저장: 계산 중간 결과나 메서드 간에 전달해야 하는 임시 데이터를 스레드별로 저장하기 위해 사용할 수 있다. 이러한 용도로 ThreadLocalUtil을 사용하면 메서드의 매개변수를 줄이고 코드의 가독성을 높일 수 있다.

 

|ThreadLocalUtil 예시

아래는 ThreadLocalUtil 을 사용하여 스레드별로 사용자 아이디를 저장하는 간단한 예시이다.

ThreadLocalUtil 클래스를 사용하여 각 스레드에서 사용자 ID를 설정하고 필요할때마다 안전하게 접근할 수 있다. 다만 스레드 작업이 완료되면 clear() 메서드를 호출하여 메모리 누수를 방지해야한다.

public class ThreadLocalUtil {
    private static final ThreadLocal<String> userId = new ThreadLocal<>();

    public static void setUserId(String id) {
        userId.set(id);
    }

    public static String getUserId() {
        return userId.get();
    }

    public static void clear() {
        userId.remove();
    }
}

 

 

아래처럼 로그인 성공시, 사용자 ID를 ThreadLocalUtil에 저장하도록 하고 필요한 곳에서 ThreadLocalUtil을 사용하여 현재 세션의 사용자 ID를 가져와 사용할 수 있다.

// 사용자 로그인 시 사용자 ID를 ThreadLocalUtil에 저장하는 예시
public void onUserLogin(String userId) {
    // 사용자 ID를 ThreadLocalUtil에 저장
    ThreadLocalUtil.set(ThreadLocalUtil.KEY.sessUserId, userId);
}

// ThreadLocalUtil로부터 현재 세션의 사용자 ID를 가져와 저장하는 예시
public void someMethod() {
    // ThreadLocalUtil에서 사용자 ID 가져오기
    String sessUserID = (String) ThreadLocalUtil.get(ThreadLocalUtil.KEY.sessUserId);
    
    // 가져온 사용자 ID 사용 (예: 사용자 ID 확인, 로그 출력 등)
    System.out.println("Current Session User ID: " + sessUserID);
}