Dependency Injection.
의존성 주입.
이는 소프트웨어 공학과 객체 지향 프로그래밍에서 사용되는 개념 중 하나이다.
클래스나 모듈 사이의 의존 관계를 느슨하게 만들어 주는 디자인 패턴 중 하나이기도 하다.
객체가 필요로 하는 의존성을, 자신이 직접 생성하는 대신 외부에서 주입받도록 하는 게 DI다.
어떤 객체가 다른 객체의 특정한 성질에 의존한다 생각해 보자.
예를 들어, 자동차는 엔진이 필요하다.
그러면 Car 클래스는 Engine 객체에 의존한다.
Car 클래스는 Engine 객체를 사용하여 움직이기 때문이다.
// Engine 클래스 정의
public class Engine {
public void start() {
System.out.println("Engine is started.");
}
}
// Car 클래스 정의
public class Car {
private Engine engine; // Engine 객체에 의존
public Car(Engine engine) {
this.engine = engine;
}
public void startCar() {
engine.start();
System.out.println("Car is moving.");
}
}
// 메인 클래스에서 의존성 주입을 통해 Car 객체 생성 및 사용
public class Main {
public static void main(String[] args) {
// Engine 객체 생성
Engine engine = new Engine();
// Car 객체 생성 및 의존성 주입
Car car = new Car(engine);
// Car 객체를 사용하여 자동차 시작
car.startCar();
}
}
이렇게 DI하지 않으면 코드가 어떻게 될까?
// Engine 클래스 정의
public class Engine {
public void start() {
System.out.println("Engine is started.");
}
}
// Car 클래스 정의 (DI를 사용하지 않음)
public class Car {
private Engine engine; // Engine 객체에 의존
public Car() {
// 의존성을 하드 코딩하여 Engine 객체 생성
this.engine = new Engine();
}
public void startCar() {
engine.start();
System.out.println("Car is moving.");
}
}
// 메인 클래스에서 Car 객체 생성 및 사용
public class Main {
public static void main(String[] args) {
// Car 객체 생성
Car car = new Car();
// Car 객체를 사용하여 자동차 시작
car.startCar();
}
}
얼핏 보면 큰 문제가 없어 보인다.
과연 그럴까.
위 코드에서 Car 클래스는 생성자에서 Engine 객체를 직접 생성하고 있다.
하드코딩이다.
이러면 Car 클래스를 수정하거나 특정 상황에 따라 다른 종류의 Engine 객체를 사용하기가 어려워진다.
테스트할 때도 실제 Engine 객체를 사용해야 해 테스트가 어려워진다.
DI를 하면
의존성을 외부에서 주입받기 때문에
1) 객체 간의 결합이 느슨해지고
2) 유언성과
3) 테스트 용이성이 향상돼 좋다.
DI에도 종류가 있다.
아니, 많다.
1) 생성자 주입
가장 일반적인 DI 방법 중 하나다.
의존성을 객체 생성자를 통해 주입한다.
이는 클래스의 생성 시점에 의존성이 주입되므로 안정적이고 불변한 객체를 생성한다.
2) 세터 주입
의존성을 객체의 세터 메서드를 통해 주입한다.
이 방법은 선택적인 의존성을 다룰 때 유용하며, 객체 생성 후에도 의존성을 변경할 수 있는 게 특징이다.
3) 메서드 주입
메서드의 매개변수를 통해 의존성을 주입한다.
주로 특정 메서드에만 필요한 의존성을 주입할 때 사용된다.
4) 필드 주입
의존성을 클래스의 필드(멤버 변수)에 직접 주입하는 방식이다.
생성자나 세터 메서드를 사용하지 않고, 주로 DI 컨테이너가 자동으로 주입하는 경우에 활용된다.
하지만 필드 주입은 일부 경우에는 테스트하기 어렵다는 단점이 있다.
5) 자동 의존성 주입
주로 스프링과 같은 프레임워크에서 제공되는 방식으로, DI 컨테이너가 객체 간의 의존성을 자동으로 관리한다.
클래스나 메타데이터를 통해 의존성을 자동으로 주입할 수 있으며, 개발자가 직접 코드를 작성하지 않아도 되는 게 특징이다.
6) 인터페이스 기반 주입
의존성을 인터페이스를 통해 주입하는 방법이다.
이를 통해 다형성을 활용하고, 객체의 구체적인 구현에 대한 의존성을 낮출 수 있다.
7) 설정 파일 기반 주입
XML 또는 프로퍼티 파일과 같은 설정 파일을 사용하여 의존성을 주입하는 방법이다.
주로 복잡한 의존성 관리나 다양한 환경 설정을 다룰 때 활용된다.
8) 컨텍스트 주입
DI 컨테이너나 컨텍스트에 따라 의존성을 다르게 주입하는 방법이다.
예를 들어 개발, 테스트, 프로덕션 환경에 따라 다른 의존성을 주입하는 것을 말한다.
9) 어노테이션 기반 주입
어노테이션을 사용하여 의존성을 주입하는 방법으로, 스프링 프레임워크에서 @Autowired, @Qualifier, @Resource와 같은 어노테이션을 활용한다.
10) 순수 자바로 구현한 DI
DI 컨테이너 없이 순수 자바 코드로 의존성 주입을 구현하는 방법이다.
객체 생성과 의존성 주입을 개발자가 수동으로 처리한다.
나는 주로 스프링부트를 사용하니 이를 기준으로 기록하겠다.
1) 생성자 주입
스프링 부트에서 DI를 적용할 때 가장 일반적인 방법 중 하나이다.
클래스의 생성자를 사용하여 의존성을 주입한다.
스프링 부트는 생성자 주입을 권장한다.
@Service
public class MyService {
private final MyRepository repository;
@Autowired
public MyService(MyRepository repository) {
this.repository = repository;
}
}
2) 세터 주입
세터 메서드를 통해 의존성을 주입하는 방법이다.
@Service
public class MyService {
private MyRepository repository;
public void setRepository(MyRepository repository) {
this.repository = repository;
}
}
3) 필드 주입
클래스의 필드에 직접 의존성을 주입하는 방법이다.
@Service
public class MyService {
private MyRepository repository;
}
4) 자동 스캔과 컴포넌트 스캔
스프링 부트는 클래스의 패키지 스캔을 통해 자동으로 빈(bean)을 등록하고 의존성을 주입할 수 있는 기능을 제공한다.
@SpringBootApplication 어노테이션이 있는 클래스가 있는 패키지와 하위 패키지를 스캔하여 빈을 자동으로 등록한다.
@SpringBootApplication
public class MyApplication {
public static void main(String[] args) {
SpringApplication.run(MyApplication.class, args);
}
}
5) 프로퍼티 주입
application.properties 또는 application.yml 파일에서 프로퍼티 값을 설정하고 @Value 어노테이션을 사용하여 프로퍼티 값을 주입할 수 있다.
@Service
public class MyService {
@Value("${my.property}")
private String myProperty;
}
1) 일반적으로 생성자 주입이 권장된다.
이렇게 하면 클래스의 의존성을 객체 생성 시점에 설정하므로 객체가 생성된 후에 불변하게 유지되기 때문이다.
객체가 immutable하게 유지되면 상태가 예측 가능하고 테스트하기 쉽다.
2) 자동 스캔과 컴포넌트 스캔을 활용하면 좋다.
프레임워크를 사용하면 스캔 기능으로 빈을 자동 등록해서 DI할 수가 있다.
주의할 부분
1) 필드 주입, 세터 주입은 되도록 하지 않는다.
2) 프로퍼티 주입도 덜 안전하니 신중히 사용한다.
3) 의존성은 단방향으로 유지한다.
4) 테스트 케이스 작성을 고려해서 DI를 설계한다.
2023년 기준...
1) 생성자 주입이 주류다.
2) 컴포넌트 스캔과 자동 스캔이 흔하다.
3) Lombok과 같은 라이브러리 활용이 증가한다.
4) 함수형 프로그래밍과 리액티브 프로그래밍이 증가한다.
5) 테스트 주도 개발(TDD)이 더 중요해진다.
6) 클라우드 네이티브와 마이크로서비스 아키텍처에서는 컨테이너 기반 DI가 중요하다.
7) 자바 모듈 시스템 활용이 증가한다.