TIL

섹션 5 탬플릿

다시보는 OCP

• 개방 폐쇄 원칙 (OCP)
  • 클래스나 모듈은 확장에 열려 있고 변경엔 닫혀 있어야 한다.
• 변화의 특성이 다른 부분을 구분하고 효율적인 구조로 만들어야 한다.
  • 각각 다른 목적과 이유에 의해 다른 시점에 독립적으로 변경될 수 있도록
  • ex) 환율을 가져오는 방식이 바뀌어도 변화가 없는 PaymentService처럼

탬플릿

• 변경이 거의 일어나지 않으며 일정한 패턴으로 유지되는 특징을 가진 부분을 탬플릿이라 한다.
• 탬플릿으로부터 자유롭게 변경되는 성질을 가진 부분을 독립시켜 효과적으로 사용할 수 있다.
• ex) 탬플릿 메소드 패턴
  • 상속을 이용해 고정된 탬플릿과 변경 가능한 훅 부분을 분리하는 패턴
• ex) 탬플릿 콜백 패턴
  • 전략 패턴과 유사하게 인터페이스로 만들어진 콜백을 교체하며 탬플릿을 활용하는 패턴
• 스프링이 제공하는 탬플릿
  • JdbcTemplate (스프링 6에는 좀 더 모던한 JdbcClient가 추가되었다.)
  • RestTemplate (최근에는 RestClient가 추가되어 더 모던한 API 스타일을 작성할 수 있게 되었다.)
  • TransactionTemplate

WebApiExRateProvider 리팩터링

public class WebApiExRateProvider extends ExRateProvider {
  @Override
  BigDecimal getExRate(String currency) throws IOException {
    // 네트워크 호출을 통해 환율을 가져오는 로직
    // ...
    return exRate;
  }
}

• 세부 사항이라 코드를 자세히 적진 않았지만 WebApiExRateProvider는 네트워크 통신을 수행한다.
• 그 과정에서 IOEXception이 체크 예외로 발생할 수 있기에 기존에는 위처럼 예외를 메서드 밖으로 던졌다.
• 하지만 ExRateProvider 인터페이스만 본다면 네트워크 통신을 해야하니 IOException 난다는 사실을 모른다.
  • 다른 구현체는 IOException이 필요 없을 수 있다.
• 즉 WebApiExRateProvider는 IOException을 적절히 처리해야 한다.
  • 런타임 예외로 전환해서 던지는 방법이 있다.
  • 결국 시스템은 예외를 알긴 알아야 한다. (IOException이 아닌)
• 런타임 예외로 전환하면 ExRateProvider 외부에선 try/catch나 throws를 선언하지 않아도 된다.
  • 런타임 예외는 결국 어딘가에서 적절히 처리해야 한다.
  • 적어도 PaymentService 쪽의 관심사에선 분리하는 거에 의미가 있다.

변하는 코드 분리하기 - 메서드 추출

public class WebApiExRateProvider extends ExRateProvider {
  @Override
  BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    
    URI uri;
    uri = // 1. URI를 준비하고 예외 처리를 위한 작업을 하는 코드
    
    try {
      // 2. API를 실행하고 서버로부터 받은 응답을 가져오는 코드
    } catch (IOException e) {
      throw new RuntimeException(e)
    }
    
    try {
      // 3. JSON 문자열을 파싱하고 필요한 환율 정보를 추출하는 코드
    } catch (JsonProcessingException e) {
      throw new RuntimeException(e)
    }
    
    return exRate;
  }
}

• 메서드 흐름에서 2번과 3번은 변경과 확장이 될 가능성이 높다.
  • API 호출 방법이 다른 기술(라이브러리)로 변경될 수 있음
  • JSON 파싱 방법이 다른 기술(라이브러리)로 변경될 수 있음
• 2, 3번을 어떻게 나머지 변하지 않는 부분으로부터 분리시킬 수 있을까?
  • 일단 메서드로 추출해볼 수 있다.

public class WebApiExRateProvider extends ExRateProvider {
  @Override
  BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    URI uri;
    uri = // 1. URI를 준비하고 예외 처리를 위한 작업을 하는 코드
    
    String response;
    try {
      response = executeApi(uri);
    } catch (IOException e) {
      throw new RuntimeException(e)
    }
    
    try {
      return extractExRate(response)
    } catch (JsonProcessingException e) {
      throw new RuntimeException(e)
    }
  }
  
  private BigDecimal extractExRate(String response) throws JsonProcessingException {
    return // 3. JSON 문자열을 파싱하고 필요한 환율 정보를 추출하는 코드
  }
  
  private String executeApi(URI uri) throws IOException {
    return // 2. API를 실행하고 서버로부터 받은 응답을 가져오는 코드
  }
}

• 메서드로 추출함으로써 getExRate 메서드 내부의 코드는 2, 3번이 변화해도 바뀌지 않게 되었다.
  • 더 정확히는 api의 엔드포인트는 변할 수 있기 때문에 url 변수로 URI를 생성하는 부분부터 변하지 않는 부분
• 변하지 않는 부분 또한 정확히 잘라내기 위해 메서드로 추출해보자

public class WebApiExRateProvider extends ExRateProvider {
  @Override
  BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    
    return runApiForExRate(url);
  }
  
  private BigDecimal runApiForExRate(String url) {
    // 변하지 않는 코드
  }
  
  private BigDecimal extractExRate(String response) throws JsonProcessingException {
    return // 3. JSON 문자열을 파싱하고 필요한 환율 정보를 추출하는 코드
  }
  
  private String executeApi(URI uri) throws IOException {
    return // 2. API를 실행하고 서버로부터 받은 응답을 가져오는 코드
  }
}

• runApiForExRate는 변하지 않는, 탬플릿이 되었다.
• 메서드를 통해 변하는 부분과 변하지 않는 부분을 분리했지만 아직 부족하다.
  • 결국 변화가 생기면 WebApiExRateProvider 클래스가 바뀌게 된다.

인터페이스 도입과 클래스 분리

• 변하는 부분을 클래스로부터도 분리를 해보자.
  • 결합을 낮추기 위해 인터페이스를 도입하고, 구현체를 유연하게 변경할 수 있도록 할 것이다.

ApiExecutor

• API 호출을 실행하고 결과를 받는 excuteApi 메서드를 인터페이스로 분리

public interface ApiExecutor {
  String execute(URI uri) throws IOException;
}

public class SimpleApiExecutor implements ApiExecutor {
  @Override
  public String execute(URI uri) throws IOException {
    // ...
  }
}

콜백과 메소드 주입

• 콜백 (Callback)
  • 실행되는 것을 목적으로 다른 오브젝트의 메소드에 전달되는 오브젝트
  • 파라미터로 전달된다.
  • 값을 참조하기 위한 것이 아닌 특정 로직을 담은 메소드를 실행시키는 것이 목적
  • 자바에선 하나의 메소드를 가진 인터페이스 또는 람다로 사용된다.
• 탬플릿 콜백 패턴으로 ApiExecutor를 전달해보자.
  • 변하지 않는 탬플릿에 변하는 콜백을 메소드 주입으로 전달

public class WebApiExRateProvider extends ExRateProvider {
  @Override
  public BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    
    return runApiForExRate(url, new SimpleApiExecutor());
  }
  
  private BigDecimal runApiForExRate(String url, ApiExecutor apiExecutor) {
    // ...
    String response;
    try {
      response = apiExecutor.execute(uri);
    } catch (IOException e) {
      throw new RuntimeException(e)
    }
    // ...
  }
  //...
}

• JSON을 파싱하는 extractExRate 메소드도 똑같이 인터페이스로 만들고 구현체를 메소드 주입으로 전달해보자.

public class WebApiExRateProvider extends ExRateProvider {
  @Override
  public BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    
    return runApiForExRate(url, new SimpleApiExecutor(), new ErApiExRateExtractor());
  }
  
  private BigDecimal runApiForExRate(String url, ApiExecutor apiExecutor, ExRateExtractor extractor) {
    // 변하지 않는 탬플릿에서 변하는 콜백을 전달 받아 호출
  }
}

ApiTemplate 분리

• 환율 정보 API를 사용하는 기본 탬플릿을 ApiTemplate이라 정의해보자.
  • API 호출과 정보 추출의 기본 틀 제공
  • 두 가지 콜백을 이용
  • 유사한 여러 오브젝트 재사용 가능
• 탬플릿의 특징은 변하지 않는 것이기 때문에 그냥 클래스로 만들어도 될 것이다.

public class ApiTemplate {
  public BigDecimal getExRate(String url, ApiExecutor apiExecutor, ExRateExtractor extractor) {
    URI uri;
    try {
      uri = new URI(url);
    } catch(URISyntaxException e) {
      throw new RuntimeException(e);
    }
    
    String response;
    try {
      response = apiExecutor.execute(uri);
    } catch (IOException e) {
      throw new RuntimeException(e)
    }
    
    try {
      return extractor.extract(response)
    } catch (JsonProcessingException e) {
      throw new RuntimeException(e)
    }
  }
}

• 탬플릿을 사용하는 클라이언트인 WebApiExRateProvider에서 ApiTemplate을 사용해보자.

public class WebApiExRateProvider extends ExRateProvider {
  private final ApiTemplate apiTemplate = new ApiTemplate();
  
  @Override
  public BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    
    return apiTemplate.getExRate(url, new SimpleApiExecutor(), new ErApiExRateExtractor());
  }
}

• 이 때 콜백을 다른 구현체로 변경하려면 어떻게 해야할까?
  • 지금은 WebApiExRateProvider에서 구현체를 명시적으로 바꾸는 수밖에 없다.

public class WebApiExRateProvider extends ExRateProvider {
  private final ApiTemplate apiTemplate = new ApiTemplate();
  
  @Override
  public BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    
    return apiTemplate.getExRate(url, new HttpClientApiExecutor(), new ErApiExRateExtractor());
  }
}

디폴트 콜백과 탬플릿 빈

대폴트 콜백

• 매번 탬플릿에 콜백을 전달하는건 번거로울 수 있다.
• 콜백을 명시적으로 전달하지 않으면 디폴트값을 사용하도록 내부에서 지정하면 다른 콜백을 쓸 때만 주입해서 사용할 수 있다.
  • 메소드 오버로딩 사용

public class ApiTemplate {
  private final ApiExecutor apiExecutor;
  private final ExRateExtractor exRateExtractor;
  
  public ApiTemplate() {
    this.apiExecutor = new HttpClientApiExecutor();
    this.exRateExtractor = new ErApiExtractor();
  }
  
  public BigDecimal getExRate(String url) {
    // ...
  }

  public BigDecimal getExRate(String url, ApiExecutor apiExecutor, ExRateExtractor extractor) {
    // ...
  }
}

• 위와 같이 하면 클라이언트에선 url만 전달해서 탬플릿을 사용할 수 있다.

public class WebApiExRateProvider extends ExRateProvider {
  private final ApiTemplate apiTemplate = new ApiTemplate();
  
  @Override
  public BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    
    return apiTemplate.getExRate(url);
  }
}

탬플릿 빈

• 이제 ApiTemplate을 스프링 빈 주입 받도록 설정해보자

@Configuration
public class ObjectFactory {
  // ...
  @Bean
  public ExRateProvider exRateProvider() {
    return new WebApiExRateProvider(apiTemplate());
  }
  
  @Bean
  public ApiTemplate apiTemplate() {
    return new ApiTemplate();
  }
}

public class WebApiExRateProvider extends ExRateProvider {
  private final ApiTemplate apiTemplate;
  
  public WebApiExRateProvider(ApiTemplate apiTemplate) {
    this.apiTemplate = apiTemplate;
  }
  
  @Override
  public BigDecimal getExRate(String currency) {
    String url = "https://open.er-api.com/v6/latest/" + currency;
    
    return apiTemplate.getExRate(url);
  }
}

디폴트 콜백 유연하게 세팅

• 디폴트 콜백도 경우에 따라 외부에서 주입 받아 사용하게 만들 수 있다.
• 생성자 오버로딩을 사용하자

public class ApiTemplate {
  private final ApiExecutor apiExecutor;
  private final ExRateExtractor exRateExtractor;
  
  public ApiTemplate() {
    this.apiExecutor = new HttpClientApiExecutor();
    this.exRateExtractor = new ErApiExtractor();
  }
  
  public ApiTemplate(ApiExecutor apiExecutor, ExRateExtractor extractor) {
    this.apiExecutor = apiExecutor;
    this.exRateExtractor = extractor;
  }
  
  // ...
}