본문 바로가기

Java/spring

[Java/스프링 입문] 스프링 빈과 의존관계 - 컴포넌트 스캔과 자동 의존관계 설정(@Controller, @Service, @Repository, @Autowired), 자바 코드로 직접 스프링 빈 등록하기 (@Configuration, @Bean)

들어가며

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

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

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

 

1. 컴포넌트 스캔과 자동 의존관계 설정 (@Controller, @Service, @Repository, @Autowired)

1) @Controller, @Service, @Repository

  • 의존 관계
    • 앞서 만든 서비스에 화면을 붙이기 위해선 Controller와 View가 필요합니다.
    • MemberController는 MemberService를 통해서 회원가입, 조회할 수 있어야 합니다.
      => 이러한 관계를  MemberController가 MemberService를 의존한다고 표현합니다.

 

  • 컴포넌트 스캔
    • @Component
      : @Component 어노테이션이 있으면 스프링 빈으로 자동 등록됩니다. (Controller, Service, Repository가 스프링 빈으로 자동 등록되는 이유도 컴포넌트 스캔 때문입니다.)
      • @Controller, @Service, @Repository
        : 본 어노테이션이 있으면 해당 클래스가 스프링 컨테이너에 하나의 빈으로 등록됩니다.
      • Controller  통해서 외부의 요청을 받고, Service에서 비즈니스 로직을 만들고, Repository에서 데이터를 저장
        => Controller Service Repository 패턴 (정형화되어 있음)

 

2) @Autowired

  • @Autowired
    • Controller와 Service를 연결시켜 줍니다.
      MemberController가 생성될 때, 스프링 빈에 등록되어 있는 memberService 객체를 가져다가 넣어줍니다.
      => DI
    • Service와 Repository를 연결시켜 줍니다.
      MemberService가 생성될 때, 스프링 컨테이너에 있는 memberRepository를 가져다가 넣어줍니다.
      => DI

 

3) 싱글톤

  • 스프링은 스프링 컨테이너에 빈을 등록할 때 기본적으로 싱글톤으로 등록합니다.
    • 싱글톤으로 등록한다 == 같은 빈을 여러 번 요청해도 항상 같은 객체를 반환한다
      == 어떤 클래스 A를 빈으로 등록했을 때, 스프링이 A 클래스의 객체를 하나만 만들어두고, 그 객체를 필요할 때마다 재사용한다
    • 아래 코드를 보면 new MemberService()와 같이 직접 객체를 생성하는 것이 아니라,  스프링 컨테이너에서 관리되는 MemberService 객체를 사용합니다. 이렇게 하면 MemberService가 싱글톤으로 관리되어 애플리케이션 전반에서 동일한 객체를 사용할 수 있습니다.
  • 설정으로 싱글톤이 아니게 설정할 수 있지만, 특별한 경우를 제외하면 대부분 싱글톤을 사용합니다.

 

package hello.hello_spring.controller;

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

@Controller
public class MemberController {
    private final MemberService memberService;

    // new를 사용하지 않고 스프링 컨테이너에 등록하여 사용하자
    @Autowired // 스프링 컨테이너에서 memberService를 가져온다
    public MemberController(MemberService memberService) {
        this.memberService = memberService;
    }
}
package hello.hello_spring.service;

import hello.hello_spring.domain.Member;
import hello.hello_spring.repository.MemberRepository;
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;
    
    // 회원 서비스 코드가 DI 가능하게 변경한다
    @Autowired
    public MemberService(MemberRepository memberRepository) {
        this.memberRepository = memberRepository;
    }

    /**
     * 회원가입
     */
    public long join(Member member) {
        // 같은 이름이 있는 중복 회원은 불가하다는 조건을 추가한다면?
        validateDuplicateMember(member); // 중복회원 검증
        memberRepository.save(member);
        return member.getId();
    }

    private void validateDuplicateMember(Member member) {
        memberRepository.findByName(member.getName())
                .ifPresent(m -> { // 값이 있다면 throw로 오류를 날리도록 한다
                    throw new IllegalArgumentException("이미 존재하는 회원입니다.");
                });
    }

    /**
     * 전체 회원 조회
     */
    private List<Member> findMembers() {
        return memberRepository.findAll();
    }

    public Optional<Member> findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }
}
package hello.hello_spring.repository;

import hello.hello_spring.domain.Member;
import org.springframework.stereotype.Repository;

import java.util.List;
import java.util.Optional;

@Repository
public interface MemberRepository {
    Member save(Member member);
    Optional<Member> findById(Long id);
    Optional<Member> findByName(String name);
    List<Member> findAll();
}

 

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

1) @Configuration, @Bean

  • MemberService, MemberRepository의 어노테이션을 제거하고 진행합니다. (@Service, @Repository, @Autowired)

 

  • main > java > hello > hello_spring > SpringConfig
    • @Configuration: 이 클래스가 스프링의 설정 파일이라는 것을 나타냅니다. (즉, 스프링 컨테이너에 등록할 빈들을 정의하는 역할)
    • @Bean: 해당 메서드가 반환하는 객체를 스프링 컨테이너에 빈으로 등록하겠다는 뜻입니다.
      • MemberService → Bean
      • MemberRepository  Bean
    • MemberService memberService: MemberService 객체를 생성하고 반환합니다. 다른 클래스에서 이 빈을 필요로 할 때 스프링이 자동으로 주입해 줍니다.
    • MemberRepository memberRepository: MemoryMemberRepository 객체를 생성하고 반환합니다. 이는 MemberRepository 인터페이스를 구현한 클래스이기 때문에, 스프링 컨테이너는 MemberRepository 타입의 빈이 필요한 곳에 이 객체를 주입합니다.
package hello.hello_spring.controller;

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

@Controller
public class MemberController {
    private final MemberService memberService;

    // new를 사용하지 않고 스프링 컨테이너에 등록하여 사용하자
    @Autowired // 스프링 컨테이너에서 memberService를 가져온다
    public MemberController(MemberService memberService) {
        this.memberService = memberService;
    }
}
package hello.hello_spring;

import hello.hello_spring.repository.MemberRepository;
import hello.hello_spring.repository.MemoryMemberRepository;
import hello.hello_spring.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();
    }
}

 


 

3. 장단점 비교

  컴포넌트 스캔과 자동 의존관계 설정 자바 코드로 직접 스프링 빈 등록하기
장점 간편합니다.
표준적인 구조에서는 특별한 설정 없이도 동작합니다.
(@Controller, Service, Repository, Autowired)
모든 빈이 자바 코드로 명확하게 정의되기 때문에 어떤 빈이 생성되고, 어떤 의존성을 주입 받는지 코드에서 바로 알 수 있습니다.
단점 스프링의 컴포넌트 스캔에 의해 관리되는 객체가 많아지면, 자동화 과정에서 발생할 수 있는 에러를 파악하기 어려울 수 있습니다. (이름 충돌, 순환 참조 문제 등) 많은 빈을 필요로 하는 대규모 애플리케이션에서는 설정 코드가 길어질 수 있고, 유지보수 시 관리해야 할 코드가 늘어납니다.
  • 의존성 주입(DI)
    • 생성자 주입을 권장하는 이유: 대부분의 경우 의존관계가 한번 설정되면 애플리케이션이 실행되는 동안 그 관계가 변하지 않기 때문입니다.
    • 만약 의존관계가 변경될 가능성이 있다면 setter나 필드 주입을 사용할 수 있겠지만 그런 경우는 드뭅니다.
  • 정형화되지 않은 의존성
    • 의존성이 어떤 특정한 클래스에 고정되어 있지 않고, 상황에 따라 다른 구현체를 사용할 가능성이 있는 경우를 말합니다.
    • 개발 환경에서는 MemoryMemberRepository를 사용하고, 운영 환경에서는 DbMemberRepository를 사용하고자 할 때 구현체를 변경해야 하는 상황이 발생합니다.
    • 이러한 경우 설정 파일(@Configuration을 이용한 빈 등록)을 통해 스프링 빈으로 등록하는 것이 좋습니다. 설정 파일에서 @Bean 메서드를 사용해 특정 상황에 맞는 구현체를 빈으로 등록하여, 필요한 경우 다른 구현체를 손쉽게 교체할 수 있습니다.
  • 스프링 컨테이너에 등록된 빈들 사이에서만 @Autowired 어노테이션이 동작합니다.
    • 즉, 스프링이 관리하지 않는 객체를 Autowired를 사용할 수 없고, 의존성 주입이 이루어지지 않습니다.
    • 스프링 컨테이너는 @Controller, Service, Repository 같은 어노테이션이 붙은 클래스들이나, 설정 파일에 @Bean으로 등록한 클래스만 관리합니다.
    • 따라서 만약 특정 객체에 의존성을 주입하고 싶다면, 해당 객체는 반드시 스프링 컨테이너에 의해 관리되는 빈이어야 합니다.

 

[지금 무료] 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술 강의 | 김영한 - 인프

김영한 | 스프링 입문자가 예제를 만들어가면서 스프링 웹 애플리케이션 개발 전반을 빠르게 학습할 수 있습니다., 스프링 학습 첫 길잡이! 개발 공부의 길을 잃지 않도록 도와드립니다. 📣 확

www.inflearn.com

 

반응형