[Spring] 빈 스코프

1. 빈 스코프란?

스프링 컨테너가 만들어질 때 빈들도 함께 생성이된다. 그리고 생성된 빈들은 계속 작동이 되다가 스프링이 종료될 때 같이 소멸된다. 이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다. 스코프란 빈들이 존재할 수 있는 범위를 뜻하며 스프링은 아래와 같은 스코프를 지원한다.

• 싱글톤: 기본 스코프다. 스프링 컨테이너의 시작때 생성되며 스프링 종료까지 유지된다.
• 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 짧은 범위의 스코프다. (스프링 컨테이너가 관리하지 않기 때문에 종료 메서드는 호출되지 않는다.)
• 웹 관련
  • request: 웹 요청이 들어오고 나갈때 까지 유지된다.
  • session: 웹 세션이 생성되고 종료될 때까지 유지된다.
  • application: Servlet Context와 같은 범위로 유지되는 스코프다.

빈 스코프는 아래와 같이 지정할 수 있다.

// 자동 등록의 경우
@Scope("prototype")
@Component
public class Bean1 {}

// 수동 등록의 경우
@Scope("prototype")
@Bean
public Beantype Bean2 {
     return new Bean2();
}

2. 프로토타입 스코프

싱글톤 스코프의 빈은 조회시 항상 같은 인스턴스를 반환하지만 프로토타입 스코프를 가진 빈을 조회하면 항상 새로운 인스턴스를 생성해 반환한다. 자세히 말하자면 프로토타입 스코프 빈을 우리가 요청할 때만 스프링 컨테이너는 빈 생성 후 의존 관계 주입을 완료하여 빈을 봔환해준다. 단, 이후 해당 빈을 관리하지 않는다. 이때 중요한 점은 스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다는 점이다. 즉, 빈을 관리하지 않으므로 이후 @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);

        Assertions.assertThat(singletonBean1).isSameAs(singletonBean2);
        ac.close();
    }

    @Scope("singleton")
    static class SingletonBean{
        @PostConstruct
        public void init() {
            System.out.println("초기화 메서드");
        }

        @PreDestroy
        public void destroy() {
            System.out.println("소멸 메서드");
        }
    }
}

• SingletonBean에는 @Component 혹은 @Configuration이 붙지 않아도 AnnotationConfigApplicationContext() 생성자에 넘겨주면 알아서 @Component가 붙은것 처럼 처리하여 (자동으로 컴포넌트 스캔의 대상이 됨.) 해당 클래스에는 @Component를 붙여줄 필요가 없다.

위 테스트 코드는 singleton 타입의 테스트 결과로 초기화 메서드, 소멸 메서드가 모두 실행되고, 호출된 두 스프링 빈 모두 같은 객체인 것을 확인할 수 있다.

다음은 프로토타입의 테스트 결과를 확인해보자.

public class PrototypeTest {

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

        PrototypeBean prototypeBean1 = ac.getBean(PrototypeBean.class);
        PrototypeBean prototypeBean2 = ac.getBean(PrototypeBean.class);

        Assertions.assertThat(prototypeBean1).isNotSameAs(prototypeBean2);
        ac.close();
    }

    @Scope("prototype")
    static class PrototypeBean {
        @PostConstruct
        public void init() {
            System.out.println("초기화 메서드");
        }

        @PreDestroy
        public void destroy() {
            System.out.println("소멸 메서드");
        }
    }
}

위 코드에서 prototypeBean은 총 두 번 호출된다. 이때 호출마다 새로운 빈을 생성하고, 의존관계를 주입하고, 초기화를 진행하므로 init이 총 두 번 호출된다. 빈 반환 이후 스프링 컨테이너는 해당 빈을 관리하지 않기 때문에 destory()는 호출되지 않는다.

이와 같이 프로토타입 빈은 프로토타입을 조회한 클라이언트가 관리해야 하며 종료 메서드 호출 또한 클라이언트가 관리해야 한다. 

3. 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 문제점

프로토타입 스코프의 빈을 요청하면 새로운 인스턴스를 매번 생성하여 반환한다는 것을 알았다. 하지만 싱글톤 빈과 함께 사용하면 의도한대로 잘 동작하지 않는 점을 주의하자. 아래 상황은 일반적인 프로토타입 빈의 사용 상황이다.

• 클라이언트(A)가 프로토타입 빈을 요청한다.
• 스프링 컨테이너는 프로토타입 빈(X)을 생성하여 반환한다. 이때 해당 빈의 count 필드 값이 0이라 하자.
• 클라이언트가 조회한 프로토타입 빈의 count값을 1을 올린다. (X의 count 필드 값은 1이다.)
• 그리고 다른 클라이언트(B)가 스프링 컨테이너에 프로토타입 빈을 요청한다. 
• 컨테이너는 새로운 인스터스(Y)를 생성하여 반환한다. 해당 빈의 count 필드 값은 0이다.
• 해당 클라이언트가 count 필드 값을 1 올린다. (Y의 count 필드 값은 1이다.)

이번에는 싱글톤 빈(clientBean)에서 프로토타입 빈을 사용하는 예시를 살펴보자.

• clientBean은 싱글톤이다. 따라서 스프링 컨테이너 생성시 생성되고, 의존 관계 주입도 발생한다. 
• clientBean은 의존관계 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
• 스프링 컨테이너는 프로토타입 빈을 생성하여 clientBean에 반환한다. 프로토타입 빈의 count 필드는 0이다.
• 지금부터 clientBean은 프로토타입 빈을 내부 필드에 보관한다. 
• 클라이언트(A)가 clientBean을 요청한다. 이후 clienBean의 프로토타입 빈 count값을 1 올린다. (프로토타입 빈의 count값은 1이 된다.)
• 또 다른 클라이언트(B)가 clientBean을 요청하고, count값을 올린다. 따라서 clientBean 내부 필드의 프로토타입 빈의 count값은 2가 된다. 

이는 프로토타입 빈은 스프링 컨테이너에서 요청을 받을 때마다 생성하는 것인데 처음 주입 받을 때 주입되어 계속 같은 인스턴스로 유지되기 때문에 발생한 문제다. 이를 해결하기 위해서 Provider를 사용할 수 있다. (위와 같이 동작할 거면 싱글톤을 쓰지 프로토타입 빈을 사용할 이유가 없다.)

• 서로 다른 싱글톤 스코프의 스프링 빈에서 자동 주입으로 같은 프로토타입 빈을 요청한다면 각각 다른 인스턴스로 들어간다. 단, 위에서 봤던 것처럼 사용할 때마다 새로 생성되는 것은 아니다.

4. 프로토타입 스코프 - 싱글톤 빈과 함께 사용시 Provider로 문제 해결

위에서 봤던 문제를 해결하기 위한 첫번째 방법은 그냥 프로토타입을 사용할 때마다 스프링 컨테이너에 새로 요청하는 것이다. 예시 코드는 아래와 같다.

@Scope("singleton")
    static class ClientBean {
        
        @Autowired
        private ApplicationContext ac;

        public int logic() {
            // 1을 올리는 로직 수행할 때마다 프로토타입 생성
            PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
            prototypeBean.addCount();
            int count = prototypeBean.getCount();
            return count;
        }
    }

• 이와 같이 의존관계를 외부에서 주입(DI)받는 것이 아니라 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL, 의존관계 탐색)이라고 부른다.

하지만 위와 같이 스프링의 ApplicationContext 전체를 주입받으면 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다. 현재 필요한 것은 지정한 프로토타입 빈을 컨테이너에서 찾아주는 DL 정도의 기능만 필요하다. 스프링은 이를 위한 어노테이션을 제공한다. 

 

이를 위해 스프링은 ObjectFactory와 ObjectProvider를 제공한다. ObjectProvider는 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공하며 과거에는 ObjectFactory를 사용했다. ObjectFactory에 편의 기능을 추가한 것이 ObjectProvider이다. 간단한 예시 코드는 아래와 같다.

public class SingletonWithPrototypeTest {

    @Test
    void singletonClientUsePrototype() {
        AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(ClientBean.class, PrototypeBean.class);
        
        // 클라이언트1이 값을 1올리면 프로토타입 빈의 count값은 1이됨.
        ClientBean clientBean1 = ac.getBean(ClientBean.class);
        int count1 = clientBean1.logic();
        Assertions.assertThat(count1).isEqualTo(1);
        
        // 클라이언트2이 값을 1올리면 해당 프로토타입 빈은 새로운 빈이므로 count값은 1이다.
        ClientBean clientBean2 = ac.getBean(ClientBean.class);
        int count2 = clientBean2.logic();
        Assertions.assertThat(count2).isEqualTo(1);
    }

    @Scope("singleton")
    static class ClientBean {

        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;

        public int logic() {
            // ObjectProvider를 통해 프로토타입 빈을 컨테이너에서 가져온다. 즉, 새로 생성한다.
            PrototypeBean prototypeBean = prototypeBeanProvider.getObject();
            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("프로토타입 초기화 메서드: "+this);
        }

        @PreDestroy
        public void destroy() {
            System.out.println("프로토타입 소멸 메서드: "+this);
        }
    }
}

• ObjectProvider는 getObject()를 호출하면 스프링 컨테이너에서 프로토타입 빈을 찾아서 반환해준다. ObjectProvider는 스프링 컨테이너를 통해 뭔가 찾아주는 과정을 간단하게 도와주는 것으로 생각하면 된다. 프로토타입 전용은 아니다. 핵심은 스프링 컨테이너에 직접 조회하는 것보다 ObjectProvider가 대신 조회해주는 대리자 역할을 한다는 점이다.
• ObjectProvider는 딱 DL정도의 기능만 제공한다.

ObjectFactory와 ObjectProvider는 아래와 같은 특징을 가진다.

• ObjectFactory: 기능이 단순하며 별도의 라이브러리가 필요하지 않다. 스프링에 의존한다.
• ObjectProvider: ObjectFactory를 상속받는다. 옵션, 스트림 처리 등 편의 기능이 많다. 별도의 라이브러리가 필요하지 않고 스프링에 의존한다.

위와 같이 두 친구들 모두 스프링에 의존한다는 문제를 가진다. 따라서 스프링에 의존하는 새로운 방법인 JSR-330 Provider가 나온다. 이 방법은 javax.inject.Provider라는 자바 표준을 사용하기 때문에 "javax.inject:javax.inject:1"라이브러리를 gradle에 추가해야 한다. build.gradle의 dependencies에 아래 줄을 포함시키면 된다.

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

사용법은 ObjectProvider와 거의 동일한데, getObject()메서드 대신 get() 메서드를 사용하면 된다.

@Scope("singleton")
static class ClientBean {

    @Autowired
    private Provider<PrototypeBean> prototypeBeanProvider;

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

Provider의 특징은 다음과 같다.

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

굳이 다른 컨테이너를 사용할 필요가 없는 경우 ObjectProvider를 사용하면 된다.

5. 웹 스코프

웹 스코프의 특징은 다음과 같다.

• 웹 스코프는 웹 환경에서만 동작한다. 단, 프로토타입과 다르게 스프링이 해당 스코프의 종료 시점까지 관리한다. 따라서 종료 메서드도 호출 된다.
• request: HTTP 요청 하나가 들어오고 나갈 때까지 유지되는 스코프다. 각각의 HTTP 요청마다 별도의 빈 인스턴스가 생성되고 관리된다. 만약 client A와 B가 동시에 HTTP 요청을 보낸다면 controller는 A와 B에 다른 인스턴스를 할당한다. 왜냐하면 client A와 B의 request 각각에 맞춰 각각 다른 스프링 빈이 생성되어 사용되기 때문이다. 만약 client A가  
• session: HTTP Session과 동일한 생명주기를 가진다.
• application: ServletContext와 동일한 생명주기를 가진다.
• websocket: 웹 소켓과 동일한 생명주기를 가진다. 

각각은 생명 주기만 다를 뿐이지 동작방식은 비슷하다.

6. request 스코프 예제 + 스코프와 Provider

웹 스코프는 웹 환경에서만 동작하므로 뭔 아래 내용을 build.gradle의 dependencies 부분에 추가하자.

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

이때 @SpringBootApplication인 스프링 부트 실행 코드를 실행시키고 "localhost:8080"을 접속했을 때 아래와 같이 오류 페이지가 발생하면 설정에 성공한 것이다.

• spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용하여 웹 서버와 스프링을 함께 실행시킨다. 
• 웹 라이브러리가 없으면 "AnnotationConfigApplicationContext"를 기반으로 어플리케이션을 작동시킨다. 단, 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경이 필요하여 "AnnotationConfigServletWebServerAppliationContext"를 기반으로 어플리케이션을 구동한다.
• 만약 8080포트말고 다른 포트를 사용하고 싶다면 main/resources/application.properties 파일을 만들고 server.port=9000과 같이 작성해주면 된다.

우리가 웹을 운영하면 동시에 여러 HTTP 요청이 오게된다. 이때 정확히 어떤 요청이 남긴 로그인지 판단하기 어려운데 이런 경우 request 스코프를 사용하면 좋다. 이번 장에서는 각 요청의 로그를 아래 형태로 남기는 작업을 해보자.

• [UUID] [requestURL] [message] (단, UUID는 요청을 구분할 수 있는 ID다.)

아래는 예시 코드다.

@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("["+this.uuid+"] ["+this.requestURL+"] : "+message);
    }

    @PostConstruct
    public void init() {
        this.uuid = UUID.randomUUID().toString(); //UUID.randomUUID().toString() = 랜덤한 ID 하나가 생성됨.
        System.out.println("["+this.uuid+"]: request scope bean create: "+this);
    }

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

• 위에서 생성한 uuid는 각 요청당 하나씩 생기므로 다른 HTTP 요청과 구분할 수 있다.

그리고 아래 LogDemoService는 logic()이라는 하나의 로그를 출력하는 메서드를 가진 클래스다.

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

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

• 단, requestURL을 MyLogger에 저장하는 부분은 컨트롤러 보다는 공통 처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화 하기 위해 위와 같이 처리한 것이다.

그리고 총 로그를 관리하는 컨트롤러의 코드는 아래와 같다.

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

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

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

        return "OK";
    }
}

• 만약 위처럼 ObjectProvider를 사용하지 않는다면 컨트롤러가 생성될 수 없다. 왜냐하면 ObjectProvider를 사용하지 않느다면 컨트롤러(LogDemoController)가 만들어질 때 MyLogger를 주입 받아야 한다. 하지만 해당 빈은 http 요청이 발생해야만 생기기 때문에 해당하는 빈은 없는 상태라 에러가 발생한다. 즉, "localhost:8080/log-Demo"요청을 받을 때 MyLogger의 빈이 생성되고, 이 생성된 빈을 getObject()를 통해 가져와야 한다.

스프링 부트를 실행시키면 해당 url 요청시 아래와 같이 로그가 정상적으로 발생하는 것을 확인할 수 있다.

9. 스코프와 프록시

프록시는 아래와 같이 "proxyMode=scopedProxyMode.TARGET_CLASS"를 통해 사용할 수 있다.

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

• 적용 대상이 클래스면 TARGET_CLASS를 추가한다.
• 적용 대상이 인터페이스면 INTERFACES를 선택한다.
• 위와 같이 적용하면 MyLogger의 가짜 프록시 클래스를 만들고, Http request에 상관없이 가짜 프록시 클래스를 다른 빈에 미리 주입한다. 그리고 실제 MyLogger의 어떠한 기능을 호출하는 시점에 Provider가 동작하는 것처 진짜를 찾아서 동작한다. 

위와 같이 프록시를 사용하면 이전처럼 ObjectProvider를 사용하지 않아도 된다. 즉, 아래와 같이 사용할 수 있다.

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

    ...
}

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

    ...
}

• 스프링 컨테이너는 CGLIB라는 바이트 코드 조작 라이브러리를 사용하여 MyLogger를 상속받은 가짜 프록시 객체를 생성한다. 그리고 스프링 컨테이너에 myLogger라는 이름으로 진짜 대신에 가짜 프록시 객체를 등록한다. 그래서 만약 'ac.getBean("myLogger", MyLogger.class)'로 조회해도 프록시 객체가 조회된다. 어쨋든 의존관계 주입시 이 가짜 프록시 객체가 주입되는 것을 기억하자.
• 가짜 프록시 객체는 요청이 오면 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다. 즉, 프록시 빈은 내부에 실제 MyLogger를 찾는 방법을 가지고 있다. 클라이언트는 myLogger.logic()과 같이 메소드를 호출하면 프록시 객체의 메서드가 호출된다. 이때 프록시 객체는 진짜 myLogger을 찾아서 myLogger.logic()을 호출해준다. 
• 어쨋든 Provider든 프록시든 핵심은 "진짜 객체 조회를 꼭 필요한 시점까지 지연하다가 처리한다는 점이다."
• 프록시는 웹 스코프가 아니어도 사요알 수 있다. 단, 싱글톤을 사용하는 것 같이 동작하지만 다르게 동작하는 점을 주의하자. 또한 특별한 scope는 꼭 필용한 곳에만 사용하자. 

---

출처: https://www.inflearn.com/course/%EC%8A%A4%ED%94%84%EB%A7%81-%ED%95%B5%EC%8B%AC-%EC%9B%90%EB%A6%AC-%EA%B8%B0%EB%B3%B8%ED%8E%B8