Spring 핵심 원리 기본편 3 (마지막)

현재까지 1,2 편을 적고 3을 적게 됐다. 이렇게 보니 엄청 길게 느껴졌던 내용들이 생각보다 짧은 것 같기도..? 하다.

빈 생명주기 콜백과 빈 스코프가 남았다. 바로 시작!

 

스프링 프로그램이 시작하기 전과 후에 무언가 부가적인 작업을 해줘야 할 때가 있다. 예를 들면 데이터베이스 커넥션 풀이나 네트워크 소켓 등이 있다. 애플리케이션이 시작될 시점에 미리 필요한 연결을 해둬야 하고, 종료될 쯤에는 연결됐던 걸 다시 해제하는 작업이 필요하다. 이러한 부가 작업들은 주요 프로그램이 실행되기 전과 후에 각각 이루어져야 한다.

 

이번 시간에는 네트워크 소켓을 담당하는 NetworkClient라는 객체를 만들어서 테스트한다. 네트워크 소켓을 담당하는 빈이기 때문에 이 빈의 로직이 실행되기 전에 네트워크 연결이 세팅되어야 하고, 끝나고 나서는 연결이 해제되는 부가작업이 자동으로 이뤄져야 한다. 스프링에서 어떻게 이런 것들을 자동으로 할 수 있을까?

 

스프링 빈은 이전 2편에서 설명했듯, 객체(빈) 생성 -> 의존관계 주입 의 라이프사이클을 가지는데, 스프링은 의존관계 주입이 완료됐을 때 스프링 빈에게 콜백 메소드로 부가작업을 할 시점을 알려주고, 스프링 컨테이너가 종료되기 직전에 빈 소멸 콜백을 주는 기능도 제공한다. 스프링 빈의 이벤트 라이프사이클을 정리하면 아래와 같다.

 

스프링 컨테이너 생성 -> 스프링 빈 생성 -> 의존관계 주입

-> 초기화 콜백(의존관계 주입이 완료되고 주요 프로그램이 실행되기 직전에 이뤄져야 할 작업을 여기에 선언할 수 있다.)

-> 빈 사용(주요 프로그램 로직들이 실행됨)

-> 소멸전 콜백('일반적으로는' 스프링 컨테이너가 종료되기 직전에 이뤄져야 할 작업을 여기에 선언할 수 있다.)

-> 스프링 종료

 

소멸전 콜백은 '일반적으로' 라는 말을 썼는데, 빈 자기 자신의 종료 직전에 실행된다고 보면 된다. 싱글톤은 스프링 컨테이너에 의해 관리되고 컨테이너의 시작과 종료까지 생존하지만, 생명주기가 짧게 설정된 빈의 경우 컨테이너랑 무관하게 해당 빈이 종료되기 직전에 소멸전 콜백이 일어난다. 빈의 생명주기는 빈 스코프 부분에서 설명한다.

빈 생명주기 콜백

---

위에서 라이프사이클을 설명했다. 초기화 콜백은 빈이 생성되고 빈의 의존관계 주입이 완료된 후에 호출되고, 소멸전 콜백은 빈이 소멸되기 직전에 호출된다. 스프링에서는 이런 생명주기 콜백을 다양한 방식으로 지원한다. 크게 세 가지 방법이 있는데 내 글에서는 마지막 것만 적을 예정이다.

 

• 인터페이스 (InitializingBean, DisposableBean)
  • 초기화, 소멸전 콜백을 활용하고 싶은 빈이 위 인터페이스를 implements 해야만 쓸 수 있다.
  • 그래서 외부 라이브러리 같은 데에 콜백을 활용할 수 없다. 
• 설정 정보에 초기화 메소드와 종료 메소드를 지정. @Bean(initMethod = "", destroyMethod="")
  • 설정 정보에 코드를 적으니까 외부 라이브러리에도 초기화, 종료 메소드를 적용할 수 있다.
  • @Bean의 기능이고, 추론 기능을 갖고 있어서 종료 메소드를 따로 적지 않더라도 close나 shutdown 이라는 이름의 메소드를 종료 메소드라고 추론해서 자동으로 빈 소멸 전에 호출해준다.
• @PostContstuct, @PreDestroy
  • 제일 편하고, javax.annotation.PostConstruc를 import하는 데에서 알 수 있듯 스프링 기술이 아니라 자바 표준이다. 스프링이 아닌 다른 컨테이너에서도 동작한다. 
  • 유일한 단점은 빈 객체 내에 선언해서 사용하다 보니, 코드를 고칠 수 없는 외부 라이브러리에는 적용할 수 없다. 이때는 두번째에서 소개한 @Bean의 initMethod 같은 걸 활용하면 된다.

 

빈 생성과 초기화 작업의 분리

---

그냥 초기화 작업, 즉 빈 프로그램 실행 전에 이뤄져야할 부가 작업을 따로 콜백으로 진행하지 말고 빈 생성할 때 같이 해주면 안되나? 라는 생각이 들 수도 있다. 하지만 생성자는 필수 정보들을 파라미터로 받고 메모리를 할당해서 객체를 생성하는 책임을, 그리고 초기화는 이렇게 생성된 값을 활용해서 외부 커넥션을 연결하는 등의 무거운 동작의 책임을 가진다. 따라서 생성자 안에서 이런 무거운 초기화 작업을 함께하는 것보다, 객체 생성이라는 책임과 초기화 책임을 명확하게 분리하는 것이 유지보수 관점에서 더 좋다.

 

@PostContuct, @PreDestroy 써보기

---

1. 빈 객체 내에 어노테이션으로 부가작업들을 선언했다.

2. 빈으로 추가해주는 설정파일을 만든다. 테스트용으로 테스트 클래스 내에 간단히 선언하려고 static으로 만들었다.

 

3. PostConstruct와 PreDestroy가 동작된 모습

근데 어노테이션 이름이 약간 헷갈려서 직역해봤다. PostConstruct는 '빈이 방금 construct되었음을 post한다, 알린다.' 라고 생각하면 될 거 같고, preDestroy는 '다 종료되기 이전에 미리 없애준다. 파괴한다.' 라고 직역해서 생각하기로 했다. ㅋㅋㅋ

 

빈 스코프

---

지금까지 본 빈들은 모두 스프링 컨테이너가 시작될 때 생성되고, 컨테이너가 종료될 때까지 유지됐다. 스프링 빈이 기본적으로 싱글톤 스코프로 생성되기 때문이다. 스코프는 빈이 존재할 수 있는 생명주기 범위다.

 

스프링 빈의 스코프 종류는 아래와 같다.

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

빈 스코프는 아래와 같이 지정할 수 있다. 왼쪽은 컴포넌트 스캔의 자동 빈 등록을 활용할 때고, 오른쪽은 수동 등록이다.

 

프로토타입 빈과 초기화/소멸 콜백

---

싱글톤 빈을 조회하면 스프링 컨테이너는 항상 같은 인스턴스의 스프링 빈을 반환한다. 반면 프로토타입 스코프를 조회하면 스프링 컨테이너는 항상 새로운 인스턴스를 생성해서 반환한다. 프로토타입 빈의 경우 스프링 컨테이너가 빈 생성과 의존관계 주입 그리고 초기화까지는 처리하고 그 이후부터는 그 빈을 관리하지 않는다. 그래서 @PostConstruct 까지는 호출되지만 @PreDestroy는 호출되지 않는다.

 

싱글톤 테스트부터.

1. 초기화 콜백과 소멸전 콜백이 모두 호출된다.
2. 스프링컨테이너에서 빈을 꺼내올 때마다 동일한 빈이 꺼내진다.

 

프로토타입 테스트

1. 초기화 콜백만 호출되고 소멸전 콜백은 호출되지 않는다.
2. 스프링 컨테이너에서 빈을 꺼내올 때마다 다른 빈이 꺼내진다. 싱글톤이 보장되지 않는다.

 

프로토타입 스코프 + 싱글톤 빈 함께 사용 시 주의사항

---

스프링 컨테이너에서 프로토타입 스코프인 빈을 직접 요청해서 꺼내올 때는 위에서 봤듯 매번 새로운 빈이 생성되어 반환된다. 그렇다보니 내부에서 count를 선언하고 이 값을 add하는 기능으로 테스트를 해봐도 아예 새로운 객체가 생성되고 반환됨을 알 수 있다.

1. 스프링 컨테이너에 같은 타입의 빈을 두 번 요청해서 가져온 뒤 addCount를 했는데 두 번 다 1까지로밖에 증가되지 않았다.
2. 두 객체가 요청때에 새로 생성되어 반환된 서로 다른 빈임을 알 수 있다.
3. 이번에도 프로토타입 빈은 초기화콜백만 실행되고 소멸전 콜백이 실행되지 않았다.

 

이번에는 clientBean이라는 싱글톤 빈이 의존관계 주입을 통해서 프로토타입 빈을 주입받아서 사용하는 예시를 보자. 두 프로토타입의 count값이 어떨까?

 

위와 같이 프로토타입 빈을 품은 싱글톤 객체를 두 번 요청하고, 그 내부의 프로토타입 속 count 값을 가져왔더니 이번에는 프로토타입 객체가 두 요청에서 모두 새롭게 생성되는 것이 아니라 기존의 프로토타입 객체가 그대로 나왔다. 그러면서 count 값이 최종적으로는 두 번 증가하여 2가 되었다. 플로우를 살펴보면 아래와 같다.

 

1. clientBean은 생성자 주입을 사용하고 있으니 필요한 빈이 모두 생성된 다음에 의존관계가 주입되는게 아니라 생성자가 실행되는 도중에 프로토타입 빈과의 의존관계도 같이 주입된다. 이때 clientBean은 프로토타입 빈의 참조값을 내부 필드에 보관한다.
2. clientBean은 싱글톤이므로 두 번 컨테이너에서 꺼내올 때 두 번 다 동일한 객체가 가져와진다.
3. 첫번째로 컨테이너에 clientBean을 요쳥해서 받아온 뒤 clientBean.logic()을 호출하면, clientBean은 addCount()를 호출해서 프로토타입 빈의 count를 증가시키고 count가 1이 된다.
4. 그 후 다시 clientBean을 다시 스프링 컨테이너에게 요청하면 이는 싱글톤이라서 3번에서 반환된 객체와 동일한 객체가 반환된다. clientBean은 생성 시점에 본인과 같이 주입됐던 프로토타입 빈의 참조값을 가지고 있으니까 clientBean의 logic을 다시 호출하면 과거에 주입됐던 프로토타입 빈의 addCount()를 호출하게 되면서 count값이 2가 된다.
5. clientBean이 내부에 가지고 있던 프로토타입은 이미 과거에 주입이 끝난 빈이다. clientBean이 프로토타입 빈을 주입해야할 때 그 시점에만 스프링 컨테이너에 이 빈을 달라고 요청하니까 그때는 프로토타입 빈이 생성되는데, 이제는 clientBean의 생성자가 호출될 일이 없으니 스프링 컨테이너한테 프로토타입 빈 주입을 위해 이 타입의 빈을 달라는 요청 자체를 할 일이 없다. 컨테이너한테 요청이 안 들어가니까 아무리 스코프가 프로토타입이더라도 빈이 새로 생성될 일이 없다.

 

프로토타입 스코프 빈을 여러 개의 싱글톤 빈이 주입받는다면?

---

싱글톤인 clientBeanA, clientBeanB가 각각 의존관계를 주입 받으면 각각 다른 인스턴스의 프로토타입 빈을 주입 받는다. 강의자료엔 생략됐지만 테스트해보자.

 

쓰던 clientBean, 새로운 clientBeanB 로 두 개의 싱글톤 빈을 만들었다. 각각을 여러 번 요청해도 내부의 프로토 타입은 변화가 없지만, 각각을 생성할 때는 모두 스프링 컨테이너에게 본인이 주입할 프로토타입 빈을 요청했을테니 새로 생성된 서로 다른 프로토타입 빈이 들어가 있다.

 

Provider: 싱글톤이더라도 내부의 프로토타입 빈은 항상 새롭게!

---

위에서 봤듯 싱글톤 빈의 내부에 있는 프로토타입 빈이라면, 기존에 이미 주입되었고 더는 주입할 일이 없어서 프로토타입 빈이 새로 생성되지 않는다. 어떻게 해야 싱글톤 빈 내부로 이미 주입되었다 할지라도 요청이 들어올 때마다 새로운 프로토타입 빈을 생성할 수 있을까?

 

logic()에서 생성 시점에 주입된 프로토타입을 그대로 쓰지말고 이때마다 스프링 컨테이너에서 프로토타입 빈을 꺼내오면 된다. 그러면 컨테이너에게 매번 요청하니까 본래의 스코프 역할대로 늘 새로 생성된 프로토타입 빈을 받아볼 수 있다.

싱글톤인 clientBean의 logic을 변경. 이미 주입받은 프로토타입 빈을 쓰지 않고 컨테이너에게 새로 요청함.

근데 이렇게 logic이라는 메소드 내에서 스프링 애플리케이션 컨텍스트(ac)를 호출하려면 이 스프링 애플리케이션 컨텍스트를 외부에서 주입받아야 한다. 매번 외부에서 ac 전체를 주입받으면 스프링 컨테이너에 종속적인 코드가 되고 단위 테스트도 어렵다. 우리는 지금 프로토타입 빈을 스프링 컨테이너에게 매번 요청해주는 기능만 추가하면 되는데 너무 과해졌다.

 

지정한 프로토타입 빈을 스프링컨테이너에게 계속 대신해서 요청해줄 녀석이 필요한데, 이게 ObjectProvider다.

아까 쓴 코드를 주석처리하고 아래처럼 변경하면 된다.

이것도 직역해서 지정된 타입의 객체를 제공해준다! 스프링 컨테이너에게 대신 요청해서 받아온 뒤 이걸 제공해주는 역할이라고 생각하면 된다. 딱 스프링 컨테이너를 통해 해당 빈을 찾아서 반환해주는 역할까지만 해 주는게 ObjectProvider다.

 

참고

• 스프링부트 3.0 미만 : javax.inject:javax.inject:1을 gradle에 추가해야 사용 가능
• 스프링부터 3.0 이상 : jakarta.inject:jakarta.inject-api:2.0.1을 gradle에 추가해야 사용 가능

 

request 스코프 테스트

---

request 빈은 http 요청이 들어올 때 하나씩 생성됐다가 요청이 끝나는 시점에 소멸된다. 초기화콜백에 uuid를 생성하면 다른 http 요청과 구분할 수 있다.

 

위처럼 열심히 request 스코프를 만들 수 있는데, 이렇게 만들기만 하고 스프링을 실행시키면 해당 빈을 생성할 수 없다고 나온다. request 스코프 빈은 실제 고객의 요청이 와야만 생성할 수 있기 때문이다.

 

이전에 배운 Provider는 내가 원하는 시점에 스프링 컨테이너에게 요청하게 할 수 있게 한다. 여기서는 요청이 왔을 때 logic()을 실행할 때에만 스프링 컨테이너에게 요청하면 되고 그때는 이미 요청이 왔을 때이니까 request 스코프 빈도 생성이 된 이후라서 에러가 나지 않을 것이다. 그래서 아래처럼 MyLogger를 바로 주입받았던 컨트롤러와 서비스 코드를 ObjectProvider<MyLogger>를 주입받도록 변경했다.

service도 똑같이 하면 된다.

이제는 스프링 애플리케이션이 잘 실행되고 해당 요청을 넣었을 때 request 스코프 빈이 생성되고 OK로 응답하기 전에 close된다. 그리고 테스트에는 없지만 동일한 요청으로 들어오면 동일한 스프링 빈이 반환된다.

 

Provider 말고 프록시를 활용할 수도 있다.

위처럼 작성하면 CGLIB 라이브러리를 통해서 MyLogger에 대한 가짜 객체를 미리 만들고 이 가짜 프록시 객체로 의존관계를 주입한다. bean에 해당 타입으로 조회해보면 프록시 객체가 조회된다. 이렇게 가짜이더라도 일단 객체를 만들어서 의존관계 주입까지 할 수 있으니 애플리케이션은 정상적으로 실행되었다가, 실제로 요청이 들어오면 그제서야 진짜 빈을 요청하는 위임 로직이 실행된다. 

 

1. 가짜 객체로 생성되어 의존관계까지 주입됨
2. 클라이언트가 myLogger.logic()을 호출하면 가짜 프록시 객체의 logic 메소드가 호출된다.
3. 가짜 프록시 객체는 request 스코프의 진짜 myLogger.logic()을 호출한다. 안에 실제 빈을 요청해서 일을 처리하는 위임 로직이 들어있다.
4. 가짜 프록시 객체는 원본 클래스를 extends 해서 만들어진거라 이 객체를 사용하는 클라이언트 입장에서는 사실 원본인지 가짜객체인지 모르게 동일하게 사용할 수 있다.

 

Provider든 프록시든 처음부터 가져오지 말고, 해당 객체가 실제로 필요한 시점에 가져오기 위한 장치이다. 즉, 진짜 객체를 꼭 필요한 시점까지 기다렸다가 조회하는 지연처리를 지원하는 것이다. 그리고 애노테이션 설정을 변경하는 것만으로도 진짜 객체를 가짜 프록시 객체로 대체할 수 있다. 가짜 객체는 진짜 객체를 extends한 거라 가능한 거고, 이거는 모두 자바가 다형성을 지원하니까 가능한 일이다.

 

쓰면서 글이 매우 길어졌지만... 그래도 긴 강의를 세 포스팅에 정리해봤다. 이제 MVC로 가자~