web.xml

먼저 Spring MVC를 시작하기 위해 DispatcherServlet을 등록한다. DispatcherServlet은 HTTP 요청을 Spring MVC 컨트롤러로 전달한다. 다음과 같이 설정한다.

<servlet>
  <servlet-name>dispatcher</servlet-name>
  <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
  <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
  <servlet-name>dispatcher</servlet-name>
  <url-pattern>/</url-pattern>
</servlet-mapping>

Spring MVC를 사용하기 위해 애플리케이션의 Spring 설정을 로드하는 Context Listener도 등록한다.

<listener>
  <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

기본적으로 Spring은 /WEB-INF/applicationContext.xml을 설정 파일로 사용한다. 디폴트 설정이 우리에게 충분하므로 별도의 설정은 필요하지 않다.

이것으로 web.xml 설정이 완료되었다. MyBatis 3의 설정은 Spring의 applicationContext.xml에서 이루어진다.

applicationContext.xml

이미 아는 것처럼 applicationContext.xml은 스프링의 설정파일이다. 스프링은 의존성 주입을 처리하는 프레임워크이고 어떤 빈을 생성해야 하는지 어떻게 바인딩을 해야 하는지와 applicationContext.xml 파일이 어떤 역할을 하는지 알아야 한다. 그러면 이제부터 하나씩 살펴보자.

가장 먼저 쉽게 할수 있는 것은 스프링이 서비스 빈을 어디에 있는지 알아내게 하는 것이다. 스프링이 클래스패스에서 빈을 찾도록 할것이다. 그러기 위해서는 검색할 기본 패키지를 지정할 필요가 있다.

<context:component-scan base-package="org.mybatis.jpetstore.service" />

중요 스프링의 컴포넌트 스캔기능으로 마이바티스 매퍼를 찾을수는 없다. 매퍼는 POJO와 같은 단순한 빈이 아니기 때문에 스프링이 매퍼를 인스턴스화하는 방법을 알지 못한다. 그래서 매퍼를 찾기 위해서 MapperScannerConfigurer가 필요하다. MapperScannerConfigurer는 잠시 후 다시 볼것이다.

DataSource 와 TransactionManager가 필요하다. 데모 애플리케이션은 테스트용 스프링 DataSource를 사용한다. 테스트용 스프링 DataSource는 HSQL 이라는 인메모리 타입의 데이터베이스를 사용하고 데이터베이스 스크립트를 로드한 뒤 트랜잭션을 다루기 위해 스프링의 DataSourceTransactionManager 를 사용한다.

<jdbc:embedded-database id="dataSource">
  <jdbc:script location="classpath:database/jpetstore-hsqldb-schema.sql"/>
  <jdbc:script location="classpath:database/jpetstore-hsqldb-dataload.sql"/>
</jdbc:embedded-database>

<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource" />
</bean>

지금까지 우리는 Spring MVC와 스프링의 설정파일을 살펴봤다. 이제는 마이바티스를 다룰 차례이다. 마이바티스와 스프링을 셋업하는 메뉴얼에서 배운것처럼 최소한 두가지가 필요하다. 여기서 두가지는 SqlSessionFactoryBean과 매퍼 클래스이다. 먼저 SqlSessionFactoryBean를 정의해보자.

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
</bean>

그래서 지금은 매퍼를 셋업할 필요가 있다. 이러한 목적으로 스프링의 컴포넌트 스캔과 유사한 MapperScannerConfigurer 를 사용할 것이다. 매퍼 클래스를 클래스패스에서 찾아서 마이바티스에 등록할 것이다. 스프링의 컴포넌트 스캔과 유사하게 검색할 기본 패키지를 설정해야 한다.

<mybatis:scan base-package="org.mybatis.jpetstore.mapper" />

매퍼 XML파일을 작성할때 좀더 작성하기 수월하도록 하기 위해 빈의 짧은 별칭을 사용하고자 할것이다. SqlSessionFactoryBean은 빈을 검색할 수 있고 다음처럼 typeAliasPackage 프로퍼티를 셋팅해서 별칭처럼 짧은 이름을 등록할수도 있다.

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
  <property name="typeAliasesPackage" value="org.mybatis.jpetstore.domain" />
</bean>

이제 애플리케이션은 설정이 완료되었고 실행할 준비가 되었다. 하지만 실행하기전에 어떻게 돌아가는지 보기 위해 코드를 살펴보자.

프리젠테이션

프리젠테이션 레이어는 JSP파일과 Spring MVC 컨트롤러로 구성되었다. JSP는 평범한 HTML과 JSTL 태그를 사용한다. Spring MVC 컨트롤러는 요청을 처리하고 적절한 뷰를 반환한다.

Spring MVC 컨트롤러는 Spring의 의존성 주입을 사용할 수 있으므로 서비스 객체를 직접 생성하거나 검색할 필요 없이 주입받아 사용할 수 있다. 예를 들어 CatalogController를 살펴보자.

@Controller
public class CatalogController {

  @Autowired
  private CatalogService catalogService;

  @GetMapping("/catalog/categories/{categoryId}")
  public String viewCategory(@PathVariable String categoryId, Model model) {
    model.addAttribute("productList",
        catalogService.getProductListByCategory(categoryId));
    model.addAttribute("category",
        catalogService.getCategory(categoryId));
    return "catalog";
  }
  ...

@Controller 애노테이션은 이 클래스가 Spring MVC 컨트롤러임을 나타내며, Spring은 @Autowired를 사용하여 CatalogService를 컨트롤러에 주입한다. 요청 매핑 애노테이션은 HTTP 요청을 적절한 컨트롤러 메서드로 연결한다.

로직

애플리케이션 로직은 서비스처럼 동작하는 자바빈과 도메인 모델처럼 동작하는 자바빈으로 구성된다. 이 레이어는 데이터베이스 데이터로 도메인 객체를 만들고 도메인 객체의 컨텐츠로 데이터베이스 데이터를 업데이트한다. 이러한 작업을 처리하기 때문에 이 레이어는 트랜잭션을 처리할수 있어야 한다. 그래야 데이터베이스 업데이트에서 원자성(atomic)을 보장할 수 있다.

트랜잭션을 처리하는 방법을 보기 위해 OrderService 코드를 보자.

@Service
public class OrderService {

  @Autowired
  private ItemMapper itemMapper;
  @Autowired
  private OrderMapper orderMapper;
  @Autowired
  private LineItemMapper lineItemMapper;

  @Transactional
  public void insertOrder(Order order) {
    order.setOrderId(getNextId("ordernum"));
    for (int i = 0; i < order.getLineItems().size(); i++) {
      LineItem lineItem = (LineItem) order.getLineItems().get(i);
      String itemId = lineItem.getItemId();
      Integer increment = new Integer(lineItem.getQuantity());
      Map<String, Object> param = new HashMap<String, Object>(2);
      param.put("itemId", itemId);
      param.put("increment", increment);
      itemMapper.updateInventoryQuantity(param);
    }

    orderMapper.insertOrder(order);
    orderMapper.insertOrderStatus(order);
    for (int i = 0; i < order.getLineItems().size(); i++) {
      LineItem lineItem = (LineItem) order.getLineItems().get(i);
      lineItem.setOrderId(order.getOrderId());
      lineItemMapper.insertLineItem(lineItem);
    }
  }

주의깊게 봐야할 첫번째는 서비스에 JDBC코드와 마이바티스 코드가 없다는 점이다. DAO패턴과 데이터베이스 접근 코드를 데이터베이스 레이어에서만 사용해야 한다고 생각할지도 모르겠다. 하지만 이후에 보는것처럼 데이터베이스 레이어는 평범한 자바 인터페이스인 마이바티스 매퍼로 작성되었다. 그래서 전체 애플리케이션에서 마이바티스 API를 호출하는 곳을 찾을수가 없을것이다. 사실 매퍼를 사용하면 마이바티스 API를 직접 사용할 필요가 없다.

주의깊게 봐야할 두번째는 커밋이나 롤백하는 코드가 없다는 점이다. 스프링의 선언적인 트랜잭션 관리기능을 사용하기 때문에 가능하다. 이 선언적인 트랜잭션 관리는 마이바티스 스프링 연동모듈에서 모두 지원한다. 스프링의 @Transactional 애노테이션은 이 메서드가 트랜잭션을 다루는 메서드임을 나타낸다. 이 말은 updateInventoryQuantity, insertOrder 그리고 insertLineItem 매퍼 호출이 성공하면 커밋되고 에러가 발생하면 롤백이 된다는 것을 의미한다.

퍼시스턴스

퍼시스턴스 레이어는 마이바티스 매퍼로 구성되었다. 매퍼는 평범한 자바 인터페이스이고 매퍼 XML파일은 SQL구문을 가진다. 이 레이어에는 개발자가 작성한 어떤 부가적인 자바코드도 없다. getOrder 메서드가 OrderMapper 인터페이스에서 호출되면 마이바티스는 OrderMapper.xml 파일의 getOrder SQL구문을 실행할것이고 받은 데이터는 Order 도메인 빈을 생성한다.

public interface OrderMapper {
  List<Order> getOrdersByUsername(String username);
  Order getOrder(int orderId);
  void insertOrder(Order order);
  void insertOrderStatus(Order order);
}

<mapper namespace="org.mybatis.jpetstore.mapper.OrderMapper">

  <cache />

  <select id="getOrder" resultType="Order" parameterType="int">
    SELECT
      BILLADDR1 AS billAddress1,
      BILLADDR2 AS billAddress2,
      BILLCITY,
      BILLCOUNTRY,
      BILLSTATE,
      BILLTOFIRSTNAME,
      BILLTOLASTNAME,
      BILLZIP,
      SHIPADDR1 AS shipAddress1,
      SHIPADDR2 AS shipAddress2,
      SHIPCITY,
      SHIPCOUNTRY,
      SHIPSTATE,
      SHIPTOFIRSTNAME,
      SHIPTOLASTNAME,
      SHIPZIP,
      CARDTYPE,
      COURIER,
      CREDITCARD,
      EXPRDATE AS expiryDate,
      LOCALE,
      ORDERDATE,
      ORDERS.ORDERID,
      TOTALPRICE,
      USERID AS username,
      STATUS
    FROM ORDERS, ORDERSTATUS
    WHERE ORDERS.ORDERID = #{value}
      AND ORDERS.ORDERID = ORDERSTATUS.ORDERID
  </select>
  ...
</mapper>

중요 매퍼 XML파일에 <cache /> 엘리먼트를 추가해서 쿼리별로 캐시를 추가할 수 있다. 아니면 스프링을 사용해서 매퍼와 서비스 메서드 전반에 좀더 높은 레벨에서 캐시를 사용할 수도 있다.