[spring] 수동 빈 등록 vs 컴포넌트 스캔 (예제실습)

목차

1. 서론
2. 수동 빈 등록
3. 컴포넌트 스캔 
4. 수동, 자동 언제 사용하나요?

서론

백 번 보는 것 보다 한번 만들어 보는것이 낫겠다 싶어서 예제를 만들어 본 후, 정리해 보려고 합니다. 제가 만들고 싶은 예제는 다음과 같습니다.

치킨 가게의 요리사는 치킨 레시피에 의존합니다. 만약 치킨 레시피가 변경된다면, 요리사는 치킨을 새로운 방법으로 만들게 됩니다. 치킨 레시피는 총 2개로 카레 치킨과 후라이드 치킨이 있습니다. 

수동 빈 등록

먼저, ChickenChef 클래스를 생성한 뒤, 생성자를 통한 의존관계 주입을 설정합니다. log라는 현재 주입된 스프링 빈을 출력하는 간단한 로직도 추가했습니다.

package hello.core.chicken;

public class ChickenChef{
    private final ChickenRecipe chickenRecipe;

    public ChickenChef(ChickenRecipe chickenRecipe) {  //생성자
        this.chickenRecipe = chickenRecipe;
    }

    public String log() {
        return this.chickenRecipe.toString();
    }

}

이제 ChickenRecipe라는 인터페이스를 하나 만든 후, 인터페이스를 상속하는 CurryChickenRecipe와 FriedChickenRecipe 클래스를 생성해줍니다.

package hello.core.chicken;

public class CurryChickenRecipe implements ChickenRecipe{
    public CurryChickenRecipe() { System.out.println("카레~");}
}

package hello.core.chicken;

public class FriedChickenRecipe implements ChickenRecipe{
    public FriedChickenRecipe() { System.out.println("후라이드~");}
}

이제 Configuration 설정만 하면 되겠군요. @Configuration, @Bean을 이용하여 스프링 빈에 등록해줍니다. 저는 후라이드 치킨을 더 좋아하니 후라이드 치킨을 주입하겠습니다.

package hello.core;

@Configuration
public class AppConfig {
    @Bean
    public ChickenChef chickenChef() {
        return new ChickenChef(chickenRecipe());
    }
    @Bean
    public ChickenRecipe chickenRecipe() {return new FriedChickenRecipe();}
}

실행 코드는 대충 이런식으로 작성해보았습니다. 어떤 ChickenChef에 스프링 빈이 주입되었는지 출력하는 간단한 코드입니다.

package hello.core.chicken;

import hello.core.AppConfig;
import hello.core.AutoAppConfig;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class app {
    public static void main(String[] args) {
        ApplicationContext ac = new AnnotationConfigApplicationContext(AppConfig.class);
        //ApplicationContext ac = new AnnotationConfigApplicationContext(AutoAppConfig.class);

        ChickenChef chickenChef = ac.getBean(ChickenChef.class);

        String a = chickenChef.log();
        System.out.println("a = " + a);
    }
}

결과는 후라이드 치킨 빈이 잘 주입되어 있는 것을 확인할 수 있습니다.

---

컴포넌트 스캔

이제 컴포넌트 스캔 방식으로 같은 내용을 진행해 보겠습니다. ChickenChef 클래스에서 @Component 어노테이션을 클래스 위에 추가하고, @Autowired를 생성자 위에 추가합니다.

package hello.core.chicken;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class ChickenChef{
    private final ChickenRecipe chickenRecipe;

    @Autowired
    public ChickenChef(ChickenRecipe chickenRecipe) {  //생성자
        this.chickenRecipe = chickenRecipe;
    }

    public String log() {
        return this.chickenRecipe.toString();
    }

}

치킨 레시피들도 스프링 빈으로 등록해야 하므로 클래스 위에 @Component를 추가해줍니다. 이번에는 카레 치킨을 주입하기 CurryChickenRecipe 위에 @Primary(우선순위설정)을 추가로 설정합니다.

package hello.core.chicken;

import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

@Component
@Primary
public class CurryChickenRecipe implements ChickenRecipe{
    public CurryChickenRecipe() { System.out.println("카레~");}
}

package hello.core.chicken;

import org.springframework.stereotype.Component;

@Component
public class FriedChickenRecipe implements ChickenRecipe{
    public FriedChickenRecipe() { System.out.println("후라이드~");}
}

기존의 AppConfig 대신, AutoAppConfig를 생성하여 @ComponetScan을 붙여줍니다. 이때 필터가 없으면 기존의 AppConfig도 스캔하므로 AutoAppConfig만 스캔하도록 필터를 추가해줍니다. 

package hello.core;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;

@Configuration
@ComponentScan(excludeFilters = @ComponentScan.Filter(type= FilterType.ANNOTATION, classes = Configuration.class))
public class AutoAppConfig {
}

자 이제 결과를 확인해보면, CurryChickenRecipe가 잘 주입된 것을 확인할 수 있습니다.

자동, 수동 언제 사용하나요?

편리한 자동 기능을 기본으로 사용합니다.

애플리케이션은 크게 업무 로직과 기술 지원 로직으로 나눌 수 있습니다.

• 업무 로직 빈: 웹을 지원하는 컨트롤러, 핵심 비즈니스 로직이 있는 서비스, 데이터 계층의 로직을 처리하는 리포지토리 등이 모두 업무 로직입니다. 보통 비즈니스 요구사항을 개발할 때 추가되거나 변경됩니다.
• 기술 지원 빈: 기술적인 문제나 공통 관심사(AOP)를 처리할 때 주로 사용됩니다. 데이터베이스 연결이나, 공통 로그 처리 처럼 업무 로직을 지원하기 위한 하부 기술이나 공통 기술들입니다.
• 업무 로직은 숫자도 매우 많고, 한번 개발해야 하면 컨트롤러, 서비스, 리포지토리처럼 어느정도 유사한 패턴이 있습니다. 이런 경우 자동 기능을 적극 사용하는 것이 좋습니다. 보통 문제가 발생해도 어떤 곳에서 문제가 발생했는지 명확하게 파악하기 쉽습니다.
• 기술 지원 로직은 업무 로직과 비교해서 그 수가 매우 적고, 보통 애플리케이션 전반에 걸쳐서 광범위하게 영향을 미칩니다. 그리고 업무 로직은 문제가 발생했을때 어디가 문제인지 명확하게 잘 드러나지만, 기술 지원 로직은 적용이 잘 되고 있는지 아닌지 조차 파악하기 어려운 경우가 많습니다. 그래서 이런 기술 지원 로직들은 가급적 수동 빈 등록을 사용해서 명확하게 드러내는 것이 좋습니다.

애플리케이션에 광범위하게 영향을 미치는 기술 지원 객체는 수동 빈으로 등록해서 딱! 설정 정보에 바로 나타나게 하는 것이 유지보수 하기 좋습니다. 

 

즉, 편리한 자동 기능을 기본으로 사용하되 직접 등록하는 기술 지원 객체는 수동 등록합니다.

 

 

전체 코드는 github에 올려두었습니다.

toki0411/Spring-Playground

간단한 예제인데도 처음 해보니까 조금 헤맸네요..ㅜㅜ

참고

김영한 님의 스프링 핵심원리 기본편 강의 섹션 6,7