Chapter4. 의존 자동 주입

@Autowired 애노테이션을 이용한 의존 자동 주입

• 자동 주입 기능을 사용하면 스프링이 알아서 의존 객체를 찾아서 주입한다.
• 스프링 컨테이너 설정에 의존 객체를 명시하지 않아도 스프링 필요한 의존 빈 객체를 찾아서 주입해준다.

@Autowired 사용 전(@Bean생성해주는 클래스 파일)

@Bean
public MemberDao memberDao() {//생성자 주입 방법
    return new MemberDao();
        }
@Bean
public ChangePasswordService changePwdSvc() {//setter 메소드 주입 방법
    ChangePasswordSerivce pwdSvc = new ChangePasswordSerivce();
    pwdSvc.setMemberDao(memberDao());
    return pwdSvc;
        }

• pwdSvc.setMemberDao(memberDao()); 를 이용하여 빈객체 주입
• ChangePasswordService 객체의 setMemberDao로 MemberDao 빈 객체를 주입하고있다.

@Autowired 사용 후(@Bean생성해주는 클래스 파일)

@Bean
public MemberDao memberDao() {//생성자 주입 방법
    return new MemberDao();
        }
@Bean
public ChangePasswordService changePwdSvc() {//setter 메소드 주입 방법
    ChangePasswordSerivce pwdSvc = new ChangePasswordSerivce();
    return pwdSvc;
        }

• @Autowired를 이용해서 자동으로 필요한 객체를 주입해주기 때문에 빈 객체를 주입하지 않는다.

의존을 주입할 대상에 @Autowired 애노테이션을 붙여준다.

package spring;

import org.springframework.beans.factory.annotation.Autowired;

public class ChangePasswordService {

	@Autowired
	private MemberDao memberDao;

	public void changePassword(String email, String oldPwd, String newPwd) {
		Member member = memberDao.selectByEmail(email);
		if (member == null)
			throw new MemberNotFoundException();

		member.changePassword(oldPwd, newPwd);

		memberDao.update(member);
	}

	public void setMemberDao(MemberDao memberDao) {
		this.memberDao = memberDao;
	}

}

• ChangePasswordService 클래스에서 MemberDao 객체에 @Autowired 애노테이션을 사용했다.
• setMemberDao() 메서드를 사용하지 않고도 스프링 컨테이너가 @Autowired가 붙은 필드에 해당 타입의 빈객체를 찾아서 주입한다.
• @Autowired 애노테이션을 필드나 세터 메서드에 붙이면 스프링은 타입이 일치하는 빈 객체를 찾아 주입한다.

일치하는 빈이 없는 경우

스프링 컨테이너가 자동 주입을 하려면 해당 타입을 가진 빈이 어떤 빈인지 정확하게 한정할 수 있어야한다.
주입할 타입의 빈이 2개이거나 없는 경우 스프링은 자동 주입에 실패하고 익셉션을 발생 시킨다.

@Qualifier 애노테이션을 이용한 의존 객체 선택

자동 주입 가능한 빈이 2개 이상이면 @Qualifier 애노테이션을 사용해서 자동 주입 대상 빈을 한정한다.

@Qualifier 애노테이션 사용 방법 1번째 위치

	@Bean
	@Qualifier("printer")
	public MemberPrinter memberPrinter1() {
		return new MemberPrinter();
	}
	
	@Bean
	@Qualifier("summaryPrinter")
	public MemberSummaryPrinter memberPrinter2() {
		return new MemberSummaryPrinter();
	}

• @Bean애노테이션을 붙인 빈 설정 메서드에서 사용한 예시이다.
• 가장 위의 printer값을 갖는 @Qualifier 애노테이션을 붙여 해당 빈의 한정 값을 "printer"로 지정한다.
• 이렇게 지정한 한정 값은 @Autowired 애노테이션에서 자동 주입할 빈을 한정할 때 사용한다.

@Qualifier 애노테이션 사용 방법 2번째 위치

@Autowired
@Qualifier("printer")
public void setMemberPrinter(MemberPrinter printer) {
    this.printer = printer;
        }

• setMemberPrinter() 메서드에 @Autowired 애노테이션을 붙였으므로 MemberPrinter 타입의 빈을 자동 주입한다.
• 이제 해당 빈이 자동 주입할때 @Bean 객체중 "printer"라고 한정된 MemberPrinter 타입의 (memberPrinter1)을 자동 주입 대상으로 사용한다.

빈 이름과 기본 한정자

	@Bean
	public MemberPrinter printer1() {
		return new MemberPrinter();
	}
	
	@Bean
	@Qualifier("mprinter")
	public MemberPrinter printer2() {
		return new MemberPrinter();
	}

    @Bean
    public MemberInfoPrinter2 infoPrinter() {
            MemberInfoPrinter2 infoPrinter = new MemberInfoPrinter2();
            return infoPrinter;
            }

• printer()메서드로 정의한 빈의 한정자는 빈 이름인 "printer"가 된다.
• printer2()메서드는 "mprinter"가 한정자가 된다.
• @Autowired 애노테이션도 @Qualifier 애노테이션이 없으면 필드나 파라미터 이름을 한정자로를 사용한다.
• 예를 들면 printer 필드에 일치하는 빈이 2개 이상 존재하면 한정자로 필드 이름인 "printer"를 사용한다.

상위/하위 타입 관계와 자동 주입

package spring;

public class MemberSummaryPrinter extends MemberPrinter {

	@Override
	public void print(Member member) {
		System.out.printf(
				"회원 정보: 이메일=%s, 이름=%s\n", 
				member.getEmail(), member.getName());
	}

}

위 클래스는 MemberPrinter 클래스를 상속한 MemberSummaryPrinter클래스이다.

AppCtx클래스 설정에서 memberPrinter2() 메서드가 MemberSummaryPrinter 타입의 빈 객체를 설정하도록 변경하자.

	@Bean
	public MemberPrinter memberPrinter1() {
		return new MemberPrinter();
	}
	
	@Bean
	public MemberSummaryPrinter memberPrinter2() {
		return new MemberSummaryPrinter();
	}

• memberPrinter2()메서드를 MemberSummaryPrinter가 MemberPrinter클래스를 상속하기 때문에 위처럼 변경해줄 수 있다.
• 하지만, MemberPrinter타입 빈 2개에 @Qualifier 애노테이션을 붙이지 않았을 때와 동일한 익셉션이 발생한다.
• memberPrinter2 빈을 MemberSummaryPrinter 타입으로 변경했음에도 중복되는 Bean을 찾지못하는 에러가 발견되는 이유는
• MemberSummaryPrinter 클래스가 MemberPrinter 클래스를 상속했기 때문이다.
• MemberSummaryPrinter 클래스는 MemberPrinter 타입에도 할당할 수 있으므로, 스프링 컨테이너는 MemberPrinter 타입 빈을 자동 주입해야 하는 @Autowired 애노테이션 태그를 만나면 memberPrinter1 빈과 memberPrinter2 타입의 빈 중에서 어떤 빈을 주입해야하는지 알수없다.

MemberListPrinter 클래스와 MemberInfoPrinter 클래스가 MemberPrinter 타입의 빈을 자동 주입하므로 어떤 빈을 주입할지 결정하는 2가지 방법

우선 AppCtx 설정 파일에 @Qualifier 애노테이션을 이용해서 주입할 빈을 한정한다.

package config;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import spring.MemberPrinter;

@Configuration
public class AppCtx {

@Bean
@Qualifier("printer")
public MemberPrinter memberPrinter1() {
    return new MemberPrinter();
}

}

package spring;

    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.beans.factory.annotation.Qualifier;

public class MemberInfoPrinter {

private MemberDao memDao;
private MemberPrinter printer;

public void printMemberInfo(String email) {
    Member member = memDao.selectByEmail(email);
    if (member == null) {
        System.out.println("데이터 없음\n");
        return;
    }
    printer.print(member);
    System.out.println();
}

@Autowired
public void setMemberDao(MemberDao memberDao) {
    this.memDao = memberDao;
}

@Autowired
@Qualifier("printer")
public void setPrinter(MemberPrinter printer) {
    this.printer = printer;
}

}

- MemberInfoPrinter 클래스에서 사용되는 MemberPrinter 빈 객체를 한정해주고, 한정자를 이용해서 자동 주입해준다.

> MemberListPrinter 클래스에 자동 주입할 MemberPrinter 타입 빈 주입하는 방법 1
```java
	@Bean
	@Qualifier("summaryPrinter")
	public MemberSummaryPrinter memberPrinter2() {
		return new MemberSummaryPrinter();
	}

public class MemberListPrinter {

    private MemberDao memberDao;
    private MemberPrinter printer;

    public MemberListPrinter() {
    }

    ...

    @Autowired
    @Qulifier("summaryPrinter")
    public void setMemberPrinter(MemberPrinter printer) {//이부분이 다르다.
        this.printer = printer;
    }
}

• 첫번째 위의 방법처럼 한정자를 이용해서 자동 주입을 연결 해줄 수 있다.

MemberListPrinter 클래스에 자동 주입할 MemberPrinter 타입 빈 주입하는 방법 2

public class MemberListPrinter {

private MemberDao memberDao;
private MemberPrinter printer;

public MemberListPrinter() {
}

...

@Autowired
public void setMemberPrinter(MemberSummaryPrinter printer) {//이 부분에 상속 받는 MemberSummaryPrinter 클래스 사용
    this.printer = printer;
}

}

- MemberSummaryPrinter 타입 빈은 한 개만 존재하므로 MemberSummaryPrinter 빈을 자동 주입 받도록 수정한다.
- 자동 주입 대상이 두개 이상이어서 발생하는 문제 피할 수 있다.
- MemberSummaryPrinter 클래스는 MemberPrinter 클래스를 상속 받기 때문에 사용할 수 있다.

### @Autowired 애노테이션의 필수 여부
```java
public class MemberPrinter {
    private DateTimeFormatter dateTimeFormatter;

    public MemberPrinter() {
        dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy년 MM월 dd일");
    }

    public void print(Member member) {
        if (dateTimeFormatter == null) {
            System.out.printf(
                    "회원 정보: 아이디=%d, 이메일=%s, 이름=%s, 등록일=%tF\n",
                    member.getId(), member.getEmail(),
                    member.getName(), member.getRegisterDateTime());
        } else {
            System.out.printf(
                    "회원 정보: 아이디=%d, 이메일=%s, 이름=%s, 등록일=%s\n",
                    member.getId(), member.getEmail(),
                    member.getName(),
                    dateTimeFormatter.format(member.getRegisterDateTime()));
        }
    }
// 빈객체가 없는 경우 에러를 발생시킬 수 있다.
    @Autowired
    public void setDateFormatter(DateTimeFormatter dateTimeFormatter) {
        this.dateTimeFormatter = dateTimeFormatter;
    }
}

• dateTimeFormatter 필드가 null이면 날짜 형식을 %tF로 출력하고 이 필드가 null이 아니면 dateTimeFormatter를 이용해서 날짜형식을 맞추는 print()메서드다.
• print() 메서드는 dateTimeFormatter가 null인 경우에도 알맞게 동작한다.
• 반드시 setDateFormatter()를 통해서 의존 객체를 주입할 필요는 없다.
• setDateFormatter()에 주입할 빈이 존재하지 않아도 MemberPrinter가 동작하는데는 문제가 없다.
• 하지만 @Autowired 애노테이션은 기본적으로 @Autowired 애노테이션을 붙인 타입에 해당하는 빈이 존재하지 않으면 익셉션을 발생한다.
• 따라서 setDateFormatter() 메서드에서 필요로 하는 DateTimeFormatter 타입의 빈이 존재하지 않으면 익셉션이 발생한다.
• MemberPrinter는 setDateFormatter()메서드에 자동 주입할 빈이 존재하지 않으면 익셉션이 발생하기 보다는 그냥 dateTimeFormatter 필드가 null이면 된다.

🔽 자동 주입할 대상이 필수가 아닌경우의 속성값! 1

//첫번째 방법
public class MemberPrinter {
    ...//필드
    @Autowired(required = false)
    public void setDateFormatter(DateTimeFormatter dateTimeFormatter) {
        this.dateTimeFormatter = dateTimeFormatter;
    }
}

//첫번째 방법 필드에서
public class MemberPrinter {
    @Autowired(required=false)
    private DateTimeformatter dateTimeFormatter;
    
    public void print(Member member) {
        ...
    }
}

• 주입할 대상이 필수가 아닌 경우에는 required속성을 false로 한다.
• 이렇게 하면 매칭되는 빈이 없어도 익셉션이 발생하지 않으며 자동 주입을 수행하지 않는다.
• 위의 예시는 DateTimeFormatter 빈이 존재하지 않으면 주입을 하지않고, setDateFormmatter 메서드를 실행하지 않는다.

🔽 스프링 5버전 부터의 자동 주입할 대상이 필수가 아닌경우의 속성 처리 2 ✅

//두번째 방법
public class MemberPrinter {
    ...//필드
    @Autowired
    public void setDateFormatter(Optional<DateTimeFormatter> formatterOpt) {
        if (formatterOpt.isPresent()) {
            this.dateTimeFormatter = formatterOpt.get();
        } else {
            this.dateTimeFormatter = null;
        }
    }   
}

//두번째 방법 필드에서
public class MemberPrinter {
    @Autowired
    private Optional<DateTimeformatter> formatterOpt;
    
    public void print(Member member) {
        DateTimeFormatter dateTimeFormatter = formatterOpt.orElse(null);
        if(dateTimeFormatter == null) {
            ...
        } else {
            ...//여기에서 사용하는것이 정상적일 것
        }
    }
}

• 자바 8의 Optional을 사용한다.
• 자동 주입 대상 타입이 Optional인 경우, 일치하는 빈이 존재하지 않으면 값이 없는 Optional을 인자로 전달하고 (익셉션이 발생하지 않는다.)
• "formatterOpt.isPresent()"를 이용해서 true이면 값이 존재하므로 dateTimeFormatter를 필드에 할당한다.
• 즉, DateTimeFormatter 타입 빈을 주입 받아 dateTimeFormatter필드에 할당한다.
• 값이 존재하지 않으면 주입 받은 빈 객체가 없으므로 dateTimeFormatter 필드에 null을 할당한다.

🔽 @Nullable 애노테이션을 이용한 방법 3

//세번째 방법
public class MemberPrinter {
    ...//필드
    @Autowired
    public void setDateFormatter(@Nullable DateTimeFormatter dateTimeFormatter) {
        this.dateTimeFormatter = dateTimeFormatter;
    }
}

//세번째 방법 필드에서
public class MemberPrinter {
    @Autowired
    @Nullable
    private DateTimeformatter dateTimeFormatter;

    public void print(Member member) {
        ...
    }
}

• @Nullable 애노테이션을 의존 주입 대상 파라미터에 붙이면, 스프링 컨테이너는 세터 메서드를 호출할 때 자동 주입할 빈이 존재하면 해당 빈을 인자로 전달하고,
• 존재하지 않으면 인자로 null을 전달한다.

✅ @Nullable vs @Autowired

• @Nullable 애노테이션을 사용하면 자동 주입할 빈이 존재하지 않아도 메서드가 호출된다.
• @Autowired 애노테이션의 경우 required 속성이 false인데 주입할 대상의 빈이 존재하지 않으면 세터 메서드를 호출하지 않는다.

생성자 초기화와 필수 여부 지정 방식 동작 이해

@Nullable 과 @Autowired(required = false) 의 차이점

• 일치하는 빈이 없으면 값 할당 자체를 하지않는 @Autowired(required=false)
• @Nullable 애노테이션을 사용하면 일치하는 빈이 없을 때 null값을 할당한다.
• Optional 타입은 매칭 되는 빈이 없으면 값이 없는 Optional을 할당한다.
• ✅ 기본 생성자에서 자동 주입 대상이 외는 필드를 초기화할 때는 이 점에 유의해야한다.

public class MemberPrinter {
	private DateTimeFormatter dateTimeFormatter;
	
	public MemberPrinter() {//생성자에서 필드값을 초기화 해준다.
		dateTimeFormatter = DateTimeFormatter.ofPattern("yyyy년 MM월 dd일");
	}
	
	public void print(Member member) {
		if (dateTimeFormatter == null) {
			System.out.printf(
					"회원 정보: 아이디=%d, 이메일=%s, 이름=%s, 등록일=%tF\n", 
					member.getId(), member.getEmail(),
					member.getName(), member.getRegisterDateTime());
		} else {
			System.out.printf(
					"회원 정보: 아이디=%d, 이메일=%s, 이름=%s, 등록일=%s\n", 
					member.getId(), member.getEmail(),
					member.getName(), 
					dateTimeFormatter.format(member.getRegisterDateTime()));
		}
	}
	
	@Autowired(required = false)
	public void setDateFormatter(DateTimeFormatter dateTimeFormatter) {
		this.dateTimeFormatter = dateTimeFormatter;
	}
    // 출력 : 2018년 01월 02일 null값 전달 X

	@Autowired
	public void setDateFormatter(Optional<DateTimeFormatter> formatterOpt) {
		if (formatterOpt.isPresent()) {
			this.dateTimeFormatter = formatterOpt.get();
		} else {
			this.dateTimeFormatter = null;
		}
	}
	
	@Autowired
	public void setDateFormatter(@Nullable DateTimeFormatter dateTimeFormatter) {
		this.dateTimeFormatter = dateTimeFormatter;
	}
	// 출력 : 2018-01-02 null값 전달 O
}

• @Autowired(required = false)인 경우는 빈이 존재하지않을 때 필드나 메서드에 null값을 전달하지 않는다.
• 그래서 기본 생성자에서 초기화한 DateTimeFormatter의 형식으로 날짜를 출력한다.
• ✅ 하지만 @Nullable인 경우는 필드나 메서드에 null값을 전달함으로 생성자에서 dateTimeFormatter를 초기화 해도 setDateFormatter() 메서드가 null을 전달받아 dateTimeFormatter 필드가 다시 null로 바뀐다.

자동 주입과 명시적 의존 주입 간의 관계

설정 클래스에서 의존을 주입했는데 자동 주입이 대상이라면?

AppCtx 설정 클래스의 infoPrinter() 메서드 예시

@Configuration
public class AppCtx {

    ...
	
	@Bean
	@Qualifier("printer")
	public MemberPrinter memberPrinter1() {
		return new MemberPrinter();
	}
	
	@Bean
	@Qualifier("summaryPrinter")
	public MemberSummaryPrinter memberPrinter2() {
		return new MemberSummaryPrinter();
	}
	
	@Bean
	public MemberListPrinter listPrinter() {
		return new MemberListPrinter();
	}
	
	@Bean
	public MemberInfoPrinter infoPrinter() {
		MemberInfoPrinter infoPrinter = new MemberInfoPrinter();
        //memberPrinter2 빈을 주입
        infoPrinter.setPrinter(memberPrinter2());
		return infoPrinter;
	}
    ...
}

• infoPrinter.setPrinter(memberPrinter2()) 코드를 통해서 memberPrinter2 빈을 주입하고 있다.
• memberPrinter2 빈은 MemberSummaryPrinter 객체이므로 이메일과 이름만 출력한다.
• 하지만 회원 전체의 정보를 보여준다. memberPrinter1 빈을 사용해서 회원 정보를 출력한 것이다.

해당 세터 메서드의 한정자와 자동 주입 애노테이션을 통해서 알아서 빈을 찾아주는 예시

public class MemberInfoPrinter {
    ...
    
    @Autowired
    @Qualifier("printer")
    public void setPrinter(MemberPrinter printer) {
        this.printer = printer;
    }
}

• 즉 AppCtx(설정클래스) 클래스에서 세터 메서드를 통해 의존을 주입해도 해당 세터 메서드에 @Autowired 애노테이션이 붙어 있으면 자동 주입을 통해서 일치하는 빈을 주입한다.
• 따라서 @Autowired 애노테이션을 사용했다면, AppCtx(설정클래스) 클래스에서 객체를 주입하기 보다는 스프링이 제공하는 자동 주입 기능을 사용하는 편이 낫다.

의존 자동주입과 수동주입을 함께 사용하는 것도 바람직하지 않다.
자동 주입을 사용한다면 일관성있게 지속적으로 @Autowired를 이용한 자동 주입을 사용하는 것을 권장한다.