-
[spring] 의존성 주입(DI)JAVA 2021. 8. 13. 09:47
1. 의존성 주입(Dependency Injection)의 개념과 필요성
[ 의존성 주입(Dependency Injection) 이란? ]
Spring 프레임워크는 3가지 핵심 프로그래밍 모델을 지원하고 있는데, 그 중 하나가 의존성 주입(Dependency Injection, DI) 이다.
DI란 외부에서 두 객체 간의 관계를 결정해주는 디자인 패턴으로, 인터페이스를 사이에 둬서 클래스 레벨에서는 의존관계가 고정되지 않도록 하고 런타임 시에 관계를 다이나믹하게 주입하여 유연성을 확보하고 결합도를 낮출 수 있게 해준다.
의존성이란 한 객체가 다른 객체를 사용할 때 의존성이 있다고 한다.
[ 의존성 주입(Dependency Injection)이 필요한 이유 ]
예를 들어 연필이라는 상품과 1개의 연필을 판매하는 Store 클래스가 있다고 하자.
public class Pencil { }public class Store { private Pencil pencil; public Store() { this.pencil = new Pencil(); } }1. 두 클래스가 강하게 결합되어 있음
위와 같은 Store 클래스는 현재 Pencil 클래스와 강하게 결합되어 있다는 문제점을 가지고 있다. 두 클래스가 강하게 결합되어 있어서 만약 Store에서 Pencil이 아닌 Food와 같은 다른 상품을 판매하고자 한다면 Store 클래스의 생성자에 변경이 필요하다. 즉, 유연성이 떨어진다. 각각의 다른 상품들을 판매하기 위해 생성자만 다르고 나머지는 중복되는 Store 클래스들이 파생되는 것은 좋지 못하다. 이에 대한 해결책으로 상속을 떠올릴 수 있지만, 상속은 제약이 많고 확장성이 떨어지므로 피하는 것이 좋다.
2. 객체들 간의 관계가 아니라 클래스 간의 관계가 맺어지고 있음
또한 위의 Store와 Pencil는 객체들 간의 관계가 아니라 클래스들 간의 관계가 맺어져 있다는 문제가 있다. 올바른 객체지향적 설계라면 객체들 간에 관계가 맺어져야 하지만 현재는 Store 클래스와 Pencil 클래스가 관계를 맺고 있다. 객체들 간에 관계가 맺어졌다면 다른 객체의 구체 클래스(Pencil인지 Food 인지 등)를 전혀 알지 못하더라도, (해당 클래스가 인터페이스를 구현했다면) 인터페이스의 타입(Product)으로 사용할 수 있다.
결국 위와 같은 문제점이 발생하는 근본적인 이유는 Store에서 불필요하게 어떤 제품을 판매할 지에 대한 관심이 분리되지 않았기 때문이다. Spring에서는 DI를 적용하여 이러한 문제를 해결하고자 하였다.
[ 의존성 주입(Dependency Injection)을 통한 문제 해결 ]
위와 같은 문제를 해결하기 위해서는 우선 다형성이 필요하다. Pencil, Food 등 여러 가지 제품을 하나로 표현하기 위해서는 Product 라는 Interface가 필요하다. 그리고 Pencil에서 Product 인터페이스를 우선 구현해주도록 하자.
public interface Product { }public class Pencil implements Product { }이제 우리는 Store와 Pencil이 강하게 결합되어 있는 부분을 제거해주어야 한다. 이를 제거하기 위해서는 다음과 같이 외부에서 상품을 주입(Injection)받아야 한다.
public class Store { private Product product; public Store(Product product) { this.product = product; } }여기서 Spring이 DI 컨테이너를 필요로 하는 이유를 알 수 있는데,
우선 Store에서 Product 객체를 주입하기 위해서는 애플리케이션 실행 시점에 필요한 객체(빈)를 생성해야 하며,
의존성이 있는 두 객체를 연결하기 위해 한 객체를 다른 객체로 주입시켜야 하기 때문이다.
예를 들어 다음과 같이 Pencil 이라는 객체를 만들고, 그 객체를 Store로 주입시켜주는 역할을 위해 DI 컨테이너가 필요하게 된 것이다.
//DI 컨테이너 역할 : 웹 어플리케이션 실행 시 이 작업을 하는 것이다. public class BeanFactory { public void store() { // Bean의 생성 Product pencil = new Pencil(); // 의존성 주입 Store store = new Store(pencil); } }그리고 이러한 개념은 제어의 역전(Inversion of Control, IoC)라고 불리기도 한다. 어떠한 객체를 사용할지에 대한 책임이 BeanFactory와 같은 클래스에게 넘어갔고, 자신은 수동적으로 주입받는 객체를 사용하기 때문이다. (실제 Spring에서는 BeanFactory를 확장한 Application Context를 사용한다.)
2. 의존성 주입(Dependency Injection, DI) 정리
[ 의존성 주입(Dependency Injection) 정리 ]
한 객체가 어떤 객체(구체 클래스)에 의존할 것인지는 별도의 관심사이다. Spring에서는 DI 컨테이너를 통해 서로 강하게 결합되어 있는 두 클래스를 분리하고, 두 객체 간의 관계를 결정해 줌으로써 결합도를 낮추고 유연성을 확보하고자 하였다. 의존성 주입으로 애플리케이션 실행 시점에 객체를 생성하고 관계를 결정해 줌으로써 다른 구체 클래스에 의존하는 코드를 제거하며 서로 다른 두 객체의 결합을 약하게 만들어 주었다. 또한 이러한 방법은 상속보다 훨씬 유연하다. 단, 여기서 주의해야 하는 것은 다른 빈을 주입받으려면 자기 자신이 반드시 컨테이너의 빈이여야 한다는 것이다.
- 두 객체 간의 관계라는 관심사의 분리
- 두 객체 간의 결합도를 낮춤
- 객체의 유연성을 높임
- 테스트 작성을 용이하게 함
하지만 의존 관계를 주입할 객체를 계속해서 생성하고 소멸한다면, 아무리 GC가 성능이 좋아졌다고 하더라도 부담이 된다. 그래서 Spring에서는 Bean들을 기본적으로 싱글톤(Singleton)으로 관리하는데, 이에 대해 자세히 알 필요가 있다.
3. 다양한 의존성 주입 방법
[ 1. 생성자 주입(Constructor Injection) ]
생성자를 통해 의존 관계를 주입하는 방법이다.
@Service public class UserServiceImpl implements UserService { private UserRepository userRepository; private MemberService memberService; @Autowired public UserServiceImpl(UserRepository userRepository, MemberService memberService) { this.userRepository = userRepository; this.memberService = memberService; } }생성자 주입은 생성자의 호출 시점에 1회 호출 되는 것이 보장된다. 그렇기 때문에 주입받은 객체가 변하지 않거나, 반드시 객체의 주입이 필요한 경우에 강제하기 위해 사용할 수 있다. 또한 Spring 프레임워크에서는 생성자 주입을 적극 지원하고 있기 때문에, 생성자가 1개만 있을 경우에 @Autowired를 생략해도 주입이 가능하도록 편의성을 제공하고 있다. 그렇기 때문에 위의 코드는 아래와 동일한 코드가 된다.
@Service public class UserServiceImpl implements UserService { private UserRepository userRepository; private MemberService memberService; public UserServiceImpl(UserRepository userRepository, MemberService memberService) { this.userRepository = userRepository; this.memberService = memberService; } }생성자 주입 실습 코드 예제 참고: https://datamoney.tistory.com/201
[ 2. 수정자 주입(Setter 주입, Setter Injection) ]
필드 값을 변경하는 Setter를 통해서 의존 관계를 주입하는 방법이다. Setter 주입은 생성자 주입과 다르게 주입받는 객체가 변경될 가능성이 있는 경우에 사용한다. (실제로 변경이 필요한 경우는 극히 드물다.)
@Service public class UserServiceImpl implements UserService { private UserRepository userRepository; private MemberService memberService; @Autowired public void setUserRepository(UserRepository userRepository) { this.userRepository = userRepository; } @Autowired public void setMemberService(MemberService memberService) { this.memberService = memberService; } }@Autowired로 주입할 대상이 없는 경우에는 오류가 발생한다. 위의 예제에서는 XXX 빈이 존재하지 않을 경우에 오류가 발생하는 것이다. 주입할 대상이 없어도 동작하도록 하려면 @Autowired(required = false)를 통해 설정할 수 있다.
[ 3. 필드 주입(Field Injection) ]
필드에 바로 의존 관계를 주입하는 방법이다. IntelliJ에서 필드 인젝션을 사용하면 Field injection is not recommended이라는 경고 문구가 발생한다.
@Service public class UserServiceImpl implements UserService { @Autowired private UserRepository userRepository; @Autowired private MemberService memberService; }필드 주입을 이용하면 코드가 간결해져서 과거에 상당히 많이 이용되었던 주입 방법이다. 하지만 필드 주입은 외부에서 변경이 불가능하다는 단점이 존재하는데, 점차 테스트 코드의 중요성이 부각됨에 따라 필드의 객체를 수정할 수 없는 필드 주입은 거의 사용되지 않게 되었다. 또한 필드 주입은 반드시 DI 프레임워크가 존재해야 하므로 반드시 사용을 지양해야 한다. 그렇기에 애플리케이션의 실제 코드와 무관한 테스트 코드나 설정을 위해 불가피한 경우에만 이용하도록 하자.
[ 4. 일반 메소드 주입(Method Injection) ]
일반 메소드를 통해 의존 관계를 주입하는 방법이다. 한번에 여러 필드를 주입 받을 수 있지만, 거의 사용할 필요가 없는 주입 방법이다.
4. 생성자 주입을 사용해야 하는 이유
최근에는 Spring을 포함한 DI 프레임워크의 대부분이 생성자 주입을 권장하고 있는데, 자세한 이유를 살펴보도록 하자.
[ 생성자 주입을 사용해야 하는 이유 ]
1. 객체의 불변성 확보
의존 관계 주입의 변경이 필요한 상황은 거의 없다. 하지만 수정자 주입이나 일반 메소드 주입을 이용하면 불필요하게 수정의 가능성을 열어두게 되며, 이는 OOP의 5가지 개발 원칙 중 OCP(Open-Closed Principal, 개방-폐쇄의 법칙)를 위반하게 된다. 그러므로 생성자 주입을 통해 변경의 가능성을 배제하고 불변성을 보장하는 것이 좋다.
2. 테스트 코드의 작성
실제 코드가 필드 주입으로 작성된 경우에는 순수한 자바 코드로 단위 테스트를 작성하는 것이 불가능하다. 예를 들어 아래와 같은 실제 코드가 존재한다고 하자.
@Service public class UserServiceImpl implements UserService { @Autowired private UserRepository userRepository; @Autowired private MemberService memberService; @Override public void register(String name) { userRepository.add(name); } }위의 코드에 대한 순수 자바 테스트 코드를 작성하면 다음과 같이 작성할 수 있다.
public class UserServiceTest { @Test public void addTest() { UserService userService = new UserServiceImpl(); userService.register("MangKyu"); } }위와 같이 작성한 테스트 코드는 어떻게 되겠는가? 테스트 코드가 Spring과 같은 DI 프레임워크 위에서 동작하지 않으므로 의존 관계 주입이 되지 않을 것이고, userRepository가 null이 되어 userRepository의 add 호출 시 NPE가 발생할 것이다. 이를 해결하기 위해 Setter를 사용하면 OCP(Open-Closed Principal, 개방-폐쇄의 법칙)를 위반하게 된다.
반면에 생성자 주입을 사용하면 컴파일 시점에 객체를 주입받아 테스트 코드를 작성할 수 있으며, 주입하는 객체가 누락된 경우 컴파일 시점에 오류를 발견할 수 있다.
심지어 우리가 테스트를 위해 만든 Test객체를 생성자로 넣어 편리함을 얻을 수도 있다.
테스트 코드 작성 용이(이 블로그 참고): https://jackjeong.tistory.com/41
3. final 키워드 작성 및 Lombok과의 결합
생성자 주입을 사용하면 필드 객체에 final 키워드를 사용할 수 있으며, 컴파일 시점에 누락된 의존성을 확인할 수 있다. 반면에 생성자 주입을 제외한 다른 주입 방법들은 객체의 생성(생성자 호출) 이후에 호출되므로 final 키워드를 사용할 수 없다.
또한 final 키워드를 붙임으로써 Lombok과 결합되어 코드를 간결하게 작성할 수 있다. Lombok에는 final 변수를 위한 생성자를 대신 생성해주는 @RequiredArgsConstructor가 있다.
Spring과 같은 DI 프레임워크는 Lombok과 환상적인 궁합을 보여주는데, 위에서 작성했던 생성자 주입 코드를 Lombok과 결합시키면 다음과 같이 간편하게 작성할 수 있다.
@Service @RequiredArgsConstructor public class UserServiceImpl implements UserService { private final UserRepository userRepository; private final MemberService memberService; @Override public void register(String name) { userRepository.add(name); } }이러한 코드가 가능한 이유는 앞서 설명하였듯 Spring에서는 생성자가 1개인 경우 @Autowired를 생략할 수 있도록 도와주고 있으며, 해당 생성자를 Lombok으로 구현하였기 때문이다.
4. 순환 참조 에러 방지
애플리케이션 구동 시점(객체의 생성 시점)에 순환 참조 에러를 방지할 수 있다.
예를 들어 UserServiceImpl의 register 함수가 memberService의 add를 호출하고, memberServiceImpl의 add함수가 UserServiceImpl의 register 함수를 호출한다면 어떻게 되겠는가?
@Service public class UserServiceImpl implements UserService { @Autowired private MemberServiceImpl memberService; @Override public void register(String name) { memberService.add(name); } }@Service public class MemberServiceImpl extends MemberService { @Autowired private UserServiceImpl userService; public void add(String name){ userService.register(name); } }위의 두 메소드는 서로를 계속 호출할 것이고, 메모리에 함수의 CallStack이 계속 쌓여 StackOverflow 에러가 발생하게 된다.
Caused by: java.lang.StackOverflowError: null at com.mang.example.user.MemberServiceImpl.add(MemberServiceImpl.java:20) ~[main/:na] at com.mang.example.user.UserServiceImpl.register(UserServiceImpl.java:14) ~[main/:na] at com.mang.example.user.MemberServiceImpl.add(MemberServiceImpl.java:20) ~[main/:na] at com.mang.example.user.UserServiceImpl.register(UserServiceImpl.java:14) ~[main/:na]만약 이러한 문제를 발견하지 못하고 서버가 운영된다면 어떻게 되겠는가? 해당 메소드의 호출 시에 StackOverflow 에러에 의해 서버가 죽게 될 것이다.
하지만 생성자 주입을 이용하면 이러한 순환 참조 문제를 방지할 수 있다.
Description: The dependencies of some of the beans in the application context form a cycle: ┌─────┐ | memberServiceImpl defined in file [C:\Users\Mang\IdeaProjects\build\classes\java\main\com\mang\example\user\MemberServiceImpl.class] ↑ ↓ | userServiceImpl defined in file [C:\Users\Mang\IdeaProjects\build\classes\java\main\com\mang\example\user\UserServiceImpl.class] └─────┘애플리케이션 구동 시점(객체의 생성 시점)에 에러가 발생하기 때문이다.
( 빈등록은 런하면 바로 다 실행한다. )
그러한 이유는 Bean에 등록하기 위해 객체를 생성하는 과정에서 다음과 같이 순환 참조가 발생하기 때문이다.
new UserServiceImpl(new MemberServiceImpl(new UserServiceImpl(new MemberServiceImpl()...)))Bean 등록은 위에서 '의존성 주입을 통한 문제해결' 라고 설명한 부분에 DI 컨테이너 코드 단을 보면 알 수 있듯이
등록할 때 주입할 객체와 주입받을 객체를 초기화 시켜 컨테이너에 넣어 놓는다.
생성자주입외의 메서드 주입등은 해당 메서드를 호출할 때, 주입이 필요함을 확인하여 주입하기 때문에 메서드 호출시 에러가 난다.
생성자주입은 처음 런할때 생성자로 호출해 초기화 하기때문에, 바로 주입이 필요함을 보고 주입하다가 위와 같은 순환참조가 구동하면 바로 나오게 된다.
[ 요약 정리 ]
- OCP 원칙을 지키며 객체의 불변성을 확보할 수 있다.
- 테스트 코드의 작성이 용이해진다.
- final 키워드를 사용할 수 있고, Lombok과의 결합을 통해 코드를 간결하게 작성할 수 있다.
- 순환 참조 문제를 를 애플리케이션 구동(객체의 생성) 시점에 파악하여 방지할 수 있다.
이러한 이유들로 우리는 DI 프레임워크를 사용하는 경우, 생성자 주입을 사용하는 것이 좋다.
출처: https://mangkyu.tistory.com/150 [MangKyu's Diary]'JAVA' 카테고리의 다른 글
[mybatis] xml v.s annotation (0) 2021.08.15 [spring] 어노테이션 정리 (0) 2021.08.13 [java] JSP, Servlet 의 기본 개념 및 MVC모델 (0) 2021.08.12 [spring] CharacterEncodingFilter (0) 2021.08.12 [mybatis] 스코프와 생명주기 (0) 2021.08.12