[스프링 핵심 원리 - 고급편] #1. 예제만들기(1)

[Pracrobo]

프로젝트 생성

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class AdvancedApplication {
    public static void main(String[] args) {
        SpringApplication.run(AdvancedApplication.class, args);
    }
}

main 실행

예제 프로젝트 만들기 - V0

• Controller → Service → Repository

Repository

package hello.advanced.v0;

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Repository;

@Repository
@RequiredArgsConstructor
public class OrderRepositoryV0 {

    public void save(String itemId) {
        // 저장로직
        if (itemId.equals("ex")) {
            throw new IllegalArgumentException("예외발생! ");
        }
        sleep(1000);
    }

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

Service

package hello.advanced.v0;

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
@RequiredArgsConstructor
public class OrderServiceV0 {
    private final OrderRepositoryV0 orderRepository;

    public void orderItem(String itemId) {
        orderRepository.save(itemId);
    }
}

또는 @requiredargsconstructor 가 없다면

package hello.advanced.v0;

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;

@Service
public class OtherService {
    private final OrderRepositoryV0 orderRepository;
    // 생성자
    @Autowired
		public OrderService(OrderRepositoryV0 orderRepository) {
			this.orderRepository = orderRepository;
		}
		
    public void orderItem(String itemId) {
        orderRepository.save(itemId);
    }
}

Controller

package hello.advanced.v0;

import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController // @Controller + @ResponseBody
@RequiredArgsConstructor
public class OrderControllerV0 {
    private final OrderServiceV0 orderService;

    @GetMapping("/v0/request")
    public String request(String itemId) {
        orderService.orderItem(itemId);
        return "OK"; // @RestController 이기 때문에 문자
    }

}

정상출력

ex 입력시

package hello.advanced.v0;

import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Repository;

@Repository
@RequiredArgsConstructor
public class OrderRepositoryV0 {

    public void save(String itemId) {
        // 저장로직
        if (itemId.equals("ex")) {
            throw new IllegalArgumentException("예외발생! ");
        }
        sleep(1000);
    }

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

로그추적기 - 요구사항 분석

요구사항 - 로그추적기 만들기
모니터링이 중요해짐, 병목현상이 생겨서, 로그를 통해 확인하는게 중요해진 상황
미리 남겨두면 손쉽게 찾을 수 있으니 이 부분을 개선하고 자동화하는 것이 미션 !

요구사항

• 모든 PUBLIC 메서드 호출과 응답 정보를 로그로 출력
• 애플리케이션의 흐름을 변경하면 안됨 : 예외가 발생해도 돌아가야함
  • 로그를 남긴다고 해서 비즈니스 로직의 동작에 영향을 주면 안됨
• 메서드 호출에 걸린 시간 (time)
• 정상흐름과 예외 흐름 구분
  • 예외 발생시 예외 정보가 남아야 함
• 메서드 호출의 깊이 표현(level 표현 : |—>)
• HTTP 요청을 구분 (ID는 랜덤으로 만들어)
  • HTTP 요청 단위로 특정 ID 를 남겨서 어떤 HTTP 요청에서 시작된 것인지 명확하게 구분이 가능해야함
  • 트랜잭션 ID(DB 트랜잭션 X, ex. [0980889b]), 여기서는 하나의 HTTP 요청이 시작해서 끝날때까지를 하나의 트랜잭션이라 함

예시

참고

모니터링 툴을 도입하면 많은 부분이 해결되지만 지금은 학습이 목적

로그추적기 V1 - 프로토타입개발

• 애플리케이션의 모든 로직에 로그를 남겨도 됨

• 그것보다는 효율적인 방법이 필요함

• 깊이를 표현하는 방법을 기존 정보에 이어 받아야하기 때문에 단순히 로그만 남긴다고 해결할 수 있는건 아니다.

• 요구사항에 맞추어 애플리케이션에 효과적으로 로그를 남기기 위한 로그 추적기를 개발해보자

  • 먼저 프로토타입 버전을 개발해보자, 아마 코드를 모두 작성하고 테스트 코드까지 실행해보아야 어떤것을 하는지 감이 올 것이다.

• 먼저 로그 추적기를 위한 기반 데이터를 가지고 있는 ‘TraceId’, ‘TraceStatus’ 클래스를 만들어 보자.

TraceId 클래스

로그 추적기는 트랜잭션 ID와 깊이를 표현하는 방법이 필요하다

여기서는 트랜잭션ID 와 깊이를 표현하는 level을 묶어서 ‘TraceId’라는 개념을 만들었다.

‘TraceId’는 단순히 ‘id’(트랜잭션ID)와 ‘level’정보를 함께 가지고 있다.

package hello.advanced.trace;

import java.util.UUID;

public class TraceId {
    private String id; //트랜잭션Id
    private int level;

    public TraceId() {
        this.id = createId();
        this.level = 0;
    }

    private TraceId(String id, int level) {
        this.id = id;
        this.level = level;
    }

    // UUID
    // ab99e16f-3cde-4d24-8241-256108c203a2 //생성된 UUID
    // ab99e16f //앞 8자리만 사용
    private String createId() {
        return UUID.randomUUID().toString().substring(0, 8);
    }

    public TraceId createNextId() {  //  id는 같고 레벨만 증가해서 표현
        return new TraceId(id, level + 1);
    }

    public TraceId createPreviousId() {
        return new TraceId(id, level - 1);
    }

    public boolean isFirstLevel() {
        return level == 0;
    }

    public String getId() {
        return id;
    }

    public int getLevel() {
        return level;
    }
}

createNextId()

다음 TranceId 를 만든다. 예제 로그를 보면 깊이가 증가해도 트랜잭션 ID 는 같다. 대신에 깊이가 하나 증가한다

new TraceId(jd, level + 1)

따라서 createNextId()를 사용해서 현재 TraceId 를 기반으로 다음 TraceId를 만들면 ‘id’는 기존과 같고 ‘level은 하나 증가한다.

createPreviousId()

createNextId()의 반대 역할을 한다.

id는 기존과 같고, level은 하나 감소한다.

isFirstLevel()

첫번째 레벨 여부를 편리하게 확인할 수 있는 메서드

TraceStatus클래스

로그의 상태 정보를 만드는것

package hello.advanced.trace;

public class TraceStatus {
    private TraceId traceId;
    private Long startTimeMs;
    private String message;

    public TraceStatus(TraceId traceId, Long startTimeMs, String message) {
        this.traceId = traceId;
        this.startTimeMs = startTimeMs;
        this.message = message;
    }

    public TraceId getTraceId() {
        return traceId;
    }

    public Long getStartTimeMs() {
        return startTimeMs;
    }

    public String getMessage() {
        return message;
    }
}

로그를 시작하면 끝이 있어야 한다.

TraceStatus 는 로그를 시작할때의 상태 정보를 가지고 있다. 이 상태 정보는 로그를 종료할때 사용된다.

• traceId : 내부에 트랜잭션 ID와 level을 가지고 있다.
• startTimeMs : 로그 시작 시간이다. 로그 종료시 이 시작 시간을 기준으로 시작~종료까지 전체 수행 구간을 구할 수 있다.
• message : 시작시 사용한 메세지이다. 이후 로그 종료시에도 이 메세지를 사용해서 출력한다.

TraceId, TraceStatus 를 사용해서 실제 로그를 생성하고 처리하는 기능을 개발해보자.

package hello.advanced.trace.hellotrace;

import hello.advanced.trace.TraceId;
import hello.advanced.trace.TraceStatus;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;

@Slf4j
@Component
public class HelloTraceV0 {

    private static final String START_PREFIX = "-->";
    private static final String COMPLETE_PREFIX = "<--";
    private static final String EX_PREFIX = "<X-";

    public TraceStatus begin(String message) {
        TraceId traceId = new TraceId();
        Long startTimeMs = System.currentTimeMillis();
        log.info("[{}] {}{}", traceId.getId(), addSpace(START_PREFIX,
                traceId.getLevel()), message); //addSpace ->
        // 로그 출력
        return new TraceStatus(traceId, startTimeMs, message);
    }

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

    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());
        }
    }
    // 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();

    }
}

• HelloTraceV1 을 사용해서 실제 로그를 시작하고 종료할 수 있다. 그리고 로그를 출력하고 실행시간도 측정할 수 있다.
• @Component : 싱글톤으로 사용하기 위해 스프링 빈으로 등록한다. 컴포넌트 스캔의 대상이 된다.

공개 메서드

로그 추적기에서 사용되는 공개 메서드는 다음 3가지이다.

• begin(..)
• end(..)
• exception(..)

하나씩 알아보자

TraceStatus begin(String message)

• 로그를 시작한다.
• 로그 메시지를 파라미터로 받아서 시작 로그를 출력한다.
• 응답 결과롤 현재 로그의 상태인 TraceStatus 를 반환한다.

void end(TraceStatus status)

• 로그를 정상 종료한다.
• 파라미터로 시작 로그의 상태(TraceStatus)를 전달받는다. 이 값을 활용해서 실행시간을 계산하고 종료시에도 시작할때와 동일한 로그 메시지를 출력할 수 있다.
• 정상 흐름에서 호출한다.

void exception(TraceStatus status, Exception e)

• 로그를 예외 상황으로 종료한다.
• TraceStatus, Exception 정보를 함께 전달받아서 실행시간, 예외정보를 포함한 결과 로그를 출력한다.
• 예외가 발생했을때 호출한다.

비공개 메서드

• complete(TraceStatus status, Exception e)
  • ‘end()’ , ‘exception()’ 의 요청 흐름을 한곳에서 편리하게 처리한다. 실행 시간을 측정하고 로그를 남긴다.
• String addSpace(String prefix, int level) : 다음과 같은 결과를 출력한다.

  • prefix : -->

    • level 0 : ‘ ’
    • level 1: ‘ |—>‘
    • level 2: ‘ | |—>’

  • prefix: ‘←-’

    • level 0 : ‘ ‘
    • level 1: ‘|←-’
    • level 2: ‘| |←-’

  • prefix: ‘<X—’

    • level 0: ‘ ‘
    • level 1: ‘|<X-’
    • level 2: ‘| |<X-’

참고로 HelloTraceV1 는 아직 모든 요구사항을 만족하지는 못한다. 이후에 기능을 하나씩 추가할 예정이다.

테스트 작성

package hello.advanced.trace.hellotrace;

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

class HelloTraceV1Test {

    @Test
    void begin_end() {
        HelloTraceV1 trace = new HelloTraceV1();
        TraceStatus status = trace.begin("hello");
        trace.end(status);
    }

    @Test
    void begin_exception() {
        HelloTraceV1 trace = new HelloTraceV1();
        TraceStatus status = trace.begin("hello");
        trace.exception(status, new IllegalStateException());
    }
}

이제 다음시간에 실제 애플리케이션에 적용해볼 것임

참고: 이것은 온전한 테스트 코드가 아니다. 일반적으로 테스트라고 하면 자동으로 검증하는 과정이 필요하다. 이 테스트는 검증하는 과정이 없고 결과를 콘솔로 직접 확인해야 한다. 이렇게 응답값이 없는 경우를 자동으로 검증하려면 여러가지 테스트 기법이 필요하다. 이번 강의에서는 예제를 최대한 단순화하기 위해 검증 테스트를 생략했다..

[YuDeokRin]

수고하셧습니다 !