[Spring] IoC 컨테이너와 설정 방법

📌  DI(Dependency Injection)

의존성 주입은 객체를 생성할 때, 그 객체가 의존하고 있는 다른 객체들을 외부에서 주입해 주는 디자인 패턴이다.

interface MessageService {
    void sendMessage(String message, String receiver);
}

class EmailService implements MessageService {
    public void sendMessage(String message, String receiver) {
        // 이메일 보내기 로직
    }
}

 

위 코드에 있는 MessageService를 MyApplication에서 의존하고 있다면 다음과 같은 코드를 작성할 수 있다.

 

class MyApplication {
    private MessageService email = new EmailService();

    public void processMessages(String message, String receiver) {
        // 메시지 처리 로직
        email.sendEmail(message, receiver);
    }
}

 

MyApplication 내부에서 EmailService 인스턴스를 직접 생성하는 것을 볼 수 있다. 이는 EmailService와 MyApplication 사이의 높은 결합도를 야기하며, EmailService를 다른 서비스로 교체하려면 MyApplication의 코드를 변경해야 한다.

class MyApplication {
    private MessageService service;

    // 생성자를 통한 의존성 주입
    public MyApplication(MessageService svc) {
        this.service = svc;
    }

    public void processMessages(String message, String receiver) {
        // 메시지 처리 로직
        service.sendMessage(message, receiver);
    }
}

 

그래서 위와 같이 생성자를 통해 외부에서 의존성을 주입받으면 코드가 훨씬 유연해진다. EmailService와 MyApplication 간 결합도를 낮추는 것뿐만 아니라 테스트와 유지보수가 용이해진다는 이점 또한 얻을 수 있다.

 

📌  IoC(Inversion Of Control) 컨테이너

IoC는 제어의 역전이라는 개념으로, 객체의 생성 및 관리 책임을 개발자로부터 추상화된 프레임워크에게 위임하는 프로그래밍 원칙이다.

 

스프링 프레임워크에서는 IoC를 의존성 주입을 통해 구현한다. IoC 컨테이너는 애플리케이션의 메타데이터를 기반으로 객체를 생성하고 관리하며, 이 메타데이터는 XML 설정 파일 혹은 애테이션(@Component)을 통해 제공된다. 스프링 IoC 컨테이너는 이 메타데이터를 이용하여 객체의 인스턴스를 생성하고, 해당 객체들 간의 의존성을 주입하며, 생성된 Bean 인스턴스를 관리한다.

---

XML 기반 설정

package learn.controller;

import learn.service.HelloService;

public class HelloController {
    private HelloService helloService;

    public HelloService getHelloService() {
        return helloService;
    }

    public void setHelloService(final HelloService helloService) {
        this.helloService = helloService;
    }
}

package learn.service;

public class HelloService {
}

 

위와 같이 HelloService와 HelloController가 정의되었을 때, XML을 이용해 설정하기 위해서는 다음과 같이 XML 파일을 작성해야 한다.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans
		https://www.springframework.org/schema/beans/spring-beans.xsd">

    <bean id="helloController"
          class="learn.controller.HelloController">
        <property name="helloService" ref="service" />
    </bean>
    <bean id="service" class="learn.service.HelloService">
    </bean>
</beans>

 

위와 같이 <bean> 태그를 통해서 스프링 컨테이너에 Bean을 정의하고, <property> 태그를 사용하여 의존성 주입을 설정할 수 있다.

 

package learn;

import learn.service.HelloService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import learn.controller.HelloController;

public class Application {

    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
        HelloController helloController = context.getBean("controller", HelloController.class);
        HelloService injectedHelloService = helloController.getHelloService();
        System.out.println(helloController);

        HelloService helloService = context.getBean("service", HelloService.class);
        System.out.println(helloService.equals(injectedHelloService));
    }
}

 

 

resources 폴더 에 있는 XML 파일을 불러와서 ApplicationContext를 생성하고 파일에 설정된 id 값으로 해당 Bean을 조회하면 컨테이너가 내부적으로 생성한 Bean을 얻을 수 있다. 

 

실행 후에는 위와 같은 결과가 출력된다. 스프링 컨테이너는 기본적으로 Bean을 싱글톤으로 관리하기 때문에, ApplicationContext에서 직접 조회한 HelloService 인스턴스와 HelloController에 주입된 HelloService 객체가 일치하는 것을 볼 수 있다.

---

Annotation 기반 설정 

1. @Bean을 이용한 설정

package learn.config;

import learn.service.HelloService;
import learn.controller.HelloController;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class AppConfig {
    @Bean
    public HelloService helloService() {
        return new HelloService();
    }

    @Bean
    public HelloController helloController() {
        return new HelloController(helloService());
    }
}

 

@Configuration은 스프링 설정 정보(Bean 정의)를 담고 있는 객체임을 나타내는 애테이션이다. @Bean은 메서드 레벨로 사용되어, 해당 메서드가 생성한 객체를 스프링 Bean으로 등록하도록 하는 역할을 한다. @Configuration이 붙은 클래스 내부에 정의된 메서드에 @Bean을 사용하면, 그 메서드의 반환 객체는 스프링 컨테이너에 의해 관리되는 Bean으로 등록된다. 

package learn;

import learn.config.AppConfig;
import learn.controller.HelloController;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Application {

    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        HelloController helloController = context.getBean(HelloController.class);
        System.out.println(helloController);
        System.out.println(helloController.getHelloService());
    }
}

 

그래서 AppConfig를 통해 ApplicationContext를 불러오면 다음과 같이 Bean이 잘 등록된 것을 확인할 수 있다.

 

2. @Autowired와 @Component를 이용한 설정

@Component

• 클래스 레벨의 애너테이션으로 사용되며, 이를 사용하면 Spring 프레임워크가 해당 클래스를 자동으로 찾아 Spring IoC 컨테이너에서 관리하는 Bean으로 등록한다.
• @Repository, @Service, @Controller 등은 @Component의 특화된 형태로, 각각의 영역(예를 들어, 데이터 액세스 계층, 서비스 계층, 프레젠테이션 계층)에 맞게 추가적인 특징을 제공한다.

@Autowired

• @Autowired는 클래스의 필드, 세터, 생성자에 사용할 수 있으며, Spring IoC 컨테이너에 의해 자동으로 의존성이 주입된다.
• 생성자, 필드, 세터 메서드에 적용할 수 있으나, 의존성 주입에 있어서 생성자 주입 방식이 권장된다. 이는 주입 받는 객체들을 불변(immutable)으로 유지할 수 있게 해주며, 순환 의존성 문제를 방지하고 테스트 용이성을 개선하는 등의 이점이 있다.
• 생성자가 하나만 존재하고, 해당 생성자의 파라미터 타입들이 Bean으로 등록 가능할 때는 @Autowired 애너테이션을 생략할 수 있다. 스프링은 그러한 경우에 자동으로 생성자를 통한 의존성 주입을 시도한다.

package learn.service;

import org.springframework.stereotype.Service;

@Service
public class HelloService {
}

package learn.controller;

import learn.service.HelloService;
import org.springframework.stereotype.Controller;

@Controller
public class HelloController {
    private HelloService helloService;

    // @Autowired 생략
    public HelloController(HelloService helloService) {
        this.helloService = helloService;
    }

    public HelloService getHelloService() {
        return helloService;
    }
}

package learn.config;

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

@Configuration
@ComponentScan(basePackages = "learn")
public class AppConfig {
}

package learn;

import learn.config.AppConfig;
import learn.controller.HelloController;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Application {

    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class);
        HelloController helloController = context.getBean(HelloController.class);
        System.out.println(helloController);
        System.out.println(helloController.getHelloService());
    }
}

 

위와 같이 HelloController와 HelloService를 각각 @Controller와 @Service 애너테이션을 통해 Bean으로 등록한 후 애플리케이션을 실행하면 다음과 같이 등록된 빈을 확인할 수 있다.

 

 

📌 Annotaion Based와 XML과의 관계

Annotaion Based 설정

애너테이션 기반 설정은 Spring에서 객체의 생성과 의존성 주입을 파일 대신 클래스, 메서드, 또는 필드 선언에 직접 사용하여 재구성을 수행한다.

 

Annotaion Based의 장점

1. 코드 내 관련성

애너테이션을 사용함으로써, 의존성 관리와 관련된 설정 정보가 코드 내에 위치하게 되므로, 코드를 읽는 사람은 클래스의 역할과 의존성 관리 방식을 한눈에 볼 수 있다.

 

2. 간편한 설정

XML 기반 설정에 비해 간결하고 명확한 설정이 가능해진다. 복잡한 파일을 관리하는 대신 클래스에 직접 애너테이션을 적용하여 의존성을 주입받을 수 있다. 

 

3. 유지보수성 향상

애너테이션을 활용한 설정은 코드의 재사용성을 높이고 유지보수를 용이하게 한다. @ComponentScan을 활용하면 지정된 패키지에서 @Component, @Service 등의 애너테이션을 갖는 클래스들을 자동으로 스캔하여 빈을 등록할 수 있고, 애플리케이션 규모가 커지더라도 관리가 쉽다.

 

XML과의 관계

애너테이션 기반 설정과 XML 설정은 상호 보완적으로 사용될 수 있다. 애너테이션이 클래스에 직접 적용되어 가독성이 높아지지만, XML을 사용하면 클래스를 수정하지 않고도 의존성을 주입할 수 있다는 장점이 있다. 실제로 Spring은 애너테이션과 XML 설정을 혼합하여 사용하는 것을 허용한다. 단, 애너테이션을 이용한 주입이 XML을 통한 주입보다 우선시된다. 절대적으로 어느 방식이 더 낫다는 결론을 내리기 어렵기에 상황에 따라 적절한 방식을 선택하는 것이 좋을 것 같다.

 

 

 

https://docs.spring.io/spring-framework/reference/core/beans/annotation-config.html#page-title

https://docs.spring.io/spring-framework/reference/core/beans/java/configuration-annotation.html

https://docs.spring.io/spring-framework/reference/core/beans/introduction.html

https://docs.spring.io/spring-framework/reference/core/beans/basics.html