템플릿 메서드 패턴

템플릿 메서드 패턴 개요

이전 포스팅에서 쓰레드 로컬을 사용하여, 매개변수를 넘기는 수고를 덜 수 있는 로그 추적기를 만들었다.
- 이전 게시글: [스프링-ADV] 쓰레드 로컬
꼭 이전 글을 참고한 뒤, 본 글을 읽자.

기존 로그 추적기의 문제점

이전 포스팅에서 요구사항을 만족하는 로그 추적기를 잘 만들었다. 또한 파라미터를 넘기는 불편함까지 제거했다.
- 요구사항 참고 링크

하지만 여전히 불편한 점이 있다. 로그 추적기 도입 전과 도입 후의 코드를 비교해보자.

로그 추적기 도입 전 - OrderControllerV0 , OrderServiceV0

  //OrderControllerV0 코드
  @GetMapping("/v0/request")
  public String request(String itemId) {
    orderService.orderItem(itemId);
    return "ok";
  }

  //OrderServiceV0 코드
  public void orderItem(String itemId) {
      orderRepository.save(itemId);
  }

로그 추적기 도입 후 - OrderControllerV3 , OrderServiceV3

  //OrderControllerV3 코드
  @GetMapping("/v3/request")
  public String request(String itemId) {
    TraceStatus status = null;
    try {
      status = trace.begin("OrderController.request()");
      orderService.orderItem(itemId);
      trace.end(status);
      return "ok";
    } catch (Exception e) {
      trace.exception(status, e);
      throw e; //반드시 예외를 다시 던져주어야 한다. (로깅 로직이 원래 로직에 영향을 주면 안되므로)
    }
  }

  //OrderServiceV3 코드
  public void orderItem(String itemId) {
    TraceStatus status = null;
        
    try {
      status = trace.begin("OrderServiceV1.orderItem()");
      orderRepository.save(itemId);
      trace.end(status);
    } catch (Exception e) {
      trace.exception(status, e);
      throw e;
    }
  }

OrderControllerV0 과 OrderServiceV0 은 해당 메서드가 실제 처리해야 하는 핵심 기능만 깔끔하게 남아있다.
반면에 OrderControllerV3 과 OrderServiceV3 은 핵심 기능보다 로그를 출력해야 하는 부가 기능 코드가 훨씬 더 많고 복잡하다.

핵심 기능 vs 부가 기능

앞으로 코드를 설명할 때 핵심 기능과 부가 기능으로 구분해서 설명하겠다.

핵심 기능
- 해당 객체가 제공하는 고유의 기능(핵심로직)이다.
- 예시: OrderService 의 핵심 기능은 레포지토리 클래스의 메서드를 호출하는 것이다.
부가 기능
- 핵심 기능을 보조하기 위해 제공되는 기능이다.
- 서브로직이라고도 한다.
- 예시: 로깅

OrderControllerV0 , OrderServiceV0 에는 핵심 기능만 있지만, OrderControllerV3 , OrderServiceV3 에는 핵심 기능과 부가 기능이 함께 섞여 있다.

즉, OrderControllerV3 , OrderServiceV3 에는 핵심 기능 코드보다 부가 기능 코드가 더 많다. 이 문제를 해결해보자.

부가 기능의 패턴

OrderControllerV3 , OrderServiceV3 , OrderRepositoryV3 를 유심히 살펴보면 아래와 같이 동일한 패턴이 있다.

TraceStatus status = null;
try {
	status = trace.begin("message");
	
	//핵심 기능 호출
	
	trace.end(status);
} catch (Exception e) {
	trace.exception(status, e);
	throw e;
}

다시 말해, 로그 추적기를 사용하는 구조는 모두 동일하다. 중간에 핵심 기능을 사용하는 코드만 다를 뿐이다.
코드가 중복되는 부분을 따로 메서드로 뽑아내서 사용하게끔 한다면 해결이 될까?
- 그렇지 않다. try-catch 구문이 존재하고, 핵심 기능 부분이 중간에 있어서 단순하게 메서드로 추출하는 것은 어렵다.

변하는 것과 변하지 않는 것을 분리

좋은 설계는 변하는 것과 변하지 않는 것을 분리하는 것이다.
핵심 기능 = 변하는 것
부가 기능 (로그 추적기) = 변하지 않는 것

템플릿 메서드 패턴을 통해 이 문제를 해결할 수 있다.