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

테스트

수동 테스트의 한계

프린트된 메세지를 수동으로 확인하는 방법은 불편
사용자 웹 UI까지 개발한 뒤에 확인하는 방법은 테스트가 실패했을 때 확인해야할 코드가 많음
테스트할 대상이 많아질수록 검증하는데 시간이 많이 걸리고 부정확함

작은 크기의 자동 수행되는 테스트(Automated Test)

개발자가 만드는 테스트

개발한 코드에 대한 검증 기능을 코드로 작성
자동으로 테스트를 수행하고 결과를 확인
테스팅 프레임워크를 활용
테스트 작성과 실행도 개발 과정의 일부

JUnit5

@Test 테스트 메서드
@BeforeEach 테스트
- 각 테스트 전에 실행
모든 테스트 실행마다 새로운 인스턴스가 만들어짐
- 각 실행마다 독립적으로 실행되어야 함

PaymentService 테스트의 문제점

강의 코드

package tobyspring.hellospring.payment;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import tobyspring.hellospring.exrate.WebApiExRateProvider;

import java.io.IOException;
import java.math.BigDecimal;
import java.time.LocalDateTime;

import static org.assertj.core.api.Assertions.assertThat;

class PaymentServiceTest {

    @Test
    @DisplayName("prepare 메서드가 요구사항 3가지를 잘 충족했는지 검증")
    void prepare() throws IOException {
        PaymentService paymentService = new PaymentService(new WebApiExRateProvider());

        Payment payment = paymentService.prepare(1L, "USD", BigDecimal.TEN);

        // 환율정보 가져온다
        assertThat(payment.getExRate()).isNotNull();
        // 원화환산금액 계산
        assertThat(payment.getConvertedAmount())
                .isEqualTo(payment.getExRate().multiply(payment.getForeignCurrencyAmount()));
        //원화환산금액유효시간 계산
        assertThat(payment.getValidUntil()).isAfter(LocalDateTime.now());
        assertThat(payment.getValidUntil()).isBefore(LocalDateTime.now().plusMinutes(30));
    }
}

제어할 수 없는 외부 시스템에 문제가 생기면?
- 외부API 환율 정보이 관여
ExRateProvider가 제공하는 환율 값으로 계산한 것인가?
환율 유효 시간 계산은 정확한 것인가?

테스트의 구성 요소

테스트 대상 (SUT)
테스트
협력자
- 임포스터? 테스트 더블(대역)?
BigDecimal은 유효자리수도 따지기 때문에 isEqualByComparingTo 로 비교하는게 나음

테스트와 DI

수동 DI를 이용하는 테스트

테스트용 협력자/의존 오브젝트를 테스트 대상에 직접 주입하고 테스트

스프링 DI를 이용하는 테스트

테스트용 협력자/의존 오브젝트를 스프링의 구성 정보를 이용해서 지정하고 컨테이너로부터 테스트 대상을 가져와서 테스트
@ContextConfiguration, @Autowired

학습 테스트 (Learing Test)

직접 만들지 않은 코드, 라이브러리, 레거시 시스템에 대한 테스트
테스트 대상의 사용방법을 익히고 동작 방식을 확인하는데 유용
외부 기술, 서비스가 버전이 올라갔을 때 이전과 동일하게 동작하는지 확인

도메인 오브젝트 테스트

도메인 모델 아키텍처 패턴

도메인 로직, 비즈니스 로직을 어디에 둘지를 결정하는 패턴
- 트랜잭션 스크립트
  - 서비스 메서드
- 도메인 모델
  - 도메인 모델 오브젝트
템플릿

스프링과 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) 타입의 오브젝트 또는 람다 오브젝트

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

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

메서드 주입

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

템플릿/콜백의 작업 흐름

!https://user-images.githubusercontent.com/10750614/55551325-7fb4dd00-5715-11e9-96a7-23b8a0a8b103.png

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

Leehyoungwoo / spring-study

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

테스트

수동 테스트의 한계

작은 크기의 자동 수행되는 테스트(Automated Test)

개발자가 만드는 테스트

JUnit5

PaymentService 테스트의 문제점

테스트의 구성 요소

테스트와 DI

수동 DI를 이용하는 테스트

스프링 DI를 이용하는 테스트

학습 테스트 (Learing Test)

도메인 오브젝트 테스트

도메인 모델 아키텍처 패턴

템플릿

스프링과 JDK 업그레이드

개방 폐쇄 원칙(OCP)

템플릿

WebApiExRateProvider Refactoring

변하는 코드 분리하기

WebApiExRateProvider의 구성

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

템플릿

템플릿 메서드 패턴

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

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

콜백(Callback)

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

메서드 주입

템플릿/콜백의 작업 흐름

ExRateExtractor 콜백 - Callback + Method Injection

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

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

스프링이 제공하는 템플릿

RestTemplate

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

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

doExecute()

스프링에의 Template

MyBatis