Spring Bean / IoC Container / DI

Goal

• Spring Bean
• Spring IoC Container
• Dependency Injection (DI)
  • Constructor Injection
  • Method Injection
  • Setter Injectio

---

Spring Bean

Spring Bean 으로 등록된 클래스는 IoC Contrainer 에 의해 생성된 Singleton 객체를 의미하며, Bean 으로 등록된 클래스만 컨테이너를 통해 의존성이 주입(Dependency Injection)되어 객체의 생명주기를 개발자가 아닌 컨테이너가 관리하도록 한다.

Register Bean

• @Bean
  • @Bean 은 @Configuration 이 붙은 DI 설정용 클래스에서 사용되는 어노테이션으로, 메소드를 이용해 Bean Object 의 생성과 의존 관계 주입을 수행한다.

@Configuration
class DataSourceConfig {
    @Bean
	fun dataSource(): DataSource {
        val dataSource = SimpleDriverDataSource()

        dataSource.setDriverClass(Driver::class.java)
        dataSource.url = "jdbc:mysql://localhost/springbook?characterEncoding=UTF-8"
        dataSource.username = "user"
        dataSource.password = "password"

        return dataSource
    }
}

• @Autowired
  • Spring Framework 는 @Autowired 가 붙은 수정자 메소드(Setter) 가 있으면 파라미터 타입을 보고 주입 가능한 타입의 Bean 을 모두 검색하여 주입한다.
  • 이같은 @Autowired 어노테이션을 이용하면 손쉽게 의존성을 주입할 수 있어 DI 관련 코드를 대폭 줄일 수 있어서 코드를 간결히 작성할 수 있는 장점이 있지만, Bean 설정 정보를 보고 다른 빈과의 의존 관계가 어떤지 파악하기 힘들다는 단점이 있다.
  • 단, 의존 객체의 구현체가 두 개 이상인 경우 구현체 별로 다른 Bean 이름을 설정하여 최종 후보를 선택하도록 만들어야 한다.
    
    • @Component("AComponentImpl") 와 같이 Bean 객체의 이름을 지정한다.

// ProductServiceConfig
@Configuration
class ProductServiceConfig(
  	@Autowired
	private val productRepository: ProductRepository
) {
	@Bean
	fun productService(): ProductService = ProductService(productRepository)
}

// ProductRepositoryConfig
@Configuration
class ProductRepositoryConfig() {
	@Bean
	fun productRepository(): ProductRepository = ProductRepository()
}

• @Component
  • 해당 어노테이션은 클래스에서 사용 가능하며 Bean Scanner 를 통해 자동으로 Bean 객체로 등록된다.
  • @Componenet 어노테이션을 사용해 Bean 으로 등록하려면 @ComponentScan 과 같은 어노테이션을 추가적으로 사용하여 어떤 범위까지 스캔할 것인지 설정하는 과정이 필요하다.
    • @ComponentScan @Component 및 하위 어노테이션이 붙은 클래스를 어느 범위까지 검색할 수 있을지 설정하기 위해 사용된다. 패키지를 기준으로 하며 설정 가능한 패키지는 다중 선택이 가능하다. 
  • @Controller, @Service, @Repository 등

@Target(AnnotationTarget.CLASS)
@Retention(AnnotationRetention.RUNTIME)
@MustBeDocumented
@Component
annotation class WebAdapter(
    @get:AliasFor(annotation = Component::class)
    val value: String = ""
)

---

Spring IoC Container

Spring IoC Container() 는 DI(Dependency Injection) 과 밀접한 관계를 맺고 있다. 이러한 Spring Container 는 다음과 같은 경우에 객체를 정의하도록 하는 프로세스를 거친다.

ApplicationContext 는 Spring IoC Container 의 Bean 클래스의 인스턴스화, 구성 및 조립 등을 담당하는 역할이다. 이로 인해 컨테이너는 설정 메타데이터 를 통해 Bean 인스턴스 생성 설정을 읽어 들인다. 설정 메타데이터는 XML 이나 Java Annotation, Java Code 등으로 설정 가능하다.

Spring Framework 는 ApplicationContext 인터페이스의 여러 구현체를 제공하는데, ClassPathxmlApplicationContext, FileSystemXmlApplicationContext 클래스의 인스턴스가 사용되는 것이 일반적이다. 기존에는 XML 을 통해 설정 메타데이터를 정의 했으나 이러한 형식을 Java Annotation 이나 Code 를 이용해 선언적으로 작성할 수 있도록 컨테이너에서 조작 가능하다.

Config Metadata Annotation

• @Import
  • @Configuration으로 설정한 파일을 두 개 이상 사용하는 경우

@Import(QueryFactoryConfig::class)
@Configuration
class JpaQueryFactoryConfig {

    @PersistenceContext
    private lateinit var entityManager: EntityManager

    @Bean
    fun queryFactory() = JPAQueryFactory(this.entityManager)
}

•  @DependsOn
  • 빈이 등록되는 순서를 지정하는 어노테이션

@Component("calculator-2")
@DependsOn(value = ["calculator-1"])
class Calculator(
        var number: Int
)

---

Dependency Injection

Dependency Injection(DI)는 Bean 객체에서 필요한 외부의 Bean 객체를 주입하도록 하는 프로세스이다. 이러한 DI 원칙에 의해 코드를 깔끔하게 작성할 수 있어며, 객체 간 종속성에 대한 Decoupling 을 효과적으로 다룰 수 있다. 또한, 의존이 필요한 Bean 객체는 외부에서 주입받는 Bean 객체의 위치나 구현체를 알 수 없다. 즉, 인터페이스나 추상 클래스를 주입 받음으로써 테스트 진행이 용이해지도록 하며 유연한 확장이 가능하도록 한다. 이러한 DI 는 개방 폐쇄 원칙의 관점에서 폐쇄의 관점에서 볼 때 재사용이 가능하다는 점은 철저히 해당 원칙을 준수하고 있다고 볼 수 있다.

DI 활용 방법

• 핵심 기능 변경
  • 의존 대상의 구현을 바꿔 핵심 기능의 동작 방식을 다른 구현체로 변경 할 수 있다. 이러한 특징은 기존 JDBC 를 사용하다가 JPA 나 MyBatis 등으로 구현체를 통째로 변경하는 것으로 예시를 들 수 있다.
• 핵심 기능의 동적인 변경
  • DI 는 기본적으로 런타임 시 동적으로 의존 오브젝트를 연결해주지만, 한 번 의존성이 주입되고 나면 그 후로는 구현체가 변경되지 않는다. 즉, 정적인 관계로 의곤관계를 맺어주는 것이다. 하지만 DI 를 잘 활용하면 애플리케이션이 동작하는 중간에 의존하는 구현체를 동적으로 변경할 수 있다. 이는 Dynamic Routing Proxy / Proxy Object 기법을 활용하여 응용할 수 있다.
  • 회원의 등급에 따라 다른 구현체를 사용하도록 하거나 사용자별로 독립적인 의존 오브젝트를 사용하게끔 한다.
• 부가 기능 추가
  • 기존 구현된 핵심 기능은 그대로 둔채 추가적으로 부가 기능을 구현 할 수 있다. 그 예시로 Decorator 패턴이 있다. 의존 오브젝트는 인터페이스를 사용하게 하도록 하고, 실제 사용할 오브젝트는 DI 를 적용하도록 하면 Decorator 패턴을 쉽게 적용할 수 있다.
• 인터페이스 변경
  • Proxy
    • 필요한 시점에서 실제 사용할 오브젝트를 초기화하고 리소스를 준비하게 해주는 Lazy Loading 적용 시 Proxy 객체를 이용하도록 한다.
  • Template / Callback
    • 반복적으로 등장하지만 항상 고정적인 작업 흐름과 그 사이에서 자주 바뀌는 부분을 분리해서 Template 과 Callbak 으로 만들어 DI 원리를 응요해 적용하면 반복적으로 작성된 지저분한 코드를 간결하게 만들 수 있다.
  • Singleton / Object Scope
    • Spring DI 는 기본적으로 Singleton 으로 Bean 객체를 만들어 사용하도록 한다. 이 덕분에 IoC Container 는 Bean 으로 등록된 Singleton 객체의 생명주기를 직접 제어하게 되어 개발자는 이를 활용해 자유롭게 설계할 수 있다는 장점을 가진다.
    • 때로는 Singleton 생명주기 뿐만 아니라 임의의 생명주기를 갖는 객체가 필요할 때도 있다. HTTP 요청 당 하나의 객체가 만들어지거나, HTTP Session 하나 당 새로운 객체가 만들어지게끔 할 수 있다.
  • Test
    • 의존 객체를 대신해서 동작할 Stub / Mock 객체를 이용해 테스트에 사용할 수 있다. DI 를 위해 만든 수정자 메소드를 사용하면 테스트 코드 안에서 수동으로 Mock 객체를 주입할 수 있다.

의존성 주입 방식

• Constructor Inject
  • 생성자 기반 DI 는 컨테이너가 생성자를 통해 여러 인자를 호출하여 의존성을 주입하게 된다. 이는 정적 팩토리 메소드를 호출하는 것와 동등하며, 의존 인자를 유사하게 다룬다.

@RestController
class ProductController(
	private val getProductsUseCase: GetProductsUseCase
)

• Setter Inject

@RestController
class ProductController(
	lateinit var getProductsUseCase: GetProductUseCase
)

• Field Inject

@RestController
class ProductController(
    @Autowired
    private val getProductUseCase: GetProductUseCase
)