예제 소스 코드

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

<!-- BookStore.class -->

public interface BookStore {
    
}

<!-- NobleBookStore.class -->

@Service
public class NobleBookStore implements BookStore {

}

<!-- EssayBookStore.class -->

@Service
public class EssayBookStore implements BookStore {

}

중복된 의존주입

동일한 타입의 Bean을 의존 주입 받으려고 하면 문제가 발생합니다(동일한 타입의 Bean 등록에는 문제가 없다).

1
2
3
4
5
6
7
8
9

@Component
public class City {
    @Autowired
    BookStore bookStore;

    public BookStore getBookStore() {
        return bookStore;
    }
}

1

Error creating bean with name 'city': Unsatisfied dependency expressed through field 'bookStore'

동일한 타입의 Bean이 2개가 존재하기 때문에 위와 같은 에러가 발생합니다.

해결방법

@Primary 어노테이션 사용

우선적으로 의존 주입하고 싶은 class에 @Primary 어노테이션을 사용합니다.

1
2
3
4
5

@Service
@Primary
public class NobleBookStore implements BookStore {

}

1
2
3
4
5
6
7
8
9

public class TestControllerTest {

    @Test
    public void test() {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
        System.out.println(((City)applicationContext.getBean("city")).getBookStore());

    }
}

1

kr.co.spring.NobleBookStore@16e7dcfd

@Qulifier 어노테이션 사용

@Autowired와 함께 사용하며 사용하고자 하는 빈의 아이디를 적어주면 됩니다(빈의 아이디를 따로 설정하지 않으면 default로 class 명에 첫글자가 소문자인 아이디로 설정된다).

1
2
3
4
5
6

@Component
public class City {
    @Autowired
    @Qualifier("nobleBookStore")
    BookStore bookStore;
}

@Qulifier 어노테이션 사용하지 않기

기본적으로 @Autowried는 타입으로 의존주입을 해주지만 타입이 존재하지 않으면 Bean Name으로도 의존주입이 가능합니다. 그래서 굳이 @Qulifier를 사용하지 않아도 사용이 가능합니다.

아래의 코드를 보면 이해가 가능합니다.

1
2
3
4
5

@Component
public class City {
    @Autowired
    BookStore nobleBookStore;   // 기존에 bookStore 대신 nobleBookStore를 사용하과 있다.
}

동일한 타입의 Bean 모두 의존주입 받기

동일한 타입의 Bean들을 모두 의존주입을 받을수가 있습니다.

1
2
3
4
5

@Component
public class City {
    @Autowired
    List<BookStore> bookRepoitories;   
}

Comment and share

@Autowried는 Bean으로 등록된 객체를 자동으로 삽입해주는 역할을 합니다. 생성자, 필드, set메소드를 활용 하여 적용이 가능합니다.

예제 Class 등록

해당 포스팅 시에 사용 할 Book 클래스입니다. 아래에서 사용 될 Book 클래스는 아래 소스 코드를 사용하게 됩니다.

1
2
3
4
5
6
7
8

package kr.co.spring;

import org.springframework.stereotype.Component;

@Component
public class Book {

}

생성자를 이용한 방법

생성자 메소드 위에 @Autowired만 등록 해서 사용 하면 됩니다.

1
2
3
4
5
6
7
8
9

@Component
class BookStore {
    private Book book;

    @Autowired
    public BookStore(Book book) {
        this.book = book;
    }
}

setter를 이용한 방법

setter 메소드 위에 @Autowired만 등록 해서 사용 하면 됩니다. 생성자와는 달리 @Autowired를 붙여주지 않으면 의존주입이 되지 않습니다.

1
2
3
4
5
6
7
8
9

@Component
class BookStore {
    private Book book;

    @Autowired
    public setBook(Book book) {
        this.book = book;
    }
}

setter를 활용하면 Bean을 필수적으로 의존주입 받을지 여부를 선택할수 있습니다. 옵션을 주지 않는 경우 의존주입 받을 Bean이 없는 경우 에러가 발생합니다. 이때 @Autowired(required = false)를 사용해서 만약 Bean이 존재하지 않는 경우 의존주입을 받지 않도록 설정이 가능합니다.

필드에 직접 사용

필드 위에 @Autowired를 등록해서 사용이 가능합니다. 가장 심플하게 코드를 작성할수 있습니다. setter와 마찬가지로 required 옵션을 사용가능합니다.

1
2
3
4
5

@Component
class BookStore {
    @Autowired
    private Book book;
}

외부 라이브러리를 Bean 등록하고 의존주입

수정이 불가능한 외부라이브러리를 Bean으로 등록하고 해당 Bean에 의존주입까지 해주어야 하는 경우가 있습니다.

1
2
3
4

<bean id="library" class="kr.co.spring.Library">
    <constructor-arg value="라이브러리"/>
    <property name="location" value="서울"/>
</bean>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

public class Library {
    private String name;
    private String location;

    public Library(String name) {
        this.name = name;
    }

    public void setLocation(String location) {
        this.location = location;
    }

    @Override
    public String toString() {
        return "Library{" +
                "name='" + name + '\'' +
                ", location='" + location + '\'' +
                '}';
    }
}

1
2
3
4
5
6
7
8
9

public class TestControllerTest {

    @Test
    public void test() {
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("spring/spring-bean.xml");
        Library library = (Library) applicationContext.getBean("library");
        System.out.println(library.toString());
    }
}

1

Library{name='라이브러리', location='서울'}

만약 생성자에서 파라미터를 여러개 받는 경우에는 index를 이용하면 됩니다.

1
2
3
4
5
6
7

<bean id="library" class="kr.co.spring.Library">
    <constructor-arg index="0" value="1"/>
    <constructor-arg index="1" value="라이브러리"/>

    <property name="location" value="서울"/>
</bean>

type 속성을 이용해서도 사용 가능합니다.

1
2
3
4
5
6

<bean id="library" class="kr.co.spring.Library">
    <constructor-arg value="1" type="int"/>
    <constructor-arg value="라이브러리" type="java.lang.String"/>

    <property name="location" value="서울"/>
</bean>

Comment and share

IoC란

Ioc란 Inversion of Control의 약자로써, 어떤 객체가 사용하는 의존 객체를 직접 만들어 사용하는게 아니라 주입받아서 사용하는 방법을 일컫는 말입니다.

스프링 IoC 컨테이너

컨테이너는 보통 인스턴스의 생명주기를 관리하며, 생성된 인스턴스에게 추가적인 기능을 제공하는 것입니다. 스프링 컨테이너는 어플리케이션 컴포넌트의 중앙 저장소와 같은 역할을 하며 빈 설정 소스로부터 빈 정의를 읽어 들여 빈을 구성 하고 제공하는 역할을 합니다.

IoC 컨테이너의 핵심적인 역할을 하는 인터페이스가 BeanFactory이다.

IoC 컨테이너의 장점

1. 의존주입을 통한 빈 관리가 용이하다.
2. 싱글톤 사용을 할수 있다.
3. 라이프사이클 인터페이스를 제공해준다.
   • @PostConstruct : 메소드 위에 사용하면 빈이 생성될때 실행된다(ApplicationContext에서 제공).
4. 의존주입 방법을 통해서 테스트 하기 쉬운 코드를 작성할수 있다.
   • Mock 객체를 생성해서 의존성 주입을 할수 있어 테스트 하기에 용의하다.

Bean

스프링 IoC 컨테이너가 관리하는 객치입니다.

Bean 등록방법

1. XML을 이용한 방법

bean이라는 태그를 이용해서 Bean 등록을 할수 있다.

1

<bean id="인스턴스명" class="클래스경로"/>

옵션

1. id : 보통 카멜케이스로 작성을 하며 사용할 인스턴스명을 입력해주면 된다.
2. class : Bean 등록 하려는 클래스의 경로를 입력해주면 된다.
3. scope : 말그대로 스코프를 설정
   • 기본값은 싱글톤
   • 매번 다른 값을 사용하려면 prototype으로 설정
   • 이외에도 request, session 등이 존재
4. autowire

의존주입

property 태그를 이용해서 의존주입 관계를 형성 할수 있습니다. name은 의존주입할 set메소드 이름이고, ref는 Bean의 id입니다. 인스턴스가 아닌 경우 ref 대신 value를 사용합니다.

1
2
3
4

<bean id="book" class="kr.co.Book"/>
<bean id="store" class="kr.co.Store">
    <property name="set메소드이름" ref="의존주입할 Bean의 id"/>
</bean>

1
2
3
4
5
6
7

class Store {
    private Book book;

    public void setBookTest(Book book) {    // property의 name으로 bookTest를 입력해주어야 함
        this.book = book;
    }
}

예제 코드

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

<!-- Test.class -->

public class Test {
    public void test() {
        System.out.println("너는 안녕?");
    }
}

<!-- TestController.class -->

public class TestController {
    private Test test;


    public void test() {
        System.out.println("안녕하세요");
        test.test();
    }

    public void setTest(Test test) {
        this.test = test;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

<!-- spring-bean.xml -->

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="
    http://www.springframework.org/schema/beans 
    http://www.springframework.org/schema/beans/spring-beans.xsd
">

    <bean id="test" class="kr.co.spring.Test"></bean>

    <bean id="testController" class="kr.co.spring.TestController">
        <property name="test" ref="test"/>
    </bean>
</beans>

테스트 코드를 통해서 XML 빈 등록이 잘 되고 있음을 확인할수 있습니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14

public class TestControllerTest {

    @Test
    public void test() {
        ApplicationContext applicationContext = 
                new ClassPathXmlApplicationContext("spring/spring-bean.xml");

        TestController testController = 
                (TestController) applicationContext.getBean("testController");

        testController.test();
        System.out.println("등록 된 Bean" + Arrays.toString(applicationContext.getBeanDefinitionNames()));
    }
}

1

등록 된 Bean[test, testController]

단점

XML로 작성하는 경우에는 문자열로 작성을 하기 때문에 자동완성기능 등 IDE의 도움을 받는 것에 제한이 되기 때문에 작성하는데에 어려움이 존재 합니다(지원 되는 것도 존재하지만 그래도 자바소스 작성시보다는 불편하다).

component-scan

지금까지는 수동으로 Bean을 등록을 하였었는데 이 방법으로는 수많은 Bean들을 직접 등록하기가 힘듭니다. 그래서 어노테이션을 통해서 좀더 간편하게 Bean등록하는 방법인 component-scan이 등장하게 되었습니다. package를 설정하여 해당 package내에서 @Component 어느테이션이 등록 된 객체를 Bean에 등록해 줍니다.

예제 코드

1
2
3
4
5
6
7
8

package kr.co.spring;

import org.springframework.stereotype.Component;

@Component
public class ComponentScanTest {
    
}

1
2
3
4
5
6
7
8
9
10
11

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns:context="http://www.springframework.org/schema/context"
   xsi:schemaLocation="http://www.springframework.org/schema/beans 
   http://www.springframework.org/schema/beans/spring-beans.xsd 
   http://www.springframework.org/schema/context 
   http://www.springframework.org/schema/context/spring-context.xsd
">
    <cotext:component-scan base-package="kr.co.spring"/>
</beans>

1
2
3
4
5
6
7
8
9
10

public class TestControllerTest {

    @Test
    public void test() {
        ApplicationContext applicationContext = 
                new ClassPathXmlApplicationContext("spring/spring-bean.xml");

        System.out.println("등록 된 Bean" + Arrays.toString(applicationContext.getBeanDefinitionNames()));
    }
}

1

등록 된 Bean[componentScanTest, ...]

클래스 설정파일로 Bean 등록

Spring 3.0 이후 보전부터 자바 소스 코드로도 Bean을 등록 할수 있는 방법이 추가 되었습니다. 자바 소스 코드로 작성하게 되면 IED의 기능을 활용할수 있기 때문에 XML보다 작성이 용이하다는 장점이 있습니다.

자바소스로 Bean 구성방법은 @Configuration과 @Bean으로 쉽게 구성이 가능합니다. @Configuration은 해당 클래스가 설정파일임을 명시해 줍니다. @Bean은 메소드 정의시에 사용하며 해당 메소드가 반환한 객체를 Bean으로 등록해줍니다. default로 메소드이름이 Bean Name이 됩니다.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

@Configuration
public class BeanConfig {

    @Bean
    public Test test() {
        return new Test();
    }

    @Bean
    public TestController testController(Test test) {
        TestController testController = new TestController();
        testController.setTest(test);
        return testController;
    }
}

1
2
3
4
5
6
7
8
9
10

public class TestControllerTest {

    @Test
    public void test() {
        ApplicationContext applicationContext = 
            new AnnotationConfigApplicationContext(BeanConfig.class);   // 클래스설정파일로 Bean등록할때 사용하는 ApplicationContext
        System.out.println("등록 된 Bean" + Arrays.toString(applicationContext.getBeanDefinitionNames()));

    }
}

1

등록 된 Bean[..., test, testController]

@Bean을 활용한 DI에는 2가지 방법이 존재 합니다.

1. 파라미터로 Bean 등록 된 객체를 작성하면 자동으로 주입해 줍니다(위의 방법).
2. @Bean을 사용하는 메소드를 호출합니다(이 방법은 같은 클래스 내부에 존재할때만 가능).

클래스 설정파일로 component-scan

@Bean을 이용하는 방법 또한 직접 작성을 해야하기 때문에 등록하기가 힘듭니다. XML에서 compoennt-scan을 사용하였듯이 클래스 설정파일에서도 마찬가지로 component-scan을 사용할수 있습니다.

@ComponentScan(“base 패키지명”)으로 설정파일에 작성해주면 사용이 가능합니다.

1
2
3
4
5

@Configuration
@ComponentScan("kr.co.spring")
public class BeanConfig {

}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

@Component
public class ComponentScanTest {

}


public class TestControllerTest {

    @Test
    public void test() {
        ApplicationContext applicationContext = new AnnotationConfigApplicationContext(BeanConfig.class);
        System.out.println("등록 된 Bean" + Arrays.toString(applicationContext.getBeanDefinitionNames()));

    }
}

1

등록 된 Bean[..., componentScanTest]

@ComponentScan 옵션

1. @ComponentScan : 아무런 옵션도 주지 않는 경우로 해당 클래스가 위치한 패키지 내부를 basePackage로 설정합니다.
2. @ComponentScan(basePackages = “패키지명”) : 위의 예제와 같은 경우로 직접 basePackage를 설정합니다.
3. @ComponentScan(basePackageClasses = 클래스명.class) : 특정 클래스가 위치한 패키지를 basePackage로 설정할때 사용합니다.

스프링부트에서의 Bean 등록

스프링부트에서 제공하는 SpringBootApplication 어노테이션을 사용하면 위에서 작업했었던 component-scan, ApplicationContext 생성과 같은 소스코드를 작성할 필요가 없습니다. 해당 어노테이션이 자동으로 생성을 해 줍니다.

공부하면서 느낀점

XML로 Bean을 등록 하는 것보다는 IDE의 도움을 받을수 있는 자바소스로 설정하는게 좀더 편하다고 생각한다. 그리고 Bean을 직접 등록해서 사용하는 것보다는 component-scan을 이용하것이 좋을것 같다.

결론

직접 작성 한 클래스는 component-scan을 활용하고, 외부 라이브러리를 사용할시에는 @Bean을 직접 등록 해서 사용하자!

Comment and share