[Spring] 빈 스코프

출처 :  김영한님의 스프링 핵심 원리 - 기본편 인프런 강의

스프링 핵심 원리 - 기본편 - 인프런 | 강의

 

빈 스코프란?

빈이 존재할 수 있는 범위로 이때까지의 스프링 빈은 싱글톤 스코프를 가진 스프링 컨테이너의 시작과 함께 생성되고 종료화 함께 소멸되었다.

• 싱글톤 스코프 : 기본 스코프로 생명주기가 스프링 컨테이너와 같은 가장 긴 스코프이다.
• 프로토타입 스코프 : 스프링 컨테이너가 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 신경 안쓰는 짧은 스코프
• 웹 관련 스코프
  • request : http 고객 요청이 오고 나서 최초 스프링 컨테이너를 호출할 때 생성이 돼서 애플리케이션이 동작하다가 고객의 요청이 response로 빠져나갈 때까지 유지
  • session : 웹 세션이 생성 - 종료 될때까지 유지
  • application : 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프

 

빈 스코프 지정 방법

• 컴포넌트 스캔 자동 등록

@Scope("prototype")
@Component
public class HelloBean {}

• 수동 등록

@Scope("prototype")
@Bean
PrototypeBean HelloBean() {
	return new HelloBean();
}

 

프로토타입 스코프

싱글톤 스코프의 빈은 싱글톤이기에 항상 같은 인스턴스의 스프링 빈을 반환하지만 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.

 

 

 

스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화 까지만 처리한다는 것이 핵심이다. 프로토 타입 빈을 반환한 이후로는 스프링 컨테이너는 손을 떼고 프로토타입 빈을 관리할 책임은 클라이언트에게 넘어간다. 그래서 @PreDestroy같은 스프링 컨테이너가 호출해주는 종료 메서드 자체가 아예 호출되지 않는다.

 

싱글톤 스코프의 빈

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);
        Assertions.assertThat(singletonBean1).isSameAs(singletonBean2);

        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");
        }
    }
}

여러번 호출해도 같은 객체를 반환해주고 종료시 소멸 메서드도 스프링 컨테이너가 잘 호출해준다.

 

 

프로토타입 스코프의 빈

public class PrototypeTest {

    @Test
    void prototypeBeanFind() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(PrototypeBean.class);

        System.out.println("find prototypeBean1");
        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        System.out.println("find prototypeBean2");
        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);
        System.out.println("prototypeBean1 = " + prototypeBean1);
        System.out.println("prototypeBean2 = " + prototypeBean2);

        assertThat(prototypeBean1).isNotSameAs(prototypeBean2);

        ac.close();
    }

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

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

• 프로토타입 조회 직전에 빈을 생성하고 초기화 메서드 실행
• 프로토타입 조회 시마다 다른 객체가 반환
• 2번 조회해서 2번 객체 생성하고 2번 초기화 실행
• 종료 시에 소멸 메서드가 호출X

 

프로토타입 스코프를 싱글톤 빈과 함께 사용하면 생기는 문제

싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받는 경우를 생각해보자

 

 

clientBean은 싱글톤이고 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토 타입 빈을 요청한다. 스프링 컨테이너는 프로토타입 빈을 생성 후 반환하면 clientBean은 프로토타입 빈의 참조값을 내부 필드에 보관하는 상황이다.

 

여기에서 만약 클라이언트 A가 clientBean을 스프링 컨테이너에 요청해서 받은 후 clientBean.logic()을 호출해서 clientBean이 프로토타입빈의 addCount()를 호출했다고 가정해보자

그럼 addCount()에 의해 count가 1로 증가했을 것이다. 

 

여기서 만약 클라이언트 B가 또 clientBean을 스프링 컨테이너에 요청해서 받은 후 clientBean.logic()을 호출하게 되면 어떻게 될까? 

 

clientBean은 싱글톤이니까 같은 객체를 받아올 것이고 그 객체 내부의 필드에 있는 프로토타입 빈도 같이 그대로 딸려올 것이다. 이미 과거에 주입이 끝난 빈이니까 클라이언트 B가 요청 시에도 주입되어 있는 프로토타입 빈이 호출되는 것이다! 그래서 이전의 count 값이 1에서 2로 증가된다.

 

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);
    }

    static class ClientBean {

        private final 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);
        }

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

싱글톤 빈은 생성 시점에만 의존관계 주입을 받아서 프로토타입 빈이 생성되기는 하지만 필드값으로 싱글톤 빈과 함께 계속 유지되는 것이 문제다.

 

이럴거면 싱글톤을 쓰지 굳이 프로토 타입 빈을 쓸 이유가 없지 않나?

프로토타입을 쓰는 이유가 사용할 때마다 새로 생성해서 사용하길 원해서 스코프로 지정하는 것이기 때문에 문제인 것이다.

 

 

Provider로 해결

 

가장 간단하고 무식한 방법은 싱글톤 빈이 프로토타입을 사용할 때마다 스프링 컨테이너에 새로 요청하는 것이다.

 

public int logic() {
    // logic 호출할 때마다 프로토타입 빈 생성
    PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
    
    prototypeBean.addCount();
    int count = prototypeBean.getCount();
    return count;
}

이렇게 하면 항상 새로운 프로토타입 빈이 생성되기는 하지만 의존관계를 외부에서 주입(DI)받는 것이 아닌 필요한 의존관계를 찾는 의존관계 조회(DL. Dependency Lookup)을 한다.

이렇게 스프링 애플리케이션 컨텍스트 전체를 주입받게 되면 스프링 컨테이너에 의존적이게 되고 단위 테스트도 어려워진다.

 

딱 DL만 해주는 기능이 필요한 상황이다.

 

ObjectFacory, ObjectProvider

지정한 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 정도의 기능만 제공하는 것이 바로 ObjectProvider이다. 

@Autowired
private ObjectProvider<PrototypeBean> prototypeBeanProvider;

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

 

이렇게 하면 ApplicationContext에서 직접 찾는 것이 아니라 prototypeBeanProvider가 DL 기능으로 대신 찾아준다. 실행해보면 항상 새로운 프로토타입 빈이 생성되는 것을 볼 수 있다.

 

ObjectProvider의 getObject()를 호출하면 내부에서는 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. ObjectProvider는 따로 스프링 빈으로 등록하지 않아도 스프링이 자동으로 생성해서 주입해주기 때문에 스프링의 기능이지만 단순해서 단위테스트나 mock 코드를 만들기 쉽다.

 

• ObjectFactory: 기능이 단순, 별도의 라이브러리 필요 X, 스프링에 의존
• ObjectProvider: ObjectFactory 상속 + 부가기능

 

 

JSR-330 Provider 

javax.inject.Provider라는 자바 표준을 사용해서 스프링에 의존하지 않고도 프로토타입을 DL해줄 수 있는 기능이다.

 

1. build.gradle에 javax.inject:javax.inject:1 라이브러리 추가
2. Provider 적용

@Autowired
private Provider<PrototypeBean> provider;

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

provider.get()을 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환하는 DL 기능을 제공한다. 자바 표준이고 기능이 단순해서 단위 테스트나 mock 코드를 만들기 훨씬 쉽다. 또한 자바 표준이므로 스프링이 아닌 컨테이너에서도 사용 가능하지만 별도의 라이브러리가 필요하다.

 

ObjectProvider vs JSR-330 Provider

대부분 스프링이 더 다양하고 편리한 기능을 제공해주기 때문에 다른 컨테이너를 사용할 일이 없으면 스프링이 제공하는 기능을 사용하면 된다. 

• 스프링의 기능이 편하면 스프링 기능 사용(@Autowired)
• 기능이 비슷하고 스프링에서 표준 기능을 권장하면 표준 사용 (@PostConstruct, @PreDestroy)

 

프로토타입 빈은 언제 사용할까?

매번 사용할 때마다 의존관계 주입이 완료된 새로운 객체가 필요할 때 사용하는데 실제 실무에서는 거의 싱글톤 빈으로 대부분의 문제를 해결하기 때문에 사용이 드물다.

 

ObjectProvider, JSR330 Provider 등은 프로토타입 뿐만 아니라 DL 기능이 필요한 경우에 언제든지 사용 가능하다.

 

 

Provider 사용처

• lazy or optional retrieval of an instance : 지연 or optional하게 가져올 때
• breaking circular depnedencies : 순환 의존 관계. A와 B가 서로 의존해서 순환 참조가 일어날 때
• retrieving multiple instance : 프로토타입 필요시
• ...

 

웹 스코프

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

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

 

request 스코프

요청이 들어오면 그 요청 전용의 request 관련 빈 객체를 생성해주고 만약 서비스 로직에서 또 이 객체를 조회하면 이미 만들어진 객체를 반환해준다. 

 

프로토타입은 요청될 때마다 생성되었다면 request 스코프는 HTTP request의 요처이 들어오고 나갈때까지 같은 객체로 관리된다.

 

request 로그 예제

동시에 여러 HTTP 요청이 들어왔을 시 어떤 요청이 남긴 로그인지 구분하기 위한 예제를 만들어보자

 

먼저 build.gradle web 라이브러리 추가해준다. 웹 라이브러리가 없으면 지금까지 사용한 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동하고 웹 라이브러리가 추가되면 

AnnotationConfigServletWebServerApplicationContext를 기반으로 구동된다.

 

 

만들고 싶은 것은 다음 로그 형태이다.

[UUID 유니크 아이디][requestURL][message]

 

1. 로그를 출력하기 위한 MyLogger 클래스 작성

import java.util.UUID;

@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);
    }
}

 

스코프는 request 스코프로 지정했다. 이 빈이 생성되는 시점에 @PostConstruct로 UUID를 생성해서 저장해둔다. 이 빈은 HTTP 요청 당 하나씩 전용으로 생성되므로 UUID로 다른 HTTP 요청과 구분할 수 있다.

 

request는 종료시까지 스프링에서 관리해주기 때문에 @PreDestory를 사용해 종료 메시지를 남긴다.

requestURL은 빈이 생성되는 시점에는 알 수 없으므로 외부에서 setter로 입력받는다.

 

 

2. 로거가 잘 작동하는지 확인하는 테스트용 컨트롤러 작성

• requestURL 값 : http://localhost:8080/log-demo
• 받은 requestURL을 myLogger에 저장 후 컨트롤러에서 controller test라는 로그 남기기
• myLogger는 request 스코프라서 각각 구분되므로 섞일 걱정 X

 

3. 비즈니스 로직이 있는 서비스 계층에서 로그 출력해보기

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final MyLogger myLogger;
    
    public void logic(String id) {
        myLogger.log("service id = " + id);
    }
}

여기서 request 스코프를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘기면 파라미터가 많아서 더러워지고, 웹과 관련된 정보가 상관없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 하고 서비스 계층은 웹 기술에 종속되지 않도록 순수하게 유지하는 것이 좋다. 

 

request 스코프의 MyLogger 덕분에 더럽게 파라미터 안넘기고 MyLogger의 멤버 변수에 저장해서 깔끔하게 유지할 수 있다.

 

실행을 해보면 우리가 기대했던 출력이 아닌 오류가 생긴다.

Error creating bean with name 'myLogger': Scope 'request' is not active for the
current thread; consider defining a scoped proxy for this bean if you intend to
refer to it from a singleton;

스프링 애플리케이션을 실행하는 시점에 싱글톤 빈은 생성해서 주입이 가능하지만 request 스코프 빈은 고객의 요청이 와야지 실행된다. 

 

스프링 컨테이너가 뜰 때 @Controller를 스프링 빈으로 등록해야 하는데 그 때 의존관게 주입이 일어난다. 의존관계 주입을 위해 스프링 컨테이너에서 myLogger를 찾아야 하는데 myLogger의 스코프가 request라서 요청이 없기 때문에 생존 범위가 아니라서 에러가 발생하는 것이다.

 

그럼 의존관계 주입 단계를 실제 고객의 요청이 올 때까지 지연시키면 되는데 이 때 배웠던 Provider를 사용하면 된다.

 

스코프와 Provider

1. Provider

@Service
@RequiredArgsConstructor
public class LogDemoService {
    private final ObjectProvider<MyLogger> myLoggerProvider;
    
    public void logic(String id) {
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.log("service id = " + id);
    }
}

이제 main() 메서드로 스프링을 실행하고 http://localhost:8080/log-demo에 접속하면 잘 작동되는 것을 볼 수 있다.

• ObjectProvider 덕분에 getObject()로 호출하는 시점까지 request scope 빈의 생성을 지연 가능
• getObject를 호출하는 시점에는 HTTP 요청이 진행중이므로 request scope 빈의 생성이 가능

 

 

스코프와 프록시

@Scope의 속성으로 프록시 모드를 적용해준다.

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

프록시 모드를 사용하면 CGLIB 바이트코드 조작 라이브러리를 이용해 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입해둘 수 있다.

 

프록시 모드를 적용한 상태에서 Provider를 사용 전으로 돌려주고 실행해보면 잘 작동하는 것을 볼 수 있다. 어떻게 가능한 걸까?

웹 스코프와 프록시 동작 원리

주입된 가짜 클래스 myLogger를 출력해보면 CGLIB 라이브러리로 바이트 코드가 조작된 가짜 프록시 객체가 출력되는 것을 볼 수 있다.

스프링 컨테이너에 "myLogger"라는 이름으로 진자 대신 이 가짜 프록시 객체를 등록한 것이다. 

 

getBean으로 타입 조회를 해봐도 프록시 객체가 조회되는 것을 볼 수 있다.

• 가짜 프록시 객체는 내부의 진짜 myLogger를 찾는 방법을 알고 있어서 요청이 오면 그 때 내부에서 진짜 빈을 요청한다. 
• 클라이언트가 logic()을 호출하면 가짜 프록시 객체의 메서드를 호출한 것이고, 가짜 프록시 객체는 request 스코프의 진짜 logic()을 호출한다.
• 가짜 프록시 객체는 원본 클래스를 상속받았기 때문에 클라이언트는 가짜인지 아닌지도 모르게 사용 가능하다. (다형성)
• 덕분에 마치 싱글톤 빈을 사용하듯 편리하게 request 스코프를 사용할 수 있다.
• Provider든 프록시든 핵심은 진짜 객체 조회를 지연 시키는 것