web.xml

まずはじめに Stripes を開始する必要があるので、Stripes のマニュアルに従って設定していきます。 マニュアルによれば、Dispatcher Servlet と Filter を登録する必要があるようです。
早速やってみましょう。

<filter>
	<display-name>Stripes Filter</display-name>
	<filter-name>StripesFilter</filter-name>
	<filter-class>net.sourceforge.stripes.controller.StripesFilter</filter-class>
</filter>
<filter-mapping>
	<filter-name>StripesFilter</filter-name>
	<servlet-name>StripesDispatcher</servlet-name>
	<dispatcher>REQUEST</dispatcher>
</filter-mapping>
<servlet>
	<servlet-name>StripesDispatcher</servlet-name>
	<servlet-class>net.sourceforge.stripes.controller.DispatcherServlet</servlet-class>
	<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
	<servlet-name>StripesDispatcher</servlet-name>
	<url-pattern>*.action</url-pattern>
</servlet-mapping>

Stripes が ActionBean クラスを検出する際、検索対象となるパッケージを指定します。

<filter-class>net.sourceforge.stripes.controller.StripesFilter</filter-class>
  <init-param>
    <param-name>ActionResolver.Packages</param-name>
    <param-value>org.mybatis.jpetstore.web</param-value>
  </init-param>
</filter>

Stripes に関する設定は以上です。次に Spring の設定を行います。 Spring のマニュアルによれば、Spring を開始するために Context Listener を登録する必要があるようです。
早速やってみましょう。

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

特に指定しなければ、Spring は /WEB-INF/applicationContext.xml を設定ファイルとして使用します。デフォルトの設定で問題ないので次へ進みます。

Spring を使用することを Stripes にも教えておく必要があります。これによって、Spring Bean を直接 Stripes の ActionBean にインジェクトできるようになります。 再度 Stripes のマニュアルに従って Interceptor を登録します。

<filter-class>net.sourceforge.stripes.controller.StripesFilter</filter-class>
  ...
  <init-param>
    <param-name>Interceptor.Classes</param-name>
    <param-value>net.sourceforge.stripes.integration.spring.SpringInterceptor</param-value>
  </init-param>
</filter>

web.xml は完成です。気づいたかも知れませんが、MyBatis 3 に関してはまだ何も設定していません。 次のセクションで説明しますが、Spring の applicationContext.xml の方で行います。

applicationContext.xml

ご存知のように、applicationContext.xml は Spring の設定ファイルです。 依存性注入フレームワークである Spring に、どの Bean を生成し、どのように依存性を解決するかを指示するのが applicationContext.xml の役目です。詳しく見て行きましょう。

まずは、どこに Service Bean が配置されているか指定しましょう。Spring はクラスパス内を検索しますので、起点となるパッケージを指定するだけで OK です。

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

NOTE Spring のコンポーネントスキャン機能では、MyBatis の Mapper を検出することはできません。 Mapper は通常の Bean ではないので、どのように初期化すれば良いか Spring には分かりません。 すぐ後で説明するように、Mapper は MapperScannerConfigurer を使って生成します。

DataSource と TransactionManager も必要です。このアプリケーションはデモなので、HSQL のインメモリデータベースを作成して用意されたデータを流し込むテスト用の DataSource と、トランザクションのために標準的な 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>

ここまでは Stripes と Spring に関する標準的な設定のみでしたが、ここからは MyBatis に関する設定を行なっていきます。 このマニュアルで学んだように、MyBatis を Spring と連携させる場合、最低必要となるのは SqlSessionFactoryBean と Mapper クラスの２つです。 まずは SqlSessionFactoryBean を定義しましょう。

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

次に Mapper の設定が必要ですが、ここでは Spring のコンポーネントスキャンと似たような機能を持った MapperScannerConfigurer を使います。 このクラスはクラスパスを検索して、検出した Mapper クラスを MyBatis に登録します。Spring のコンポーネントスキャンと同様、起点となるパッケージを指定する必要があります。

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

Mapper XML ファイルを作成する際のタイピング量を減らすため、Bean のエイリアスを使いましょう。 SqlSessionFactoryBean の typeAliasPackage で Bean の検索対象を指定しておくと、短縮名で Bean を参照できるようになります。

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

これで設定は完了ですが、実行する前にコード全体の構成を確認してみましょう。

プレゼンテーション層

プレゼンテーション層は、JSP ファイルと Stripes の ActionBean で構成されています。 JSP で使っているのは HTML、JSTL タグ、Stripes タグのみなので、このサンプルに関しては特筆すべきことはありません。 Stripes の ActionBean は Struts のアクションや Spring MVC のコントローラーに相当するクラスで、これについても特別なことはありません。

Stripes と Spring を連携できるように設定したので、Service を ActionBean にインジェクトすることができます。これによって生成や参照取得について考えなくても Service を利用することができます。 例として、CatalogActionBean を見てみましょう。

@SessionScope
public class CatalogActionBean extends AbstractActionBean {
  ...
  @SpringBean
  private transient CatalogService catalogService;
  ...
  public ForwardResolution viewCategory() {
    if (categoryId != null) {
      productList = catalogService.getProductListByCategory(categoryId);
      category = catalogService.getCategory(categoryId);
    }
    return new ForwardResolution(VIEW_CATEGORY);
  }
  ...

@SpringBean アノテーションによって、Spring に登録されている Bean が ActionBean に注入されます。

ロジック層

アプリケーションロジック層は、サービスとして動作する Plain な Java Bean と、ドメインとして動作する Plain な Java Bean によって構成されています。 この層では、データベースから取得したデータをドメインオブジェクトに設定する処理と、ドメインオブジェクトのデータを使ってデータベースを更新する処理を担当しています。 そのため、この層はトランザクショナル、つまり複数のデータベース更新処理をまとめて実行できるようになっている必要があります。

これをどのようにして実現しているのか、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 関連のコードや MyBatis 関連のコードがないということです。 DAO パターンを使っていてデータベースアクセスのコードは DAO 側に記述してあるのだろう、と思うかも知れませんが、後で見るようにデータアクセス層は通常の Java インターフェイスである MyBatis Mapper で構築されています。 こうした構成にしておくことで、アプリケーション全体を通して MyBatis API の呼び出しが不要となっているのです。

次に目立つのは、コミットやロールバックの記述がないという点でしょう。 これは MyBatis-Spring がサポートする Spring の宣言的トランザクションを使っているためです。 Spring の @Transactional アノテーションは、このメソッドがトランザクション管理の対象であり、updateInventoryQuantity, insertOrder, insertLineItem の一連の呼び出しが全て成功しない限り、コミットされないことを表しています。

パーシステンス層

パーシステンス層は MyBatis の Mapper によって構成されています。 Mapper は Plain な Java インターフェイスと SQL ステートメントを含む Mapepr XML ファイルです。 この層には独自の Java コードはありません。 OrderMapper インターフェイスの getOrder メソッドが呼ばれると、MyBatis によって 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>

NOTE Mapper XML ファイルに <cache /> 要素を追加することで、簡単にクエリ結果のキャッシュを有効化することができます。 お望みであれば Spring を使ってより高いレベルで Mapper や Service メソッドへの呼び出し結果をキャッシュさせることもできます。