[Spring] 스프링 빈과 의존관계

인프런의 스프링 입문 - 코드로 배우는 스프링 부트, 웹 MVC, DB 접근 기술를 정리한 글이다

🏃🏻‍♀️ 컴포넌트 스캔과 자동 의존관계 설정

멤버 컨트롤러가 멤버 서비스를 통해 회원가입을 하고, 멤버 서비스를 통해 데이터를 조회할 수 있어야 한다.

-> 서로 의존관계가 있다! (컨트롤러가 서비스에 의존한다.)

 

1. 컨트롤러

controller 패키지에 MemberController 생성

package hello.hellospring.controller;

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

/**
 * 스프링이 처음에 뜰 때, 스프링 컨테이너라는 통이 생기고 거기에
 * 아래와 같이 Controller라는 어노테이션이 있으면
 * MemberController 객체를 생성해서 스프링에 넣어두고, 스프링이 관리한다.
 */
@Controller
public class MemberController {

    /**
     * MemberService를 new해서 사용하면 다른 여러 컨트롤러들이 MemberService를 사용할 때마다 새로운 객체가 생성된다. (매번 생성)
     * -> 하나의 객체를 공유해서 사용하면 됨
     */
    private final MemberService memberService;

    /**
     * 생성자 사용
     * 생성자에 Autowired가 있으면 스프링이 스프링 컨테이너에 있는 서비스를 연결시켜 준다.
     * ! 그런데 !
     * MemberSerivce는 순수한 자바 클래스이기 때문에 스프링이 얘를 알 수가 없다.
     * -> MemberService에 @Service를 넣어준다.
     * MemoryMemberRepository도 마찬가지 (@Repository를 넣어주면 된다.)
     */
    @Autowired
    public MemberController(MemberService memberService) { // MemberController를 생성할 때, memberService를 넣어준다. (의존관계)
        this.memberService = memberService;
    }
}
/**
 * 컨트롤러를 통해 외부 요청을 받고,
 * 서비스를 통해 비즈니스 로직을 만들고,
 * 레포지토리에서 데이터를 저장
 */

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

 

실행시켜보면, 다음과 같이 오류가 발생한다.

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

이유는 MemberService가 스프링 빈으로 등록되어 있지 않기 때문이다.

2. 서비스

해결방법

MemberService에 @Service 어노테이션을 입력해주면, 스프링 빈으로 등록된다.

package hello.hellospring.service;

import hello.hellospring.domain.Member;
import hello.hellospring.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;

    @Autowired
    public MemberService(MemberRepository memberRepository) { // MemberService는 MemberRepository가 필요 (의존관계)
        this.memberRepository = memberRepository;
    }

    /**
     * 회원가입
     * 같은 이름이 있는 회원은 가입 불가
     */
    public Long join(Member member) {
//        // 같은 이름이 있는 중복 회원 X
        /**
         * 방법 1
         */
//        Optional<Member> result = memberRepository.findByName(member.getName()); // command + option + V하면 쉽게 코드 작성 가능
//        // Optional!
//        result.ifPresent(m -> { // ifPresent는 Optional이기 때문에 가능하다! 만약 객체가 존재하면~ 이라는 뜻의 함수
//            throw new IllegalStateException("이미 존재하는 회원입니다.");
//        });
        /**
         * 방법 2
         * 위의 코드를 아래와 같이 예쁘게 줄일 수 있다.
         */
//        memberRepository.findByName(member.getName())
//                .ifPresent(m -> {
//                    throw new IllegalStateException("이미 존재하는 회원입니다.");
//                });

        /**
         * 방법 3
         * 위의 코드를 메서드로 뽑아내는 경우
         * 위 코드를 모두 잡고, control + T를 사용해 Refactor 관련된 것들을 볼 수 있다. -> 9. Extract Method 사용
         */
        validateDuplicateMember(member); // 중복 회원 검증

        memberRepository.save(member);

        return member.getId();
    }

    private void validateDuplicateMember(Member member) {
        memberRepository.findByName(member.getName())
                .ifPresent(m -> {
                    throw new IllegalStateException("이미 존재하는 회원입니다.");
                });
    }

    /**
     * 전체 회원 조회
     */
    public List<Member> findMembers() { // 서비스 클래스는 보통 비즈니스와 비슷한 이름을 사용한다. (Role에 맞도록 네이밍)
        return memberRepository.findAll();
    }

    /**
     * 회원 조회
     */
    public Optional<Member> findOne(Long memberId) {
        return memberRepository.findById(memberId);
    }
}

 

3. 레포지토리

MemberService는 MemoryMemberRepository와 의존 관계이므로, MemoryMemberRepository도 스프링 빈으로 등록해준다. 

-> @Repository 어노테이션 입력

package hello.hellospring.repository;

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

import java.util.*;

/**
 * 동시성 문제가 고려되어 있지 않다.
 * 실무에서는 ConcurrentHashMap과 AtomicLong을 주로 사용한다.
 */
@Repository
public class MemoryMemberRepository implements MemberRepository {

    private static Map<Long, Member> store = new HashMap<>(); // 동시성을 위해, 실무에서는 ConcurrentHashMap을 사용한다.
    private static long sequence = 0L; // 0, 1, 2 인덱스 생성해주는 변수 / 동시성을 위해, 실무에서는 AtomicLong을 사용한다.

    @Override
    public Member save(Member member) {
        member.setId(++sequence); // sequence 값을 하나 올려준다. store에 넣기 전에 id 값 세팅
        store.put(member.getId(), member);

        return member;
    }

    @Override
    public Optional<Member> findById(Long id) {
        return Optional.ofNullable(store.get(id)); // Optional을 사용하면 store.get(id)가 null이어도 감싸서 반환해준다.
    }

    @Override
    public Optional<Member> findByName(String name) {
        return store.values().stream()
                .filter(member -> member.getName().equals(name)) // member.getName()이 파라미터로 넘어온 name과 같은지 확인
                .findAny(); // 위에서 같은 경우에만 필터링이 되고, 찾은 경우 return한다. findAny()는 결과가 Optional로 반환된다!
    }

    @Override
    public List<Member> findAll() {
        return new ArrayList<>(store.values()); // store는 Map이고, 현재 return 값은 list이므로 이렇게 반환해줘야 한다.
    }

    // 테스트 케이스에서 사용하기 위해
    public void clearStore() {
        store.clear();
    }
}

 

컴포넌트 스캔 원리

1. @Component 어노테이션이 있으면, 스프링 빈으로 자동 등록된다.

2. @Controller 컨트롤러가 스프링 빈으로 자동 등록된 이유도 컴포넌트 스캔 때문이다.

3. @Component를 포함하는 다음 어노테이션도 스프링 빈으로 자동 등록된다.

        - @Controller

        - @Service

        - @Repository

 

스프링 빈 등록 이미지

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

[참고]

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

 

🏃🏻‍♀️ 자바 코드로 직접 스프링 빈 등록하기

위에서 작성한 MemberService와 MemoryMemberRepository의 @Service, @Repository, @Autowired 어노테이션을 제거하고 진행한다.

 

hellospring 패키지 아래에 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 {

    /**
     * memberService와 memberRepository를 스프링 빈에 등록하고,
     * memberService와 memberRepository 의존관계 설정
     */
    @Bean
    public MemberService memberService() {
        return new MemberService(memberRepository()); // Autowired와 비슷
    }

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

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

[참고]

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

! 주의 !

@Autowired를 통한 DI는 helloController, MemberService 등과 같이 스프링이 관리하는 객체에서만 동작한다.
스프링 빈으로 등록하지 않고, 내가 직접 생성한 객체에서는 동작하지 않는다.
-> new 해서 객체를 생성하는 경우에는 @Autowired가 동작하지 않는다.