[내일배움캠프_Spring Boot 숙련주차] Bean

Bean을 수동으로 등록하는 방법

@ComponentScan이 @Component를 스캔해 자동으로 Bean을 등록해줌. 일반적으로 3 Layer Annotation인 @Controller, @Service, @Repository를 사용해서 자동으로 Bean을 등록해주는게 좋음

→ 프로젝트 규모가 커질수록 Bean 자동 등록을 사용하면 편리함

 

하지만, 기술적인 문제(기술 지원 Bean)나 공통적인 관심사를 처리할 때 사용하는 객체들은 수동으로 등록하는 것이 좋음(ex: 공통 로그 처리, 같은 비즈니스 로직을 지원하기 위한 부가적인 기능)

 

ex) 비밀번호를 암호화하는 객체를 Bean으로 수동 등록하기

1. Bean으로 등록하고자 하는 객체를 반환하는 메서드 선언
2. 그 메서드 위에 @Bean 어노테이션 추가
3. Bean을 등록하는 메서드가 속해 있는 Class 위에 @Configuration 어노테이션 추가하면
4. Spring Server가 뜰 때 Spring IoC Container에 Bean으로 저장됨

package com.sparta.springauth.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;
import org.springframework.security.crypto.password.PasswordEncoder;

// Bean으로 등록하고자 하는 객체를 반환하는 메서드 선언
// 그 메서드 위에 @Bean 어노테이션 추가
// Bean을 등록하는 메서드가 속해 있는 Class 위에 @Configuration 어노테이션 추가하면
// Spring Server가 뜰 때 Spring IoC Container에 Bean으로 저장됨
@Configuration
public class PasswordConfig {
    @Bean
    public PasswordEncoder passwordEncoder() {
        // BCrypt는 비밀번호를 암호화해주는 Hash 함수로, Password를 Encode 해줌
        return new BCryptPasswordEncoder();
    }
}

 

테스트 수행

package com.sparta.springauth;

import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.security.crypto.password.PasswordEncoder;

@SpringBootTest
public class PasswordEncoderTest {

    @Autowired
    PasswordEncoder passwordEncoder; // 빈 주입 받아옴

    @Test
    @DisplayName("수동 등록한 passwordEncoder를 주입 받아와 문자열 암호화")
    void test1() {
        String password = "Robbie's password";

        // 암호화
        String encodePassword = passwordEncoder.encode(password);
        System.out.println("encodePassword = " + encodePassword);

        String inputPassword = "Robbie";

        // 해시된 비밀번호와 사용자가 입력한 비밀번호를 해싱한 값을 비교
        // passwordEncoder.matches(입력 받은 문자열, 암호화한 비밀번호)
        boolean matches = passwordEncoder.matches(inputPassword, encodePassword);
        System.out.println("matches = " + matches); // 암호화할 때 사용된 값과 다른 문자열과 비교했기 때문에 false
    }
}

테스트 결과

---

같은 타입의 Bean이 2개라면?

Food 인터페이스

package com.sparta.springauth.food;

public interface Food {
    void eat();
}

 

Chicken 클래스

package com.sparta.springauth.food;

import org.springframework.stereotype.Component;

@Component
public class Chicken implements Food {
    @Override
    public void eat() {
        System.out.println("치킨을 먹습니다.");
    }
}

 

Pizza 클래스

package com.sparta.springauth.food;

import org.springframework.stereotype.Component;

@Component
public class Pizza implements Food {
    @Override
    public void eat() {
        System.out.println("피자를 먹습니다.");
    }
}

 

• 인터페이스 클래스 생성 후, 인터페이스를 구현하는 구현체 클래스를 만든 다음에 Bean으로 등록(@Component, @Controller, 등등)하면 해당하는 인터페이스도 Bean으로 등록됨

Food 인터페이스의 Bean 등록

• 즉, 하나의 인터페이스에서 두 개의 구현체를 빈으로 등록하는건 큰 문제는 없음

• 자동 주입을 하려고 할 때, Food라는 타입으로 Bean이 한 개이상이어서 에러 발생함
• 즉, Food 필드에 Bean을 주입을 해야 하는데 같은 타입의 Bean 객체가 하나 이상이라 어떤 Bean을 등록해 줘야 할지 모른다는 의미

같은 타입의 Bean이 2개 이상인 경우, 자동 주입 에러 해결 방법

1. 등록된 Bean의 이름 명시

기본적으로 @Autowired는 Bean DI를 지원하기 때문에 Food라는 타입으로 Bean을 찾음 → 타입으로 찾을 때 Bean이 2개인 것을 확인 → 그 다음 이름으로 Bean을 찾음(chicken, pizza)

@SpringBootTest
public class BeanTest {

    @Autowired
    Food pizza; // Bean 주입 받기

    @Autowired
    Food chicken; // Bean 주입 받기
}

테스트 결과

 

2. @Primary 어노테이션 추가

같은 타입의 Bean이 여러 개 있더라도 우선적으로 @Primary가 적용이 되어있는 Bean 객체를 주입해줌

@Component
@Primary
public class Chicken implements Food {
    @Override
    public void eat() {
        System.out.println("치킨을 먹습니다.");
    }
}

@SpringBootTest
public class BeanTest {

    @Autowired
    Food food; // Bean 주입 받기

    @Test
    @DisplayName("테스트")
    void test1() {
        food.eat();
    }
}

테스트 결과

 

3. @Qualifier 어노테이션 추가

@Component
@Qualifier("pizza")
public class Pizza implements Food {
    @Override
    public void eat() {
        System.out.println("피자를 먹습니다.");
    }
}

@SpringBootTest
public class BeanTest {

    @Autowired
    @Qualifier("pizza")
    Food food; // Bean 주입 받기

    @Test
    @DisplayName("테스트")
    void test1() {
        food.eat();
    }
}

테스트 결과

 

﹡같은 타입의 Bean들에 @Qualifier랑 @Primary가 동시에 걸려 있다고 하면, @Qualifier 우선순위가 더 높음! 하지만, Qualifier는 주입 받고자 하는 곳에 반드시 @Qualifier를 반드시 붙여줘야 함

• 범용적으로 사용되는 Bean 객체에는 @Primary를 사용
• 지역적으로 사용되는 Bean 객체에는 @Qualifier를 사용