[Spring Intro] Section 04. 스프링 빈과 의존관계_컴포넌트 스캔과 자동 의존관계 설정, 자바 코드로 직접 스프링 빈 등록하기

컴포넌트 스캔과 자동 의존관계 설정

 

# 스프링 빈을 등록하고 의존관계 설정하기

지난 Section3에서 구축했던 백엔드 기능에 화면을 붙여보자.

화면 구축을 위해서는 Controller와 View Template이 필요하다.

그러려면 MemberController를 만들어야 하는데,

MemberController는 MemberService를 통해서 회원가입과 데이터 조회가 가능해야 한다.

 

이러한 관계를 'MemberController가 MemberService에 의존한다'고 표현한다.

 

@Controller : 스프링이 처음에 뜰 때 스프링 컨테이너가 생기는데,

이때 @Controller가 있으면 객체(여기에서는 MemberController)를 생성해서

스프링 컨테이너에 넣어 둠. 이렇게 컨테이너에 넣어두면 스프링이 관리하게 됨.

이 과정을 스프링 컨테이너에서 스프링 빈이 관리된다 고 표현한다.

 

아래 사진을 통해 좀 더 쉽게 이해할 수 있다.

스프링 컨테이너 내부에 콩 모양 초록색 원의 컨트롤러(스프링 빈)가 있다

 

 

# 회원 컨트롤러에 의존관계 추가

 

회원 컨트롤러

src/main/java/hello.hellospring/controller/MemberController.java

package hello.hellospring.controller;

import hello.hellospring.service.MemberService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;

@Controller
public class MemberController {
    private final MemberService memberService;

    @Autowired
    public MemberController(MemberService memberService) {
        this.memberService = memberService;
    }
}

생성자에 @Autowired가 있으면 스프링이 연관된 객체를 스프링 컨테이너에서 찾아서 넣어준다.
이렇게 객체 의존관계를 외부에서 넣어주는 것을 DI(Dependency Injection), 의존성 주입이라 한다.
이전 테스트에서는 개발자가 직접 주입했고, 여기서는 @Autowired에 의해 스프링이 주입해준다.

 

 

# 오류 발생

Consider defining a bean of type 'hello.hellospring.service.MemberService' in your configuration.

그러나 코드를 실행시켜보면, @Autowired를 사용했음에도 위와 같은 오류가 발생한다.

memberService가 스프링 빈으로 등록되어 있지 않다는 오류인데, 그 이유를 자세히 살펴보자.

 

참고
helloController는 스프링이 제공하는 컨트롤러여서 스프링 빈으로 자동 등록된다.
@Controller가 있어도 스프링 빈으로 자동 등록된다.

 

MemberController의 @Autowired를 통해 스프링 컨테이너에서 memberService를 가져와야 하는데,

MemberController는 annotation을 걸어두었기 때문에 자동 등록되지만

memberService는 순수한 자바 클래스이기 때문에 스프링이 이를 인식할 수 있는 방법이 없다.

 

MemberService / MemoryMemberRepository

이때, MemberService에서 @Service를 선언하고,

MemoryMemberRepository에 @Repository를 선언하면

각각이 스프링 컨테이너에 등록된다.

 

 

# 스프링 빈을 등록하는 두 가지 방법

• 컴포넌트 스캔과 자동 의존관계 설정
• 자바 코드로 직접 스프링 빈 등록하기
  
  

# 컴포넌트 스캔 원리

• @Component 애노테이션이 있으면 스프링 빈으로 자동 등록된다.
• @Controller 컨트롤러가 스프링 빈으로 자동 등록된 이유도 컴포넌트 스캔 때문이다.
• @Component를 포함하는 다음 애노테이션도 스프링 빈으로 자동 등록된다.
  • @Controller
  • @Service
  • @Repository
    
    

@Controller를 통해 외부 요청을 받고,
@Service에서 비즈니스 로직을 만들고,
@Repository에서 데이터를 저장하는 것이 보통 정형화된 패턴이다.

 

 

# 회원 서비스 스프링 빈 등록

java/hello/hellospring/service/MemberService.java

@Service
public class MemberService {
    private final MemberRepository memberRepository;

    @Autowired
    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }
}

참고: 생성자에 @Autowired를 사용하면 객체 생성 시점에 스프링 컨테이너에서 해당 스프링 빈을 찾아서 주입한다.

(생성자가 1개만 있으면 @Autowired는 생략할 수 있다.)

 

 

# 회원 리포지토리 스프링 빈 등록

java/hello/hellospring/repository/MemoryMemberRepositoryTest.java

@Repository
public class MemoryMemberRepository implements MemberRepository {}

 

 

# 스프링 빈 등록 이미지

> 이렇게 memberService와 memberRepository가 스프링 컨테이너에 스프링 빈으로 등록되었다.
위 과정들이 객체 의존관계를 외부에서 넣어주는 DI(Dependency Injection), 의존성 주입이다.

 

 

# 주의

우리는 HelloSpringApplication을 실행하기 때문에

hello.hellospring 패키지를 포함한 모든 하위 요소들은

스프링이 전부 컴포넌트 스캔을 실행한다.

 

하지만 그 이외는 컴포넌트 스캔을 실행하지 않는다.

(위 사진에서 demo 위치의 패키지와 그 하위 요소인 demo.java에

@Service와 같은 컴포넌트를 넣어도 스캔을 하지 않는다.)

 

 

# 싱글톤에 대해

스프링은 스프링 컨테이너에 스프링 빈을 등록할 때, 기본으로 싱글톤으로 등록한다(유일하게 하나만 등록해서 공유한다).
따라서 같은 스프링 빈이면 모두 같은 인스턴스다.
설정으로 싱글톤이 아니게 설정할 수 있지만, 특별한 경우를 제외하면 대부분 싱글톤을 사용한다.

 

ex ) 위 스프린 빈 등록 이미지의 상태에서
orderService가 @Autowired를 통해 memberRepository가 필요하다고 하면 같은 인스턴스를 넣어준다.

(설정으로 memberRepository를 @Autowired 할 때 마다 다른 인스턴스를 넣도록 할 수 있음)

 

---

자바 코드로 직접 스프링 빈 등록하기

시작하기 이전에 앞서 작성했던 회원 서비스와 회원 리포지토리의
@Service, @Repository, @Autowired 애노테이션을 제거하고 진행한다.

!! MemberController의 @Autowired는 제거하지 않는 것에 주의하자. !!

 

# 자바 코드로 스프링 빈 등록

java/hello.hellospring/SpringConfig.java

package hello.hellospring;

import hello.hellospring.repository.MemberRepository;
import hello.hellospring.repository.MemoryMemberRepository;
import hello.hellospring.service.MemberService;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class SpringConfig {

    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository());
    }

    @Bean
    public MemberRepository memberRepository() {
        return new MemoryMemberRepository();
    }
}

@Bean을 통해 memberService와 memberRepository를 각각 스프링 빈에 등록하고

return new MemberService(memberRepository())에서
스프링 빈에 등록되어 있는 memberRepository를 memberService에 넣어준다. (@Autowired와 같은 효과)

 

 

완료하면 자바 코드를 통한 스프링 빈 등록으로 이전 컴포넌트 스캔과 같은 구조가 완성된다.

 

---

컴포넌트 스캔으로 자동 의존관계 설정 vs 자바 코드로 스프링 빈 등록

 

✔️ XML로 설정하는 방식이 있지만 최근에는 잘 사용하지 않으므로 생략한다.

 

✔️ DI에는 필드 주입, setter 주입, 생성자 주입의 3가지 방법이 있다.

 

---

# 필드 주입

@Controller
public class MemberController {

    @Autowired private MemberService memberService;
    
...

> 변형을 자유롭게 할 수 없다는 단점이 있음

 

# setter 주입

@Controller
public class MemberController {
    private MemberService memberService;

    public void setMemberService(MemberService memberService) {
        this.memberService = memberService;
    }
}

> 누군가가 MemberController를 호출했을때 setMemberService가 public으로 열려있어야 함

setMemberService는 한번 세팅되면 잘 바뀌지 않는데 public하게 노출된다는 단점이 있음

 

# 생성자 주입

@Controller
public class MemberController {
    private final MemberService memberService;

    @Autowired
    public MemberController(MemberService memberService) {
        this.memberService = memberService;
    }
}

> 조립 시점에 생성자로 한 번만 조립해놓고 이후로는 변경하지 못하도록 막는 것이 가능함

의존관계가 실행 중에 동적으로 변하는 경우는 거의 없으므로 생성자 주입을 권장한다.

---

 

✔️ 실무에서는 주로 정형화된 컨트롤러, 서비스, 리포지토리 같은 코드는 컴포넌트 스캔을 사용한다.
     그리고 정형화 되지 않거나, 상황에 따라 구현 클래스를 변경해야 하면 설정을 통해 스프링 빈으로 등록한다.

• 우리는 아직 데이터 저장소가 선정되지 않았다는 것을 전제로 프로젝트를 진행했으므로
  이후에 메모리 리포지토리를 다른 리포지토리로 바꿔야 함.
  이때 기존에 운영 중인 코드를 하나도 변경하지 않고 바꿀 수 있도록 하기 위해
  컴포넌트 스캔 방식 대신 자바 코드로 스프링 빈을 설정한다.
  
  -> SpringConfig 파일의 memberRepository에서 return new MemoryMemberRepository()를
       이후에 return new dbMemberRepository()로만 변경해주면 된다! 아주 쉬움.

 

✔️ 주의 : @Autowired를 통한 DI는 helloController , memberService 등과 같이 스프링이 관리하는 객체에서만 동작한다.
               스프링 빈으로 등록하지 않고 내가 직접 생성한 객체에서는 동작하지 않는다.

 

✔️ 스프링 컨테이너, DI 관련된 자세한 내용은 스프링 핵심 원리 강의에서 설명한다.

 

 

 

 

내용 및 이미지 출처 : 김영한의 스프링 입문