Spring에서의 ThreadLocal

hoyong.eom·2023년 9월 11일

Java Spring ThreadLocal

스프링

목록 보기

40/59

Spring

ThreadLocal

일반적으로 스프링빈으로 등록된 객체는 싱글톤 패턴으로 사용된다.
따라서, 스프링빈으로 등록된 객체의 상태 변화를 일으킬 수 있는 인스턴스 변수, 또는 함수는 동시성 문제를 일으킬 수 있다.

이러한 문제를 해결하기 위해서 자바는 쓰레드 로컬이라는 기능을 사용할 수 있다.

쓰레드 로컬은 해당 쓰레드만 접근할 수 있는 특별한 저장소를 말한다. 쉽게 이야기해서 물건 보관 창구를 떠올리면 된다. 여러 사람이 같은 물건 보고나 창구를 사용하더라도 창구 직원은 사용자를 인식해서 사용자별로 확실하게 물건을 구분해준다.
사용자 A, 사용자 B 모두 창구 직원을 통해 물건을 보관하고, 꺼내지만 창구 직원이 사용자에 따라 보관한 물건을 구분해주는 것이다.

위 그림처럼 일반적으로 여러 쓰레드가 같은 인스턴스의 필드에 접근하면 처음 쓰레드에 보관한 데이터가 사라질 수 있다.

그러나, 쓰레드 로컬을 사용하면 각 쓰레드마다 별도의 내부 저장소를 제공한다. 따라서 같은 인스턴스의 쓰레드 로컬 필드에 접근해도 문제가 없다.

thread-A가 userA라는 값을 저장하면 쓰레드 로컬은 thread-A 전용 보관소에 데이터를 안전하게 보관한다.

thread-B가 user-B라는 값을 저장하면 쓰레드 로컬은 thread-B 전용 보관소에 데이터를 안전하게 보관한다.

쓰레드 로컬을 통해서 데이터를 조회할 때도 thred-A가 조회하면 쓰레드 로컬은 thread-A 전용 보관소에서 userA 데이터를 반환해준다. 물론 thread-B가 조회하면 thread-B 전용 보관소에서 userB 데이터를 반환해준다.

자바는 언어 차원에서 쓰레드 로컬을 지원하기 위한 java.lang.ThreadLocal 클래스를 제공한다.

ThreadLocal 예제

아래는 예제 코드이다.

public class ThreadLocalServiceTest {

    private ThreadLocalService service = new ThreadLocalService();

    @Test
    void field() {
        log.info("main start");
        Runnable userA = () -> {
            service.logic("userA");
        };
        Runnable userB = () -> {
            service.logic("userB");
        };

        Thread threadA = new Thread(userA);
        threadA.setName("thread-A");
        Thread threadB = new Thread(userB);
        threadB.setName("thread-B");

        threadA.start();
//        sleep(2000); //동시성 문제 발생X
        sleep(100); //동시성 문제 발생O
        threadB.start();

        sleep(3000); //메인 쓰레드 종료 대기
        log.info("main exit");
    }

    private void sleep(int millis) {
        try {
            Thread.sleep(millis);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

@Slf4j
public class ThreadLocalService {

    private ThreadLocal<String> nameStore = new ThreadLocal<>();

    public String logic(String name) {
        log.info("저장 name={} -> nameStore={}", name, nameStore.get());
        nameStore.set(name);
        sleep(1000);
        log.info("조회 nameStore={}", nameStore.get());
        return nameStore.get();
    }

    private void sleep(int millis) {
        try {
            Thread.sleep(millis);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

쓰레드에서 작업이 수행될 서비스의 인스턴스 변수로 쓰레드로컬변수가 선언되어 사용되고 있다.

private ThreadLocal<String> nameStore = new ThreadLocal<>();

ThreadLocal 사용 방법

값 저장 : ThreadLocal.set(xxx)
값 조회 : ThreadLocal.get()
값 제거 : ThreadLocal.remove()

주의
해당 쓰레드가 쓰레드 로컬을 모두 사용하고 나면 ThreadLocal.remove()를 호출해서 쓰레드 로컬에 저장된 값을 제거해줘야한다.

ThreadLocal 주의 사항

추가로 쓰레드 로컬을 모두 사용하고 나면 꼭!! <ThreadLocal.remove()>를 호출해서 쓰레드 로컬에 저장된 값을 제거해줘야한다.
만약, 제거하지않고 두면 WAS(톰캣)처럼 쓰레드 풀을 사용하는 경우에 심각한 문제를 발생시킬 수 있다.

1. 사용자A가 저장 HTTP를 요청했다.
1. WAS는 쓰레드풀에서 쓰레드를 하나 조회한다.
1. 쓰레드 thread-A가 할당되었다.
1. thread-A는 사용자A의 데이터를 쓰레드 로컬에 저장한다.

1. 사용자 A의 HTTP 응답이 끝난다.
1. WAS는 사용이 끝난 thread-A를 쓰레드 풀에 반환한다. 쓰레드를 생성하는 비용은 비싸기 때문에 쓰레드를 제거하지 않고 보통은 쓰레드 풀을 통해 쓰레드를 재사용한다.
1. thread-A는 쓰레드풀에 아직 살아있다. 따라서 쓰레드 로컬의 thread-A 전용 보관소에 사용자A 데이터도 함께 살아있다.