[Spring 기본] 9. 빈 스코프

안녕하세요!

드디어 마지막 섹션입니다!

그럼 바로 시작해볼게요 고고!!

---

1. 빈 스코프란..?

지금까지 스프링 빈이 스프링 컨테이너의 시작과 함께 생성되어서 스프링 컨테이너가 종료될 때까지 유지된다고 공부했습니다.

이것은 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문입니다.

스코프는 번역 그대로 빈이 존재할 수 있는 범위를 뜻합니다.

 

스프링은 다음과 같은 다양한 스코프를 지원합니다.

• 싱글톤: 기본 스코프입니다. 스프링 컨테이너의 시작과 종료까지 유지되는 가장 넓은 범위의 스코프입니다.
• 프로토타입: 스프링 컨테이너는 프로토타입 빈의 생성과 의존관계 주입까지만 관여하고 더는 관리하지 않는 매우 짧은 범위의 스코프입니다.
• 웹 관련 스코프
  • request: 웹 요청이 들어오고 나갈 때까지 유지되는 스코프입니다.
  • session: 웹 세션이 생성되고 종료될 때까지 유지되는 스코프입니다.
  • application: 웹의 서블릿 컨텍스트와 같은 범위로 유지되는 스코프입니다.

 

빈 스코프는 다음과 같이 지정할 수 있습니다.

• 컴포넌트 스캔 자동 등록

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

• 수동 등록

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

 

지금까지 싱글톤 스코프를 계속 사용해 보았으니, 이번엔 프로토타입 스코프부터 확인해보겠습니다.

 

---

2. 프로토타입 스코프

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

반면에 프로토타입 스코프를 스프링 컨테이너에 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환합니다.

 

2-1. 싱글톤 빈 요청 vs 프로토타입 빈 요청

<⭐싱글톤 빈 요청 과정⭐>

싱글톤 빈 요청

1. 싱글톤 스코프의 빈을 스프링 컨테이너에 요청합니다.

2. 스프링 컨테이너는 본인이 관리하는 스프링 빈을 반환합니다.

3. 이후에 스프링 컨테이너에 같은 요청이 와도 스프링 빈을 반환합니다.

 

<⭐프로토타입 빈 요청 과정⭐>

프로토타입 빈 요청1

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

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

프로토타입 빈 요청2

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

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

<정리✏️>

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

 

 

2-2. 싱글톤 스코프 빈 테스트 vs 프로토타입 스코프 빈 테스트

우선 ⭐싱글톤 스코프 빈 테스트⭐부터 해보겠습니다.

test의 hello.core에 scope라는 패키지를 만들고, 이 패키지 안에 SingletonTest라는 클래스를 만들어보겠습니다.

public class SingletonTest {

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

        SingletonBean sb1 = ac.getBean(SingletonBean.class);
        SingletonBean sb2 = ac.getBean(SingletonBean.class);

        System.out.println("singletonBean1 = " + sb1);
        System.out.println("singletonBean2 = " + sb2);
        assertThat(sb1).isSameAs(sb2);
        
        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");
        }
    }
}

우선 내부 클래스를 static class로 SingletonBean을 만들어줍니다.

전 섹션에서 했던 @PostConstruct와 @PreDestroy도 사용했습니다. 빈 생명주기 콜백을 지원하기 위해서죠!

가장 편리하게 초기화와 종료를 실행하였습니다.

 

그러고 메인 테스트 클래스로 가보겠습니다.

우선, 늘 했던 것처럼 AnnotationConfigApplicationContext를 통해 SingletonBean 클래스를 설정으로 등록하여 스프링 컨테이너를 생성했습니다.

그리고, getBean() 메서드로 SingletonBean을 2번 요청했습니다. 이름은 구분되게 sb1과 sb2로 나눴습니다.

마지막으로, assertions를 통해 두 객체가 같은 인스턴스인지 확인 작업을 했습니다.

 

결과를 한 번 확인해보겠습니다.

싱글톤 스코프 빈 테스트

두 번의 호출에도 동일한 객체가 반환된다는 것을 알 수 있습니다.

즉, 빈 초기화 메서드를 실행하고, 같은 인스턴스의 빈을 조회하고, 종료 메서드까지 정상 호출된 것을 확인할 수 있습니다.

이것이 싱글톤 스코프 빈의 특징입니다!!

 

이번에는 ⭐프로토타입 스코프 빈 테스트⭐를 해보겠습니다.

앞서 만들었던 scope라는 패키지 안에 PrototypeTest라는 클래스를 만들어보겠습니다.

public class PrototypeTest {

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

        System.out.println("find pb1");
        PrototypeBean pb1 = ac.getBean(PrototypeBean.class);
        System.out.println("find pb2");
        PrototypeBean pb2 = ac.getBean(PrototypeBean.class);

        System.out.println("prototypeBean1 = " + pb1);
        System.out.println("prototypeBean2 = " + pb2);
        assertThat(pb1).isNotSameAs(pb2);

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

우선 내부 클래스를 static class로 PrototypeBean을 만들어줍니다.

그리고, 초기화와 종료 메서드를 편하게 실행하기 위해 위에처럼 @PostConstruct와 @PreDestroy를 사용했습니다.

@Scope("prototype")은 빈이 요청할 때마다 새로운 인스턴스를 생성한다는 의미입니다.

그리고, 초기화와 종료가 잘 되면 init 메서드와 destroy 메서드는 잘 실행이 되어서 prototypeBean.init과 PrototypeBean.destroy가 출력이 되어야 합니다.

 

메인 테스트 클래스로 가보겠습니다.

우선, 늘 했던 것처럼 AnnotationConfigApplicationContext를 통해 PrototypeBean 클래스를 설정으로 등록하여 스프링 컨테이너를 생성했습니다.

그리고, pb1이라는 이름으로 첫 번째 prototypeBean 객체를 가져옵니다. 이 시점에 빈이 새로 생성됩니다.

그 다음, pb2라는 이름으로 또 다른 prototypeBean 객체를 가져옵니다. prototype 스코프이므로 새로운 인스턴스가 생성됩니다.

프로토타입 스코프 빈은 스프링 컨테이너에서 빈을 조회할 때마다 생성되고, 초기화 메서드도 그 때 같이 실행되기 때문에 프로토타입 빈을 2번 조회하면 초기화도 2번 실행됩니다.

그러고 나서 두 객체가 서로 다른 객체인지 assertThat(pb1).isNotSameAs(pb2);를 통해 검증합니다.

 

결과를 한 번 확인해보겠습니다.

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

싱글톤 스코프 빈 테스트 때랑은 다른 결과가 나왔습니다.

우선 보면, 확실히 다른 객체라는 것이 마지막 두 줄에 보입니다.

 

그러고 보면 초기화는 되었는데 종료가 안 되었다는 것을 확인할 수 있습니다.

destroy 메서드가 왜 실행이 안 되었을까요??🤔

⭐prototype 스코프 빈은 컨테이너가 destroy()를 자동으로 호출하지 않습니다.⭐

스프링 컨테이너가 생명주기를 관리하지 않기 때문이죠.

 

종료가 필요하다면 destroy()를 수동으로 호출하거나, 별도로 관리하는 로직을 만들어야 합니다.

 

2-3. 싱글톤 스코프 빈과 프로토타입 스코프 빈의 차이점 정리

• 싱글톤 스코프 빈
  • 스프링 컨테이너 생성 시점에 초기화 메서드 실행됩니다.
  • 스프링 컨테이너가 관리하기 때문에 스프링 컨테이너가 종료될 때 빈의 종료 메서드가 실행됩니다.
• 프로토타입 스코프 빈
  • 스프링 컨테이너에서 빈을 조회할 때 생성되고, 그 때 초기화 메서드도 실행됩니다.
  • 스프링 컨테이너가 생성과 의존관계 주입과 초기화까지만 관여하고 더는 관리하지 않기 때문에, 스프링 컨테이너가 종료될 때 @PreDestroy 같은 종료 메서드는 전혀 실행되지 않습니다.
  • 그래서 프로토타입 빈은 프로토타입 빈을 조회한 클라이언트가 관리해야 합니다.
    종료 메서드에 대한 호출도 클라이언트가 직접 해야 합니다.

 

---

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

스프링 컨테이너에 프로토타입 스코프의 빈을 요청하면 항상 새로운 객체 인스턴스를 생성해서 반환합니다.

하지만, 싱글톤 빈과 함께 사용할 때는 의도한 대로 잘 동작하지 않으므로 주의해야 합니다.

그림과 코드로 봐보도록 하겠습니다.

 

먼저, 스프링 컨테이너에 프로토타입 빈을 직접 요청하는 예제를 봐보도록 하겠습니다.

 

<⭐프로토타입 빈 직접 요청⭐>

프로토타입 빈 직접 요청1

1. 클라이언트A는 스프링 컨테이너에 프로토타입 빈을 요청합니다.

2. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x01) 합니다. 해당 빈의 count 필드 값은 0 입니다.

3. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하면서 count 필드를 +1 합니다.

✔️결과적으로 프로토타입 빈(x01)의 count는 1이 됩니다.

프로토타입 빈 직접 요청2

4. 클라이언트B는 스프링 컨테이너에 프로토타입 빈을 요청합니다.

5. 스프링 컨테이너는 프로토타입 빈을 새로 생성해서 반환(x02) 합니다. 해당 빈의 count 필드 값은 0 입니다.

6. 클라이언트는 조회한 프로토타입 빈에 addCount()를 호출하면서 count 필드를 +1 합니다.

✔️결과적으로 프로토타입 빈(x02)의 count는 1이 됩니다.

 

코드로 한 번 봐보겠습니다.

아까 만들었던 test.hello.core.scope에 SingletonWithPrototypeTest1이라는 클래스를 만들어줍니다.

public class SingletonWithPrototypeTest1 {

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

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

        PrototypeBean pb2 = ac.getBean(PrototypeBean.class);
        pb2.addCount();
        assertThat(pb2.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");
        }
    }
}

 

우선 내부 클래스부터 보겠습니다.

prototype 스코프이므로, getBean()을 호출할 때마다 새로운 객체가 생성됩니다.

 

위의 그림에서 봤던 addCount()와 getCount() 메서드를 사용했습니다.

count 값을 증가시키고 확인하는 간단한 로직입니다.

위에서도 얘기했지만, 프로토타입 빈에서는 @PreDestroy는 자동 호출되지 않습니다.

 

메인 클래스로 가보겠습니다.

첫 번째 PrototypeBean 인스턴스를 가져오고, addCount() 호출로 count 값을 1 증가시킵니다.

그러고, getCount()가 1인지 확인합니다.

 

두 번째 인스턴스를 다시 스프링 컨테이너에서 가져옵니다.

새로운 객체이기 때문에 count 값은 다시 0부터 시작하고, addCount() 후에는 count 값이 다시 1이 됩니다.

결론은 pb1과 pb2는 서로 다른 인스턴스라는 것!

 

결과를 한 번 봐보겠습니다.

프로토타입 빈 직접 요청 결과

잘 나왔습니다.

두 개가 서로 다른 인스턴스(객체)라는 것을 바로 알 수 있습니다.

 

이번에는 clientBean이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아 사용하는 예제를 봐보겠습니다.

<⭐싱글톤에서 프로토타입 빈 사용⭐>

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

👉🏻 clientBean은 싱글톤이므로, 보통 스프링 컨테이너 생성 시점에 함께 생성되고, 의존관계 주입도 발생합니다.

1. clientBean은 의존관계 자동 주입을 사용합니다. 주입 시점에 스프링 컨테이너에 프로토타입 빈을 요청합니다.

2. 스프링 컨테이너는 프로토타입 빈을 생성해서 clientBean에 반환합니다. 프로토타입 빈의 count 필드 값은 0 입니다.

✔️이제 clientBean은 프로토타입 빈을 내부 필드에 보관합니다. (정확히는 참조값을 보관합니다.)

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

👉🏻 클라이언트A는 clientBean을 스프링 컨테이너에 요청해서 받습니다. 싱글톤이므로 항상 같은 clientBean이 반환됩니다.

3. 클라이언트A는 clientBean.logic()을 호출합니다.

4. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가합니다. count 값은 1이 됩니다.

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

👉🏻 클라이언트B는 clientBean을 스프링 컨테이너에 요청해서 받습니다. 싱글톤이므로 항상 같은 clientBean이 반환됩니다.

여기서 중요한 점이 하나 있습니다.

✔️clientBean이 내부에 가지고 있는 프로토타입 빈은 이미 과거에 주입이 끝난 빈 입니다.

✔️주입 시점에 스프링 컨테이너에 요청해서 프로토타입 빈이 새로 생성이 된 것이고, 사용할 때마다 새로 생성되는 것이 아닙니다.

5. 클라이언트B는 clientBean.logic()을 호출합니다.

6. clientBean은 prototypeBean의 addCount()를 호출해서 프로토타입 빈의 count를 증가합니다. 원래 count 값이 1 이었으므로 2가 됩니다. (count 값 1👉🏻2)

 

코드로 한 번 봐보겠습니다.

아까 만들었던 SingletonWithPrototypeTest1 클래스를 수정해서 작성해보겠습니다.

 

 

 

 

 

---

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

 

 

 

 

 

 

 

 

---

이렇게 끝이 났습니다.

와아아 프로젝트로 다시 돌아올게요!

안뇨옹😄