[Spring] 디자인 패턴 : 적은 코드 수정으로 공통 로직을 작성하기

🎓 이 글은 인프런에서 제공하는 "스프링 핵심 원리 - 고급편" 강의를 수강하면서 정리한 내용을 바탕으로 작성한 글입니다.

https://inf.run/FWeFN

 

적은 코드 수정으로 공통 로직을 작성할 수 있기 위해 고안된 메서드 패턴을 소개한다. 

 

공통 로직 (로그 추적기) 요구사항

* 모든 PUBLIC 메서드의 호출과 응답 정보를 로그로 출력

* 애플리케이션의 흐름을 변경하면 안됨 - 로그를 남긴다고 해서 비즈니스 로직의 동작에 영향을 주면 안됨

* 메서드 호출에 걸린 시간

* 정상 흐름과 예외 흐름 구분 - 예외 발생 시 예외 정보가 남아야 함

* 메서드 호출의 깊이 표현

* HTTP 요청을 구분

* HTTP 요청 단위로 특정 ID 를 남겨서 어떤 HTTP 요청에서 시작된 것인지 명확하게 구분이 가능해야 함

* 트랜잭션 ID (DB트랜잭션X)

 

※ 템플릿 메서드 패턴

템플릿 메서드 패턴을 사용하여 개인 프로젝트에 요청별 실행 시간을 추적하는 LogTrace 를 개발했다. 
이해도가 어느정도 있다고 생각하여 관련하여 따로 기록해두지 않겠다. 글 참고바람

 

 

※ 전략패턴

템플릿 메서드 패턴 < 전략패턴인 이유 : 전략패턴은 템플릿 메서드 패턴과 비슷한 역할을 하면서 상속의 단점을 제거할 수 있는 디자인 패턴이다.

• 템플릿 메서드 패턴 : 부모 클래스에 변하지 않는 부분들을 모아두고, 변하는 부분을 자식 클래스에 두어서 상속을 사용해서 문제를 해결한다.
• 전략 패턴 : 변하지 않는 부분을 Context 라는 곳에 두고, 변하는 부분을 Strategy 라는 인터페이스를 만들고 해당 인터페이스를 구현하도록 해서 문제를 해결한다. 상속이 아니라 위임으로 문제를 해결한다. 거대한 문맥이 존재하고, 전략이 조금씩 바뀌는 것.

 

▶ 전략패턴V1 의 구성

Strategy : 변하는 부분을 모아놓은 인터페이스

public interface Strategy {
    void call();
}

@Slf4j
public class StrategyLogic1 implements Strategy {
    @Override
    public void call() {
        log.info("비즈니스 로직1 실행");
    }
}

 

 

ContextV1 : 변하지 않는 로직을 가지고 있는 템플릿 역할 + Strategy 를 내부필드로 두고있음(이걸 통해 Strategy 를 주입받음)

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

 

 

• Strategy 필드에 변하는 부분인 Strategy 의 구현체를 주입하면 된다.
• Context 코드는 Strategy 의 구현체를 변경하거나 새로 만들어도 Context 코드에는 영향을 주지 않는다. 이처럼 전략 패턴의 핵심은 Context 는 Strategy 인터페이스에만 의존한다는 점이다. 
• 변하지 않는 로직을 갖고 있는 템플릿 역할을 하는 코드를 전략패턴에서느 컨텍스트라고 한다. 
• Context 는 크게 변하지 않지만, 그 문맥속에서 Strategy 를 통해 전략이 변경된다고 생각하면 됨. 

 

▶  전략패턴V1 의 사용

@Test
void strategyV1() {
    StrategyLogic1 strategyLogic1 = new StrategyLogic1();
    ContextV1 context1 = new ContextV1(strategyLogic1);
    context1.execute();

    StrategyLogic2 strategyLogic2 = new StrategyLogic2();
    ContextV1 context2 = new ContextV1(strategyLogic2);
    context2.execute();
}

 

Strategy 의 구현체인 StrategyLogic1 의 인스턴스를 생성하여 ContextV1에 주입한다.

이렇게 해서 Context 안에 원하는 전략을 주입한다. 

 

이 방법은 선 조립, 후 실행 방법에 적합하다. Context 내부 필드에 Strategy 를 두고 사용하고 있기 때문에 둘을 한번 조립하고 나면 그 이후로는 Context 를 실행하기만 하면 된다. 그러나 단점은 한번 조립한 이후 전략을 변경하기가 번거롭다는 점이다. 

엥 ? Setter 를 제공해서 Strategy 를 넘겨 받아 제공하면 되지 않나 ? ) 맞다. 그렇지만 Context 를 싱글톤으로 사용할 때는 동시성 이슈등 고려할 점이 많다. 그래서 전략을 실시간으로 변경해야하면 위처럼 Context 를 하나 더 생성하고 그곳에 다른 Strategy 를 주입하는 것이 나을 수 있다. 

 

위 예시는 Context 에 Strategy 라는 내부 필드를 두고, 주입해서 사용했다. 

이번에는 직접 파라미터로 전달해서 사용해보자 !

 

▶ 전략패턴 V2의 구성

ContextV2 : 변하지 않는 로직을 모아두는 템플릿 역할 + Strategy 를 파라미터로 전달 받음

@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);
    }
}

@Slf4j
public class StrategyLogic2 implements Strategy {
    @Override
    public void call() {
        log.info("비즈니스 로직2 실행");
    }
}

 

 

▶ 전략패턴 V2의 사용

    @Test
    void strategyV1() {
        ContextV2 context = new ContextV2();
        context.execute(new StrategyLogic1());
        context.execute(new StrategyLogic2());
    }

 

이렇게 하면 Context 를 실행하는 시점에 원하는 Strategy 를 전달할 수 있다. (V1에서는 객체를 생성하는 시점에 Strategy 를 주입해야 했다. 따라서 이전 방식과 비교해서 더 유연하게 변경 가능하다.)

 

 

 

※  콜백 패턴

콜백(callback) : 다른 코드의 인수로서 넘겨주는 실행가능한 코드. (한마디로 함수가 인자로 넘어오는 것)

자바 언어에서 실행 가능한 코드를 인수로 넘기려면 객체가 필요하다. 최근에는 주로 람다를 사용한다. 

 

템플릿 콜백 패턴

• ContextV2와 같은 방식의 전략패턴을 템플릿 콜백 패턴이라고 한다. 
• 스프링에서 이름에 XxxTemplate 가 있다면 템플릿 콜백 패턴으로 만들어져 있다 생각하면 된다. 
  • 예: JdbcTemplate
• Template : 전략 패턴의 Context 와 같다. 변하지 않는 부분을 모아두는 템플릿이다.
• Callback : 전략 패턴의 Strategy 와 같다. 변하는 부분을 모아둔다.

 

▶ 템플릿 콜백 패턴 V1 구성

Callback 인터페이스

public interface Callback {
    void call();
}

@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);
    }
}

 

 

▶ 템플릿 콜백 패턴 V1 사용

void callbackV1() {
        TimeLogTemplate template = new TimeLogTemplate();
        
        template.execute(new Callback() { //익명 내부 클래스
            public void call() {
                log.info("비즈니스 로직1 실행");
            }
        });

 

• Callback 인터페이스를 구현체로 만들면서 동시에 실행
• 콜백을 사용할 경우 익명 내부 클래스나 람다를 사용하는 것이 편리하다. (물론 별도의 클래스를 만들어서 전달해도 됨)

 

---

 

• 템플릿 메서드 패턴 : 다형성과 상속을 사용하여 문제를 해결한다. 부모가 바뀌면 자식이 영향을 받음
• 전략 패턴 : 위임을 사용해 문제를 해결한다. Context 와 Strategy 로 구성된다. Strategy Interface 를 구현해 전략을 변경한다. 
• 템플릿 콜백 패턴 : 전략 패턴인데 Strategy 를 인자로 전달받게 하는 것과 동일하다. 이때 용어는 Template 과 callback 이라고 사용한다. 익명 내부 클래스 혹은 람다를 사용하는 것이 권장된다. 

적은 코드로 공통 로직을 작성하기 위해 고안된 디자인 패턴을 알아봤다. 

그러나 이 방법들은 결국 공통 로직을 적용하기 위해 원본 코드를 수정해야한다는 단점이 있다.