본 포스팅은 인프런의 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 섹션 4. 스프링 빈과 의존 관계를 정리한 것이다.

스프링 빈과 의존 관계

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

회원 컨트롤러가 회원서비스와 회원 리포지토리를 사용할 수 있게 의존관계를 준비하자.

회원 컨트롤러(MemberController)에 의존관계 추가

• src/main/java/hello.hellospring 의 controller Package에 Java class MemberController를 생성하고 다음 소스코드 추가

package hello.hellospring.controller;

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

@Controller
public class MemberController {

    private final MemberService memberService;

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

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

오류 발생

그런데 상기 코드를 실행해보면 다음과 같은 에러가 발생한다.

Parameter 0 of constructor in hello.hellospring.controller.MemberController required a bean of type 'hello.hellospring.service.MemberService' that could not be found.

memberService가 스프링 빈으로 등록되어 있지 않다.

• 상기 오류가 발생한 이유는 MemberService가 스프링 빈에 등록되어 있지 않기 때문이다.

• 참고: memberController는 스프링이 제공하는 컨트롤러여서 스프링 빈으로 자동 등록된다.
  • @Controller가 있으면 자동 등록됨

컴포넌트 스캔 원리

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

회원 서비스(MemberService) 스프링 빈 등록

• 따라서 MemberService에 @Service를 추가하고 생성자에 @Autowired를 추가해야 한다.

@Service
public class MemberService {

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

• 참고: 생성자에 @Autowired를 사용하면 생성 시점에 스프링 컨테이너에서 해당 스프링 빈을 찾아서 주입한다. 생성자가 1개만 있으면 @Autowired는 생략할 수 있다.

회원 리포지토리(MemoryMemberRepository) 스프링 빈 등록

• 또한 MemberRepository의 구현체인 MemoryMemberRepository에 @Repository를 추가해야 한다.

@Repository
public class MemoryMemberRepository implements MemberRepository{}

스프링 빈 등록 이미지

• memberService와 memberRepository가 스프링 컨테이너에 스프링 빈으로 등록되었다.

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

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

• 회원 서비스(MemberService)와 회원 리포지토리(MemoryMemberRepository)의 @Service, @Repository, @Autowired를 제거하고 진행한다.
• src/main/java/hello.hellospring 에 Java class SpringConfig를 생성하고 다음 소스코드 추가

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();
    }
}

여기서는 향후 메모리 리포지토리(MemoryMemberRepository)를 다른 리포지토리로 변경할 예정이므로, 컴포넌트 스캔 방식 대신에 자바 코드로 스프링 빈을 설정할 것이다.

• 참고: XML로 설정하는 방식도 있지만 최근에는 잘 사용하지 않으므로 생략한다.

• 참고: DI(의존성 주입)에는 필드 주입, setter 주입, 생성자 주입 이렇게 3가지 방법이 있다. 의존관계가 실행중에 동적으로 변하는 경우는 거의 없으므로 생성자 주입을 권장한다.

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

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

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