스프링 컨테이너에서 빈 등록 및 조회하기

심현민·2024년 9월 7일
0

Spring

목록 보기
6/18

 ApplicationContext ac = 
new AnnotationConfigApplicationContext(AppConfig.class);
  • ApplicationContext는 자바 스프링 컨테이너이자 인터페이스이다.

  • AnnotationConfigApplicationContext는 구현체이다.

  • 파라미터인 AppConfig.class를 구성 정보로 지정

  • AppConfig.class 내부에 @Bean 어노테이션으로 지정된 메소드를 스프링 빈 저장소에 저장

  • 빈 이름은 일반적으로 @Bean 어노테이션 지정된 메소드 명이 들어감

  • public MemberRepository memberRepository() {...} memberRepository가 빈 이름이 됨

  • @Bean(name = "ThisIsBeanName")로 이름 지정 가능

빈 이름은 반드시 고유(Unique) 해야한다. 고유하지 않을 시 기존 빈을 덮어버리거나 다른 빈이 무시되는 오류가 발생한다.

스프링은 빈 생성 단계와 의존성 주입(DI) 단계가 구분된다.

MemberService memberService = 
applicationContext.getBean("memberService", MemberService.class);

getBean(빈의 이름, 빈의 타입)은 사용할 빈 객체를 구하는 메서드이다.
메인 메서드에서 사용할 때 AppConfig에 등록한 빈 객체를 반환하는 메서드이다.





AppConfig.class

package com.example.demo;
import com.example.demo.discount.DiscountPolicy;
import com.example.demo.discount.RateDiscountPolicy;
import com.example.demo.member.MemberRepository;
import com.example.demo.member.MemberService;
import com.example.demo.member.MemberServiceImpl;
import com.example.demo.member.MemoryMemberRepository;
import com.example.demo.order.OrderService;
import com.example.demo.order.OrderServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

//팩토리 메소드를 통해 등록하는 방법
@Configuration

public class AppConfig {

    @Bean
    public MemberService memberService(){
        return new MemberServiceImpl(memberRepository());
    }
    @Bean
    public MemberRepository memberRepository(){
        return new MemoryMemberRepository();
    }
    @Bean
    public OrderService orderService(){
        return new OrderServiceImpl(memberRepository(), discountPolicy());
    }
    @Bean
    public DiscountPolicy discountPolicy(){
//        return new FixDiscountPolicy();
        return new RateDiscountPolicy();
    }
}

@Bean을 통해 등록한 빈들을 편하게 꺼내서 쓸 수 있다.






빈 조회

package com.example.demo.beanfind;

import com.example.demo.AppConfig;
import com.example.demo.member.MemberRepository;
import com.example.demo.member.MemberService;
import com.example.demo.member.MemberServiceImpl;
import com.example.demo.member.MemoryMemberRepository;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

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

public class ApplicationContextBasicFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @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);
        System.out.println("memberService = " + memberService);
        System.out.println("memberService.getClass() = " + memberService.getClass());
    }

    @Test
    @DisplayName("빈 이름으로 조회")
    void findBeanByName2(){
        MemberRepository memberRepository = ac.getBean(MemberRepository.class);
        assertThat(memberRepository).isInstanceOf(MemoryMemberRepository.class);
    }

    @Test
    @DisplayName("구체 타입으로 조회")
    void findBeanByName3(){
        MemberServiceImpl memberService = ac.getBean("memberService", MemberServiceImpl.class);
        assertThat(memberService).isInstanceOf(MemberServiceImpl.class);
    }

    @Test
    @DisplayName("빈 이름으로 조회X")
    void findBeanByNameX(){
//        MemberService xxxx = ac.getBean("xxxx", MemberService.class);
        assertThrows(NoSuchBeanDefinitionException.class,
                () -> ac.getBean("xxxx", MemberService.class));
    }
}
  • 구체 타입으로 조회하는 것은 안 좋은 방법이다.
  • 구현에 의존한 거라 유연성이 떨어져서 좋지 않다. (역할과 구현이 분리된 코드가 좋은 코드 )
  • 빈 이름으로 조회x 부분은 예외가 발생하므로 junitAssertions.asserThrows메서드에 람다식을 활용해 예외가 발생할 경우 코드가 성공하게끔 설정해서 테스트 해주었다.





빈 상속 조회

package com.example.demo.beanfind;

import com.example.demo.discount.DiscountPolicy;
import com.example.demo.discount.FixDiscountPolicy;
import com.example.demo.discount.RateDiscountPolicy;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.lang.annotation.Annotation;
import java.security.Key;
import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

public class ApplicationContextExtendsFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(TestConfig.class);

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 중복 오류가 발생한다.")
    void findBeanByParentTypeDuplicate(){
        assertThrows(NoUniqueBeanDefinitionException.class,
                () -> ac.getBean(DiscountPolicy.class));
    }

    @Test
    @DisplayName("부모 타입으로 조회시, 자식이 둘 이상 있으면, 빈 이름을 지정하면 된다")
    void findByParentTypeBeanName(){
        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));
        }
    }

    @Test
    @DisplayName("부모 타입으로 모두 조회하기 - Object")
    void findAllBeanByObject(){
        Map<String, Object> beansOfType = ac.getBeansOfType(Object.class);
        for (String key : beansOfType.keySet()) {
            System.out.println("key = "+ key +" value = "+ beansOfType.get(key));
        }
    }

    //자바 객체는 모든게 Object 타입이기 때문이다.

    @Configuration
    static class TestConfig{
        @Bean
        public DiscountPolicy rateDiscountPolicy(){
            return new RateDiscountPolicy();
        }

        @Bean
        public DiscountPolicy fixDiscountPolicy(){
            return new FixDiscountPolicy();
        }

    }
}
  • 자바의 최상위격인 Object 타입으로 조회시 모두 조회할 수 있다.
  • 부모 타입으로 조회시, 자식이 둘 이상인데 특정 빈을 조회하고 싶을 때는 빈 이름을 지정해서 조회해주면 된다.
    • 부모 타입 조회시 자식이, 둘 이상 있으면, 중복 오류가 발생하기 때문
  • 테스트 클래스 내에 빈 등록을 통해 상속 관계 메서드 두 개를 등록했다.
  • 또는 부모 타입으로 모두 조회할 수도 있다.





빈 조회

package com.example.demo.beanfind;

import com.example.demo.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);

        }

    }
    @Test
    @DisplayName("애플리케이션 빈 출력하기")
    void findApplicationBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanDefinitionName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanDefinitionName);

            //애플리케이션에서 쓰기위해 등록한 빈들만 출력
            if (beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION){
                Object bean = ac.getBean(beanDefinitionName);
                System.out.println("name = " + beanDefinitionName + " object = "+ bean);

            }

        }

    }
}
  • 우리가 등록한 빈이 제대로 등록되어있는지 조회할 수도 있다.
  • BeanDefinitionRole 구분
    • BeanDefinition.ROLE_APPLCATION : 사용자가 정의한 빈 정보
    • BeanDefinition.ROLE_INFRASTRUCTURE : 스프링이 내부에서 사용하는 빈 정보





빈 중복 오류 발생

package com.example.demo.beanfind;

import com.example.demo.AppConfig;
import com.example.demo.discount.DiscountPolicy;
import com.example.demo.member.MemberRepository;
import com.example.demo.member.MemoryMemberRepository;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.NoUniqueBeanDefinitionException;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.Map;

import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;


//자바는 클래스는 기본적으로 부모인 Object 타입을 extends 받고 있다.


public class ApplicationContextSameBeanFindTest {
    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(SameBeanConfig.class);

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류가 발생한다")
    void findBeanByTypeDuplicate(){
//        MemberRepository bean = ac.getBean(MemberRepository.class);
        assertThrows(NoUniqueBeanDefinitionException.class,
                () -> ac.getBean(MemberRepository.class));
    }

    @Test
    @DisplayName("타입으로 조회시 같은 타입이 둘 이상 있으면, 빈 이름을 지정하면 된다.")
    void findBeanByName(){
        MemberRepository memberRepository = ac.getBean("memberRepository1", MemberRepository.class);
        assertThat(memberRepository).isInstanceOf(MemoryMemberRepository.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);
    }

    @Configuration
    static class SameBeanConfig {
        @Bean
        public MemberRepository memberRepository1() {
            return new MemoryMemberRepository();
        }

        @Bean
        public MemberRepository memberRepository2() {
            return new MemoryMemberRepository();
        }

    }
}
  • 타입으로 조회시 같은 타입이 둘 이상 있으면, 중복 오류 발생
    • 빈 이름을 지정해서 해결하면 된다.
  • 특정 타입을 ac.getBeansOfType()을 통해 모두 조회할 수도 있다.



빈 설정 메타정보 확인

package com.example.demo.beandefinition;

import com.example.demo.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;
import org.springframework.context.support.GenericXmlApplicationContext;

public class BeanDefinitionTest {

    AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);

    @Test
    @DisplayName("빈 설정 메타정보 확인")
    void findApplicationBean(){
        String[] beanDefinitionNames = ac.getBeanDefinitionNames();
        for (String beanName : beanDefinitionNames) {
            BeanDefinition beanDefinition = ac.getBeanDefinition(beanName);

            if(beanDefinition.getRole() == BeanDefinition.ROLE_APPLICATION){
                System.out.println("beanDefinitionName = " + beanName +
                        " beanDefinition = "+beanDefinition);
            }

        }
    }
}
  • 스프링이 다양한 설정정보를 BeanDefinition으로 추상화 해서 사용함

  • Appconfig.class 는 Factorymethod로 작동하는 방식이다. (외부에서 메소드를 호출해서 작동하는 방식)

설정 메타정보

BeanClassName : 생성할 빈의 클래스 명(자바 Appconfig 처럼 팩토리 역할의 빈을 사용하면 없음)

factoryBeanName : 팩토리 역할의 빈을 사용할 경우 이름, 예)appConfig

factoryMethodName : 빈을 생성할 팩토리 메서드 지정, 예) memberService

Scope : 싱글톤(가본값)

lazyinit : 스프링 컨테이너를 생성할때 빈을 생성하는것이 아니라, 실제 빈을 사용할 때 까지 최대한 생성을 지연처리 하는 지 여부

InitMethodName : 빈을 생성하고 의존관계를 적용한 뒤에 호출되는 초기화 메서드 명

DestroyMethodName : 빈의 생명주기가 끝나서 제거하기 직전에 호출되는 메서드 명

Constructor arguments, Properties : 의존관계 주입에서 사용한다. (자바 설정 처럼 팩토리 역할의 빈을 사용하면 없음)

profile
혼자 성장하는 것보다 함께 성장하는 것을 선호합니다.

0개의 댓글