Spring 시리즈는 혼자 공부하며 기록으로 남기고, 만약 잘못 학습 한 지식이 있다면 공유하며 피드백을 받고자 작성합니다.
스프링에 대해 깊게 공부해보고자 인프런의 김영한 강사님께서 강의를 진행하시는 (스프링 핵심 원리 - 기본편) 강의를 수강하며 정리하는 글입니다.
혹여나 글을 읽으시며 잘못 설명된 부분이 있다면 지적 부탁드리겠습니다.
스프링 빈 조회
컨테이너에 등록된 모든 빈 조회
package hello.core.beanfind;
import hello.core.AppConfig;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.config.BeanDefinition;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class ApplicationContextInfoTest {
AnnotationConfigApplicationContext 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(): 빈 이름으로 빈 객체(인스턴스)를 조회한다.- 어떤 구현체가 할당되었는지 알 수 있다.
애플리케이션 빈 출력하기
- 스프링이 내부에서 사용하는 빈 말고 내가 등록한 빈만 출력하고 싶다면?
public class ApplicationContextInfoTest {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
@Test
@DisplayName("애플리케이션 빈 출력하기")
void findApplicationBean() {
String[] beanDefinitionNames = ac.getBeanDefinitionNames();
for (String beanDefinitionName : beanDefinitionNames) {
BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);
//Role ROLE_APPLICATION: 직접 등록한 애플리케이션 빈
//Role ROLE_INFRASTRUCTURE: 스프링이 내부에서 사용하는 빈
if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION) {
Object bean = ac.getBean(beanDefinitionName);
System.out.println("name = " + beanDefinitionName + " object = " + bean);
}
}
}
}BeanDefinition: 빈 하나하나에 대한 메타데이터 정보이다..getRole()ROLE_APPLICATION: 직접 등록한 애플리케이션 빈ROLE_INFRASTRUCTURE: 스프링이 내부에서 사용하는 빈
결과
스프링 빈 조회 - 기본
- 스프링 빈을 조회하는 가장 간단한 방법은
ac.getBean(빈이름, 타입)을 사용한다. - 빈 이름 없이 타입으로만 조회도 가능하다.
ac.getBean(타입) - 조회 대상 스프링 빈이 존재하지 않으면 예외가 발생한다.
NoSuchBeanDefinitionException : No bean named 'xxxx' available
빈 이름으로 조회
@Test
@DisplayName("빈 이름으로 조회")
void findBeanByName() {
MemberService memberService = ac.getBean("memberService", MemberService.class);
assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
}- 가장 기본적인 방법으로 빈의 이름과 타입을 파라미터로 조회한다.
- 같은타입이 여러개일 경우 좀 곤란해지는 문제가 있다.
이름 없이 타입으로만 조회
@Test
@DisplayName("이름없이 타입으로만 조회")
void findBeanByType() {
MemberService memberService = ac.getBean(MemberService.class);
assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
}- 빈의 이름 없이 조회한다.
구체 타입으로 조회
@Test
@DisplayName("구체 타입으로 조회")
void findBeanByName2() {
MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
}- 구체 타입으로도 조회가 가능하지만 이러한 코드를 사용하게되면 유연성이 떨어진다.
- 항상 역할과 구현을 분리하여야한다.
- 역할에 의존해야하는데 위의 코드는 구현에 의존한 코드이다.
실패 테스트 - 빈 이름으로 조회X
@Test
@DisplayName("빈 이름으로 조회X")
void findBeanByNameX() {
// ac.getBean("xxxxx", MemberService.class);
assertThrows(NoSuchBeanDefinitionException.class,
() -> ac.getBean("xxxxx", MemberService.class));
}- JUnit의
asserThrows는 예외가 터져야 성공하는 테스트코드이다. - () -> 뒤의 코드가 실행됐을 때, 왼쪽의 Exception이 터져야 성공한다.
스프링 빈 조회 - 동일한 타입이 둘 이상
- 타입으로 조회시 같은 타입의 스프링 빈이 둘 이상이라면 오류가 발생하는데, 이럴때는 빈 이름을 지정한다.
ac.getBeansOfType()을 사용하면 해당 타입의 모든 빈을 조회할 수 있다. -> Map 으로 반환
초기작업
public class ApplicationContextSameBeanFindTest {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);
@Configuration
static class SameBeanConfig {
@Bean
public MemberRepository memberRepository1() {
return new MemoryMemberRepository();
}
@Bean
public MemberRepository memberRepository2() {
return new MemoryMemberRepository();
}
}
}- 원래대로라면 AppConfig를 사용하겠지만 그건 수정하기 싫으니 테스트에서만 쓸 static 클래스
SameBeanConfig를 생성하여 같은 타입의 빈을 등록한다.
같은 타입이 둘 이상 있으면 중복 오류 발생
@Test
@DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류 발생한다.")
void findBeanByTypeDuplicate() {
Assertions.assertThrows(NoUniqueBeanDefinitionException.class,
() -> ac.getBean(MemberRepository.class));
}ac.getBean(MemberRepository.class)를 호출하게되면 어떤 빈을 호출해야하는지 스프링은 모른다.- 같은 타입이 둘 이상 있으면
NoUniqueBeanDefinitionException이 발생한다.
같은 타입이 둘 이상 있으면 이름을 지정
@Test
@DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
void findBeanByName() {
MemberRepository memberRepository1 = ac.getBean("memberRepository1", MemberRepository.class);
assertThat(memberRepository1).isInstanceOf(MemberRepository.class);
}- 동일한 타입이 둘 이상 존재한다면 그럴때는 빈 이름을 지정해주면 조회가 가능하다.
특정 타입을 전부 조회
@Test
@DisplayName("특정 타입을 모두 조회하기")
void findAllBeanByType() {
Map<String, MemberRepository> beansOfType = ac.getBeansOfType(MemberRepository.class);
for (String key : beansOfType.keySet()) {
System.out.println("key = " + key + " value = " + beansOfType.get(key));
}
System.out.println("beansOfType = " + beansOfType);
assertThat(beansOfType.size()).isEqualTo(2);
}- 특정 타입을 모두 조회할때는
getBeansOfType()메서드에 타입을 파라미터로 지정하면 된다. - 반환값은 Map
- 테스트 결과는 다음과 같이 출력된다.
스프링 빈 조회 - 상속 관계
대원칙 : 부모 타입으로 조회하면 자식 빈들은 다 끌려나온다.
자바의 최고 부모객체는 Object타입이 존재한다. 클래스도 최고 부모는 Object 타입이다.
따라서 ac.getBeansOfType(Object.class)로 조회하면 모든 스프링 빈을 조회한다.
예재 테스트코드를 작성하기전에 테스트 코드에서 사용할 Config를 하나 임시로 생성한다.
public class ApplicationContextExtendsFindTest {
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);
@Configuration
static class TestConfig {
@Bean
public DiscountPolicy rateDiscountPolicy() {
return new RateDiscountPolicy();
}
@Bean
public DiscountPolicy fixDiscountPolicy() {
return new FixDiscountPolicy();
}
}
}앞전에 배운 같은 타입이 두개 존재하는거랑 비슷해보이지만 이건 구현체가 다르다.
부모타입으로 조회시 자식이 둘 이상 있을 때
@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("부모 타입으로 모두 조회하기")
void findAllBeanByParentType() {
Map<String, DiscountPolicy> beansOfType = ac.getBeansOfType(DiscountPolicy.class);
assertThat(beansOfType.size()).isEqualTo(2);
for (String key : beansOfType.keySet()) {
System.out.println("key = " + key + " value = " + beansOfType.get(key));
}
}DiscountPolicy타입으로 조회를 하게되면 2가지의 빈이 조회된다.FixDiscountPolicy,RateDiscountPolicy가 조회된다.
- 결과
그렇다면 자바의 최고 부모인 Object 타입으로 조회하면 어떻게될까?
Object 타입으로 모두 조회
@Test
@DisplayName("부모 타입으로 모두 조회하기 - Object")
void findAllBeanByObjectType() {
Map<String, Object> beansOfType = ac.getBeansOfType(Object.class);
for (String key : beansOfType.keySet()) {
System.out.println("key = " + key + " value = " + beansOfType.get(key));
}
}- 결과
- 내가 직접 등록한 빈 뿐만아니라 스프링에는 기본적으로 등록되어있는 빈이 무수히 많다.
- 이러한 빈들까지 다 조회가 되어 가져와진다.
