[Spring] 빈(Bean) 스코프(scope)

728x90

▒ 빈 스코프 (Bean scope)

빈 스코프란, 빈이 존재할 수 있는 범위를 뜻한다.
스프링 빈은 스프링 컨테이너와 생성되고 스프링 컨테이너가 종료될 때 같이 소멸한다.
스프링 빈은 기본적으로 싱글톤 스코프로 생성되기 때문이다.

🔍 스프링이 지원하는 다양한 스코프

싱글톤
- 기본 스코프. 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프다.
프로토타입
- 스프링 컨테어는 프로토 타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프다.
웹 관련 스코프
- request
  - 웹 요청이 들어오고 나갈때 까지 유지되는 스코프다.
  - 고객의 요청이 들어와서 최초 스프링 컨테이너를 호출할 때 생성이 된고 고객의 요청이 나갈 때 소멸된다.
- session
  - 웹 세션이 생성되고 종료될 때까지 유지되는 스코프다.
  - 로그인 부분에서 많이 쓰인다.
- application
  - 웹의 서블릿 컨텍스와 같은 범위로 유지되는 스코프다.

🔍 빈 스코프 등록 방법

✔ 빈 자동 등록인 경우

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

@Component 위에 적는다.

✔ 빈 수동 등록인 경우

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

@Bean 위에 적는다.

🔍 싱글톤 스코프

싱글톤 스코프의 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다.

package hello.core.scope;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import static org.assertj.core.api.Assertions.*;

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

        ac.close();
    }

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

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

}

SingletonBean.init
singletonBean1 = hello.core.scope.SingletonTest$SingletonBean@75d2da2d
singletonBean2 = hello.core.scope.SingletonTest$SingletonBean@75d2da2d
19:11:57.653 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@49912c99, started on Mon Jan 31 19:11:57 KST 2022
SingletonBean.destory

싱글톤은 항상 같은 인스턴스를 반환한다.
@Scope("singletone") 는 기본 값이므로 생략할 수 있다.

🔍 프로토타입 스코프

프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다.
스프링 컨테아너에 요청할 때 마다 새로 생성된다.
스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입 그리고 초기화까지만 관여한다.
종료 메서드가 호출되지 않는다.
프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야한다. 종료 메서드에 대한 호출도 클라이언트가 직접 해야한다.

① 프로토타입 스코프의 빈을 스프링 컨테이너에 요청한다.

② 스프링 컨테이너는 이 시점에서 프로토타입 빈을 생성하고, 필요한 의존관계를 주입한다.

③ 스프링 컨테이너는 생성한 프로토타입 빈을 클라이언트에 반환한다.

④ 이후에 스프링 컨테이너에 같은 요청이 오면 항상 새로운 프로토타입 빈을 생성해서 반환한다.

package hello.core.scope;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import static org.assertj.core.api.Assertions.*;

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("prototypeBean2 = " + prototypeBean2);
        System.out.println("prototypeBean1 = " + prototypeBean1);

        assertThat(prototypeBean1).isNotSameAs(prototypeBean2);

//        prototypeBean1.destory();  // 만약에 프로토타입 빈을 직접 종료시켜야 할 때
//        prototypeBean2.destory();  // 만약에 프로토타입 빈을 직접 종료시켜야 할 때

        ac.close();
    }

    @Scope("prototype")
    static class PrototypeBean {

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

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

find prototypeBean1
PrototypeBean.init
find prototypeBean2
PrototypeBean.init
prototypeBean2 = hello.core.scope.PrototypeTest$PrototypeBean@75d2da2d
prototypeBean1 = hello.core.scope.PrototypeTest$PrototypeBean@4278284b
19:23:10.412 [main] DEBUG org.springframework.context.annotation.AnnotationConfigApplicationContext - Closing org.springframework.context.annotation.AnnotationConfigApplicationContext@49912c99, started on Mon Jan 31 19:23:09 KST 2022

AnnotationConfigApplicationContext 생성자에 클래스를 파라미터로 넘길경우 해당 클래스는 자동으로 @Component가 붙으면서 자동 빈 등록이 된다. 그래서 @Component 생략 가능
싱글톤 빈은 스프링 컨테이너 생성 시점에 초기화 메서드가 실행 되지만, 프로토타입 스코프의 빈은 스프링 컨테이너에서 빈을 조회할 때 생성되고 초기화 메서드도 실행된다.
프로토타입 빈을 2번 조회했는데 서로 다른 스프링 빈이 생성 및 반환되었고, 초기화도 2번 실행된 것을 알 수 있다.
싱글톤 빈은 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행되지만, 프로토타입 빈은 스프링 컨테이너가 생성과 의존관계 주입 그리고 초기화까지만 관여하고, 더는 관리하지 않는다.
따라서 프로토타입 빈은 스프링 컨테이너가 종료될 때 @PreDestory 같은 종료 메서드가 실행되지 않는다.

💡 정리

스프링 컨테이너는 프로토타입 빈을 생성하고, 의존관계 주입, 초기화까지만 처리한다.
스프링 컨테이너는 클라이언트에 반환한 빈을 더 이상 관리하지 않는다.
프로토타입 빈을 받은 클라이언트가 프로토타입 빈을 관리한다.
그래서 @PreDestory 같은 종료 메서드가 호출되지 않는다.

🔍 프로토타입 스코프의 빈과 싱글톤 빈을 함께 사용시 문제점

스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 인스턴스를 생성해서 반환한다.
하지만 싱글톤 빈과 함께 사용할 때는 프로토타입 스코프의 빈이 싱글톤 빈의 생성자 주입에 포함이 되어서 새로운 인스턴스를 반환해서 쓰는게 아니라 기존 프로토 타입 빈을 그대로 사용되어 질 수가 있다.

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

package hello.core.scope;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import static org.assertj.core.api.Assertions.*;

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

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

    }
}

프로토 타입 빈은 빈 조회시 새로운 객체가 반환되기 때문에 prototypeBean1과 prototypeBean2은 서로 다른 빈이다.

💡 싱글톤 빈에서 프로토타입 빈 사용

clientBean은 싱글톤이므로 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 같이 발생한다.
① clientBean은 의존관계 자동 주입을 사용한다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청한다.
② 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환한다. 프로토타입 빈의 count필드 값은 0이다.
clientBean은 프로토타입 빈을 내부 필드에 보관한다. (정확히는 참조값을 보관한다.)

클라이언트A는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.
③ 클라이언트A는 clientBean.logic() 메서드를 호출한다.
④ clientBean은 prototypeBean의 addCount() 메서드를 호출해서 프로토타입 빈의 couint를 증가시킨다.
count값이 1이 된다.

클라이언트B는 clientBean을 스프링 컨테이너에 요청해서 받는다. 싱글톤이므로 항상 같은 clientBean이 반환된다.
clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈이다. 주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성된 것이지, 사용할 때마다 새로 생성되는 것이 아니다.
⑤ 클라이언트B는 clientBean.logic() 메서드를 호출한다.
⑥ clientBean은 prototypeBean의 addCount() 메서드를 호출해서 프로토타입 빈의 count를 증가한다.
원래 count값이 1 이었는데 2로 증가한다.

package hello.core.scope;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import static org.assertj.core.api.Assertions.*;

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

    }

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

    }

    @Scope("singleton")
    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");
        }

    }
}

스프링은 일반적으로 싱글톤 빈을 사용하므로, 싱글톤 빈이 프로토타입 빈을 사용하게 된다. 근데 싱글톤 빈은 생성 시점에만 의존관계 주입을 받기 때문에 프로토타입 빈이 새로 생성되기는 하지만, 싱글톤과 함께 유지되는 것이 문제다.
프로토타입 빈을 사용할 때는 주입 시점에만 새로 생성되는 것이 아니라 사용할 때 마다 새로 생성해서 사용하는 것을 원할 것이다.

✔ 대안 1

package hello.core.scope;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import static org.assertj.core.api.Assertions.*;

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

    }

    @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(1);

    }

    @Scope("singleton")
    static class ClientBean {

        @Autowired
        private ApplicationContext ac;

        public int logic() {
            PrototypeBean prototypeBean = ac.getBean(PrototypeBean.class);
            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");
        }

    }
}

logic() 메서드의 ac.getBean() 메서드를 통해서 항상 새로운 프로토타입 빈을 반환 받는다.
의존관계를 외부에서 주입(DI) 받는게 아니라 이렇게 직접 필요한 의존관계를 찾는 것을 Dependency Lookup(DL) 의존관계 조회(탐색)라고 한다.
이렇게 스프링의 애플리케이션 컨텍스트 전체를 주입받게 되면, 스프링 컨테이너에 종속적인 코드가 되고, 단위 테스트도 어려워진다.
결국 이 방법은 좋은 방법이 아니다. 프로토타입 빈을 컨테이너에서 대신 찾아주는 DL 정도의 기능만 제공하는 무엇가가 필요하다.

✔ 대안 2

package hello.core.scope;

import org.assertj.core.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;

import static org.assertj.core.api.Assertions.*;

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

    }

    @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(1);

    }

    @Scope("singleton")
    static class ClientBean {

        @Autowired
        private ObjectProvider<PrototypeBean> prototypeBeanProvider;

        public int logic() {
            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("PrototypeBean.init " + this);
        }

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

    }
}

ObjectProvider<T> 인터페이스는 지정한 빈을 컨테이너에서 대신 찾아주는 DL 서비스를 제공한다.
prototypeBeanProvider.getObject() 메서드를 통해서 항상 새로운 프로토타입 빈이 생성된다.
ObjectProvider 인터페이스의 getObject() 메서드를 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL 기능)
스프링이 제공하는 기능을 사용하지만, 기능이 단순하므로 단위 테스트를 만들거나 mock 코드를 만들기가 훨씬 쉬워졌다.
ObjectFactory<T> 인터페이스
- 기능이 단순(getObject() 메서드만 존재)
- 별도의 라이브러리가 필요 없다.
- 스프링에 의존적이다.
ObjectProvider<T> 인터페이스
- ObjectFactory<T> 인터페이스를 상속 받는다.
- 옵션, 스트림 처리 등 편의 기능이 많다.
- 별도의 라이브러리가 필요 없다.
- 스프링에 의존적이다.

✔ 대안 3

package hello.core.scope;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Scope;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import javax.inject.Provider;

import static org.assertj.core.api.Assertions.*;

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

    }

    @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(1);

    }

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

    }

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

    }
}

javax.inject.Provider라는 JSR-330 자바 표준을 사용한다.
이 방법을 사용하려면 javax.inject:javax..inject:1 라이브러리를 gradle에 추가해야한다.
Provider<T> 인터페이스는 get() 메서드 하나만 지원한다.
get() 메서드를 호출하면 내부에서 스프링 컨테이너를 통해 해당 빈을 찾아서 반환한다. (DL)
자바 표준이고, 기능이 단순하므로 단위 테스트를 만들거나 mock 코드를 만들기 쉽다.
Provider<T> 인터페이스
- get() 메서드 하나로 기능이 매우 단순하다.
- 별도의 라이브러리가 필요하다.
- 자바 표준이므로 스프링이 아닌 다른 컨테이너에서도 사용할 수 있다.

💡 정리

프로토타입 빈은 매번 사용할 때 마다 의존관계 주입이 완료된 새로운 객체가 필요하면 사용하면 된다.
그런데 실무에서 웹 애플리케이션을 개발해보면, 싱글톤 빈으로 대부분의 문제를 해결할 수 있기 때문에 프로토타입 빈을 직접적으로 사용하는 일은 매우 드물다.
ObjectProvider, JSR330 Provider 등은 프로토타입 뿐만 아니라 DL이 필요한 경우 언제든지 사용할 수 있다.
스프링이 제공하는 메서드에 @Lookup 애노테이션을 사용하는 방법도 있지만, 앞서 말한 방법들로도 충분하고 고려해야할 상황이 많아서 잘 안쓰인다.
스프링을 사용하다 보면 자바 표준과 스프링이 제공하는 기능이 겹칠때가 많다. 대부분 스프링이 더 다양하고 편리한 기능을 제공하기 때문에 특별히 다른 컨테이너를 사용할 일이 없다면 스프링이 제공하는 기능을 사용하면 된다.

🔍 웹 스코프

웹 스코프는 웹 환경에서만 동작한다.
- build.gradle 파일에 implementation 'org.springframework.boot:spring-boot-starter-web' 를 추가해야한다.
- 라이브러리를 추가 후 스프링 부트의 CoreApplication 클래스의 main 메서드를 실행하면 웹 애플리케이션이 실행된다.
- 참고로 spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.
- 스프링 부트는 웹 라이브러리가 없으면 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동한다.
- 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext를 기반으로 애플리케이션을 구동한다.
- 만약 기본 포트인 8080 포트를 다른곳에서 사용중이어서 오류가 발생하면 포트를 변경해야한다.
- 9090포트로 변경하는 방법
  - src/main/resources/application.properties 파일에서 server.port=9090 를 적어주면 된다.
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.

💡 웹 스코프 종류

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

💡 request 스코프

request 스코프는 HTTP request 요청 당 각각 할당된다.
동시에 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이럴 때 사용하기 좋은 것이 request 스코프다.
UUID를 사용해서 HHTP 요청을 구분할 수 있다.

예제

package hello.core.common;

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
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);
    }
}

MyLogger 클래스는 로그를 출력하기 위한 클래스다.
@Scope(value = "request")를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
- 정확히 빈 생성 시점은 스프링 컨테이너에 빈 조회할 때 생성된다.
빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 호출해서 uuid를 생성한 후 저장한다. 해당 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
참고로 UUID.randomUUID().toString() 메서드의 값은 전 세계에서 유니크한 값을 생성한다.
- 서로 다른 빈이 같은 값을 받을 확률이 거의 없다.
빈이 소멸되는 시점에 @PreDestroy를 사용해서 종료 메시지를 남긴다.
requestURL 필드 값은 빈이 생성되는 시점에는 알 수 없으므로 외부에서 setter 메서드로 입력 받는다.

🔍 웹 스코프

웹 스코프는 웹 환경에서만 동작한다.
- build.gradle 파일에 implementation 'org.springframework.boot:spring-boot-starter-web' 를 추가해야한다.
- 라이브러리를 추가 후 스프링 부트의 CoreApplication 클래스의 main 메서드를 실행하면 웹 애플리케이션이 실행된다.
- 참고로 spring-boot-starter-web 라이브러리를 추가하면 스프링 부트는 내장 톰켓 서버를 활용해서 웹 서버와 스프링을 함께 실행시킨다.
- 스프링 부트는 웹 라이브러리가 없으면 AnnotationConfigApplicationContext를 기반으로 애플리케이션을 구동한다.
- 웹 라이브러리가 추가되면 웹과 관련된 추가 설정과 환경들이 필요하므로 AnnotationConfigServletWebServerApplicationContext를 기반으로 애플리케이션을 구동한다.
- 만약 기본 포트인 8080 포트를 다른곳에서 사용중이어서 오류가 발생하면 포트를 변경해야한다.
- 9090포트로 변경하는 방법
  - src/main/resources/application.properties 파일에서 server.port=9090 를 적어주면 된다.
웹 스코프는 프로토타입과 다르게 스프링이 해당 스코프의 종료시점까지 관리한다. 따라서 종료 메서드가 호출된다.

💡 웹 스코프 종류

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

💡 request 스코프

request 스코프는 HTTP request 요청 당 각각 할당된다.
동시에 HTTP 요청이 오면 정확히 어떤 요청이 남긴 로그인지 구분하기 어렵다. 이럴 때 사용하기 좋은 것이 request 스코프다.
UUID를 사용해서 HHTP 요청을 구분할 수 있다.

예제

package hello.core.common;

import org.springframework.context.annotation.Scope;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
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);
    }
}

MyLogger 클래스는 로그를 출력하기 위한 클래스다.
@Scope(value = "request")를 사용해서 request 스코프로 지정했다. 이제 이 빈은 HTTP 요청 당 하나씩 생성되고, HTTP 요청이 끝나는 시점에 소멸된다.
- 정확히 빈 생성 시점은 스프링 컨테이너에 빈 조회할 때 생성된다.
빈이 생성되는 시점에 자동으로 @PostConstruct 초기화 메서드를 호출해서 uuid를 생성한 후 저장한다. 해당 빈은 HTTP 요청 당 하나씩 생성되므로, uuid를 저장해두면 다른 HTTP 요청과 구분할 수 있다.
참고로 UUID.randomUUID().toString() 메서드의 값은 전 세계에서 유니크한 값을 생성한다.
- 서로 다른 빈이 같은 값을 받을 확률이 거의 없다.
빈이 소멸되는 시점에 @PreDestroy를 사용해서 종료 메시지를 남긴다.
requestURL 필드 값은 빈이 생성되는 시점에는 알 수 없으므로 외부에서 setter 메서드로 입력 받는다.

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

@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.getRequestURL().toString();
        myLogger.setRequestURL(requestURL);

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


}

로거(logger)가 작동하는지 확인하는 테스트용 컨트롤러다.
HttpServletRequest를 통해서 요청 URL을 받았다.
- requestURL 값 : http://localhost:8080/log-demo
- 아이디, 비밀번호 등 데이터를 controller에 보내면 HttpServletRequest 객체 안에 데이터가 들어간다.
이렇게 받은 requestURL 값은 myLogger에 저장한다.
myLogger는 HTTP 요청 당 각각 구분되므로 다른 HTTP 요청 때문에 값이 섞이지 않는다.
컨트롤러에서 'controller test'라는 로그를 남긴다.
request.getRequestURL().toString() 를 통해서 어떤 url에서 요청했는지 알 수 있다.
requestURL 필드값을 MyLogger에 저장하는 부분은 컨트롤러보단 공통처리가 가능한 스프링 인터셉터나 서블릿 필터 같은 곳을 활용하는 것이 좋다. 여기서는 예제를 단순화하기 위해서 컨트롤러에 사용했다.

예제

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.web.context.annotation.RequestScope;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

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

비즈니스 로직이 있는 서비스 계층에서 로그를 출력할 수 있다.
request scope를 사용하지 않고 파라미터로 이 모든 정보를 서비스 계층에 넘긴다면, 파라미터가 많아서 지저분해진다. 더 문제는 requestURL 같은 웹과 관력된 정보가 웹과 관련없는 서비스 계층까지 넘어가게 된다. 웹과 관련된 부분은 컨트롤러까지만 사용해야 한다.
서비스 계층은 웹 기술에 종속되지 않고, 가급적 순수하게 유지하는 것이 유지보수 관에서 좋다.
request scope의 MyLogger 덕분에 이런 부분을 파라미터로 넘기지 않고, MyLogger의 멤버변수에 저장해서 코드와 계층을 깔끔하게 유지할 수 있다.

기대되는 출력

[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

기대와 다르게 애플리케이션 실행시 오류

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 스코프 빈은 아직 생성되지 않는다.
request 스코프 빈은 실제 고객의 요청이 와야 생성된다.
해결방법이 필요하다.

✔ 해결방안 1 : Provider 사용

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;

@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.getRequestURL().toString();
        MyLogger myLogger = myLoggerProvider.getObject();
        myLogger.setRequestURL(requestURL);

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

}

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.beans.factory.ObjectProvider;
import org.springframework.stereotype.Service;
import org.springframework.web.context.annotation.RequestScope;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final ObjectProvider<MyLogger> myLoggerProvider;

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

Provider로 해주었다.
main() 메서드로 스프링을 실행하고, 웹 브라우저에 http://localhost:8080/log-demo 주소를 입력하면 잘 작동한다.

[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

ObjectProvide 덕분에 ObjectProvider.getObject()를 호출하는 시점까지 request scope 빈의 생성을 지연할 수 있다.
- 빈의 생성을 지연한다는 것은 스프링 컨테이너의 요청을 지연시켜서 나중에 요청하게 만드는 것이다.
ObjectProvider.getObject() 메서드를 호출하는 시점에 HTTP 요청이 진행중이므로 request scope빈의 생성이 정상처리 된다.
ObjectProvider.getObject() 메서드를 LogDemoController 클래스, LogDemoService 클래스에서 각각 한번씩 따로 호출해도 같은 HTTP 요청이면 같은 스프링 빈이 반환된다.

✔ 해결방안 2 : 프록시 방식

package hello.core.web;

import hello.core.common.MyLogger;
import lombok.RequiredArgsConstructor;
import org.springframework.stereotype.Service;
import org.springframework.web.context.annotation.RequestScope;

@Service
@RequiredArgsConstructor
public class LogDemoService {

    private final MyLogger myLogger;

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

package hello.core.common;

import org.springframework.context.annotation.Scope;
import org.springframework.context.annotation.ScopedProxyMode;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.util.UUID;

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

@Scope 애노테이션에 proxyMode = ScopedProxyMode.TARGET_CLASS 를 추가해야 한다.
- 적용 대상이 인터페이스가 아닌 클래스면 proxyMode = ScopedProxyMode.TARGET_CLASS로 하면 된다.
- 적용 대상이 인터페이스면 proxyMode = ScopedProxyMode.INTERFACE 로 하면 된다.
이렇게 하면 MyLogger의 가짜 프록시 클래스를 만들어두고 HTTP request와 상관 없이 가짜 프록시 클래스를 다른 빈에 미리 주입한다.

동작 원리

CGLIB 라이브러르로 내 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
@Scope의 proxyMode = ScopedPorxMode.TARGET_CLASS 를 설정하면 스프링 컨테이너는 CGLIB라는 바이트코드를 조작하는 라이브러리를 사용해서 MyLogger를 상속받은 가짜 프록시 객체를 생성한다.
스프링 컨테이너에 myLogger 이름으로 진짜 대신 가짜 프록시 객체를 등록한다.
ac.getBean("myLogger", MyLogger.class) 로 조회해도 프록시 객체가 조회된다.
- 의존관계 주입도 가짜 프록시 객체가 주입된다.

가짜 프록시 객체는 요청이 오면 그 때 프록시 객체 내부에서 진짜 빈을 요청하는 위임 로직이 들어있다.
가짜 프록시 객체는 내부에서 진짜 myLogger 객체를 찾는 방법을 알고 있다.
클라이언트가 myLogger.logic() 메서드를 호출하면 사실은 가짜 프록시 객체의 메서드가 호출되는 것이다.
가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic() 메서드를 호출한다.
가짜 프록시 객체는 원본 클래스를 상속 받아서 만들어졌기 때문에 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 아닌지 모르게 동일하게 사용할 수 있다. (다형성의 장점 사용)

➰ 정리

CGLIB 라이브러리로 클래스를 상속 받은 가짜 프록시 객체를 만들어서 주입한다.
가짜 프록시 객체는 실제 요청이 오면 그 때 프록시 객체 내부에서 실제 빈을 요청하는 위임 로직이 들어있다.
가짜 프록시 객체는 실제 request scope와 관계가 없다. 그냥 가짜이고, 내부에 단순한 위임 로직만 있고 싱글톤 처럼 동작한다.
프록시 객체 덕분에 클라이언트는 마치 싱글톤 빈을 사용하듯이 편리하게 request scope를 사용할 수 있다.
Provider를 사용하든, 프록시를 사용하든 핵심 아이디어는 진짜 객체 조회를 꼭 필요한 시점까지 지연처리 한다는 점이다.
단지 애노테이션 설정 변경만으로 원본 객체를 프록시 객체로 대체할 수 있다. 이것이 바로 다형성과 DI 컨테이너가 가진 큰 장점이다.
꼭 웹 스코프가 아니어도 프록시는 사용할 수 있다.

➰ 주의

싱글톤을 사용하는 것 같지만 다르게 동작하기 때문에 주의해서 사용해야 한다.
특별한 scope는 꼭 필요한 곳에서만 최소화해서 사용하자. 무분별하게 사용하면 유지보수하기 어렵다.

728x90

'[ Spring ] > Spring' 카테고리의 다른 글

[Spring] JUnit (0)	2022.02.14
[Spring] HttpServletRequest 객체 (0)	2022.02.06
[Spring] 빈(Bean) 생명주기 콜백 시작 (0)	2022.01.29
[Spring] 조회한 빈(Bean)을 List, Map에 담기 (0)	2022.01.24
[Spring] 스프링 빈(Bean) 등록 수동, 자동 결정 기준 (0)	2022.01.24

▒ 빈 스코프 (Bean scope)

🔍 스프링이 지원하는 다양한 스코프

🔍 빈 스코프 등록 방법

🔍 싱글톤 스코프

🔍 프로토타입 스코프

💡 정리

🔍 프로토타입 스코프의 빈과 싱글톤 빈을 함께 사용시 문제점

💡 싱글톤 빈에서 프로토타입 빈 사용

✔ 대안 1

✔ 대안 2

✔ 대안 3

💡 정리

🔍 웹 스코프

💡 웹 스코프 종류

💡 request 스코프

🔍 웹 스코프

💡 웹 스코프 종류

💡 request 스코프

'[ Spring ] > Spring' 카테고리의 다른 글

티스토리툴바