[스프링 핵심원리 - 고급편] #4. 프록시 패턴과 데코레이터 패턴

[YONGHYNG]

프록시 패턴

스프링 빈을 어떻게 등록할 것인가?? 예제는 3가지 상황

1. v1 - 인터페이스와 구현 클래스 - 스프링 빈으로 수동 등록
2. v2 - 인터페이스 없는 구체 클래스 - 스프링 빈으로 수동 등록
3. v3 - 컴포넌트 스캔으로 스프링 빈 자동 등록

실무에서는 스프링 빈으로 등록할 클래스는 인터페이스가 있는 경우도 있고 없는 경우도 있음, 그리고 스프링 빈을 수동으로 직접 등록하는 경우도 있고, 컴포넌트 스캔으로 자동으로 등록하는 경우도 있음, 이런 다양한 케이스에 프록시를 어떻게 적용하는지 알아보기 위해 다양한 예제를 준비

v1 - 인터페이스와 구현 클래스 - 스프링 빈으로 수동 등록

• 지금까지 보아왔던 Controller , Service , Repository 에 인터페이스를 도입하고, 스프링 빈으로 수동 등록
• V1: 인터페이스 + 구현 클래스 -> 수동 빈 등록
• @configuration 클래스(AppV1Config)를 사용해 직접 @bean 등록
• OrderControllerV1, OrderServiceV1, OrderRepositoryV1은 인터페이스 가짐

적용 흐름

=> 기본 실행 : OrderControllerV1 -> request() 호출 -> OrderServiceV1 이 orderItem()이 실행 -> orderItem()은 OrderRepositoryV1의 save()를 호출하면 저장

OrderRepositoryV1 -- 상품 저장 기능을 담당하는 인터페이스

package hello.proxy.app.v1;

public interface OrderRepositoryV1 {
    void save(String itemId);
}

OrderRepositoryV1Impl -- 상품 저장 기능을 실제로 구현하는 클래스

package hello.proxy.app.v1;

public class OrderRepositoryV1Impl implements OrderRepositoryV1 {

    @Override
    public void save(String itemId){

        //저장 로직
        if(itemId.equals("ex")){
            throw new IllegalStateException("예외 발생!");
        }
        sleep(1000);
    }

    private void sleep(int millis){
        try{
            Thread.sleep(millis);
        } catch (InterruptedException e){
            e.printStackTrace();
        }
    }
}

OrderServiceV1 -- 주문 처리 기능을 담당하는 인터페이스

package hello.proxy.app.v1;

public interface OrderServiceV1 {
    void orderItem(String itemId);
}

OrderServiceV1Impl -- 주문 처리 기능을 실제로 구현하는 클래스

package hello.proxy.app.v1;

public class OrderServiceV1Impl implements OrderServiceV1{
    
    private final OrderRepositoryV1 orderRepository;
    
    public OrderServiceV1Impl(OrderRepositoryV1 orderRepository){
        this.orderRepository = orderRepository;
    }
    
    @Override
    public void orderItem(String itemId){
        orderRepository.save(itemId);
    }
}

OrderControllerV1 -- 웹 요청을 처리하는 인터페이스

package hello.proxy.app.v1;

import org.springframework.web.bind.annotation.*;


//@RequestMapping//스프링 @Controller 또는 @RequesetMapping이 있어야 컨트롤러로 인식
//@ResponseBody
@RestController //스프링은 @Controller, @RestController가 있어야 스프링 컨트롤러 인식
public interface OrderControllerV1 {

    @GetMapping("/v1/request")
    String request(@RequestParam("itemId") String itemId);

    @GetMapping("/v1/no-log")
    String noLog();
}

• @RequestMapping : 스프링MVC는 타입에 @Controller 또는 @RequestMapping 애노테이션이 있어
  야 스프링 컨트롤러로 인식, 그리고 스프링 컨트롤러로 인식해야, HTTP URL이 매핑되고 동작, 이 애노
  테이션은 인터페이스에 사용해도 됨
• @ResponseBody : HTTP 메시지 컨버터를 사용해서 응답한다. 이 애노테이션은 인터페이스에 사용
• @RequestParam("itemId") String itemId : 인터페이스에는 @RequestParam("itemId") 의 값을 생략하면 itemId 단어를 컴파일 이후 자바 버전에 따라 인식하지 못할 수 있음, 인터페이스에서는 꼭 넣어주자. 클래스에는 생략해도 대부분 잘 지원 됨
• 코드를 보면 request() , noLog() 두 가지 메서드 존재, request() 는 LogTrace 를 적용할 대상이고, noLog() 는 단순히 LogTrace 를 적용하지 않을 대상

OrderControllerV1Impl -- 웹 요청을 실제로 처리하는 클래스

package hello.proxy.app.v1;

public class OrderControllerV1Impl implements OrderControllerV1 {

    private final OrderServiceV1 orderService;

    public OrderControllerV1Impl(OrderServiceV1 orderService) {
        this.orderService = orderService;
    }

    @Override
    public String request(String itemId){
        orderService.orderItem(itemId);
        return "오키";
    }

    @Override
    public String noLog(){
        return "오키";
    }
}

AppV1Config

package hello.proxy;


import hello.proxy.config.AppV1Config;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Import;

@Import(AppV1Config.class)
@SpringBootApplication(scanBasePackages = "hello.proxy.app.v3")
public class ProxyApplication {

	public static void main(String[] args) {
		SpringApplication.run(ProxyApplication.class, args);
	}
}

• @Import(AppV1Config.class) : 클래스를 스프링 빈으로 등록, 여기서는 AppV1Config.class 를
  스프링 빈으로 등록, 일반적으로 @Configuration 같은 설정 파일을 등록할 때 사용하지만, 스프링 빈을 등록할 때도 사용 가능
• @SpringBootApplication(scanBasePackages = "hello.proxy.app") : @ComponentScan 의 기능과 같음, 컴포넌트 스캔을 시작할 위치를 지정, 이 값을 설정하면 해당 패키지와 그 하위 패키지를 컴포넌트 스캔, 이 값을 사용하지 않으면 ProxyApplication 이 있는 패키지와 그 하위 패키지를 스캔, 참고로 v3 에서 지금 설정한 컴포넌트 스캔 기능을 사용

스프링 3.0 수정사항

• scanBasePackages 부분에서 마지막에 v3 가 붙었다. hello.proxy.app hello.proxy.app.v3 이렇게 하는 이유는 스프링 부트 3.0부터는 @Controller , @RestController 를 사용했는데, 이렇게 하면 내부에 @Component 를 가지고 있어서 컴포넌트 스캔의 대상이 됨 - 지금 처럼 컴포넌트 스캔도 되고, 빈도 수동으로 직접 등록하게 되면 스프링 컨테이너에 등록시 충돌 오류가 발생한다. 이후에 학습할 hello.proxy.app.v3 는 빈을 직접 등록하지 않고 컴포넌트 스캔을 사용하기 때문에 괜찮음

주의

• 강의에서는 @Configuration 을 사용한 수동 빈 등록 설정을 hello.proxy.config 위치에 두고 점진적으로 변경할 예정, 지금은 AppV1Config.class 를 @Import 를 사용해서 설정하지만 이후에 다른 것을 설정한다는 이야기
• @Configuration 은 내부에 @Component 애노테이션을 포함하고 있어서 컴포넌트 스캔의 대상 따라서 컴포넌트 스캔에 의해 hello.proxy.config 위치의 설정 파일들이 스프링 빈으로 자동 등록 되지 않도록 컴포넌스 스캔의 시작 위치를scanBasePackages=hello.proxy.app 로 설정

v2 - 인터페이스 없는 구체 클래스 - 스프링 빈으로 수동 등록

• 이번에는 인터페이스가 없는 Controller, Service., Repository를 빈으로 등록
• @configuration 클래스(AppV2Config)에서 @bean으로 직접 등록
• OrderControllerV2, OrderServiceV2, OrderRepositoryV2는 인터페이스 없이 동작

OrderRepositoryV2

package hello.proxy.app.v2;

public class OrderRepositoryV2 {

    public void save(String itemId){
        //저장 로직
        if(itemId.equals("ex")) {
            throw new IllegalStateException("예외 발생!");
        }
        sleep(1000);
    }

    private void sleep(int millis){
        try{
                Thread.sleep(millis);
            } catch (InterruptedException e){
                e.printStackTrace();
        }
    }
}

OrderServiceV2

package hello.proxy.app.v2;

public class OrderServiceV2 {

    private final OrderRepositoryV2 orderRepository;

    public OrderServiceV2(OrderRepositoryV2 orderRepository){
        this.orderRepository = orderRepository;
    }

    public void orderItem(String itemId){
        orderRepository.save(itemId);
    }
}

OrderControllerV2

package hello.proxy.app.v2;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Slf4j
@RequestMapping
@ResponseBody
public class OrderControllerV2 {

    private final OrderServiceV2 orderService;

    public OrderControllerV2(OrderServiceV2 orderService) {
        this.orderService = orderService;
    }

    @GetMapping("/v2/request")
    public String request(String itemId){
        orderService.orderItem(itemId);
        return "오키";
    }

    @GetMapping("/v2/no-log")
    public String noLog(){
        return "오키";
    }
}

• @RequestMapping : 스프링MVC는 타입에 @Controller 또는 @RequestMapping 애노테이션이 있어야 스프링 컨트롤러로 인식, 그리고 스프링 컨트롤러로 인식해야, HTTP URL이 매핑되고 동작
• 그런데 여기서는 @Controller 를 사용하지 않고, @RequestMapping 애노테이션을 사용, 그 이유는 @Controller 를 사용하면 자동 컴포넌트 스캔의 대상이 되기 때문, 여기서는 컴포넌트 스캔을 통한 자동 빈 등록이 아니라 수동 빈 등록을 하는 것이 목표
• 따라서 컴포넌트 스캔과 관계 없는 @RequestMapping 를 타입에 사용

AppV2Config

package hello.proxy.config;

import hello.proxy.app.v2.OrderControllerV2;
import hello.proxy.app.v2.OrderRepositoryV2;
import hello.proxy.app.v2.OrderServiceV2;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppV2Config {

    @Bean
    public OrderControllerV2 orderControllerV2() {
        return new OrderControllerV2(orderServiceV2());
    }

    @Bean
    public OrderServiceV2 orderServiceV2(){
        return new OrderServiceV2(orderRepositoryV2());
    }

    @Bean
    public OrderRepositoryV2 orderRepositoryV2(){
        return new OrderRepositoryV2();
    }
}

• 수동 빈 등록을 위한 설정

ProxyApplication

package hello.proxy;

import hello.proxy.config.AppV1Config;
import hello.proxy.config.AppV2Config;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Import;

@Import({AppV1Config.class, AppV2Config.class})
@SpringBootApplication(scanBasePackages = "hello.proxy.app")
public class ProxyApplication {

	public static void main(String[] args) {
		SpringApplication.run(ProxyApplication.class, args);
	}
}

예제 프로젝트 만들기 v3

• v3 : 컴포넌트 스캔으로 스프링 빈 자동 등록
• @component, @service, @repository 같은 애노테이션 사용
• OrderControllerV3, OrderServiceV3, OrderRepositoryV3가 컴포넌트 스캔으로 자동 등록

OrderRepositoryV3

package hello.proxy.app.v3;

@Repository
public class OrderRepositoryV3 {

    public void save(String itemId){
        //저장 로직
        if(itemId.equals("ex")) {
            throw new IllegalStateException("예외 발생!");
        }
        sleep(1000);
    }

    private void sleep(int millis) {
        try {
            Thread.sleep(millis);
            } catch (InterruptedException e){
                e.printStackTrace();
        }
    }
}

OrderServiceV3

package hello.proxy.app.v3;

@Service
public class OrderServiceV3 {

    private final OrderRepositoryV3 orderRepository;

    public OrderServiceV3(OrderRepositoryV3 orderRepository) {
        this.orderRepository = orderRepository;
    }

    public void orderItem(String itemId) {
        orderRepository.save(itemId);
    }
}

OrderControllerV3

package hello.proxy.app.v3;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RestController
public class OrderControllerV3 {
    private final OrderServiceV3 orderService;
    public OrderControllerV3(OrderServiceV3 orderService) {
        this.orderService = orderService;
    }
    @GetMapping("/v3/request")
    public String request(String itemId) {
        orderService.orderItem(itemId);
        return "ok";
    }
    @GetMapping("/v3/no-log")
    public String noLog() {
        return "ok";
    }
}

요구사항 추가

• 지금까지 로그 추적기를 만들어서 기존 요구사항을 모두 만족

기존 요구사항

1. 모든 PUBLIC 메서드의 호출과 응답 정보를 로그로 출력
2. 애플리케이션의 흐름을 변경하면 안됨 - 로그를 남긴다고 해서 비즈니스 로직의 동작에 영향을 주면 안됨
3. 메서드 호출에 걸린 시간
4. 정상 흐름과 예외 흐름 구분 - 예외 발생시 예외 정보가 남아야 함
5. 메서드 호출의 깊이 표현
6. HTTP 요청을 구분 - HTTP 요청 단위로 특정 ID를 남겨서 어떤 HTTP 요청에서 시작된 것인지 명확하게 구분이 가능해야 함
   ,트랜잭션 ID (DB 트랜잭션X)

예시

다음으로

• 하지만 이 요구사항을 만족하기 위해서 기존 코드를 많이 수정해야 한다. 코드 수정을 최소화 하기 위해 템플릿 메서드
  패턴과 콜백 패턴도 사용했지만, 결과적으로 로그를 남기고 싶은 클래스가 수백개라면 수백개의 클래스를 모두 고쳐야 함,
• 로그를 남길 때 기존 원본 코드를 변경해야 한다는 사실 그 자체가 개발자에게는 가장 큰 문제로 남음

기존 요구사항에 다음 요구사항이 추가

1. 원본 코드를 전혀 수정하지 않고, 로그 추적기를 적용해라.
2. 특정 메서드는 로그를 출력하지 않는 기능 - 보안상 일부는 로그를 출력하면 안된다.
3. 다음과 같은 다양한 케이스에 적용할 수 있어야 한다.

• v1 - 인터페이스가 있는 구현 클래스에 적용
• v2 - 인터페이스가 없는 구체 클래스에 적용
• v3 - 컴포넌트 스캔 대상에 기능 적용

가장 어려운 문제는 원본 코드를 전혀 수정하지 않고, 로그 추적기를 도입하는 것이다. 이 문제를 해결하려면 프록시
(Proxy)의 개념을 먼저 이해해야 한다