[Spring Boot & MSA] Thread Context & Hystrix

✔ 깃허브 소스코드
✔ Udemy 강의

🌟 Thread Context & Hystrix

     @HystrixCommand 가 실행될 때 THREAD 와 SEMAPHORE 라는 두 가지 다른 격리 전략을 수행할 수 있습니다. 기본적으로 히스트릭스는 THREAD 격리 전략을 수행합니다. 호출을 보호하는 데 사용된 모든 히스트릭스 명령은 호출을 시도한 부모 스레드와 컨텍스트를 공유하지 않는 격리된 스레드 풀에서 수행됩니다. 이는 히스트릭스가 자기 통제하에서 원래 호출을 시도한 부모 스레드와 연관된 어떤 활동도 방해하지 않고 스레드 실행을 중단할 수 있다는 것을 의미합니다.

     반면에 SEMAPHORE 기반 격리 방법을 사용하면 히스트릭스는 새로운 스레드를 시작하지 않고 @HystrixCommand 어노테이션이 보호하는 분산 호출을 관리하며 타임 아웃이 발생하면 부모 스레드를 중단시킵니다. Tomcat 처럼 동기식 컨테이너 서버 환경에서 부모 스레드를 중단하면 개발자가 예외 처리를 할 수 없는 예외가 발생합니다. 이처럼 발생한 예외를 처리할 수 없거나 자원 정리 및 에러 처리를 수행할 수 없다면 개발자가 코드를 작성할 때 예상하지 못한 결과가 발생할 수 있습니다.

✔ 명령 풀에 대한 격리 설정 방법

@HystrixCommand(
  commandProperties = {
    @HystricProperty(name = "execution.isolation.strategy", value = "SEMAPHORE")
  }
)
public void someMethod() {}

✔ NOTE

     기본적으로 대부분의 명령에 대해 기본 격리 전략인 THREAD 방식을 권장합니다. THREAD 격리 방식은 히스트릭스 명령 스레드와 부모 스레드 사이에 격리 수준을 높이며, SEMAPHORE 격리 방식보다 무겁습니다. SEMAPHORE 격리 모델은 격량이며, 서비스에서 대용량을 처리하고 비동기 I/O 프로그래밍 모델을 적용할 때 사용해야 합니다.

🚀 ThreadLocal & Hystrix

     기본적으로 히스트릭스는 부모 스레드의 컨텍스트를 히스트릭스 명령이 관리하는 스레드에 전파하지 않습니다. 예를 들어 부모 스레드에서 ThreadLocal로 설정된 값은 기본적으로 부모 스레드가 호출하는 메소드에서 사용할 수 없고 @HystrixCommand 객체로 보호됩니다.

     REST 기반 환경에서 종종 서비스를 운영 관리하는 데 도움이 되는 컨텍스트 관련 정보를 서비스 호출로 전달하는 경우가 있습니다. 예를 들어 HTTP Header에 상관 관계 ID(Correlation ID)나 인증 토큰을 담아 전달한 후 모든 하위 서비스 호출에 전파할 수 있습니다. 여기서 상관 관계 ID를 사용하면 한 트랜잭션 내 여러 서비스 호출을 추적할 수 있는 고유한 식별자(ID)를 갖게 됩니다.

     이 값들을 모든 서비스 호출에 사용할 수 있게 하려면 스프링 필터(Spring Filter) 클래스를 사용해 REST 서비스에 대한 모든 호출을 가로채고, 들어오는 HTTP 요청에서 컨텍스트 정보를 추출해 사용자 정의한 UserContext 객체에 저장할 수 있습니다.

✔ 스프링 필터 예제 코드

@Component
public class UserContextFilter implements Filter {

    private static final Logger logger = LoggerFactory.getLogger(UserContextFilter.class);


    /**
     *
     * HTTP Request Header에서 검색한 값을 UserContextHolder의 UserContext에 저장한다.
     *
     */
    @Override
    public void doFilter(
            ServletRequest servletRequest,
            ServletResponse servletResponse,
            FilterChain filterChain
    ) throws IOException, ServletException {

        HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;

        UserContextHolder.getContext().setCorrelationId(httpServletRequest.getHeader(UserContext.CORRELATION_ID));
        UserContextHolder.getContext().setUserId(httpServletRequest.getHeader(UserContext.USER_ID));
        UserContextHolder.getContext().setAuthToken(httpServletRequest.getHeader(UserContext.AUTH_TOKEN));
        UserContextHolder.getContext().setOrgId(httpServletRequest.getHeader(UserContext.ORG_ID));

        logger.debug("UserContextFilter Correlation id: {}", UserContextHolder.getContext().getCorrelationId());

        filterChain.doFilter(httpServletRequest, servletResponse);
    }
}

UserContextHolder 클래스는 ThreadLocal 클래스에 UserContext를 저장하는 데 사용됩니다. UserContext가 ThreadLocal 저장소에 저장되면 요청으로 실행된 모든 코드에서 UserContextHolder의 UserContext 객체를 사용할 수 있습니다.

✔ UserContextHolder & UserContext 예제 코드

public class UserContextHolder {

    // 정적 ThreadLocal 변수에 저장되는 UserContext
    private static final ThreadLocal<UserContext> userContext = new ThreadLocal<UserContext>();

    public static UserContext getContext() {
        UserContext context = userContext.get();

        if(context == null) {
            context = createEmptyContext();
            userContext.set(context);
        }
        return userContext.get();
    }

    public static void setContext(UserContext context) {
        Assert.notNull(context, "Only non-null UserContext instances are permitted.");
        userContext.set(context);
    }

    public static UserContext createEmptyContext() {
        return new UserContext();
    }
}

@Component
@Getter
@Setter
public class UserContext {

    public static final String CORRELATION_ID = "spmia-correlation-id";
    public static final String AUTH_TOKEN = "spmia-auth-token";
    public static final String USER_ID = "spmia-user-id";
    public static final String ORG_ID = "spmia-org-id";

    private String correlationId = "";
    private String authToken = "";
    private String userId = "";
    private String orgId = "";
}