[Spring] 인프런 스프링 입문(김영한 님) - 스프링 빈과 의존관계 : 컴포넌트 스캔, 의존관계, DI, 스프링 빈 직접 등록하기

이 글은 인프런 김영한 님의 스프링 입문 강의 를 듣고 정리한 글입니다.

스프링 빈과 의존관계

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

만든 서비스를 화면에 붙이기 위해 컨트롤러와 View템플릿이 필요하다.

예를 들어 회원가입을 하면 그 결과를 HTML로 화면에 뿌려주는 방법을 배울 것.

먼저 Member의 Controller를 만들어야 한다.

의존관계

Controller는 Service를 통해 회원가입을 하고, 데이터를 조회할 수 있어야.

이를 '컨트롤러가 서비스에 의존하고 있다'고 표현하며, '의존관계가 있다'고 할 수 있다.

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

스프링 컨테이너와 스프링 빈

@Controller 어노테이션으로 컨트롤러를 만들어 두면,

스프링 부트가 실행될 때 스프링 컨테이너가 해당 '컨트롤러 객체'를 생성해 스프링 컨테이너에 넣어 두며 해당 객체는 스프링이 관리하는 대상이 된다.

이를 '스프링 컨테이너에서 스프링 빈이 관리된다' 고 한다.

스프링에 의해 관리되도록 하려면, 그 대상을 스프링 컨테이너에 등록해야 하며, 사용할 때도 스프링 컨테이너로부터 받아서 쓰도록 설계해야 한다.

즉, 사용할 객체를 매번 new로 만드는 것 보다, 한 번만 만들어서 스프링 컨테이너에 등록해 두는 것이 더 효율적이다.

또, 스프링 컨테이너에 등록해 두면 스프링에서 제공하는 여러 기능들도 사용할 수 있다.

• @Autowired : 생성자에 선언되면, 객체 생성 시점에 생성자에 필요한 객체를 스프링 컨테이너에 등록된 스프링 빈 중에서 찾아서 넣어 준다.
• DI (Dependency Injection, 의존성 주입) : 객체 의존관계를 외부에서 넣어 주는 것. 스프링이 객체를 넣어 주고 있다.

그러나 그냥 @Autowired를 선언하면 오류가 발생할 것이다.

왜? 스프링 컨테이너는 스프링 빈으로 등록되어 있지 않은 대상은 찾을 수 없기 때문.

따라서 회원 서비스 MemberService 클래스에도 @Service어노테이션을 추가해야 한다.

회원 저장소의 구현체 MemoryMemberRepository클래스에도 @Repository 어노테이션을 추가해야 한다.

컨트롤러, 서비스, 리포지토리

''컨트롤러, 서비스, 리포지토리''

이 세 요소는 정형화된 패턴이기 때문에 스프링에서 어노테이션을 제공한다.

• @Controller : 외부 요청을 받는다.
• @Service : 비즈니스 로직을 만들고 수행한다.
• @Repository : 데이터를 저장한다.

현재 상황에서 MemberController는 MemberService에, MemberService는 MemberRepository에 의존해야 한다.

어노테이션을 사용해 의존관계를 만든 코드는 다음과 같다.

• 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;
      }
  }
  

• MemberService.java

  package hello.hellospring.service;
  
  import hello.hellospring.domain.Member;
  import hello.hellospring.repository.MemberRepository;
  import hello.hellospring.repository.MemoryMemberRepository;
  import org.springframework.beans.factory.annotation.Autowired;
  import org.springframework.stereotype.Service;
  
  import java.util.List;
  import java.util.Optional;
  
  @Service
  public class MemberService {
      private final MemberRepository memberRepository;
  
      @Autowired
      public MemberService(MemberRepository memberRepository) {
          this.memberRepository = memberRepository;
      }
      // codes ...
  }

• MemoryMemberRepository.java (MemberRepository의 구현체)

  package hello.hellospring.repository;
  
  import hello.hellospring.domain.Member;
  import org.springframework.stereotype.Repository;
  
  import java.util.*;
  
  @Repository
  public class MemoryMemberRepository implements MemberRepository{
      // codes ...
  }

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

스프링을 사용할 때는 웬만한 객체는 전부 스프링 빈으로 만들어 등록해 사용한다.

왜? 그렇게 했을 때 얻는 이점이 더 많기 때문.

• 컴포넌트 스캔과 자동 의존관계 설정
  • @Component어노테이션(또는 @Component 어노테이션이 포함된 어노테이션)이 있으면 스프링 빈으로 자동 등록된다. (스프링에 의해 컴포넌트 스캔이 가능하다.)
  • @Controller, @Service, @Repository 모두 @Component 어노테이션이 포함되어 있다.
  • 스프링이 @Component를 만나면, 해당 객체를 생성해 스프링 컨테이너에 스프링 빈으로 등록해 둔다.
  • 자동 의존관계 : @Autowired을 사용해 스프링 컨테이너로부터 스프링 빈을 가져와 사용.
• 자바 코드로 직접 스프링 빈 등록하기 (다음 시간 수업)

✔ 스프링이 컴포넌트 스캔을 할 때는 실행할 수 있는 클래스( @SpringBootApplication)의 패키지 및 하위 패키지 의 파일들만 스캔한다. 다른 패키지의 파일은 컴포넌트 스캔의 대상이 되지 않는다.

✔ 스프링은 스프링 컨테이너에 스프링 빈을 등록할 때, 기본으로 싱글톤으로 등록한다 (= 유일하게 하나만 등록하고, 그것을 공유해 사용한다). 따라서 같은 스프링 빈이면 모두 같은 인스턴스다.

(특별한 경우에는 별도 설정을 통해 싱글톤이 아니게 등록되도록 할 수 있다.)

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

저번 시간과 다르게, 자바 코드로 직접 스프링 빈을 등록하는 방법을 알아본다.

@Controller, @Service, @Repository 및 @Autowired 없이 스프링 빈을 등록할 수 있다.

직접 스프링 빈 등록하기

컨트롤러, 서비스, 리포지토리들을 아우르는 패키지에 SpringConfig.java를 만들고 해당 클래스를 @Configuration으로 선언한다.

그리고 등록할 인스턴스를 @Bean으로 선언해 스프링 빈을 등록한다.

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

• 메소드의 리턴 객체들이 스프링 빈으로 스프링 컨테이너에 등록된다.

• new MemberService(memberRepository())

  MemberService의 경우 memberRepository()에서 등록된 MemoryMemberRepository를 사용한다.

  즉, 스프링 빈에 등록된 컴포넌트를 사용하는 것이므로 @Autowired와 같은 기능을 한다.

• 컴포넌트의 경우에는 직접 등록하기보다 @Component와 @Autowired를 사용하는 것이 낫다.

(참고) 과거에는 스프링 빈을 xml문서로 설정했으나, 지금은 거의 자바 코드로만 설정하므로 설명을 생략한다.

DI 방식

DI (의존관계 주입)에는 ''필드 주입, setter 주입, 생성자 주입'' 의 3가지 방식이 있다.

@Controller
public class MemberController {
    // 필드 주입 방식
    @Autowired private final MemberService memberService;

    // setter 주입 방식
    @Autowired
    public void setMemberService(MemberService memberService) {
        this.memberService = memberService
    }

    // 생성자 주입 방식
    @Autowired
    public MemberController(MemberService memberService) {
        this.memberService = memberService;
    }
}

• 필드 주입 방식
  • 변경에 유연하지 못하다는 단점이 있다.
• setter 주입 방식
  • setter가 public이어야 한다는 특징 때문에 외부에 노출된다는 단점이 있다.
• 생성자 주입 방식
  • 스프링 컨테이너에서 애플리케이션이 조립되는 시점에, 객체가 생성되며 한 번 주입한다.
  • 객체 생성 시점 이외에 변경할 수 없도록 막을 수 있다.

결론 : DI에는 생성자 주입 방식을 권장한다.

컴포넌트 스캔 사용하기 vs 자바 코드로 직접 스프링 빈 등록하기

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

  • 상황에 따라 구현 클래스를 변경해야 할 때 : 우리가 가정한 것처럼 '아직 데이터 저장소가 선정되지 않은'경우, 스프링 빈을 설정 파일로 직접 등록하는 것이 낫다.

    (나중에 데이터 저장소가 선정되면 그 부분의 설정파일만 바꾸면 되기 때문)

• @Autowired를 통한 DI는 스프링이 관리하는 객체에서만 동작한다.

  • = 스프링 컨테이너에 스프링 빈으로 등록한 객체에 대해서만 @Autowired가 동작한다.