🔥 TIL - Day 78 디자인 패턴 - 템플릿 메서드 Template Method

템플릿 메서드가 무엇인지 알아보기 전에 템플릿 메서드가 필요한 상황을 먼저 알아보자.

두 클래스 TestA 와 TestB가 있다.
두 클래스는 한 개 메서드(logic)를 갖고 해당 메서드는 0.5초가 소요되는 어떤 작업을 수행한다.

logic 메서드의 실행시간을 측정해야 하는 요구사항이 있어서 아래와 같이 구현했다.

@Slf4j
public class WithoutTemplateMethodTest {

    public class TestA {
        public void logic() throws InterruptedException {           
            log.info("start");
            // 실행시간 측정시작
            long start = System.currentTimeMillis();
            
            // 비즈니스 로직
            log.info("TestA logic1 processing ...");
            Thread.sleep(500);

            // 실행시간 로그출력
            long end = System.currentTimeMillis();
            long spendTime = end - start;
            log.info("end, time = {}", spendTime);
        }
    }

    public class TestB {
        public void logic() throws InterruptedException {
            // 실행시간 측정시작
            log.info("start");
            long start = System.currentTimeMillis();

            // 비즈니스 로직
            log.info("TestB logic processing ...");
            Thread.sleep(500);
            
            // 실행시간 로그출력
            long end = System.currentTimeMillis();
            long spendTime = end - start;
            log.info("end, time = {}", spendTime);
        }
    }
}

두 클래스의 logic 메서드에서 비즈니스 로직을 수행하는 코드는 단 두 줄이다.
비즈니스 로직과는 관계없는 실행시간을 측정하는 코드의 양이 훨씬 많다. 또한 실행시간 측정 부분은 완벽하게 중복된다. 이렇게 비즈니스 로직과 관련없는 공통의 부가기능 때문에 코드가 길어지고 중복된다.

이렇게 비즈니스 로직과 관계없는 부가기능 (로깅, 실행시간 측정 등 ..) 을 분리해내는 솔루션으로 템플릿 메서드를 사용할 수 있다.

📌 템플릿 메서드 적용

템플릿 메서드는 이름 그대로 어떤 템플릿을 제공하는 것이다.
여기서 템플릿에는 변하지 않는 부가기능이 담겨져 있고 템플릿 코드의 원하는 곳에서 비즈니스 로직을 수행하는 메서드를 호출시키면 된다.

상속을 이용해서 템플릿 메서드 패턴을 적용할 것이다.
템플릿 역할을 하는 추상클래스 하나를 정의하고 자식 클래스에서 비즈니스 로직을 위해 오버라이딩 될 추상메서드 하나를 제공한다.

공통의 부가기능에 해당하는 execute 부분에서 자식클래스에서 오버라이딩 할 비즈니스 로직을 담당하는 call 메서드를 호출하도록 구현한다.

@Slf4j
public abstract class AbstractTemplate {

    public void execute() {
        log.info("start");
        long start = System.currentTimeMillis();

        call();

        long end = System.currentTimeMillis();
        long spendTime = end - start;
        log.info("end, time = {}", spendTime);
    }

    protected abstract void call();
}

이제 실행시간을 측정하고자 하는 메서드를 가진 클래스는 AbstractTemplate를 상속하고 call 메서드를 오버라이딩 하면 된다.

@Slf4j
public class SubClass1 extends AbstractTemplate {

    @Override
    protected void call() {
        log.info("logic1 processing ...");
        try {
            Thread.sleep(500);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}


@Slf4j
public class SubClass2 extends AbstractTemplate{

    @Override
    protected void call() {
        log.info("logic2 processing ...");
        try {
            Thread.sleep(500);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
    }
}

정의한 두 클래스의 인스턴스를 생성하고 테스트를 수행한다.

public class TemplateMethodTest {

    @Test
    void test() {
        AbstractTemplate subClass1 = new SubClass1();
        subClass1.execute();

        SubClass2 subClass2 = new SubClass2();
        subClass2.execute();
    }
}

부모타입으로 인스턴스를 생성(업케스팅)하고 오버라이딩 된 메서드를 호출하면 오버라이딩 된 자식 클래스의 메서드가 수행된다.

테스트 결과 템플릿 메서드를 적용하지 않았을 때와 완벽하게 같은 것을 학인할 수 있다.

📌 참고

인프런 - 스프링 핵심 원리 고급편 (김영한 님)