토비의 스프링 6 | 섹션 4 요약

[all-cloudz]

섹션4. 템플릿

• 다시 보는 개방 폐쇄 원칙
  • 코드의 변화 특성이 다른 부분을 구분하고, 다른 목적과 이유에 의해 다른 시점에 독립적으로 변경될 수 있는 효율적인 구조를 만드는 것 ⇒ 대표적인 예시가 바로 템플릿 + 콜백!!
• 템플릿 콜백 패턴은 전략 패턴의 일종
  • 전략 패턴을 클라이언트가 특정 컨텍스트에서 사용할 알고리즘을 주입해주는 패턴이라 정의하면 템플릿 콜백 패턴이 전략 패턴의 특수한 케이스라고 할 수 있음
  • 두 패턴의 차이를 꼽자면, 전략 패턴은 상태를 갖는 알고리즘, 둘 이상의 알고리즘(메서드) 등을 클라이언트가 제공하기 위해 인터페이스나 추상클래스를 사용하지만, 템플릿 메서드 패턴은 단일 추상 메서드를 가진 인터페이스(함수형 인터페이스), 람다 표현식을 사용하여 하나의 알고리즘만 제공하는 것이 보편적
  • 템플릿 콜백 패턴에서는 상태를 갖는 알고리즘을 실행하기 위해 컨텍스트에서 만든 상태를 콜백에 넣어서 실행, 대부분의 경우에 상태는 컨텍스트에서 만들지만 외부에서 컨텍스트에 상태를 주입해줘야 한다면 전략 패턴이 더 적절함
  • 클라이언트가 콜백을 제공하고, 추후에 콜백이 호출되면 콜백 함수는 클라이언트의 (Effective) Final 변수에 접근할 수 있음, 이렇게 하면 전략 패턴을 사용하지 않는 것도 가능함, 개인적으로는 그냥 전략 패턴을 쓰는 게 코드를 읽기는 더 쉽지 않을까 싶음
• Checked Exception vs Unchecked Exception (Runtime Exception)
  • Checked Exception ⇒ throw를 강제 ⇒ 외부에(인터페이스에) 불필요한 영향 발생
  • Checked Exception ⇒ try-catch 블록을 강제 ⇒ 비즈니스 로직을 가림
  • (대체로) 외부에 영향을 주는 것보다는 내부의 비즈니스 로직을 가리는 게 당장은 더 낫기 때문에 try-catch 블록을 사용하여 Checked Exception을 Unchecked Exception으로 바꿔서 던지는 것을 권장

[Leehyoungwoo]

템플릿

스프링과 JDK 업그레이드

• 스프링 6.0 → 6.1 (스프링 부트 3.2)
• JDK 21

개방 폐쇄 원칙(OCP)

• 클래스나 모듈은 확장에는 열려 있어야 하고 변경에는 닫혀 있어야 한다
• 변화에 특성이 다른 부분을 구분하고 각각 다른 목적과 이유에 의해 다른 시점에 독립적으로 변경될 수 있는 효율적인 구조를 만들어야 한다

템플릿

• 코드 중에서 변경이 거의 일어나지 않으며 일정한 패턴으로 유지되는 특성을 가진 부분을 자유롭게 변경되는 성질을 가진 부분으로부터 독립시켜서 효과적으로 활용할 수 있도록 하는 방법
  • 템플릿
    • 변경이 거의 일어나지 않으며 일정한 패턴으로 유지되는 특성을 가진 부분
  • 콜백
    • 자유롭게 변경되는 성질을 가진 부분

WebApiExRateProvider Refactoring

• 예외 처리 변경 → WebApiExRateProvider에서만 IOException이 터지는데 상위에서 throws할 필요 있나? → 모든 implements에 throws IOException이 붙어버리잖아

변하는 코드 분리하기

WebApiExRateProvider의 구성

• URI 준비하고 예외처리를 위한 작업을 하는 코드

• API를 실행하고, 서버로부터 받은 응답을 가져오는 코드

  • API를 호출하는 기술과 방법이 변경될 수 있음

• JSON 문자열을 파싱하고 필요한 환율 정보를 추출하는 코드

  • API 응답의 JSON 구조에 따라 정보를 추출하는 방식이 변경

  • 예시 코드

    package tobyspring.hellospring.exrate;
    
    import com.fasterxml.jackson.core.JsonProcessingException;
    import com.fasterxml.jackson.databind.ObjectMapper;
    import org.springframework.stereotype.Component;
    import tobyspring.hellospring.payment.ExRateProvider;
    
    import java.io.BufferedReader;
    import java.io.IOException;
    import java.io.InputStreamReader;
    import java.math.BigDecimal;
    import java.net.HttpURLConnection;
    import java.net.URI;
    import java.net.URISyntaxException;
    import java.net.URL;
    import java.util.stream.Collectors;
    
    @Component
    public class WebApiExRateProvider implements ExRateProvider {
    
        @Override
        public BigDecimal getExRate(String currency) {
            String url = "https://open.er-api.com/v6/latest/" + currency;
    
            URI uri;
            try {
                uri = new URI(url);
            } catch (URISyntaxException e) {
                throw new RuntimeException(e);
            }
            String response;
            try {
            // 2번
                HttpURLConnection connection = (HttpURLConnection) uri.toURL().openConnection();
                try (BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
                    response = in.lines().collect(Collectors.joining());
                }
            // 2번 끝
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
    
            try {
            // 3번
                ObjectMapper mapper = new ObjectMapper();
                ExRateData data = mapper.readValue(response, ExRateData.class);
                return data.rates().get("KRW");
            // 3번 끝
            } catch (JsonProcessingException e) {
                throw new RuntimeException(e);
            }
        }
    }
    

• 메서드 추출

변하지 않는 코드 분리하기 - 템플릿

템플릿

• 어떤 목적을 위해 미리 만들어진 모양이 있는 틀
• 고정된 틀 안에 바꿀 수 있는 부분을 넣어서 사용하도록 만들어진 오브젝트
• 템플릿 메서드 패턴도 템플릿을 사용

템플릿 메서드 패턴

• 고정된 틀의 로직을 가진 템플릿 메서드를 슈퍼 클래스에 두고 바뀌는 부분을 서브 클래스의 메서드에 두는 구조로 이루어짐

• 예시 코드

  package tobyspring.hellospring.exrate;
  
  import com.fasterxml.jackson.core.JsonProcessingException;
  import com.fasterxml.jackson.databind.ObjectMapper;
  import org.springframework.stereotype.Component;
  import tobyspring.hellospring.payment.ExRateProvider;
  
  import java.io.BufferedReader;
  import java.io.IOException;
  import java.io.InputStreamReader;
  import java.math.BigDecimal;
  import java.net.HttpURLConnection;
  import java.net.URI;
  import java.net.URISyntaxException;
  import java.util.stream.Collectors;
  
  @Component
  public class WebApiExRateProvider implements ExRateProvider {
  
      @Override
      public BigDecimal getExRate(String currency) {
          String url = "https://open.er-api.com/v6/latest/" + currency;
  
          return runApiForExRate(url);
      }
  
      private static BigDecimal runApiForExRate(String url) {
          URI uri;
          try {
              uri = new URI(url);
          } catch (URISyntaxException e) {
              throw new RuntimeException(e);
          }
          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 static BigDecimal extractExRate(String response) throws JsonProcessingException {
          ObjectMapper mapper = new ObjectMapper();
          ExRateData data = mapper.readValue(response, ExRateData.class);
          return data.rates().get("KRW");
      }
  
      private static String executeApi(URI uri) throws IOException {
          String response;
          HttpURLConnection connection = (HttpURLConnection) uri.toURL().openConnection();
          try (BufferedReader in = new BufferedReader(new InputStreamReader(connection.getInputStream()))) {
              response = in.lines().collect(Collectors.joining());
          }
          return response;
      }
  }
  

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

ApiExecutor 콜백과 메서드 주입 - Callback + Method Injection

콜백(Callback)

• 실행되는 것을 목적으로 다른 오브젝트의 메서드에 전달되는 오브젝트
• 파라미터로 전달되지만 값을 참조하기 위한 것이 아니라 특정 로직을 담은 메서드를 실행시키는 것이 목적
• 하나의 메서드를 가진 인터페이스 타입(SAM) 타입의 오브젝트 또는 람다 오브젝트

템플릿/콜백은 전략 패턴의 특별한 케이스

• 템플릿은 전략 패턴의 컨텍스트
• 콜백은 전략 패턴의 전략
• 템플릿/콜백은 메서드 하나만 가진 전략 인터페이스를 사용하는 전략 패턴

메서드 주입

• 의존 오브젝트가 메서드 호출 시점에 파라미터로 전달되는 방식
• 의존관계 주입의 한 종류
• 메서드 호출 주입이라고도 함

템플릿/콜백의 작업 흐름

ExRateExtractor 콜백 - Callback + Method Injection

ApiTemplacte 분리 - 환율 정보 API의 기본 틀

• 환율정보 API로부터 환율을 가져오는 기능을 제공
• API 호출과 정보 추출의 기본 틀 제공
• 두 가지 콜백을 이용
• 유사한 여러 오브젝트에서 재사용 가능

디폴트 콜백과 템플릿 빈 - 재사용 가능한 템플릿 빈

• 상태값을 가지고 있으면 싱글톤으로 사용하면 안됨

스프링이 제공하는 템플릿

RestTemplate

HTTP API 요청을 처리하는 템플릿

• HTTP Client 라이브러리 확장
  • ClientHttpRequestFactory
• Message Body를 변환하는 전략
  • HttpMessageConverter

HTTP Client 기술을 사용해서 ClientHttpRequest를 생성하는 전략

• SImpleClientHttpRequest(HttpURLConnection)
• JdkClientHttpRequest(HttpClient)
• NettyClientRequest
• JettyClientRequest
• OkHttp3ClientRequest

doExecute()

• HTTP API 호출 workflow를 가지고 있는 템플릿 메서드로 두 개의 콜백을 받음
  • RequestCallback
    • void doWithRequest(ClientHttpRequest request) throws IOException;
  • ResponseExtractor
    • T extractData(ClientHttpResponse response) throws IOException;
  • execute(), getForObject(), postForEntity(), .. 등등의 편리한 메서드 제공

스프링에의 Template

• JdbcTemplate
• JmsTemplate
• TransactionTemplate
• HibernateTemplate
• JpaTemplate

MyBatis

• SqlSessionTemplate

[all-cloudz]

추가적으로 정리할 것

• [ ] 전략 패턴과 템플릿 콜백 패턴의 차이
• [ ] RestClient(RestTemplate)에서 템플릿을 이용하여 구현한 부분 분석
• [ ] JdbcClient(JdbcTemplate)에서 템플릿을 이용하여 구현한 부분 분석