はじめに
本稿ではStruts 2にSpring Frameworkの機能を追加するプラグインを紹介します。Spring Frameworkの機能を用いてデータベースとのアクセスとトランザクション管理機能の設定する方法を解説します。
対象読者
- Struts 2のWebアプリケーション開発に興味ある方
- Spring Framework、iBATISの開発経験がある方
必要な環境
最低動作環境は以下のとおりです。
- Java SE 5
- Struts 2.1.8.1が動作する環境
- Tomcat 5.5.x / 6.0.x
Spring Frameworkとは
Spring Frameworkは、Javaのクラスを作成する際に共通する設定、機能を間接的に追加できるフレームワークで、Java EEの代替としてStruts 1時代からも連携して使われています。特に、トランザクションの管理機構とそれに伴う共通処理を一括で管理、設定をすることができるため多くの場面で利用されています。
導入方法
Spring Frameworkプラグイン(以下、Spring FrameworkをSpringと略します)は、Struts 2.1.8.1からは標準バンドルされていますが、Spring Framework本体は別途入手する必要があります。Spring Framework本体をSpringSource communityからダウンロードし、他のJARファイルと同様、(Webアプリケーションのフォルダ)/WEB-INF/lib以下へ配置することで利用できます。現在最新のバージョンは3.0.2ですが、今回は前バージョンの安定版である2.5.6SEC02を利用します。
なお、今回データベースとのやり取りをする上で、O/RマッピングフレームワークであるiBATISを利用しています。iBATISよりバージョン2.3.4の最新版を入手し、同様に/WEB-INF/libへ配置をしてください。
なお、iBATISはApacheプロジェクトからの更新リリースが停止しました。ソースならびにバイナリ(JARファイル)は引き続き入手可能です。
今回の狙い
Springプラグインの機能を使ってStruts 2のActionクラスをSpring管理化に置きます。同時にデータベースとのアクセスとトランザクション管理機能をあわせて使い、Actionクラスの実装が簡単にできることを理解します。
設定手順(Java EE + Struts 2)
Springプラグインを利用するためには、前もって以下の設定を行います。
- struts.xmlまたはstruts.propertiesに設定を追加します。
- デプロイメント・ディスクリプタ(web.xml)にSpringの初期パラメータとリスナーを追加します。
struts.xmlの設定は次のようになります。
<?xml version="1.0" encoding="UTF-8" ?> <struts> …(中略)… <constant name="struts.objectFactory" value="org.apache.struts2.spring.StrutsSpringObjectFactory" /> </struts>
struts.objectFactory = org.apache.struts2.spring.StrutsSpringObjectFactory
どちらかに設定すればよいです。
続いてSpringのリスナー設定です。web.xmlに次の設定を行います。設定箇所はSpringで利用する<context-param>と、<listener>の2か所になります。
<?xml version="1.0" encoding="UTF-8"?> <web-app id="WebApp_Spring" version="2.5" …(省略)…> <display-name>Spring</display-name> <!-- Spring initial parameters --> <context-param> <param-name>contextConfigLocation</param-name> <param-value>/WEB-INF/spring/applicationContext.xml,/WEB-INF/spring/applicationContext-*.xml</param-value> </context-param> <!-- Spring-Struts2 --> <listener> <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class> </listener> …(中略)… </web-app>
<context-param>要素で、Springの設定ファイルを設定します。カンマ区切りで複数設定が可能で、*でワイルドカード指定も可能です。この例では、/WEB-INF/spring/ディレクトリ以下にapplicaionContextというファイル名で複数設定されています。
<listener>要素ではSpringのリスナー設定をします。基本的にこの内容を変更することはありません。
以上でStruts 2側でSpringを利用する下準備は整いました。続いてSpring側の設定です。