스프링 핵심 원리 - 고급편

목록보기

스프링 핵심원리 고급편(3) 템플릿 메서드 패턴과 콜백 패턴

2023년 03월 22일

0. 템플릿 메서드 패턴 - 시작

지금까지 로그 추적기를 열심히 잘 만들었다. 하지만 코드가 계속 중복된다는 단점이 있다.

로그 추적기 도입 후 - V3 코드

//OrderControllerV3 코드
@GetMapping("/v3/request")
public String request(String itemId) {
    TraceStatus status = null;
      
    try {
        status = trace.begin("OrderController.request()");
        orderService.orderItem(itemId); //핵심 기능
        trace.end(status);
    } catch (Exception e) {
        trace.exception(status, e);
        throw e;
    }
    	return "ok";
}
  
//OrderServiceV3 코드
public void orderItem(String itemId) {
    TraceStatus status = null;
    try {
        status = trace.begin("OrderService.orderItem()");
        orderRepository.save(itemId); //핵심 기능
        trace.end(status);
    } catch (Exception e) {
    	trace.exception(status, e);
    	throw e;
    }
}

V3에는 핵심 기능보다 로그를 출력해야 하는 부가 기능 코드가 훨씬 더 많고 복잡하다.

핵심 기능 vs 부가 기능

핵심 기능은 해당 객체가 제공하는 고유의 기능이다. 예를 들어서 orderService 의 핵심 기능은 주문 로직이다. 메서드 단위로 보면 orderService.orderItem() 의 핵심 기능은 주문 데이터를 저장하기 위해 리포지토리를 호출하는 orderRepository.save(itemId) 코드가 핵심 기능이다.
부가 기능은 핵심 기능을 보조하기 위해 제공되는 기능이다. 예를 들어서 로그 추적 로직, 트랜잭션 기능이 있다. 이러한 부가 기능은 단독으로 사용되지는 않고, 핵심 기능과 함께 사용된다. 예를 들어서 로그 추적 기능은 어떤 핵심 기능이 호출되었는지 로그를 남기기 위해 사용한다. 그러니까 핵심 기능을 보조하기 위해 존재한다.

해결방안

Controller , Service , Repository 의 코드를 잘 보면, 로그 추적기를 사용하는 구조는 모두 동일하다. (try, catch)
부가 기능과 관련된 코드가 중복이니 중복을 별도의 메서드로 뽑아내면 될 것 같다. 그런데, try ~ catch 는 물론이고, 핵심 기능 부분이 중간에 있어서 단순하게 메서드로 추출하는 것은 어렵다.

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

좋은 설계는 변하는 것과 변하지 않는 것을 분리하는 것이다. 여기서 핵심 기능 부분은 변하고, 로그 추적기를 사용하는 부분은 변하지 않는 부분이다. 이 둘을 분리해서 모듈화해야 한다.

템플릿 메서드 패턴(Template Method Pattern)은 이런 문제를 해결하는 디자인 패턴이다.

1. 템플릿 메서드 패턴 - 예제1

템플릿 메서드 패턴을 쉽게 이해하기 위해 테스트에 단순한 예제 코드를 만들어보자.

TemplateMethodTest

package hello.advanced.trace.template;
  
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
  
@Slf4j
public class TemplateMethodTest {
  
    @Test
    void templateMethodV0(){
        logic1();
        logic2();
    }
  
    private void logic1(){
        long startTime = System.currentTimeMillis();
        //비즈니스 로직 실행
        log.info("비즈니스 로직1 실행");
        //비즈니스 로직 종료
        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("resultTime={}", resultTime);
    }
  
    private void logic2(){
        long startTime = System.currentTimeMillis();
        //비즈니스 로직 실행
        log.info("비즈니스 로직2 실행");
        //비즈니스 로직 종료
        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("resultTime={}", resultTime);
    }
}

logic1() , logic2() 를 호출하는 단순한 테스트 코드이다.

실행 결과

비즈니스 로직1 실행
resultTime=5
비즈니스 로직2 실행
resultTime=1

logic1() 과 logic2() 는 시간을 측정하는 부분과 비즈니스 로직을 실행하는 부분이 함께 존재한다.
- 변하는 부분: 비즈니스 로직
- 변하지 않는 부분: 시간 측정

이제 템플릿 메서드 패턴을 사용해서 변하는 부분과 변하지 않는 부분을 분리해보자.

2. 템플릿 메서드 패턴 - 예제2

템플릿 메서드 패턴 구조 그림

AbstractTemplate (test 폴더)

템플릿 메서드 패턴은 이름 그대로 템플릿을 사용하는 방식이다. 템플릿은 기준이 되는 거대한 틀이다. 템플릿이라는 틀에 변하지 않는 부분을 몰아둔다. 그리고 일부 변하는 부분을 별도로 호출해서 해결한다.

package hello.advanced.trace.template.code;
  
import lombok.extern.slf4j.Slf4j;
  
@Slf4j
public abstract class AbstractTemplate {
  
    public void execute(){
        long startTime = System.currentTimeMillis();
        //비즈니스 로직 실행
        call();
        //비즈니스 로직 종료
        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("resultTime={}", resultTime);
    }
  
    protected abstract void call();
}

AbstractTemplate 코드를 보자. 변하지 않는 부분인 시간 측정 로직을 몰아둔 것을 확인할 수 있다. 이제 이것이 하나의 템플릿이 된다. 그리고 템플릿 안에서 변하는 부분은 call() 메서드를 호출해서 처리한다. 템플릿 메서드 패턴은 부모 클래스에 변하지 않는 템플릿 코드를 둔다. 그리고 변하는 부분은 자식 클래스에 두고 상속과 오버라이딩을 사용해서 처리한다.

SubClassLogic1 / SubClassLogic2

//logic1
package hello.advanced.trace.template.code;
  
import lombok.extern.slf4j.Slf4j;
  
@Slf4j
public class SubClassLogic1 extends AbstractTemplate{
    @Override
    protected void call() {
        log.info("비즈니스 로직 1 실행");
    }
}
  
//logic2
package hello.advanced.trace.template.code;
  
import lombok.extern.slf4j.Slf4j;
  
@Slf4j
public class SubClassLogic2 extends AbstractTemplate{
    @Override
    protected void call() {
        log.info("비즈니스 로직 2 실행");
    }
}

변하는 부분인 비즈니스 로직1을 처리하는 자식 클래스이다.
템플릿이 호출하는 대상인 call() 메서드를 오버라이딩 한다.

TemplateMethodTest - templateMethodV1() 추가

```java /**
- 탬플릿 메서드 패턴 적용 */ @Test void templateMethodV1() { AbstractTemplate template1 = new SubClassLogic1(); template1.execute();
  
  AbstractTemplate template2 = new SubClassLogic2(); template2.execute(); } ```

실행 결과

비즈니스 로직1 실행
resultTime=0
비즈니스 로직2 실행
resultTime=1

템플릿 메서드 패턴 인스턴스 호출 그림

template1.execute() 를 호출하면 템플릿 로직인 AbstractTemplate.execute() 를 실행한다.
여기서 중간에 call() 메서드를 호출하는데, 이 부분이 오버라이딩 되어있다. 따라서 현재 인스턴스인 SubClassLogic1 인스턴스의 SubClassLogic1.call() 메서드가 호출된다.

템플릿 메서드 패턴은 이렇게 다형성을 사용해서 변하는 부분과 변하지 않는 부분을 분리하는 방법이다.

3. 템플릿 메서드 패턴 - 예제3 (익명 내부 클래)

익명 내부 클래스 사용하기

템플릿 메서드 패턴은 SubClassLogic1 , SubClassLogic2 처럼 클래스를 계속 만들어야 하는 단점이 있다. 익명 내부 클래스를 사용하면 이런 단점을 보완할 수 있다.
익명 내부 클래스를 사용하면 객체 인스턴스를 생성하면서 동시에 생성할 클래스를 상속 받은 자식 클래스를 정의할 수 있다. 이 클래스는 SubClassLogic1 처럼 직접 지정하는 이름이 없고 클래스 내부에 선언되는 클래스여서 익명 내부 클래스라 한다.

TemplateMethodTest - templateMethodV2() 추가

```java /**
- 템플릿 메서드 패턴, 익명 내부 클래스 사용 */ @Test void templateMethodV2(){ AbstractTemplate template1 = new AbstractTemplate() { @Override protected void call() { log.info(“비즈니스 로직1 실행”); } }; log.info(“클래스 이름 1 ={}”, template1.getClass()); template1.execute();
  
  AbstractTemplate template2 = new AbstractTemplate() { @Override protected void call() { log.info(“비즈니스 로직2 실행”); } }; log.info(“클래스 이름 2 ={}”, template2.getClass()); template2.execute(); } ```

실행 결과

클래스 이름1 class hello.advanced.trace.template.TemplateMethodTest$1
비즈니스 로직1 실행
resultTime=3
클래스 이름2 class hello.advanced.trace.template.TemplateMethodTest$2
비즈니스 로직2 실행
resultTime=0

실행 결과를 보면 자바가 임의로 만들어주는 익명 내부 클래스 이름은 TemplateMethodTest$1 , TemplateMethodTest$2 인 것을 확인할 수 있다.

4. 템플릿 메서드 패턴 - 적용1

이제 우리가 만든 애플리케이션의 로그 추적기 로직에 템플릿 메서드 패턴을 적용해보자.

AbstractTemplate

package hello.advanced.trace.template;
  
import hello.advanced.trace.TraceStatus;
import hello.advanced.trace.logtrace.LogTrace;
import lombok.RequiredArgsConstructor;
  
@RequiredArgsConstructor
public abstract class AbstractTemplate<T> {
  
    private final LogTrace trace;
  
    public T execute(String message){
        TraceStatus status = null;
  
        try{
            status = trace.begin(message);
  
            //로직 호출
            T result = call();
  
            trace.end(status);
            return result;
        }catch(Exception e){
            trace.exception(status, e);
            throw e;
        }
    }
  
    protected abstract T call();
}

AbstractTemplate 은 템플릿 메서드 패턴에서 부모 클래스이고, 템플릿 역할을 한다.
객체를 생성할 때 내부에서 사용할 LogTrace trace 를 전달 받는다.
로그에 출력할 message 를 외부에서 파라미터로 전달받는다.
템플릿 코드 중간에 call() 메서드를 통해서 변하는 부분을 처리한다.

OrderControllerV4

package hello.advanced.app.v4;
  
import hello.advanced.trace.TraceStatus;
import hello.advanced.trace.logtrace.LogTrace;
import hello.advanced.trace.template.AbstractTemplate;
import lombok.RequiredArgsConstructor;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
  
@RestController
@RequiredArgsConstructor
public class OrderControllerV4 {
  
    private final OrderServiceV4 orderService;
    private final LogTrace trace;
  
    @GetMapping("/v4/request")
    public String request(String itemId) {
  
        AbstractTemplate<String> template = new AbstractTemplate<String>(trace) {
            @Override
            protected String call() {
                orderService.orderItem(itemId);
                return "ok";
            }
        };
  
        return template.execute("OrderController.request()");
    }
}

AbstractTemplate
- 제네릭을 String 으로 설정했다. 따라서 AbstractTemplate 의 반환 타입은 String 이 된다.
익명 내부 클래스
- 익명 내부 클래스를 사용한다. 객체를 생성하면서 AbstractTemplate 를 상속받은 자식 클래스를 정의했다.
- 따라서 별도의 자식 클래스를 직접 만들지 않아도 된다.
template.execute(“OrderController.request()”)
- 템플릿을 실행하면서 로그로 남길 message 를 전달한다.

OrderServiceV4

package hello.advanced.app.v4;
  
import hello.advanced.trace.TraceStatus;
import hello.advanced.trace.logtrace.LogTrace;
import hello.advanced.trace.template.AbstractTemplate;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
  
@Service
@RequiredArgsConstructor
public class OrderServiceV4 {
  
    private final OrderRepositoryV4 orderRepository;
    private final LogTrace trace;
  
    public void orderItem(String itemId){
  
        AbstractTemplate<Void> template = new AbstractTemplate<>(trace) {
            @Override
            protected Void call() {
                orderRepository.save(itemId);
                return null;
            }
        };
        template.execute("OrderService.orderItem()");
    }
}

AbstractTemplate 제네릭에서 반환 타입이 필요한데, 반환할 내용이 없으면 Void 타입을 사용하고 null 을 반환하면 된다. 참고로 제네릭은 기본 타입인 void , int 등을 선언할 수 없다.

OrderRepositoryV4

package hello.advanced.app.v4;
  
import hello.advanced.trace.TraceStatus;
import hello.advanced.trace.logtrace.LogTrace;
import hello.advanced.trace.template.AbstractTemplate;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Repository;
  
@Repository
@RequiredArgsConstructor
public class OrderRepositoryV4 {
  
    private final LogTrace trace;
  
    public void save(String itemId) {
  
        AbstractTemplate<Void> template = new AbstractTemplate<>(trace) {
            @Override
            protected Void call() {
                if (itemId.equals("ex")) {
                    throw new IllegalStateException("예외 발생");
                }
                sleep(1000);
                return null;
            }
        };
        template.execute("OrderRepository.save()");
    }
  
    private static void sleep(int millis) {
        try {
            Thread.sleep(millis);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

실행

[aaaaaaaa] OrderController.request()
[aaaaaaaa] |-->OrderService.orderItem()
[aaaaaaaa] | |-->OrderRepository.save()
[aaaaaaaa] | |<--OrderRepository.save() time=1004ms
[aaaaaaaa] |<--OrderService.orderItem() time=1006ms
[aaaaaaaa] OrderController.request() time=1007ms

5. 템플릿 메서드 패턴 - 적용2

템플릿 메서드 패턴 덕분에 변하는 코드와 변하지 않는 코드를 명확하게 분리했다.
로그를 출력하는 템플릿 역할을 하는 변하지 않는 코드는 모두 AbstractTemplate 에 담아두고, 변하는 코드는 자식 클래스를 만들어서 분리했다.

지금까지 작성한 코드

OrderServiceV0 : 핵심 기능만 있다.
OrderServiceV3 : 핵심 기능과 부가 기능이 함께 섞여 있다.
OrderServiceV4 : 핵심 기능과 템플릿을 호출하는 코드가 섞여 있다.

V4는 템플릿 메서드 패턴을 사용한 덕분에 핵심 기능에 좀 더 집중할 수 있게 되었다.

단일 책임 원칙(SRP)

좋은 설계란

좋은 설계라는 것은 수 많은 멋진 정의가 있겠지만, 진정한 좋은 설계는 바로 변경이 일어날 때 자연스럽게 드러난다.
지금까지 로그를 남기는 부분을 모아서 하나로 모듈화하고, 비즈니스 로직 부분을 분리했다. 여기서 만약 로그를 남기는 로직을 변경해야 한다고 생각해보자. 그래서 AbstractTemplate 코드를 변경해야 한다 가정해보자.
단순히 AbstractTemplate 코드만 변경하면 된다. 템플릿이 없는 V3 상태에서 로그를 남기는 로직을 변경해야 한다고 생각해보자. 이 경우 모든 클래스를 다 찾아서 고쳐야 한다. 클래스가 수백 개라면 생각만해도 끔찍하다.

단일 책임 원칙(SRP)

V4 는 단순히 템플릿 메서드 패턴을 적용해서 소스코드 몇줄을 줄인 것이 전부가 아니다. 로그를 남기는 부분에 단일 책임 원칙(SRP)을 지킨 것이다. 변경 지점을 하나로 모아서 변경에 쉽게 대처할 수 있는 구조를 만든 것이다.

6. 템플릿 메서드 패턴 - 정의

부모 클래스에 알고리즘의 골격인 템플릿을 정의하고, 일부 변경되는 로직은 자식 클래스에 정의하는 것이다.
이렇게 하면 자식 클래스가 알고리즘의 전체 구조를 변경하지 않고, 특정 부분만 재정의할 수 있다. 결국 상속과 오버라이딩을 통한 다형성으로 문제를 해결하는 것이다.

단점

자식 클래스 입장에서는 부모 클래스의 기능을 전혀 사용하지 않으면서도 템플릿 메서드 패턴을 위해 자식 클래스는 부모 클래스를 상속 받고 있다.
- 이런 잘못된 의존관계 때문에 부모 클래스를 수정하면, 자식 클래스에도 영향을 줄 수 있다.
추가로 템플릿 메서드 패턴은 상속 구조를 사용하기 때문에, 별도의 클래스나 익명 내부 클래스를 만들어야 하는 부분도 복잡하다.

7. 전략 패턴 - 예제1

전략 패턴은 변하지 않는 부분을 Context 라는 곳에 두고, 변하는 부분을 Strategy 라는 인터페이스를 만들고 해당 인터페이스를 구현하도록 해서 문제를 해결한다. 상속이 아니라 위임으로 문제를 해결하는 것이다.
전략 패턴에서 Context 는 변하지 않는 템플릿 역할을 하고, Strategy 는 변하는 알고리즘 역할을 한다.

Strategy 인터페이스 (test 코드)

이 인터페이스는 변하는 알고리즘 역할을 한다.

package hello.advanced.trace.strategy.code.strategy;
  
public interface Strategy {
    void call();
}
  

StrategyLogic1 / StrategyLogic2

package hello.advanced.trace.strategy.code.strategy;
  
import lombok.extern.slf4j.Slf4j;
  
@Slf4j
public class StrategyLogic1 implements Strategy{
    @Override
    public void call() {
        log.info("비즈니스 로직 1 실행");
    }
}

package hello.advanced.trace.strategy.code.strategy;
  
import lombok.extern.slf4j.Slf4j;
  
@Slf4j
public class StrategyLogic2 implements Strategy{
    @Override
    public void call() {
        log.info("비즈니스 로직 2 실행");
    }
}

ContextV1 (test 코드)

ContextV1 은 변하지 않는 로직을 가지고 있는 템플릿 역할을 하는 코드이다. 전략 패턴에서는 이것을 컨텍스트(문맥)이라 한다.
쉽게 이야기해서 컨텍스트(문맥)는 크게 변하지 않지만, 그 문맥 속에서 strategy 를 통해 일부 전략이 변경된다 생각하면 된다.

package hello.advanced.trace.strategy.code.strategy;
  
import lombok.extern.slf4j.Slf4j;
  
/**
 * 필드에 전략을 보관하는 방식
 */
@Slf4j
  
public class ContextV1 {
  
    private Strategy strategy;
  
    public ContextV1(Strategy strategy) {
        this.strategy = strategy;
    }
  
    public void execute(){
        Long startTime = System.currentTimeMillis();
        //비즈니스 로직 실행
        strategy.call(); //위임
        //비즈니스 로직 종료
        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("resultTime={}", resultTime);
    }
}

Context 는 내부에 Strategy strategy 필드를 가지고 있다. 이 필드에 변하는 부분인 Strategy 의 구현체를 주입하면 된다.
전략 패턴의 핵심은 Context 는 Strategy 인터페이스에만 의존한다는 점이다. 덕분에 Strategy 의 구현체를 변경하거나 새로 만들어도 Context 코드에는 영향을 주지 않는다.
스프링에서 의존관계 주입에서 사용하는 방식이 바로 전략 패턴이다.

ContextV1Test

package hello.advanced.trace.strategy;
import ...;
  
@Slf4j
public class ContextV1Test {
  
    @Test
    void strategyV0() {
        logic1();
        logic2();
    }
  
    private void logic1() {
        long startTime = System.currentTimeMillis();
        log.info("비즈니스 로직1 실행");
        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("resultTime={}", resultTime);
    }
  
    private void logic2() {
        long startTime = System.currentTimeMillis();
        log.info("비즈니스 로직2 실행");
        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("resultTime={}", resultTime);
    }
  
  
    /**
     * 전략 패턴 사용
     */
    @Test
    void strategy(){
        StrategyLogic1 strategyLogic1 = new StrategyLogic1();
        ContextV1 context1 = new ContextV1(strategyLogic1);
        context1.execute();
  
  
        StrategyLogic2 strategyLogic2 = new StrategyLogic2();
        ContextV1 context2 = new ContextV1(strategyLogic2);
        context2.execute();
    }
  
}

코드를 보면 의존관계 주입을 통해 ContextV1 에 Strategy 의 구현체인 strategyLogic1 를 주입하는 것을 확인할 수 있다.
이렇게해서 Context 안에 원하는 전략을 주입한다. 이렇게 원하는 모양으로 조립을 완료하고 난 다음에 context1.execute() 를 호출해서 context 를 실행한다.

전략 패턴 실행 그림

Context 에 원하는 Strategy 구현체를 주입한다.
클라이언트는 context 를 실행한다.
context 는 context 로직을 시작한다.
context 로직 중간에 strategy.call() 을 호출해서 주입 받은 strategy 로직을 실행한다.
context 는 나머지 로직을 실행한다.

8. 전략 패턴 - 예제2

전략 패턴도 익명 내부 클래스를 사용할 수 있다.

전략 패턴 익명 내부 클래스1

@Test
    void strategyV2(){
        Strategy strategyLogic1 = new Strategy() {
            @Override
            public void call() {
                log.info("비즈니스 로직 1 실행");
            }
        };
        ContextV1 context1 = new ContextV1(strategyLogic1);
        log.info("strategyLogic1={}", strategyLogic1.getClass());
        context1.execute();
  
        Strategy strategyLogic2 = new Strategy() {
            @Override
            public void call() {
                log.info("비즈니스 로직 2 실행");
            }
        };
        ContextV1 context2 = new ContextV1(strategyLogic1);
        log.info("strategyLogic2={}", strategyLogic2.getClass());
        context2.execute();
    }

ContextV1Test - strategyLogic1=class
hello.advanced.trace.strategy.ContextV1Test$1
ContextV1Test - 비즈니스 로직1 실행
ContextV1 - resultTime=0
ContextV1Test - strategyLogic2=class
hello.advanced.trace.strategy.ContextV1Test$2
ContextV1Test - 비즈니스 로직2 실행
ContextV1 - resultTime=0

전략 패턴 익명 내부 클래스2

익명 내부 클래스를 변수에 담아두지 말고, 생성하면서 바로 ContextV1 에 전달해도 된다.

@Test
void strategyV3(){
    ContextV1 context1 = new ContextV1(new Strategy() {
        @Override
        public void call() {
            log.info("비즈니스 로직 1 실행");
        }
    });
    context1.execute();
  
  
    ContextV1 context2 = new ContextV1(new Strategy() {
        @Override
        public void call() {
            log.info("비즈니스 로직 2 실행");
        }
    });
    context2.execute();
}

전략 패턴 익명 내부 클래스3

@Test
void strategyV4(){
    ContextV1 context1 = new ContextV1(() -> log.info("비즈니스 로직 1 실행"));
    context1.execute();
  
    ContextV1 context2 = new ContextV1(() -> log.info("비즈니스 로직 2 실행"));
    context2.execute();
}

익명 내부 클래스를 자바8부터 제공하는 람다로 변경할 수 있다. 람다로 변경하려면 인터페이스에 메서드가 1개만 있으면 되는데, 여기에서 제공하는 Strategy 인터페이스는 메서드가 1개만 있으므로 람다로 사용할 수 있다.

선 조립, 후 실행

Context 와 Strategy 를 한번 조립하고 나면 이후로는 Context 를 실행하기만 하면 된다. 우리가 스프링으로 애플리케이션을 개발할 때 애플리케이션 로딩 시점에 의존관계 주입을 통해 필요한 의존관계를 모두 맺어두고 난 다음에 실제 요청을 처리하는 것 과 같은 원리이다.
이 방식의 단점은 Context 와 Strategy 를 조립한 이후에는 전략을 변경하기가 번거롭다는 점이다. 물론 Context 에 setter 를 제공해서 Strategy 를 넘겨 받아 변경하면 되지만, Context 를 싱글톤으로 사용할 때는 동시성 이슈 등 고려할 점이 많다.
그래서 전략을 실시간으로 변경해야 하면 차라리 이전에 개발한 테스트 코드 처럼 Context 를 하나더 생성하고 그곳에 다른 Strategy 를 주입하는 것이 더 나은 선택일 수 있다.

9. 전략 패턴 - 예제3

이번에는 전략 패턴을 조금 다르게 사용해보자. 이전에는 Context 의 필드에 Strategy 를 주입해서 사용했다. 이번에는 전략을 실행할 때 직접 파라미터로 전달해서 사용해보자.

ContextV2

ContextV2 는 전략을 필드로 가지지 않는다. 대신에 전략을 execute(..) 가 호출될 때 마다 항상 파라미터로 전달 받는다

package hello.advanced.trace.strategy.code.strategy;
  
import lombok.extern.slf4j.Slf4j;
  
/**
 * 전략을 파라미터로 전달 받는 방식
 */
@Slf4j
public class ContextV2 {
  
    public void execute(Strategy strategy){
        Long startTime = System.currentTimeMillis();
        //비즈니스 로직 실행
        strategy.call(); //위임
        //비즈니스 로직 종료
        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("resultTime={}", resultTime);
    }
}
  

ContextV2Test

package hello.advanced.trace.strategy;
import hello.advanced.trace.strategy.code.strategy.*;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
  
@Slf4j
public class ContextV2Test {
  
    /**
     * 전략 패턴 적용
     */
    @Test
    void strategyV1(){
        ContextV2 context = new ContextV2();
        context.execute(new StrategyLogic1());
        context.execute(new StrategyLogic2());
    }
  
    /**
     * 전략 패턴 익명 내부클래스
     */
    @Test
    void strategyV2(){
        ContextV2 context = new ContextV2();
        context.execute(new Strategy() {
            @Override
            public void call() {
                log.info("비즈니스 로직 1 실행");
            }
        });
        context.execute(new Strategy() {
            @Override
            public void call() {
                log.info("비즈니스 로직 2 실행");
            }
        });
    }
  
    /**
     * 전략 패턴 익명 내부클래스 lamda
     */
    @Test
    void strategyV3(){
        ContextV2 context = new ContextV2();
        context.execute(() -> log.info("비즈니스 로직 1 실행"));
        context.execute(()-> log.info("비즈니스 로직 2 실행"));
    }
  
}

Context 와 Strategy 를 ‘선 조립 후 실행’하는 방식이 아니라 Context 를 실행할 때 마다 전략을 인수로 전달한다.
클라이언트는 Context 를 실행하는 시점에 원하는 Strategy 를 전달할 수 있다. 따라서 이전 방식과 비교해서 원하는 전략을 더욱 유연하게 변경할 수 있다.
테스트 코드를 보면 하나의 Context 만 생성한다. 그리고 하나의 Context 에 실행 시점에 여러 전략을 인수로 전달해서 유연하게 실행하는 것을 확인할 수 있다

전략 패턴 파라미터 실행 그림

클라이언트는 Context 를 실행하면서 인수로 Strategy 를 전달한다.
Context 는 execute() 로직을 실행한다.
Context 는 파라미터로 넘어온 strategy.call() 로직을 실행한다.
Context 의 execute() 로직이 종료된다.

정리

ContextV1 은 필드에 Strategy 를 저장하는 방식으로 전략 패턴을 구사했다.
- 선 조립, 후 실행 방법에 적합하다.
- Context 를 실행하는 시점에는 이미 조립이 끝났기 때문에 전략을 신경쓰지 않고 단순히 실행만 하면 된다.
ContextV2 는 파라미터에 Strategy 를 전달받는 방식으로 전략 패턴을 구사했다.
- 실행할 때 마다 전략을 유연하게 변경할 수 있다.
- 단점 역시 실행할 때 마다 전략을 계속 지정해주어야 한다는 점이다.

지금 우리가 해결하고 싶은 문제는 변하는 부분과 변하지 않는 부분을 분리하는 것이다. 변하지 않는 부분을 템플릿이라고 하고, 그 템플릿 안에서 변하는 부분에 약간 다른 코드 조각을 넘겨서 실행하는 것이 목적이다. ContextV1 , ContextV2 두 가지 방식 다 문제를 해결할 수 있지만, 어떤 방식이 조금 더 나아 보이는가? 지금 우리가 원하는 것은 애플리케이션 의존 관계를 설정하는 것 처럼 선 조립, 후 실행이 아니다. 단순히 코드를 실행할 때 변하지 않는 템플릿이 있고, 그 템플릿 안에서 원하는 부분만 살짝 다른 코드를 실행하고 싶을 뿐이다. 따라서 우리가 고민하는 문제는 실행 시점에 유연하게 실행 코드 조각을 전달하는 ContextV2 가 더 적합하다.

10. 템플릿 콜백 패턴 - 시작

ContextV2 는 변하지 않는 템플릿 역할을 한다. 그리고 변하는 부분은 파라미터로 넘어온 Strategy 의 코드를 실행해서 처리한다. 이렇게 다른 코드의 인수로서 넘겨주는 실행 가능한 코드를 콜백(callback)이라 한다.

콜백 정의

프로그래밍에서 콜백(callback) 또는 콜애프터 함수(call-after function)는 다른 코드의 인수로서 넘겨주는 실행 가능한 코드를 말한다. 콜백을 넘겨받는 코드는 이 콜백을 필요에 따라 즉시 실행할 수도 있고, 아니면 나중에 실행할 수도 있다. (위키백과 참고)

쉽게 이야기해서 callback 은 코드가 호출( call )은 되는데 코드를 넘겨준 곳의 뒤( back )에서 실행된다는 뜻이다.

ContextV2 예제에서 콜백은 Strategy 이다.
여기에서는 클라이언트에서 직접 Strategy 를 실행하는 것이 아니라, 클라이언트가 ContextV2.execute(..) 를 실행할 때 Strategy 를 넘겨주고, ContextV2 뒤에서 Strategy 가 실행된다

템플릿 콜백 패턴

스프링에서는 ContextV2 와 같은 방식의 전략 패턴을 템플릿 콜백 패턴이라 한다. 전략 패턴에서 Context 가 템플릿 역할을 하고, Strategy 부분이 콜백으로 넘어온다 생각하면 된다
참고로 템플릿 콜백 패턴은 GOF 패턴은 아니고, 스프링 내부에서 이런 방식을 자주 사용하기 때문에, 스프링 안에서만 이렇게 부른다. 전략 패턴에서 템플릿과 콜백 부분이 강조된 패턴이라 생각하면 된다.
스프링에서는 JdbcTemplate , RestTemplate , TransactionTemplate , RedisTemplate 처럼 다양한 템플릿 콜백 패턴이 사용된다. 스프링에서 이름에 XxxTemplate 가 있다면 템플릿 콜백 패턴으로 만들어져 있다 생각하면 된다.

11. 템플릿 콜백 패턴 - 예제

템플릿 콜백 패턴을 구현해보자. ContextV2 와 내용이 같고 이름만 다르므로 크게 어려움은 없을 것이다.
- Context -> Template
- Strategy -> Callback

Callback - 인터페이스 (test)

콜백 로직을 전달할 인터페이스이다.

package hello.advanced.trace.strategy.code.template;
  
public interface Callback {
    void call();
}

TimeLogTemplate (test)

package hello.advanced.trace.strategy.code.template;
  
import lombok.extern.slf4j.Slf4j;
  
@Slf4j
public class TimeLogTemplate {
  
    public void execute(Callback callback){
        Long startTime = System.currentTimeMillis();
        //비즈니스 로직 실행
        callback.call(); //위임
        //비즈니스 로직 종료
        long endTime = System.currentTimeMillis();
        long resultTime = endTime - startTime;
        log.info("resultTime={}", resultTime);
    }
}

TemplateCallbackTest

별도의 클래스를 만들어서 전달해도 되지만, 콜백을 사용할 경우 익명 내부 클래스나 람다를 사용하는 것이 편리하다.
물론 여러곳에서 함께 사용되는 경우 재사용을 위해 콜백을 별도의 클래스로 만들어도 된다.

package hello.advanced.trace.strategy.code;
  
import hello.advanced.trace.strategy.code.template.TimeLogTemplate;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Test;
  
@Slf4j
public class TemplateCallbackTest {
  
    /**
     * 템플릿 콜백 패턴 - 익명 내부 클래스 lamda
     */
    @Test
    void callbackV1(){
        TimeLogTemplate template = new TimeLogTemplate();
        template.execute(()-> log.info("비즈니스 로직 1 실행"));
        template.execute(()-> log.info("비즈니스 로직 2 실행"));
    }
}

12. 템플릿 콜백 패턴 - 적용

TraceCallback 인터페이스

package hello.advanced.trace.callback;
  
public interface TraceCallback<T> {
    T call();
}
  

콜백을 전달하는 인터페이스이다.
제네릭을 사용했다. 콜백의 반환 타입을 정의한다.

TraceTemplate

TraceTemplate 는 템플릿 역할을 한다.

package hello.advanced.trace.callback;
  
import hello.advanced.trace.TraceStatus;
import hello.advanced.trace.logtrace.LogTrace;
  
public class TraceTemplate {
  
    private final LogTrace trace;
  
  
    public TraceTemplate(LogTrace trace) {
        this.trace = trace;
    }
  
    public <T> T execute(String message, TraceCallback<T> callback) {
        TraceStatus status = null;
  
        try{
            status = trace.begin(message);
  
            //로직 호출
            T result = callback.call();
  
            trace.end(status);
            return result;
        }catch(Exception e){
            trace.exception(status, e);
            throw e;
        }
    }
}

execute(..) 를 보면 message 데이터와 콜백인 TraceCallback callback 을 전달 받는다.
제네릭을 사용했다. 반환 타입을 정의한다.

OrderControllerV5

package hello.advanced.app.v5;
  
import ...;
  
@RestController
public class OrderControllerV5 {
  
    private final OrderServiceV5 orderService;
    private final TraceTemplate template;
  
    public OrderControllerV5(OrderServiceV5 orderService, LogTrace trace) {
        this.orderService = orderService;
        this.template = new TraceTemplate(trace);
    }
  
    @GetMapping("/v5/request")
    public String request(String itemId) {
        return template.execute("OrderController.request()", () -> {
            orderService.orderItem(itemId);
            return "ok";
        });
    }
}

this.template = new TraceTemplate(trace) : trace 의존관계 주입을 받으면서 필요한 TraceTemplate 템플릿을 생성한다. 참고로 TraceTemplate 를 처음부터 스프링 빈으로 등록하고 주입받아도 된다. 이 부분은 선택이다.
template.execute("OrderController.request()", ()-> {...}); : 템플릿을 실행하면서 콜백을 전달한다. (람다식)

OrderServiceV5

package hello.advanced.app.v5;
  
import hello.advanced.trace.callback.TraceCallback;
import hello.advanced.trace.callback.TraceTemplate;
import hello.advanced.trace.logtrace.LogTrace;
import hello.advanced.trace.template.AbstractTemplate;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
  
@Service
public class OrderServiceV5 {
  
    private final OrderRepositoryV5 orderRepository;
    private final TraceTemplate template;
  
    public OrderServiceV5(OrderRepositoryV5 orderRepository, LogTrace trace) {
        this.orderRepository = orderRepository;
        this.template = new TraceTemplate(trace);
    }
  
    public void orderItem(String itemId){
  
        template.execute("OrderService.orderItem()", () -> {
            orderRepository.save(itemId);
            return null;
        });
    }
}

OrderRepositoryV5

package hello.advanced.app.v5;
  
import hello.advanced.trace.callback.TraceTemplate;
import hello.advanced.trace.logtrace.LogTrace;
import hello.advanced.trace.template.AbstractTemplate;
import org.springframework.stereotype.Repository;
  
@Repository
public class OrderRepositoryV5 {
  
    private final TraceTemplate template;
  
    public OrderRepositoryV5(LogTrace trace) {
        this.template = new TraceTemplate(trace);
    }
  
  
    public void save(String itemId) {
        template.execute("OrderRepository.save()", ()->{
            if (itemId.equals("ex")) {
                throw new IllegalStateException("예외 발생");
            }
            sleep(1000);
            return null;
  
        });
    }
  
    private static void sleep(int millis) {
        try {
            Thread.sleep(millis);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

실행 및 로그

정상 실행 : http://localhost:8080/v5/request?itemId=hello

[aaaaaaaa] OrderController.request()
[aaaaaaaa] |-->OrderService.orderItem()
[aaaaaaaa] | |-->OrderRepository.save()
[aaaaaaaa] | |<--OrderRepository.save() time=1001ms
[aaaaaaaa] |<--OrderService.orderItem() time=1003ms
[aaaaaaaa] OrderController.request() time=1004ms

코드 분석

내가 이해안돼서 정리하는 코드 분석 (OrderControllerV5 로)
```
@GetMapping("/v5/request")
public String request(String itemId) {
    return template.execute("OrderController.request()", () -> {
        orderService.orderItem(itemId);
        return "ok";
    });
}
```
1. TraceTemplate 의 execute 실행 public <T> T execute(String message, TraceCallback<T> callback)
2. excute 는 ThreadLogTrace 를 구현체로 하는 Trace 를 통해 로그 남기는 메서드를 실행하고,
3. 그 안에 로직을 호출한다 (T result = callback.call();)
4. callback 함수는 TraceCallback<T> callback 으로, OrderControllerV5 에서 주입받는 람다식이다.
  - orderService.orderItem(itemId); 을 실행하는 익명 내부 클래스(람다식) 이용

Twitter Facebook LinkedIn

0. 템플릿 메서드 패턴 - 시작

로그 추적기 도입 후 - V3 코드

핵심 기능 vs 부가 기능

해결방안

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

1. 템플릿 메서드 패턴 - 예제1

TemplateMethodTest

실행 결과

2. 템플릿 메서드 패턴 - 예제2

AbstractTemplate (test 폴더)

SubClassLogic1 / SubClassLogic2

TemplateMethodTest - templateMethodV1() 추가

템플릿 메서드 패턴 인스턴스 호출 그림

3. 템플릿 메서드 패턴 - 예제3 (익명 내부 클래)

익명 내부 클래스 사용하기

TemplateMethodTest - templateMethodV2() 추가

실행 결과

4. 템플릿 메서드 패턴 - 적용1

AbstractTemplate

OrderControllerV4

OrderServiceV4

OrderRepositoryV4

실행

5. 템플릿 메서드 패턴 - 적용2

지금까지 작성한 코드

단일 책임 원칙(SRP)

좋은 설계란

단일 책임 원칙(SRP)

6. 템플릿 메서드 패턴 - 정의

단점

7. 전략 패턴 - 예제1

Strategy 인터페이스 (test 코드)

StrategyLogic1 / StrategyLogic2

ContextV1 (test 코드)

ContextV1Test

전략 패턴 실행 그림

8. 전략 패턴 - 예제2

전략 패턴 익명 내부 클래스1

전략 패턴 익명 내부 클래스2

전략 패턴 익명 내부 클래스3

선 조립, 후 실행

9. 전략 패턴 - 예제3

ContextV2

ContextV2Test

전략 패턴 파라미터 실행 그림

정리

10. 템플릿 콜백 패턴 - 시작

템플릿 콜백 패턴

11. 템플릿 콜백 패턴 - 예제

Callback - 인터페이스 (test)

TimeLogTemplate (test)

TemplateCallbackTest

12. 템플릿 콜백 패턴 - 적용

TraceCallback 인터페이스

TraceTemplate

OrderControllerV5

OrderServiceV5

OrderRepositoryV5

실행 및 로그

코드 분석

공유하기

댓글남기기

참고

[Spring Batch] SpringBatch 필요한 Reader 만들기

[EKS] EKS 에서 DNS resolve 에러

[Kafka] 카프카 스트림즈로 집계하기

[Kafka] 도커에서 카프카 접근하기