해당 게시글은 김영한 강사님의 스프링 핵심 원리 강의를 바탕으로 작성하였습니다.
https://www.inflearn.com/courses/lecture?courseId=325969&tab=curriculum&type=LECTURE&unitId=55396&subtitleLanguage=ko&audioLanguage=ko
Spring Container
기본적으로 스프링 컨테이너는 다음과 같이 생성한다.
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(AppConfig.class);ApplicationContext를 스프링 컨테이너라고 하며, 인터페이스로 정의되어 있다.
new AnnotationConfigApplicationContext(AppConfig.class);에서 AnnotationConfigApplicationContext가 ApplicationContext의 구현체이다.
스프링 컨테이너는 XML 기반으로 만들 수 있고, 애노테이션 기반의 자바 설정 클래스로도 만들 수 있다.
요즘은 XML 기반 보다는 아래와 같이 좀 더 간편한 애노테이션 기반을 사용한다.
@Configuration
public class AppConfig {
@Bean
public MemberService memberService() {
return new MemberServiceImpl(memberRepository());
}
@Bean
public OrderService orderService() {
return new OrderServiceImpl(
memberRepository(),
discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
return new MemoryMemberRepository();
}
@Bean
public DiscountPolicy discountPolicy() {
return new RateDiscountPolicy();
}
}위 코드의 생성 과정을 나타내면 다음과 같다.
AppConfig.class를 구성정보로 지정하여 등록하게 되면, 스프링 컨테이너는 @Bean이 붙은 메서드 이름을 기준으로 빈 이름을 등록한다.
@Bean(name = "ABC")와 같이 임의로 부여해도 되지만, 가능하면 기본값을 사용하는 것을 권장한다.
그리고 아래와 같이 스프링 빈에 대한 의존관계를 자동으로 설정하게 된다.
단순히 자바 코드를 호출하는 것과 동일해 보이지만, 싱글톤 컨테이너라는 중요한 개념을 달고 생성한다.
싱글톤 컨테이너에 대한 내용은 추후에 다루도록 하겠다.
BeanFactory와 ApplicationContext
스프링 컨테이너 하면 보통 BeanFactory, ApplicationContext 2개를 볼 수 있다.
이 둘은 서로 상속관계이다.
BeanFactory는 스프링 컨테이너의 최상위 인터페이스로, getBean() 메서드를 통해 스프링 빈을 관리하고 조회하는 역할을 담당한다.
ApplicationContext는 BeanFactory의 기능을 모두 상속받은 다음, 국제화, 환경 변수, 애플리케이션 이벤트, 편리한 리소스 조회 등의 부가기능을 제공한다.
Spring Bean
지금부터 설명하는 Spring Bean을 조회하고 테스트해보는 모든 코드는 깃허브에 따로 정리해 놓았으니 참고하길 바란다.
https://github.com/wonotter/Spring-Boot_Study/tree/main/puretospring
또한 아래 작성하는 코드들은 필요한 패키지를 가져오는 import문과 ApplicationContextExtendsFindTest, ApplicationContextSameBeanFindTest와 같이 테스트 클래스명은 제외하고 내용만 작성하였으니 참고하길 바란다.
Spring Bean 조회
컨테이너에 등록된 빈을 조회하는 메서드는 다음과 같다.
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
@Test
@DisplayName("모든 빈 출력하기")
void findAllBean() {
String[] beanDefinitionNames = ac.getBeanDefinitionNames();
for (String beanDefinitionName : beanDefinitionNames) {
Object bean = ac.getBean(beanDefinitionName);
System.out.println("name=" + beanDefinitionName + " object=" + bean);
}
}ac.getBeanDefinitionNames()를 통해 모든 빈 이름을 가져온 후, ac.getBean(빈이름, 타입) or ac.getBean(타입)을 통해 빈 이름으로 빈 객체를 조회할 수 있다.
만약 ac.getBean(타입)으로 조회 시 같은 타입의 스프링 빈이 2개 이상이면 오류가 발생한다. 이때는 빈 이름을 지정하여 해결하자. ac.getBeansOfType()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다.
Spring Bean 상속 조회
부모 타입으로 조회하면, 자식 타입도 함께 조회된다. 따라서 모든 자바 객체의 최고 부모인 Object 타입으로 조회하면 모든 스프링 빈을 조회한다.
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
@Test
@DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다")
void findBeanByParentTypeDuplicate() {
//DiscountPolicy bean = ac.getBean(DiscountPolicy.class);
assertThrows(NoUniqueBeanDefinitionException.class, () ->
ac.getBean(DiscountPolicy.class));
}
@Test
@DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 빈 이름을 지정하면 된다")
void findBeanByParentTypeBeanName() {
DiscountPolicy rateDiscountPolicy = ac.getBean("rateDiscountPolicy", DiscountPolicy.class);
assertThat(rateDiscountPolicy).isInstanceOf(RateDiscountPolicy.class);
}
@Test
@DisplayName("특정 하위 타입으로 조회")
void findBeanBySubType() {
RateDiscountPolicy bean = ac.getBean(RateDiscountPolicy.class);
assertThat(bean).isInstanceOf(RateDiscountPolicy.class);
}
@Test
@DisplayName("부모 타입으로 모두 조회하기 - Object")
void findAllBeanByObjectType() {
Map<String, Object> beansOfType = ac.getBeansOfType(Object.class);
for (String key : beansOfType.ketSet()) {
System.out.println("key = " + key + " value=" + beansOfType.get(key));
}
}
@Configuration
static class TestConfig {
@Bean
public DiscountPolicy rateDiscountPolicy() {
return new RateDiscountPoilicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy() {
return new FixDiscountPolicy();
}
}Singleton Container
Spring은 태생이 기업용 온라인 서비스 기술을 지원하기 위해 탄생했다. 따라서 대부분 Spring 어플리케이션은 웹 어플리케이션이다.
웹 어플리케이션 특성 상 여러 고객이 동시에 요청한다.
이전 시간에 스프링 코드 하나 없이 순수하게 자바 코드로 구현한 AppConfig 클래스를 떠올려보자. 만약 여러 클라이언트가 동시에 접속을 요청한다면 아래와 같이 동작할 것이다.
요청을 할때 마다 새로운 객체를 생성하게 된다. 만약 고객 트래픽이 초당 100이 나오면 초당 100개의 객체가 생성되고 소멸되는 것이다!
당연히 메모리 낭비가 심하며, 성능 측면에서 안좋은 코드가 될 수 밖에 없다.
이를 해결하기 위해 객체를 딱 1개만 생성하고, 이를 공유하도록 설계해야 하며, 싱글톤 패턴이라고 부른다.
Singleton Pattern
클래스의 인스턴스가 딱 1개만 생성되는 것을 보장하는 디자인 패턴이다. 따라서 아래와 같이 코드를 작성할 수 있다.
public class SingletonService {
//1. static 영역에 객체를 딱 1개만 생성해둔다.
private static final SingletonService instance = new SingletonService();
//2. public으로 열어서 객체 인스턴스가 필요하면 이 static 메서드를 통해서만 조회하도록 허용한다.
public static SingletonService getInstance() {
return instance;
}
//3. 생성자를 private으로 선언해서 외부에서 new 키워드를 사용한 객체 생성을 못하게 막는다.
private SingletonService() {
}
public void logic() {
System.out.println("싱글톤 객체 로직 호출");
}
}static 영역에 객체를 딱 1개만 생성하여 미리 올려둔다. 이 객체 인스턴스가 필요하면 getInstance() 메서드를 통해서만 조회할 수 있으며, 항상 같은 인스턴스를 반환한다.
딱 1개의 객체 인스턴스만 존재해야 하므로, 생성자를 private으로 설정하여 외부에서 생성하는 것을 막는다.
이를 적용한 테스트 코드는 다음과 같다.
@Test
@DisplayName("싱글톤 패턴을 적용한 객체 사용")
public void singletonServiceTest() {
//private으로 생성자를 막아두었다. 컴파일 오류가 발생한다.
//new SingletonService();
//1. 조회: 호출할 때 마다 같은 객체를 반환
SingletonService singletonService1 = SingletonService.getInstance();
//2. 조회: 호출할 때 마다 같은 객체를 반환
SingletonService singletonService2 = SingletonService.getInstance();
//참조값이 같은 것을 확인
System.out.println("singletonService1 = " + singletonService1);
System.out.println("singletonService2 = " + singletonService2);
// singletonService1 == singletonService2
assertThat(singletonService1).isSameAs(singletonService2);
singletonService1.logic();
}private으로 new 키워드를 막아두었으며 호출할 때 마다 같은 객체 인스턴스를 반환한다. 언뜻 보면 괜찮아보일 수 있지만, 사실 이 코드에는 우리가 이전 시간에 중요하게 다룬 객체지향 설계 원칙 SOLID 중 DIP를 위반한다는 치명적인 문제가 있다.
의존관계상 클라이언트가 구현 클래스에 의존하기 때문이다. 이 외에도 싱글톤 패턴을 구현하는 코드 자체가 많이 들어가서 불편하고, 테스트하기 까다로우며, 내부 속성을 변경하거나 초기화하기 어렵다는 단점도 존재한다.
Spring Container와 Singleton
이러한 싱글톤 패턴의 문제점을 해결하면서 객체 인스턴스를 싱글톤으로 관리하는 것이 싱글톤 컨테이너이며, 지금까지 우리가 학습한 스프링 빈이 바로 싱글톤으로 관리되는 빈이다.
또한 스프링 컨테이너는 싱글톤 컨테이너의 역할을 수행한다.
- 스프링 컨테이너는 싱글톤 패턴을 적용하지 않아도 객체 인스턴스를 싱글톤으로 관리한다.
- 스프링 컨테이너는 싱글톤 컨테이너 역할을 한다. 이를 싱글톤 레지스트리라고 한다.
- 스프링 컨테이너의 이러한 기능 덕분에 싱글톤 패턴의 모든 문제점은 해결하고 객체를 싱글톤으로 유지할 수 있다.
@Test
@DisplayName("스프링 컨테이너와 싱글톤")
void springContainer() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
//1. 조회: 호출할 때 마다 같은 객체를 반환
MemberService memberService1 = ac.getBean("memberService", MemberService.class);
//2. 조회: 호출할 때 마다 같은 객체를 반환
MemberService memberService2 = ac.getBean("memberService", MemberService.class);
//참조값이 같은 것을 확인
System.out.println("memberService1 = " + memberService1);
System.out.println("memberService2 = " + memberService2);
//memberService1 == memberService2
assertThat(memberService1).isSameAs(memberService2);
}📌 Singleton 방식의 주의점
싱글톤 패턴이든 스프링 같은 싱글톤 컨테이너를 사용하든 객체 인스턴스를 하나만 생성해서 공유하는 방식이기 때문에 싱글톤 객체는 절대로 상태를 유지(stateful)하게 설계하면 안된다!
무상태(stateless)하게 설계해야 한다! 이 말은 즉 특정 클라이언트에 의존적인 필드가 있으면 안되고, 값을 변경할 수 있는 필드가 있으면 안된다.
아래와 같이 order 메서드 호출 시 price를 저장하는 필드가 존재하는 StatefulService 클래스가 있다고 가정해보자.
public class StatefulService {
private int price; // 상태를 유지하는 필드
public void order(String name, int price) {
System.out.println("name = " + name + " price = " + price);
this.price = price; // 여기가 문제되는 지점!
}
public int getPrice() {
return price;
]
}아래는 StatefulService에 대한 테스트 코드이다. Thread A가 사용자 A를 호출한 다음, Thread B가 사용자 B를 호출하는 순서가 있다고 가정한다면 사용자 A는 10000원 주문을 기대했지만, 이후에 호출된 B에 의해 20000원이 주문되는 아찔한 상황이 벌어진다...
public class StatefulServiceTest {
@Test
void statefulServiceSingleton() {
ApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
StatefulService statefulService1 = ac.getBean("statefulService", StatefulService.class);
StatefulService statefulService2 = ac.getBean("statefulService", StatefulService.class);
//ThreadA: A사용자 10000원 주문
statefulService1.order("userA", 10000);
//ThreadB: B사용자 20000원 주문
statefulService2.order("userB", 20000);
//ThreadA: 사용자A 주문 금액 조회
int price = statefulService1.getPrice();
//ThreadA: 사용자A는 10000원을 기대했지만, 기대와 다르게 20000원 출력
System.out.println("price = " + price);
Assertions.assertThat(statefulService1.getPrice()).isEqualTo(20000);
}
static class TestConfig {
@Bean
public StatefulService statefulService() {
return new StatefulService();
}
}
}@Configuration과 싱글톤
우리가 이전에 AppConfig 클래스에 대해 스프링 컨테이너를 적용했던 코드를 생각해보자.
@Configuration
public class AppConfig {
@Bean
public MemberService memberService() {
return new MemberServiceImpl(memberRepository());
}
@Bean
public OrderService orderService() {
return new OrderServiceImpl(memberRepository(), discountPolicy());
}
@Bean
public MemberRepository memberRepository() {
return new MemoryMemberRepository();
}
...
}memberService 빈을 만드는 코드를 보면 memberRepository()를 호출하고, orderService 빈을 만드는 코드 역시 memberRepository()를 호출한다.
그렇다면 memberRepository()는 new MemoryMemberRepository()를 호출하므로 각각 다른 2개의 MemoryMemberRepository()가 생성되면서 싱글톤이 깨지는 것이 아닐까?
하지만 테스트 코드에서 Getter 메서드를 통해 memberRepository 인스턴스를 확인해보면 모두 같은 인스턴스가 공유되어 사용된다.
(테스트 코드는 너무 길어 생략하도록 하겠다...)
여러번 new를 통해 호출함에도 싱글톤이 보장되는 이유는 @Configuration 를 적용한 AppConfig이기 때문이다.
@Test
void configurationDeep() {
ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
//AppConfig도 스프링 빈으로 등록된다.
AppConfig bean = ac.getBean(AppConfig.class);
System.out.println("bean = " + bean.getClass());
//출력: bean = class hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70
}사실 AnnotationConfigApplicationContext에 파라미터로 넘긴 값은 스프링 빈으로 등록된다. 따라서 AppConfig 역시 스프링 빈이 된다.
또한 순수한 클래스라면 class hello.core.AppConfig와 같이 출력되어야 하지만, 실제로는 hello.core.AppConfig$$EnhancerBySpringCGLIB$$bd479d70와 같이 뒤에 뭔가 지저분하게 붙은게 생겼다!
@Configuration 어노테이션을 붙이게 되면 스프링이 CGLIB라는 바이트코드 조작 라이브러리를 사용해서 AppConfig 클래스를 상속받은 임의의 다른 클래스를 만들고, 이를 스프링 빈으로 등록시키는 것이다!
그리고 그 임의의 클래스가 싱글톤을 보장하도록 역할을 수행하는 것이다. 따라서 싱글톤 보장을 위해 @Configuration 어노테이션을 꼭 붙여주어야 한다.
@Bean이 붙은 메서드마다 이미 스프링 빈이 존재하면 존재하는 빈을 반환하고, 존재하지 않으면 새롭게 생성해서 스프링 빈으로 등록하고 반환하는 코드가 만들어지는 것이다.
따라서 AppConfig@CLIB 예상 코드는 다음과 같다.
@Bean
public MemberRepository memberRepository() {
if (memoryMemberRepository가 이미 스프링 컨테이너에 등록되어 있으면?) {
return 스프링 컨테이너에서 찾아서 반환;
} else { //스프링 컨테이너에 없으면
기존 로직을 호출해서 MemoryMemberRepository를 생성하고 스프링 컨테이너에 등록
return 반환
}
}만약 @Configuration 없이 @Bean만 붙이게 된다면 순수 AppConfig 클래스가 등록되어 싱글톤을 보장하지 않게 된다.
그러므로 싱글톤 보장을 위해 스프링 설정 정보는 항상 @Configuration도 붙여주는 것을 잊지 말도록 하자.
