토비의 스프링 - 1.8 XML을 이용한 설정, 1.9 1장 정리

청포도봉봉이·2024년 5월 14일
JavaSpring
1

코드로 작성해보는 토비의 스프링

목록 보기
8/13
post-thumbnail

스프링은 DaoFactory와 같은 자바 클래스를 이용하는 것 외에도, 다양한 방법을 통해 DI 의존관계 설정정보를 만들 수 있다. 가장 대표적인 것이 바로 XML이다.

XML은 단순한 텍스트 파일이기 때문에 다루기 쉽다. 또, 쉽게 이해할 수 있으며 컴파일과 같은 별도의 빌드 작업이 없다는 것도 장점이다. 환경이 달라져서 오브젝트의 관계가 바뀌는 경우에도 빠르게 변경사항을 반영할
수 있다. 스키마나 DTD를 이용해서 정해진 포맷을 따라 작성됐는지 손쉽게 확인할 수도 있다.

1.8.1 XML 설정

스프링의 애플리케이션 컨텍스트는 XML에 담긴 DI 정보를 활용할 수 있다. DI 정보가 담긴 XML 파일은 를 루트 엘리먼트로 사용한다. 이름에서 알 수 있듯이 안에는 여러
개의 을 정의할 수 있다. XML 설정은 @Configuration과 @Bean이 붙은 자바 클래스로 만든 설정과 내용이 동일하다. @Cofiguration을 , @Bean을 에
대응해서 생각하면 이해하기 쉬울 것이다.

하나의 @Bean 메서드를 통해 얻을 수 있는 빈의 DI 정보는 다음 세 가지다.

  1. 빈의 이름
  • @Bean 메서드 이름이 빈의 이름이다. 이 이름은 getBean()에서 사용된다.
  1. 빈의 클래스
  • 빈 오브젝트를 어떤 클래스를 이용해서 만들지를 정의한다.
  1. 빈의 의존 오브젝트
  • 빈의 생성자나 수정자 메서드를 통해 의존 오브젝트를 넣어준다. 의존 오브젝트도 하나의 빈이므로 이름이 있을 것이고, 그 이름에 해당하는 메서드를 호출해서 의존 오브젝트를 가져온다. 의존 오브젝트는 하나 이상일
    수도 있다.

XML에서도 을 사용해서 이 세 가지 정보를 정의할 수 있다.

connectionMaker() 전환

image

위 표에는 자바 코드로 만든 설정정보와 그에 대응되는 XML의 설정정보를 비교해뒀다.

image

XML 설정 파일의 태그를 보면 @Bean 메서드에서와 같은 작업이 일어나겠구나라고 떠올릴 수 있으면 좋을 것이다.

userDao() 전환

userDao()에는 DI 정보의 세 가지 요소가 모두 들어 있다. 여기서 관심을 가질 것은 수정자 메서드를 사용해 의존관계를 주입해주는 부분이다. 스프링 개발자가 수정자 메서드를 선호하는 이유 중에는 XML로
의존관계 정보를 만들 때 편리하다는 점도 있다. 자바빈의 관례를 따라서 수정자 메서드는 프로퍼티가 된다. 프로퍼티 이름은 메서드 이름에서 set을 제외한 나머지 부분을 사용한다. 예를 들어 오브젝트에
setConnectionMaker()라는 이름의 메서드가 있다면 connectionMaker라는 프로퍼티를 갖는다고 할 수 있다.

XML에서는 태그를 사용해 의존 오브젝트와의 관계를 정의한다. 태그는 name과 ref라는 두 개의 속성을 갖는다. name은 속성의 이름이다. 이 속성 이름으로 수정자
메서드를 알 수 있다. ref는 수정자 메서드를 통해 주입해줄 오브젝트의 빈 이름이다. DI 할 오브젝트도 역시 빈이다. 그 빈의 이름을 지정해주면 된다. @Bean 메서드에서라면 다음과 같은 다른 @Bean
메서드를 호출해서 주입할 오브젝트를 가져온다.

userDao.setConnectionMaker(connectionMaker());

여기서 userDao.setConnectionMaker()는 userDao 빈의 connectionMaker 속성을 이용해 의존관계 정보를 주입한다는 듯이다. 메서드 파라미터로 넣는 connectionMaker()는 connectionMaker() 메서드를 호출해서 리턴하는 오브젝트를 주입하라는 의미다. 이 두가지 정보를 의 name 속성과 ref 속성으로 지정해주면 된다. 각 정보를 태그에 대응하면 다음과 같이 전환이 가능하다.

image

마지막으로 이 태그를 userDao 빈을 정의한 태그 안에 넣어주면 된다.

image

XML의 의존관계 주입 정보

이렇게 해서 두 개의 태그를 이용해 @Bean 메서드를 모두 XML로 변환했다. 아래와 같이 작성해주면 XML로의 전환 작업이 끝난다.

<beans>
  <bean id="connectionMaker" class="springbook.user.dao.DConnectionMaker" />
  <bean id="userDao" class="springbook.user.dao.UserDao">
    <property name="connectionMaker" ref="connectionMaker"/>
  </bean>
</beans>

<property> 태그의 name과 ref는 의미가 다르므로 이름이 같더라도 어떤 차이가 있는지 구별할 수 있어야 한다.

image

때로는 같은 인터페이스를 구현한 의존 오브젝트를 여러 개 정의해두고 그 중에서 원하는 걸 골라 DI하는 경우도 있다. 이때는 각 빈의 이름을 독립적으로 만들어주고 ref 속성을 이용해 DI 받을 빈을 지정해주면 된다.

image

1.8.2 XML을 이용하는 애플리케이션 컨텍스트

이제 애플리케이션 컨텍스트가 DaoFactory 대신 XML 설정정보를 활용하도록 만들어보자. XML에서 빈의 의존관계 정보를 이용하는 IoC/DI 작업에는 GenericXmlApplicationContext 를 사용한다. GenericXmlApplicationContext의 생성자 파라미터로 XML 파일의 클래스패스를 지정해주면 된다. XML 설정파일은 클래스패스 최상단에 두면 편하다.

application.xml을 만들보자. (SpringBoot라면 /resource 폴더에 만들면 된다.)

<?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="connectionMaker" class="tobi.study.user.STEP1.XML을_이용한_설정_1_8.DConnectionMaker"/>

  <bean id="userDao" class="tobi.study.user.STEP1.XML을_이용한_설정_1_8.UserDao">
    <property name="connectionMaker" ref="connectionMaker"/>
  </bean>
</beans>

다음으로 UserDaoTest의 애플리케이션 컨텍스트 생성 부분을 수정한다. 기존에 사용했던 AnnotationConfigApplicationContext 대신 GenericXmlApplicationContext를 이용해서 다음과 같이 애플리케이션 컨텍스트를 생성하게 만든다.

class UserDaoTest {
    public static void main(String[] args) throws SQLException, ClassNotFoundException {
        ApplicationContext context = new GenericXmlApplicationContext("applicationContext.xml");
        UserDao userDao = context.getBean("userDao", UserDao.class);
    }
}

UserDaoTest를 실행해보면 똑같은 결과가 나온다.

image

성공한다면 이제 XML 설정파일을 사용하도록 변환하는 작업을 모두 마친 것이다.

GenericXmlApplicationContext 외에도 ClassPathXmlApplicationContext 를 이용해 XML로부터 설정정보를 가져오는 애플리케이션 컨텍스트를 만들 수 있다.

  • GenericXmlApplicationContext는 클래스 패스 뿐 아니라 다양한 소스로부터 설정파일을 읽어올 수 있다.
  • ClassPathXmlApplicationContext는 XML 파일을 클래스패스에서 가져올 때 사용할 수 있는 편리한 기능이 추가된 것이다.

ClassPathXmlApplicationContext의 기능 중에는 클래스패스의 경로 정보를 클래스에서 가져오게 하는 것이 있다. 예를 들어 springbook.user.dao 패키지 안에 daoContext.xml 이라는 설정 파일을 만들었다고 해보자. GenericXmlApplicationContext가 이 XML 설정파일을 사용하게 하려면 클래스 패스 루트로부터 파일의 위치를 지정해야 하므로 다음과 같이 작성해야 한다.

new GenericXmlApplicationContext("springbook/user/dao/daoContext.xml");

반면에 ClassPathXmlApplicationContext는 XML 파일과 같은 클래스패스에 있는 클래스 오브젝트를 넘겨서 클래스패스에 대한 힌트를 제공할 수 있다. UserDao는 springbook.user.dao 패키지에 있으므로 daoContext.xml 과 같은 클래스패스 위에 있다. 따라서 아래와 같이 지정할 수 있다.

new ClassPathXmlApplicationContext("daoContext.xml", UserDao.class);

이 방법으로 클래스패스를 지정할 경우가 아니라면 GenericXmlApplicationContext를 사용하는 편이 무난하다.

1.8.3 DataSource 인터페이스로 변환

DataSource 인터페이스 적용

javax.sql.DataSource 인터페이스를 살펴보자.

ConnectionMaker는 DB 커넥션을 생성해주는 기능 하나만을 정의한 매우 단순한 인터페이스다. IoC와 DI의 개념을 설명하기 위해 직접 이 인터페이스를 정희하고 사용했지만, 사실 자바에서는 DB 커넥션을 가져오는 오브젝트의 기능을 추상화해서 비슷한 용도로 사용할 수 있게 만들어진 DataSource 인터페이스가 이미 존재한다. 따라서 실전에서 ConnectionMaker와 같은 인터페이스를 직접 만들어서 사용할 일은 없을 것이다.

아래 코드에서 관심을 가질 것은 getConnection() 메서드 하나 뿐이다. 이름만 다르지 ConnectionMaker 인터페이스의 makeConnection()과 목적이 동일한 메서드다. DAO에서는 DataSource의 getconnection() 메서드를 사용해 DB 커넥션을 가져오면 된다.

public interface DataSource extends CommonDataSource, Wrapper {
    Connection getConnection() throws SQLException;
}

DataSource 인터페이스와 구현 클래스를 사용할 수 있도록 UserDao를 리팩토링 해보자.

코드를 아래와 같이 바꿔준다.

class UserDao {
    private DataSource dataSource;

    public void setDataSource(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    public void add(User user) throws SQLException, ClassNotFoundException {
        Connection c = dataSource.getConnection();
        
        // ...
    }
}

다음은 DataSource 구현 클래스가 필요하다. 앞에서 만들었던 DriverManager를 사용하는 SimpleConnectionMaker처럼 단순한 DataSource 구현 클래스를 하나 가져다 사용하자.

자바 코드 설정 방식

먼저 DaoFactory 설정 방식을 이용해보자. 기존 코드를 변경해 보겠다.

implementation 'com.h2database:h2'
implementation 'org.springframework:spring-jdbc'

라이브러리를 추가해준다.

그리고 DaoFactory 클래스를 아래와 같이 수정한다.

package tobi.study.user.XML을_이용한_설정_1_8;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.jdbc.datasource.SimpleDriverDataSource;
import tobi.study.user.STEP1.XML을_이용한_설정_1_8.ConnectionMaker;
import tobi.study.user.STEP1.XML을_이용한_설정_1_8.DConnectionMaker;
import tobi.study.user.STEP1.XML을_이용한_설정_1_8.UserDao;

import javax.sql.DataSource;

@Configuration
class DaoFactory {
  @Bean
  public DataSource dataSource() {
    SimpleDriverDataSource dataSource = new SimpleDriverDataSource();

    dataSource.setDriverClass(org.h2.Driver.class);
    dataSource.setUrl("jdbc:h2:tcp://localhost/~/tobiSpringStudy");
    dataSource.setUsername("sa");
    dataSource.setPassword("");

    return dataSource;
  }

  @Bean
  public UserDao userDao() {
    UserDao userDao = new UserDao();
    userDao.setDataSource(dataSource());
    return userDao;
  }

  @Bean
  public ConnectionMaker connectionMaker() {
    return new DConnectionMaker();
  }

  public UserDao getUserDao() {
    UserDao userDao = new UserDao();
    userDao.setDataSource(dataSource());
    return userDao;
  }
}

그리고 UserDaoTest를 DaoFactory를 사용하도록 바꿔준다음 테스트를 해보자.

public static void main(String[] args) throws SQLException, ClassNotFoundException {
//        ApplicationContext context = new GenericXmlApplicationContext("applicationContext.xml");
    ApplicationContext context = new AnnotationConfigApplicationContext(DaoFactory.class);
}

XML 설정 방식

이번에는 XML 설정 방식으로 변경해보자.

먼저 id가 connectionMaker인 을 없애고 dataSource라는 이름의 을 등록한다.

<bean id="dataSource" class="org.springframework.jdbc.datasource.SimpleDriverDataSource" />

하지만 이 설정으로 SimpleDriverDataSource의 오브젝트를 만드는 것까지 가능하지만, dataSource() 메서드에서 수정자로 넣어준 DB 접속 정보는 나타나 있지 않다. UserDao처럼 다른 빈에 의존하는 경우 태그와 ref 속성으로 의존할 빈 이름을 넣어주면 된다. 하지만 SimpleDriverDataSource 오브젝트의 경우는 단순 Class 타입의 오브젝트나 텍스트 값이다. 그렇다면 XML에서는 어떻게 해서 dataSource() 메서드에서처럼 DB 연결정보를 넣도록 설정을 만들 수 있을까?

1.8.4 프로퍼티 값의 주입

값 주입

이렇게 다른 빈 오브젝트의 레퍼런스가 아닌 단순 정보도 오브젝트를 초기화하는 과정에서 수정자 메서드에 넣을 수 있다.

텍스트나 단순 오브젝트 등을 수정자 메서드에 넣어주는 것을 스프링에서는 '값을 주입한다'고 말한다. 사용할 오브젝트 자체를 바꾸지는 않지만 오브젝트의 특성은 외부에서 변경할 수 있기 때문이다.

수정자 메서드를 아래와 같이 XML로 전환할 수 있다.

image

value 값 자동 변환

driveClass는 스트링 타입이 아니라 java.lang.Class 타입이다. XML에서는 별다른 타입 정보 없이 클래스의 이름이 텍스트 형태로 value에 들어가 있다. 왜 문제가 없을까?

스프링이 프로퍼티의 값을, 수정자 메서드의 파라미터 타입을 참고로 해서 적절한 형태로 변환해주기 때문이다.

내부적으로 아래와 같은 작업이 일어난다고 생각할 수 있다.

image 
<?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="dataSource" class="org.springframework.jdbc.datasource.SimpleDriverDataSource">
    <property name="driverClass" value="org.h2.Driver"/>
    <property name="url" value="jdbc:h2:tcp://localhost/~/tobiSpringStudy"/>
    <property name="username" value="sa"/>
    <property name="password" value=""/>
  </bean>

  <bean id="userDao" class="tobi.study.user.STEP1.XML을_이용한_설정_1_8.UserDao">
    <property name="dataSource" ref="dataSource"/>
  </bean>
</beans>

최종적으로 위와 같이 작성할 수 있다.

1.9 정리

1장에서는 사용자 정보를 DB CRUD를 수행할 수 있는 DAO코드를 만들었고 그 문제점을 살펴본 뒤, 이를 다양한 방법과 패턴, 원칙, IoC/DI 프레임워크까지 적용해서 개선해왔다.

  1. 책임이 다른 코드를 분리해서 클래스로 만들었다. (관심사의 분리, 리팩토링)
  2. 그 중에 바뀔 수 있는 클래스는 인터페이스를 구현하도록 하고, 다른 클래스에서 인터페이스를 통해서만 접근하도록 만들었다.


    이렇게 해서 인터페이스를 정의한 쪽의 구현 방법이 달라져 클래스가 바뀌거나 내용이 달라지더라도, 그 기능을 사용하는 클래스의 코드는 같이 수정할 필요가 없도록 만들었다. (전략 패턴)
  3. 이를 통해 자신의 책임 자체가 변경되는 경우 외에는 불필요한 변화가 발생하지 않도록 막아주고, 자신이 사용하는 외부 오브젝트의 기능은 자유롭게 확장하거나 변경할 수 있게 만들었다. (개방 폐쇄 원칙)
  4. 결국 한쪽의 기능 변화가 다른 쪽의 변경을 요구하지 않아도 되게 했고 (낮은 결합도)

    자신의 책임과 관심사에만 순수하게 집중하는 (높은 응집도) 깔끔한 코드를 구현했다.
  5. 오브젝트가 생성되고 다른 오브젝트와 관계를 맺는 작업의 제어권을 별도의 오브젝트 팩토리를 만들어서 넘겼다. 또는 오브젝트 팩토리의 기능을 일반화한 IoC 컨테이너로 넘겨서 오브젝트가 자신이 사용할 대상의 생성이나 선택에 대한 책임으로부터 자유롭게 만들어줬다 (제어의 역전 / IoC)
  6. 전통적인 싱글톤 패턴 구현 방식의 단점을 살펴보고 서버에서 사용되는 서비스 오브젝트로서의 장점을 살릴 수 있는 싱글톤을 사용하면서도 싱글톤 패턴의 단점을 극복할 수 있도록 설계된 컨테이너를 활용하는 방법에 대해 알아보았다. (싱글톤 레지스트리)
  7. 설계 시점과 코드에는 클래스와 인터페이스 사이의 느슨한 의존관계만 만들어놓고, 런타임 시에 실제 사용할 구체적인 의존 오브젝트를 제3자(DI 컨테이너)의 도움으로 주입받아서 다이내믹한 의존관계를 갖게 해주는 IoC의 특별한 케이스를 알아봤다. (의존관계 주입 / DI)
  8. 의존 오브젝트를 주입할 때 생성자를 이용하는 방법과 수정자 메서드를 이용하는 방법을 알아봤다. (생성자 주입과 수정자 주입)
  9. 마지막으로, XML을 이용해서 DI 설정정보를 만드는 방법과 의존 오브젝트가 아닌 일반 값을 외부에서 설정해서 런타임 시에 주입하는 방법을 알아봤다. (XML 설정)

스프링이란 어떻게 오브젝트가 설계되고, 만들어지고, 어떻게 관계를 맺고 사용되는지에 관심을 갖는 프레임워크라는 사실을 꼭 기억해두자.

스프링의 관심은 오브젝트와 그 관계다. 하지만 오브젝트를 어떻게 설계하고, 분리하고, 개선하고, 어떤 의존관계를 가질지는 개발자의 역할이며 책임이다.

profile
청포도봉봉이
서버 백엔드 개발자
이전 포스트

토비의 스프링 - 1.7 의존관계 주입(DI)

다음 포스트

토비의 스프링 -2.1 UserDaoTest로 보는 테스트의 유용성

0개의 댓글