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

[YONGHYNG]

인터페이스 기반 프록시 - 적용

• 인터페이스와 구현체가 있는 V1 App에 지금까지 학습한 프록시를 도입해서 LogTrace 를 사용해보자.
• 프록시를 사용하면 기존 코드를 전혀 수정하지 않고 로그 추적 기능을 도입 가능
• V1 App의 기본 클래스 의존 관계와 런타임시 객체 인스턴스 의존 관계는 아래와 같음

V1 프록시 의존 관계 추가

V1 프록시 런타임 객체 의존 관계

OrderRepositoryInterfaceProxy

package hello.proxy.config.v1_proxy.interface_proxy;

import hello.proxy.app.v1.OrderRepositoryV1;
import hello.proxy.trace.TraceStatus;
import hello.proxy.trace.logtrace.LogTrace;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class OrderRepositoryInterfaceProxy implements OrderRepositoryV1 {

    private final OrderRepositoryV1 target;
    private final LogTrace logTrace;

    @Override
    public void save(String itemId){
        TraceStatus status = null;
        try {
            status = logTrace.begin("OrderRepository.save()");
            //target 호출
            target.save(itemId);
            logTrace.end(status);
        } catch (Exception e){
          logTrace.exception(status, e);
          throw e;
        }
    }
}

• 프록시를 만들기 위해 인터페이스를 구현하고, 구현한 메서드에 LogTrace 사용 로직 추가
• 지금까지는 OrderRepositoryImpl에 이런 로직을 모두 추가했어야 함
• 프록시를 사용한 덕분에 이 부분을 프록시가 대신 처리
• 즉, OrderRepositoryImpl 코드를 변경하지 않아도 됨
• OrderRepositoryV1 tatget : 프록시가 실제 호출할 원본 리포지토리의 참조를 가지고 있어야 함

OrderServiceInterfaceProxy

package hello.proxy.config.v1_proxy.interface_proxy;

import hello.proxy.app.v1.OrderServiceV1;
import hello.proxy.trace.TraceStatus;
import hello.proxy.trace.logtrace.LogTrace;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class OrderServiceInterfaceProxy implements OrderServiceV1 {
    
    private final OrderServiceV1 target;
    private final LogTrace logTrace;
    
    @Override
    public void orderItem(String itemId){
        
        TraceStatus status = null;
        try {
            status = logTrace.begin("OrderService.orderItem()");
            //target 호출
            target.orderItem(itemId);
            logTrace.end(status);
        } catch(Exception e) {
            logTrace.exception(status, e);
            throw e;
        }
    }
}

OrderControllerInterfaceProxy

package hello.proxy.config.v1_proxy.interface_proxy;

import hello.proxy.app.v1.OrderControllerV1;
import hello.proxy.trace.TraceStatus;
import hello.proxy.trace.logtrace.LogTrace;
import lombok.RequiredArgsConstructor;

@RequiredArgsConstructor
public class OrderControllerInterfaceProxy implements OrderControllerV1 {

    private final OrderControllerV1 target;
    private final LogTrace logTrace;

    @Override
    public String request(String itemId) {
        TraceStatus status = null;
        try {
            status = logTrace.begin("OrderController.request()");
            //target 호출
            String result = target.request(itemId);
            logTrace.end(status);
            return result;
        } catch (Exception e) {
            logTrace.exception(status, e);
            throw e;
        }
    }

    @Override
    public String noLog() { //로그를 남기지 않음 단순히 target 호출
        return target.noLog();
    }
}

OrderControllerInterfaceProxy

package hello.proxy.config.v1_proxy.interface_proxy;

import hello.proxy.app.v1.*;
import hello.proxy.trace.logtrace.LogTrace;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class InterfaceProxyConfig {

    @Bean
    public OrderControllerV1 orderController(LogTrace logTrace){
        OrderControllerV1Impl controllerImpl =
                new OrderControllerV1Impl(orderService(logTrace));
        return new OrderControllerInterfaceProxy(controllerImpl, logTrace);
    }
    
    @Bean
    public OrderServiceV1 orderService(LogTrace logTrace) {
        OrderServiceV1Impl serviceImpl = 
                new OrderServiceV1Impl(orderRepository(logTrace));
        return new OrderServiceInterfaceProxy(serviceImpl, logTrace);
    }
    
    @Bean
    public OrderRepositoryV1 orderRepository(LogTrace logTrace){
        OrderRepositoryV1Impl repositoryImpl = new OrderRepositoryV1Impl();
        return new OrderRepositoryInterfaceProxy(repositoryImpl, logTrace);
    }
}

• LogTrace가 아직 스프링 빈으로 등록 안 됨, 다음에 등록 예정

V1 프록시 런타임 객체 의존 관계 설정

• 이제 프록시의 런타임 객체 의존 관계를 설정하면 됨
• 기존에는 스프링 빈이 orderControlerV1Impl , orderServiceV1Impl 같은 실제 객체를 반환, 하지만 이제는 프록시를 사용해야 함
• 따라서 프록시를 생성하고 프록시를 실제 스프링 빈 대신 등록, 실제 객체는 스프링 빈으로 등록하지 않음
• 프록시는 내부에 실제 객체를 참조하고 있음, 예를 들어서 OrderServiceInterfaceProxy 는 내부에 실제
  대상 객체인 OrderServiceV1Impl 을 가지고 있음
• 정리하면 다음과 같은 의존 관계를 가지고 있음,
• proxy -> target || orderServiceInterfaceProxy -> orderServiceV1Impl
• 스프링 빈으로 실제 객체 대신에 프록시 객체를 등록했기 때문에 앞으로 스프링 빈을 주입 받으면 실제 객체 대신에 프록시 객체가 주입 됨
• 실제 객체가 스프링 빈으로 등록되지 않는다고 해서 사라지는 것은 아님 프록시 객체가 실제 객체를 참조하기 때문에 프록시를 통해서 실제 객체를 호출할 수 있음
• 쉽게 이야기해서 프록시 객체 안에 실제 객체가 있는 것

• AppV1Config를 통해 프록시를 적용하기 전
• 실제 객체가 스프링 빈으로 등록 됨, 빈 객체의 마지막에 @x0.. 라고 해둔 것은 인스턴스라는 뜻

• InterfaceProxyConfig를 통해 프록시를 적용한 후
• 스프링 컨테이너에 프록시 객체가 등록, 스프링 컨테이너는 이제 실제 객체가 아니라 프록시 객체를 스프링 빈으로 관리
• 이제 실제 객체는 스프링 컨테이너와는 상관이 없다. 실제 객체는 프록시 객체를 통해서 참조될 뿐
• 프록시 객체는 스프링 컨테이너가 관리하고 자바 힙 메모리에도 올라간다. 반면에 실제 객체는 자바 힙 메모리에는 올라가지만 스프링 컨테이너가 관리하지는 않음

런타임 객체 의존 관계

package hello.proxy;

import hello.proxy.trace.logtrace.LogTrace;
import hello.proxy.trace.logtrace.ThreadLocalLogTrace;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Bean;

@Import(InterfaceProxyConfig.class)
@SpringBootApplication(scanBasePackages = "hello.proxy.app") //주의
public class ProxyApplication {

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

	@Bean
	public LogTrace logTrace() {
		return new ThreadLocalLogTrace();
	}
}

• @bean : 먼저 LogTrace 스프링 빈 추가를 먼저 해줘야 함, 이것을 여기에 등록한 이유는 앞으로 사용할 모든 예제에서 함께 사용하기 위함
• @import(InterfaceProxyConfig.class) : 프록시를 적용한 설정 파일을 사용

정리

• 추가된 요구사항을 다시 확인

추가된 요구사항
원본 코드를 전혀 수정하지 않고, 로그 추적기를 적용해라.
특정 메서드는 로그를 출력하지 않는 기능
보안상 일부는 로그를 출력하면 안된다.

• 다음과 같은 다양한 케이스에 적용할 수 있어야 한다.
  v1 - 인터페이스가 있는 구현 클래스에 적용

• v2 - 인터페이스가 없는 구체 클래스에 적용

• v3 - 컴포넌트 스캔 대상에 기능 적용

• 프록시와 DI 덕분에 원본 코드를 전혀 수정하지 않고, 로그 추적기를 도입할 수 있었음, 물론 너무 많은 프록시 클래스를 만들어야 하는 단점이 있기는 함

• 이 부분은 나중에 해결하기로 하고, 우선은 v2 - 인터페이스가 없는 구체 클래스에 프록시를 어떻게 적용할 수 있는지 알아봄