[스프링 핵심원리 - 고급편] #2. 스레드 로컬(Thread Local)(1)

[Pracrobo]

필드 동기화 - 개발

앞서 로그 추적기를 만들면서 다음 로그를 출력할때 트랜잭션 ID와 level을 동기화하는 문제가 있었다.

traceId를 파라미터로 넘기지 않고 이 문제를 해결하는 방법은 없을까?

코드작성

interface : LogTrace

package hello.advanced.trace.logtrace;

import hello.advanced.trace.TraceStatus;

public interface LogTrace {
    TraceStatus begin(String message);

    void end(TraceStatus status);

    void exception(TraceStatus status, Exception e);
}

FieldLogTrace

• implements method

package hello.advanced.trace.logtrace;

import hello.advanced.trace.TraceId;
import hello.advanced.trace.TraceStatus;
import lombok.extern.slf4j.Slf4j;

@Slf4j
public class FieldLogTrace implements LogTrace {

    private static final String START_PREFIX = "-->";
    private static final String COMPLETE_PREFIX = "<--";
    private static final String EX_PREFIX = "<X-";
    private TraceId traceIdHolder; // traceId 동기화, 동시성 이슈 발생

    @Override
    public TraceStatus begin(String message) {
        syncTraceId(); // 호출
        TraceId traceId = traceIdHolder; // 여기서 꺼내 쓴다.
        Long startTimeMs = System.currentTimeMillis();
        log.info("[{}] {}{}", traceId.getId(), addSpace(START_PREFIX,
                traceId.getLevel()), message); //addSpace ->
        // 로그 출력
        return new TraceStatus(traceId, startTimeMs, message);
    }

    private void syncTraceId() {
        if (traceIdHolder == null) {
            traceIdHolder = new TraceId();
        } else {
            traceIdHolder = traceIdHolder.createNextId();
        }
    }
    //생성

    @Override
    public void end(TraceStatus status) {
        complete(status, null);
    }

    @Override
    public void exception(TraceStatus status, Exception e) {
        complete(status, e);
    }

    private void complete(TraceStatus status, Exception e) {
        Long stopTimeMs = System.currentTimeMillis();
        long resultTimeMs = stopTimeMs - status.getStartTimeMs();
        TraceId traceId = status.getTraceId();
        if (e == null) {
            log.info("[{}] {}{} time={}ms", traceId.getId(),
                    addSpace(COMPLETE_PREFIX, traceId.getLevel()), status.getMessage(),
                    resultTimeMs);
        } else {
            log.info("[{}] {}{} time={}ms ex={}", traceId.getId(),
                    addSpace(EX_PREFIX, traceId.getLevel()), status.getMessage(), resultTimeMs,
                    e.toString());
        }
        releaseTraceId();
    }

    private void releaseTraceId() {
        if (traceIdHolder.isFirstLevel()) {
            traceIdHolder = null; //destory //첫번째면 destory
            
        } else {
            traceIdHolder = traceIdHolder.createPreviousId(); //  나올때 줄어듬

        }
    }

    // level = 0
    // level=1 |-->
    // level=2 |   |-->
    // level=2 ex |    |<X-
    // level=1 ex |<X-
    private static String addSpace(String prefix, int level) {
        StringBuilder sb = new StringBuilder();
        for (int i = 0; i < level; i++) {
            sb.append((i == level - 1) ? "|" + prefix : "|   ");
        }
        return sb.toString();

    }

}

• FieldLogTrace 는 기존에 만들었던 HelloTraceV2와 거의 같은 기능을 한다.
• TraceId 를 동기화하는 부분만 파라미터를 사용하는 것에서 TraceId traceIdHolder 필드를 사용하도록 변경되었다.
• 이제 직전 로그의 TraceId는 파라미터로 전달되는 것이 아니라 FieldLogTrace 의 필드인 traceIdHolder에 저장된다.

여기서 중요한 부분은 로그를 시작할때 호출하는 syncTraceId() 와 로그를 종료할때 호출하는 releaseTraceId() 이다.

• syncTraceId()

  • TraceId를 새로 만들거나 앞선 로그의 TraceId 를 참고해서 동기화하고 level도 증가한다.
  • 최초 호출이면 TraceId를 새로 만든다.
  • 직전 로그가 있으면 해당 로그의 TraceId를 참고해서 동기화하고 level도 하나 증가한다.
  • 결과를 traceHolder에 보관한다.

• releaseTraceId()

  • 메서드를 추가로 호출할 때는 level이 하나 증기해야하지만, 메서드 호출이 끝나면 level1이 하나 감소해야 한다.
  • releaseTraceId()는 level을 하나 감소한다.
  • 만약 최초 호출(*level==0)이면 내부에서 관리하는 traceId를 제거한다.

결과

정상 테스트 코드

FieldLogTraceTest

package hello.advanced.trace.logtrace;

import hello.advanced.trace.TraceStatus;
import org.junit.jupiter.api.Test;

class FieldLogTraceTest {
    FieldLogTrace trace = new FieldLogTrace();

    @Test
    void begin_end_level2() {
        TraceStatus status1 = trace.begin("hello1");
        TraceStatus status2 = trace.begin("hello2");
        trace.end(status2);
        trace.end(status1);
        
    }

}

정상 테스트 실행

예외 테스트 코드

    @Test
    void begin_exception_level2() {
        TraceStatus status1 = trace.begin("hello1");
        TraceStatus status2 = trace.begin("hello2");
        trace.exception(status2, new IllegalStateException());
        trace.exception(status1, new IllegalStateException());
    }

예외테스트 실행

• 실행결과를 보면 트랜잭션 ID도 동일하게 나오고 level1을 통한 깊이도 잘 표현된다.
• FieldLogTrace.traceIdHolder 필드를 사용해서 TraceId가 잘 동기화 되는 것을 확인할 수 있다.
• 이제 불필요하게 traceId를 파라미터로 전달하지 않아도 되고 애플리케이션의 메서드 파라미터도 변경하지 않아도 된다.