[기본] #9 빈 스코프

본 포스팅은 인프런 - 스프링 핵심 원리(기본편)을 강의를 바탕으로 공부하고 정리한 글입니다.

 

빈 스코프

스코프는 빈이 존재할 수 있는 범위, 즉 생성부터 소멸까지의 범위를 나타낸다.

 

스프링 빈은 기본적으로 싱글톤 스코프로 생성되기 때문에 스프링 컨테이너의 시작과 함께 생성되어 스프링 컨테이너가 종료될 때까지 유지된다.

빈이 가질 수 있는 다양한 스코프를 알아보자.

• 기본 빈 스코프
  • 싱글톤 : 스프링 컨테이너의 시작부터 종료까지 유지되는 가장 넓은 범위의 스코프
  • 프로토타입 : 스프링 컨테이너가 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프 (초기화 콜백까지는 호출, 소멸 콜백 호출하지 못함)
• 웹 관련 스코프
  • request : 웹 요청이 들어오고 나갈 때까지 유지되는 스코프
  • session : 웹 세션이 생성되고 종료될 때까지 유지되는 스코프
  • application : 웹의 서블릿 컨텍스와 같은 범위로 유지되는 스코프

 

빈 스코프는 @Scope("종류")로 지정해줄 수 있다.

// 컴포넌트 스캔 자동 등록 방식
@Scope("prototype")
@Component
public class HelloBean {}

// 빈 수동 등록 방식
@Scope("prototype")
@Bean
PrototypeBean HelloBean() {
	return new HelloBean();
}

 

싱글톤 스코프

• 싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다.
  • 싱글톤 스코프의 빈을 스프링 컨테이너에 요청
  • 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환
  • 이후에 스프링 컨테이너에 같은 요청이 와도 같은 객체 인스턴스의 스프링 빈을 반환한다.

👉🏻 싱글톤 스코프 빈 테스트

📁 test/scope/SingletonTest

public class SingletonTest {
    @Test
    void singletonBeanFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SingletonBean.class);

        SingletonBean singletonBean1 = ac.getBean(SingletonBean.class);
        SingletonBean singletonBean2 = ac.getBean(SingletonBean.class);
        System.out.println("singletonBean1 = " + singletonBean1);
        System.out.println("singletonBean2 = " + singletonBean2);

        assertThat(singletonBean1).isSameAs(singletonBean2); // isSameAs(==비교)

        ac.close();
    }

    @Scope("singleton")
    static class SingletonBean {
        @PostConstruct
        public void init() {
            System.out.println("SingletonBean.init");
        }

        @PreDestroy
        public void destroy() {
            System.out.println("SingletonBean.destroy");
        }
    }
}

• 스프링 컨테이너 생성 시점에 빈 초기화 메소드 실행 
• 같은 인스턴스의 빈을 조회
• 종료 메소드까지 정상 호출된 것을 확인할 수 있다.

 

프로토타입 스코프

• 프로토타입 스코프 빈을 스프링 컨테이너에 조회하면 항상 새로운 인스턴스를 생성하여 의존관계 주입 후 반환한 뒤 소멸시킨다.
  • 프로토타입 스코프의 빈을 스프링 컨테이너에 요청
  • 스프링 컨테이너는 이 시점에 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.
  • 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환하면 더이상 관리하지 않는다.
  • 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.
• 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 것이 핵심이다. 따라서 생성된 프로토타입 빈의 관리 책임은 클라이언트에게 있어 @PreDestory같은 종료 메서드가 호출되지 않는다. 

👉🏻 프로토타입 스코프 빈 테스트

📁 test/scope/PrototypeTest

public class PrototypeTest {
    @Test
    void prototypeBeanFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
        System.out.println("find protorypeBean1");
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        System.out.println("find protorypeBean2");
        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        System.out.println("prototypeBean1 = " + prototypeBean1);
        System.out.println("prototypeBean2 = " + prototypeBean2);

        assertThat(prototypeBean1).isNotSameAs(prototypeBean2);

        // 종료 메소드를 클라이언트가 직접 호출해야 함
        // prototypeBean1.destroy();
        // prototypeBean2.destroy();

        ac.close(); // 프로토 타입은 종료 메소드가 호출되지 않음
    }

    @Scope("prototype")
    static class PrototypeBean {
        @PostConstruct
        public void init() {
            System.out.println("SingletonBean.init");
        }

        @PreDestroy
        public void destroy() {
            System.out.println("SingletonBean.destroy");
        }
    }
}

• 스프링 컨테이너에서 빈을 조회할 때 프로토타입 스코프 빈이 생성되고, 초기화 메소드가 실행된다.
• 프로토타입 빈을 2번 조회한 결과 완전히 다른 스프링 빈이 생성되고, 초기화도 2번 실행된 것을 확인할 수 있다.
• 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입, 초기화까지만 관여하고 더이상 관리하지 않기 때문에
  스프링 컨테이너가 종료될때 @PreDestroy같은 종료 메소드가 전혀 실행되지 않는다.

 

💡 프로토타입 빈 특징 

• 스프링 컨테이너에 요청할 때 마다 새로운 객체의 빈이 생성된다.
• 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입, 초기화까지만 관여한다.
• 따라서 종료 메소드가 호출되지 않는다.
  • 종료 메소드를 호출해야하는 경우 클라이언트가 직접 호출해야한다.
  • ex) prototypeBean1.destroy();

 

 

싱글톤 스코프와 프로토타입 스코프을 함께 사용할 경우

스프링 컨테이너테 프로토타입 스코프 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해 반환해야 하지만, 싱글톤 빈과 함께 사용할 경우 의도한대로 동작하지 않아 주의해야 한다.

 

👉🏻 프로토타입 빈 단독 사용

📁 test/scope/SingletonWithPrototypeTest1

public class SingletonWithPrototypeTest1 {
    @Test
    void prototypeFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);
        
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        prototypeBean1.addCount();
        assertThat(prototypeBean1.getCount()).isEqualTo(1);

        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        prototypeBean2.addCount();
        assertThat(prototypeBean2.getCount()).isEqualTo(1);

    }

    @Scope("prototype")
    static class PrototypeBean {
        private int count = 0;

        public void addCount() {
            count++;
        }

        public int getCount() {
            return count;
        }

        @PostConstruct
        public void init() {
            System.out.println("PrototypeBean.init " + this); // this : 현재 나의 참조값을 출력
        }

        @PreDestroy
        public void destroy() {
            System.out.println("PrototypeBean.destroy");
        }
    }
}

• 클라이언트 A와 클라이언트 B가 각각 스프링 컨테이너에 프로토타입 빈을 요청한다
• 스프링 컨테이너는 요청마다 프로토타입 빈(x01, x02)을 새로 생성해서 반환한다.
• 이때 해당 빈의 count 필드 값은 0이다.
• 클라이언트가 조회한 프로토타입 빈에 addCount() 메소드를 호출해 count 필드가 1 증가한다.
• 결과적으로 프로토타입 빈(x01, x02) 각각의 count 값은 1이 된다.

 

하지만 싱글톤타입 빈과 프로토타입 빈을 함께 사용하는 경우 문제가 발생한다.

 

👉🏻 싱글톤 + 프로토타입 빈 함께 사용

📁 test/scope/SingletonWithPrototypeTest1

public class SingletonWithPrototypeTest1 {
    @Test
    void singletonClientUsePrototype() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);

        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int count1 = clientBean1.logic();
        assertThat(count1).isEqualTo(1);

        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        assertThat(count2).isEqualTo(2);
        
        System.out.println("clientBean1 = " + clientBean1);
        System.out.println("clientBean2 = " + clientBean2);
    }

    @Scope("singleton")
    static class ClientBean {
        private final PrototypeBean prototypeBean; // 생성시점에 prototypeBean을 생성해 주입

        @Autowired
        public ClientBean(PrototypeBean prototypeBean) {
            this.prototypeBean = prototypeBean;
        }

        public int logic() {
            prototypeBean.addCount();
            int count = prototypeBean.getCount();
            return count;
        }
    }

    @Scope("prototype")
    static class PrototypeBean {
        private int count = 0;

        public void addCount() {
            count++;
        }

        public int getCount() {
            return count;
        }

        @PostConstruct
        public void init() {
            System.out.println("PrototypeBean.init " + this); // this : 현재 나의 참조값을 출력
        }

        @PreDestroy
        public void destroy() {
            System.out.println("PrototypeBean.destroy");
        }
    }
}

• clienBean은 싱글톤이므로 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생한다.
  • clienBean은 의존관계 자동 주입을 사용하며, 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
  • 요청시점에 스프링 컨테이너는 프로토타입 빈을 생성해 clienBean에 반환한다. (이때 프로토타입 빈의 count 값은 0)
  • clienBean은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값 보관)
• 클라이언트 A,B는 clientBean을 스프링 컨테이너에 요청해서 받는다. clienBean은 싱글톤이기 때문에 같은 인스턴스가 반환된다.
  • 클라이언트 A가 logic() 메소드를 호출하면, clientBean은 프로토타입 빈의 addCount()를 호출해 count를 1 증가시킨다. (원래 count값이 0이었으므로, 1이 된다.)
  • 클라이언트 B가 logic() 메소드를 호출하면, clientBean은 프로토타입 빈의 addCount()를 호출해 count를 1 증가시킨다. (원래 count값이 1이었으므로, 2가 된다.)

스프링은 일반적으로 싱글톤 빈을 사용하므로 싱글톤 빈이 프로토타입 빈을 사용하게 된다.

이때 싱글톤 빈은 생성 시점에만 의존관계를 주입받기 때문에 프로토타입이 생성되긴 하지만, 싱글톤 빈과 함께 계속 유지되는 것이 문제점이다.

 

싱글톤 빈과 프로토타입 빈을 함께 사용할때, 사용할때 마다 항상 새로운 프로토타입 빈을 생성하도록 하는 3가지 방법을 알아보자.

 

스프링 컨테이너 DL

@Scope("singleton")
static class ClientBean {
    private final ApplicationContext ac;
    
    // 컨테이너 의존관계 연결 = DL(의존관계 조회)
    @Autowired
    public ClientBean(ApplicationContext ac) {
        this.ac = ac;
    }

    public int logic() {
     	// 로직 호출시, 프로토타입 빈을 새로 생성
        PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
    }
}

• 싱글톤 빈이 프로토타입을 사용할 때마다 스프링 컨테이너에 새로 요청한다.
• 의도한 대로 logic() 호출시 ac.getBean()을 통해서 항상 새로운 프로토타입 빈이 생성된다.
• 각각의 다른 빈이 생성되었다가 소멸되어, count값이 1을 유지하는 것을 확인 할 수 있다.

이때 의존관계를 외부에서 주입(DI)받는게 아닌, 직접 필요한 의존관계를 찾는 것을 DL(Dependency Lookup, 의존관계 조회)이라 한다.

 

이 방법은 의도한대로 동작하긴 하지만 스프링 ApplicationContext 전체를 주입 받게 되면 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트가 어려워진다는 문제가 있다.

 

ObjectProvider

@Scope("singleton")
static class ClientBean {  
    private final ObjectProvider<PrototypeBean> prototypeBeanProvider;

    @Autowired
    public ClientBean(ObjectProvider<PrototypeBean> prototypeBeanProvider) {
        this.prototypeBeanProvider = prototypeBeanProvider;
    }

    public int logic() {
        PrototypeBean prototypeBean = prototypeBeanObjectProvider.getObject();
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
    }
}

• ObjectProvider는 스프링이 제공하는 기능으로, 지정한 빈을 컨테이너에서 대신 찾아주는 DL 기능만을 제공한다.
• getObject()를 호출하면 항상 새로운 프로토타입 빈이 생성되며, 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아 반환한다.(DL)

과거에는 ObjectFactory 가 있었는데, 편의 기능을 추가해서 ObjectProvider가 만들어졌다.
• ObjectFactory : 기능이 단순, 별도 라이브러리 필요 없음, 스프링에 의존
• ObjectProvider : ObjectFactory 상속, 옵션, 편의기능 다양, 별도 라이브러리 필요없음, 스프링에 의존

 

JSR-330 Provider

javax.inject.Provider 라는 JSR-330 자바 표준을 사용하는 방법으로, 사용하려면 관련 라이브러리를 gradle에 추가해줘야 한다.

implementation 'javax.inject:javax.inject:1'

@Scope("singleton")
static class ClientBean {
    private final Provider<PrototypeBean> provider;
    
    @Autowired
	public ClientBean(Provider<PrototypeBean> prototypeBeanProvider) {
        this.prototypeBeanProvider = prototypeBeanProvider;
    }
    
    public int logic() {
        PrototypeBean prototypeBean = provider.get();
        prototypeBean.addCount();
        int count = prototypeBean.getCount();
        return count;
    }   
}

• get()을 호출하면 항상 새로운 프로토타입 빈이 생성되며, 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환해준다. (DL)
• Provider는 자바 표준이며, 기능이 단순하므로 단위테스트를 만들거나 mock 코드를 만들기 쉽다.

💡 Provider 특징

• get() 메소드 하나로 기능이 매우 단순하다.
• 별도의 라이브러리가 필요하다.
• 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

 

정리

• 프로토타입 빈은 언제 사용할까?
  • 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요할 경우 사용하면 된다.
  • 하지만, 실무에서 웹 어플리케이션을 개발해보면 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 사용하는 일은 매우 드물다.
• ObjectProvider, JSR330 Provider 등은 프로토타입 뿐만 아니라 DL 기능이 필요한 경우는 언제든 사용 가능하다.
• 스프링이 제공하는 ObjectProvider, 자바 표준의 JSR330 Provider 둘 중 무엇을 사용해야 하나?
  • 대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에, 특별히 스프링이 아닌 다른 컨테이너를 사용할 일이 없다면 스프링이 제공하는 기능을 사용하면 된다.

 

 

웹 스코프

• 웹 스코프는 웹 환경에서만 동작한다.
• 웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메소드가 호출된다.

💡 종류 

• request : HTTP 요청 하나가 들어오고 나갈때 까지 유지되는 스코프,
                  각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다.
• session : HTTP Session과 동일한 생명주기를 가지는 스코프
• application : 서블릿 컨텍스트와 동일한 생명주기를 가지는 스코프
• websoket : 웹 소켓과 동일한 생명주기를 가지는 스코프

💡 request 스코프 빈 동작 방식

HTTP request 요청마다 각각 할당되는 request 스코프

모두 범위만 다르지 동작 방식은 비슷하기 때문에 request 스코프 예제를 통해 알아보도록 하겠다. 

 

request 스코프

웹 스코프는 웹 환경에서만 동작하므로 웹 관련 라이브러리를 추가해준다.

 

📁 build.gradle

implementation 'org.springframework.boot:spring-boot-starter-web'

라이브러리를 추가해준 뒤 CoreApplication의 main 메소드를 실행해보면, 내장된 톰캣 서버를 활용해 웹 어플리케이션이 실행된다.

스프링 부트는 웹 라이브러리가 없으면 AnnotationConfigApplicationContext를 기반으로 어플리케이션을 구동하고,
웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요해 AnnotationConfigServletWebServerApplicationContext를 기반으로 어플리케이션을 구동한다.

 

이때 만약 기본 포트 8080 포트를 다른 곳에서 사용중이라 오류가 발생하면 포트를 변경해준다.

📁 resources/application.properties

server.port=9090

 

동시에 여러 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다.

이럴때 사용하기 좋은 것이 바로 request 스코프다.

 

다음과 같이 로그가 남도록 request 스코프를 활용해 추가 기능을 개발해보도록 하자.

[d06b992f...] request scope bean create
[d06b992f...][http://localhost:8080/log-demo] controller test
[d06b992f...][http://localhost:8080/log-demo] service id = testId
[d06b992f...] request scope bean close

• 공통 포맷 : [UUID][reauestURL]{message}
  • UUID를 사용해 HTTP 요청 구분 → 같은 UUID = 같은 고객이구나!
  • reqeustURL를 넣어 어떤 URL을 요청해서 남은 로그인지 확인

📁 common/MyLogger

@Component
@Scope(value = "request")
public class MyLogger {
    private String uuid;
    private String requestURL;

    public void setRequestURL(String requestURL) {
        this.requestURL = requestURL;
    }

    public void log(String message) {
        System.out.println("[" + uuid + "]" + "[" + requestURL + "] " + message );
    }

    @PostConstruct
    public void init() {
        uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] request scope bean create : " + this );
    }

    @PreDestroy
    public void close() {
        System.out.println("[" + uuid + "] request scope bean close : " + this );
    }
}

• 로그를 출력하기 위한 MyLogger 클래스이다.
• @Scope(value = "request")를 사용해 request 스코프로 지정했기 때문에, 이 빈은 HTTP 요청당 하나씩 생성되고 HTTP 요청이 끝나는 시점에 소멸된다.
• 빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메소드를 사용해 uuid를 생성해서 저장한다. (uuid를 저장해 다른 HTTP 요청과 구분할 수 있다.)
• 빈이 소멸되는 시점에 @PreDestroy를 사용해서 종료 메세지를 남긴다.

 

📁 web/LogDemoController

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    private final LogDemoService logDemoService;
    private final MyLogger myLogger;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURL = request.getRequestURI().toString();
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logDemoService.logic("testId");

        return "OK";
    }
}

• 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러다.
• HttpServletRequest를 통해 요청 URL을 받는다.
  → requestURL 값 = http://localhost:8080/log-demo
• 받은 requestURL 값을 myLogger에 저장해둔다. 이때 myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이는 걱정은 하지 않아도 된다.
• 컨트롤러에서 controller test라는 로그를 남긴다.

 

📁 web/LogDemoService

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final MyLogger myLogger;

    public void logic(String id) {
        myLogger.log("service id = " + id);
    }
}

• 비즈니스 로직이 있는 서비스 계층에서도 로그를 출력한다.
• request scope의 MyLogger 덕분에 모든 정보를 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

 

👉🏻 실행 (오류 발생)

• 실행시 에러가 발생하면서 서버가 뜨지 않는다.
• 이유는 서버가 가동되면 스프링 컨테이너가 뜨고 의존관계 자동 주입을 수행하는데, 이때 request 스코프 빈인 myLogger가 아직 생성되지 않아 주입받지 못하고 에러가 발생한 것이다.
  
  • request 스코프 빈은 애플리케이션 실행 시점에 생성되지 않고 아닌 고객 요청이 와야 생성된다.
  • 따라서 스프링 컨테이너한테 request 스코프 빈을 요청하는 단계를 의존관계 주입 단계가 아닌 실제 고객 요청 시점으로 미뤄야 한다.

이러한 문제를 해결하는 방법으로 Povider와 Proxy가 있다.

 

ObjectProvider

👉🏻 코드

📁 web/LogDemoController

@Controller
@RequiredArgsConstructor
public class LogDemoController {
    private final LogDemoService logDemoService;
    private final ObjectProvider<MyLogger> myLoggerProvider;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURL = request.getRequestURI().toString();
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.setRequestURL(requestURL);

        myLogger.log("controller test");
        logDemoService.logic("testId");

        return "OK";
    }
}

📁 web/LogDemoService

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final ObjectProvider<MyLogger> myLoggerProvider;

    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.log("service id = " + id);
    }
}

• ObjectProvider를 사용해 ObjectProvide.getObject()를 호출하는 시점까지 request 스코프 빈의 생성을 지연할 수 있다.
• getObject()를 호출하는 시점에는 HTTP 요청이 진행중이기 때문에 request 스코프 빈의 생성이 정상 처리 된다.
• 이때 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.

 

👉🏻 실행 결과 (정상 동작)

로그를 보면 같은 요청일 경우 동일한 스프링 빈임을 확인 할 수 있다.

 

Proxy 

웹 스코프를 가지는 빈은 ProxyMode를 설정해줄 수 있는데, 이를 통해 초기 빈 등록 시점에 프록시(가짜) 클래스를 생성하여 주입해줘 진짜 클래스의 생성을 지연시켜줄 수 있다.

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {
	...
}

• 프록시 방식을 사용하기 위해 proxyMode = ScopedProxyMode.TARGET_CLASS 옵션를 추가해준다.
  • 적용 대상이 클래스면 TARGET_CLASS 선택
  • 적용 대상이 인터페이스면 INGERFACES 선택
• 이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입해 둘 수 있다.

 

👉🏻 코드

📁 common/MyLogger

@Component
@Scope(value = "request", proxyMode = ScopedProxyMode.TARGET_CLASS)
public class MyLogger {

    private String uuid;
    private String requestURL;

    public void setRequestURL(String requestURL) {
        this.requestURL = requestURL;
    }

    public void log(String message) {
        System.out.println("[" + uuid + "]" + "[" + requestURL + "] " + message );
    }

    @PostConstruct
    public void init() {
        uuid = UUID.randomUUID().toString();
        System.out.println("[" + uuid + "] request scope bean create : " + this );
    }

    @PreDestroy
    public void close() {
        System.out.println("[" + uuid + "] request scope bean close : " + this );
    }
}

📁 web/LogDemoController

@Controller
@RequiredArgsConstructor
public class LogDemoController {

    private final LogDemoService logDemoService;
    private final MyLogger myLogger;

    @RequestMapping("log-demo")
    @ResponseBody
    public String logDemo(HttpServletRequest request) {
        String requestURL = request.getRequestURI().toString();
        myLogger.setRequestURL(requestURL);

        System.out.println("myLogger = " + myLogger.getclass()); // 주입된 myLogger 확인용
        
        myLogger.log("controller test");
        logDemoService.logic("testId");

        return "OK";
    }
}

📁 web/LogDemoService

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider;

    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.log("service id = " + id);
    }
}

 

👉🏻 실행 결과

주입된 myLogger를 확인해보면 우리가 등록한 순수한 MyLogger 클래스가 아닌 MyLogger$$EnhancerBySpringCGLIB라는 클래스로 만들어진 가짜 객체(프록시 객체)가 대신 등록되어 주입받은 것을 확인할 수 있다.

 

💡 동작 원리

• CGLIB라는 라이브러리로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
• 이 가짜 프록시 객체는 실제 요청이 오면 그때 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
  • 클라이언트가 myLogger.logic()을 호출하면 사실 가짜 프록시 객체의 메소드를 호출한 것이다.
  • 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출하게 된다.
• 가짜 프록시 객체는 원본 클래스를 상속 받아 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 원본인지 아닌지도 모르게 동작할 수 있다.(다형성)
• 가짜 프록시 객체는 실제 request 스코프와는 관계가 없다. 그냥 가짜이며 내부에 단순한 위임 로직만 들어 있고, 싱글톤처럼 동작한다.
• 프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request 스코프 빈을 사용할 수 있게 된다.

 

정리

• Provider를 사용하든, Proxy를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.
• 단지 어노테이션 설정 변경만으로 원본 객체를 프록시 개체로 대체할 수 있다.
  → 이것이 다형성과 DI 컨테이너가 가진 큰 장점이다
• 프록시를 사용할 경우 마치 싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 주의해서 사용해야 한다.
• 특별한 스코프는 무분별하게 사용하면 유지보수하기 어렵기 때문에 꼭 필요한 곳에서만 최소화해서 사용해야 한다 !