Backend/Spring Boot
원본 글 보기

[Spring] 의존성 주입 3가지: 생성자·필드·Setter 주입, @RequiredArgsConstructor와 @Autowired

[Spring] 의존성 주입 3가지: 생성자·필드·Setter 주입, @RequiredArgsConstructor와 @Autowired

순환 참조 에러 덕분에 자주쓰는 @Autowired 어노테이션과 @RequiredArgsConstructor에 대해 찾아보고 정리한 글.

이 글에서 일반 메서드 주입 방법은 의존성 주입 방법에서 제외한다.

1. 의존성이란?



class HiWorld {
private SayHi sayHi;
public HelloWorld() {
this.sayHi = new SayHi();
}
public startHelloWorld() {
this.sayHi.hello();
}
}

HiWorld 클래스에서 hello함수가 호출되기 위해서는 SayHi 클래스가 필요하다.

이 때 HiWorld 클래스는 SayHi 클래스의 의존성을 가진다고 말한다.

의존성 주입에는 크게 3가지 방법이 존재한다.

1) 필드 주입

2) setter 주입

3) 생성자 주입

2) 필드주입, @Autowired 예시



@Controller
public class BoardController {
    @Autowired private IBoardItemService boardItemService;
[ 생략 ]
}

@Autowired를 활용한 의존성 주입을 필드 주입 이라고 한다.

이 @Autowired 필드 주입은 사용법이 간단해서 대부분 의존성 주입을 필드 주입으로 접하지만, intelliJ에서는 이 방식을 추천하지 않는다.

intelliJ



Field injection is not recommended
Inspection info: Spring Team recommends: "Always use constructor based dependency injection in your beans. Always use assertions for mandatory dependencies".

Always 생성자 주입을 권장한다. 생성자 주입에 대해서는 아래에서 자세히 설명한다. 필드 주입을 권장하지 않는 이유는 순환 참조 방지 때문이다.

순환 참조 에러 예시:



CodeInputFileService.class

@Service
public class codeInputFileService {
    @Autowired
    private BoardService boardService;
...



CodeInputFileService.class

@Service
public class BoardService {
    @Autowired
    private CodeInputFileService  codeInputFileService;
...

위와 같이 서로 순환 참조하는 구조가 되었을 때, 필드 주입으로 구현했다면, 해당 참조가 실행돼 StackOverflowError가 발생하기 전까지는 알 수 없다. 하지만 생성자 주입으로 구현되어있다면 어플리케이션이 구동조차 되지 않고, 다음과 같이 에러가 나오는 것을 볼 수 있다.



***************************
APPLICATION FAILED TO START
***************************
Description:

The dependencies of some of the beans in the application context form a cycle:
mainController (field private com.wcp.board.BoardService com.wcp.board.main.MainController.boardService)
┌─────┐
|  boardService defined in file [C:\git\2021\WebCompile\Toy-Project\core\out\production\classes\com\wcp\board\BoardService.class]
↑     ↓
|  codeInputFileService defined in file [C:\git\2021\WebCompile\Toy-Project\core\out\production\classes\com\wcp\coding\inputFile\CodeInputFileService.class]
└─────┘

발생할 수 있는 오류를 사전에 알 수 있는 것이다. 그럼 다른 방법들을 알아보자.

Setter 주입



@Service
public class CodeInputFileService {
private CodeInputFileManager codeInputFileManager;

    @Autowired
    public void setCodeInputFileManager(CodeInputFileManager codeInputFileManager) {
this.codeInputFileManager = codeInputFileManager;
}
...

Setter 주입은 생성자 주입과 다르게 주입받는 객체가 변경될 가능성이 있는 경우에 사용한다. 주로 사용하지는 않는 방법이다.

🤔 그럼 뭘 써야 할까?

스프링에서 공식적으로 추천하는 방법은 생성자 주입이다.



@Controller
public class BoardController {
private final IBoardItemService boardItemService;
public BoardController(IBoardItemService boardItemService) {
this.boardItemService = boardItemService;
}
[ 생략 ]
}

근데 그럼 매번 생성자 주입으로 작성하게 되면

객체가 추가될 때마다 선언을 하고 생성자를 수정해줘야 하는데..

너무 번거롭기 때문에 @RequiredArgsConstructor 가 탄생했다.

3) 생성자 주입, @RequiredArgsConstructor 권장

final 필드에 대해 생성자를 만들어주는 lombok의 annotation.

Spring Framework의 DI(의존성주입) 중 Constructor Injection(생성자 주입)을 임의의 코드 없이 자동으로 설정.

위 코드를에 @RequiredArgsConstructor를 활용해서 수정하면 다음과 같다.



@Controller
@RequiredArgsConstructor
public class BoardController {
private final IBoardItemService boardItemService;
/* 이하 생략 */
}

Lombok에서 지원하는 @RequiredArgsConstructor 어노테이션을 사용하여 의존성을 주입 하는 것을 생성자 주입이라고 한다.

이렇게 RequiredArgsConstructor만 선언하면 알아서 final 키워드가 붙은 필드에 대해 생성자를 만들어준다.

또 생성자가 하나만 선언 되어있어도 @Autowired 어노테이션을 생략할 수 있다.

스프링 팀이 생성자 주입을 사용할 것을 권장하는 이유는 한번 의존성을 주입받은 객체는 프로그램이 끝날때 까지 변하지 않는 특징을 가지므로 불변성을 표시해주는 것이 좋기 때문이다.

그래서 의존성을 주입할 객체에 final 키워드를 사용한다.

(왜 불변객체(immutable object)를 사용하는 것이 좋을까?)

생성자 주입을 사용할 경우 장점

① 순환 참조 방지

② 테스트 코드 작성 용이

③ 객체 변이 방지 (final 가능)

참고:

https://upcake.tistory.com/417

https://velog.io/@cham/Spring-Field%EC%99%80-Constructor-Injection

https://madplay.github.io/post/why-constructor-injection-is-better-than-field-injection

생성자 주입을 @Autowired를 사용하는 필드 주입보다 권장하는 하는 이유