解説：springを使う

１．はじめに

これは、springを使ったｗｅｂアプリの開発法を例題で学習するための解説です。

次の例題からなります。

（１）例題１クラスの関連をspringを使って解決する簡単な例(バッチのプログラム)

（２）例題２簡単なwebアプリをspringを使って書き換えます。

（３）例題３ ActionクラスにServiceの参照を設定するのもspringがするようにします。

（４）例題４トランザクションの処理をspringに任せます。

（５）例題５ DBMSのアクセスをspringが提供するライブラリ(JdbcTemplate)を使うようにします。

なお、例題２と３、４，５の母体は、「解説：MVC＋３層 webアプリの作り方」で使った例題の中の例題３です。「解説：MVC＋３層 webアプリの作り方」で使った例題をこの解説の中で参照する場合は「webapp例題ｎ」と呼びます(ｎ＝１～３)。この解説の中の例題は単に例題ｎか、又はspring例題n(ｎ＝１～５)と呼びます。

「解説：MVC＋３層 webアプリの作り方」で使った例題は次からダウンロードできます。

TODO webapp例題ダウンロード

２．spring例題１

２．１クラス関連図

例題１のクラス図を図２－１に示します。

図２－１例題１のクラス図

Starterにmainメソッドが含まれています。

Starterは、まずspringを起動します。springはFirst、Second、Lastを具現化し、各クラスで使う参照を設定します。つまり、mainはspringに「仕事」を依頼するだけです。

springはこの「仕事」をするために「仕事」を定義した情報が必要です。springはこの情報を与える方法を複数個備えています。この例題ではすべてxml形式で外部ファイルに保存された情報を使います。詳細は後の節で説明します。

springの「仕事」の後、StarterはFirstクラスのcalcAmountを呼び出します。その後の処理は次の節で説明します。

２．２処理の概要

図２．２－１に例題のシーケンス図を示します。

図２．２－１例題１のシーケンス図

FirstのcalcAmountからSecondのgetListメソッドを呼び出し、SecondがgetStringListを呼び出します。

LastのgetStringListが戻すデータは、複数組の／で区切られた数字列です。

データの例を次に示します。

100/10/3

/25/7

57/33/28

SecondのgetListは先頭の数字のリストを戻します。先頭が／の場合は、最初の数字は０とみなします。先ほどの例の場合、次のデータを戻します。

100, 0, 38,57

FirstのcalcAmountは、Secondから戻された数のリストの合計を計算して、合計値を呼び出し元に戻します。先の例の場合は次の値を戻します。

195

２．３ Springのパラメータ

springに仕事を指示するパラメータをリスト２．３－１に示します。このリストを含んだファイルをspringコンテキストファイルと呼びます。この内容（情報）もしくはこの内容を保持しているオブジェクトをspringコンテキストと呼びます。この解説の例題では、springコンテキストをｘｍｌファイルで与えます。

リスト２．３－１ springのコンテキストｘｍｌ

1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN 2.0//EN" "http://www.springframework.org/dtd/spring-beans-2.0.dtd"> 3 <beans> 4 <bean id="theLast" class="jp.co.nsp_ltd.a0201.impl.Last"> 5 </bean> 6 <bean id="theSecond" class="jp.co.nsp_ltd.a0201.impl.Second"> 7 <property name="last" ref="theLast" /> 8 </bean> 9 <bean id="theFirst" class="jp.co.nsp_ltd.a0201.impl.First"> 10 <property name="second" ref="theSecond" /> 11 </bean> 12 </beans>

注：各行の先頭の数字は説明のための番号です。実際のデータには付けません。

説明

１ xmlの宣言です。

２ doctype文です。このまま使います。

３ springのコンテキストｘｍｌのルート要素はbeansです。

４～５ Lastクラスのインスタンスを定義します。idはコンテキストデータの中でこのインスタンス(bean)を参照するための名称(id)です。これはユニークでなければなりません。classは完全クラス名を指定します。

６～8 Secondクラスのインスタンスを定義します。idとclassについてはLastの場合と同じです。Lastと違ってproperty要素が定義されています。nameはプロパティの名称です。refはこのプロパティに設定する値です。特にrefはコンテキストデータの中の他のインスタンス(bean)の参照を設定することを意味します。該当するインスタンス(bean)のidをここに指定します。この場合はtheLastですから、４～５で定義されたLastが該当します。

なお、プロパティとしては、基本の型の値やマップ(Map)、リスト(List)、Properties(Mapの特別な場合)を設定できます。その詳細は例題の範囲外ですので説明は省きます。

９～１１ Firstクラスのインスタンスを定義します。Secondクラスと同じです。

１２閉じのタグです。

（説明終り）

springのコンテキストｘｍｌで参照がインスタンスのプロパティとして設定されることを説明しました。例として、Second クラスを見てみます。

リスト２．３－２ Second.java

... 1 public class Second implements ISecond{ 2 private ILast last; 3 public void setLast(ILast last) { 4 this.last = last; 5 } 6 public List<Integer> getList(){ 7 List<String> list = last.getStringList(); ... ... ... 8 return intList; 9 } 10 }

プロパティの名称は、Java beanの約束に従っています。たとえば、プロパティ名がlastの場合、それを設定するメソッド名はsetLastです。つまり、プロパティ名の先頭文字を大文字にして、頭にsetをつけたものが設定するメソッド名になります。

これが、３～５で定義されているメソッドです。ここではフィールドlastに引数で渡された値を設定しています。フィールドの名称はプロパティ名とは関係ありません。しかし、便宜の点から通常は同じ名前が使われます。

プロパティの値を取り出すメソッド名にはsetの代わりにgetが付きます。この例では不要ですので定義していません。

２．４ springの起動

この例題ではClassPathXmlApplicationContextを使ってspringを起動しています。他にも方法がありますがここでは触れません。

Starterの該当部分をリスト２．４－１に示します。

リスト２．４－１

... 1 public class Starter{ 2 public static void main(final String[] args) throws Exception { 3 ApplicationContext ctx = new ClassPathXmlApplicationContext("context.xml", Starter.class); 4 IFirst first = (IFirst)ctx.getBean("theFirst"); 5 int amount = first.calcAmount(); 6 System.out.println("main result amount="+amount + ", if 195, ok"); 7 } 8 }

説明

３ ClassPathXmlApplicationContextの引数

第1引数：コンテキストｘｍｌのファイル名

第2引数：コンテキストｘｍｌのファイルが存在するパッケージ内のクラス。ファイルのパスを決めるために使われるだけで内容はコンテキストｘｍｌの内容に関係ありません。

４ IFirst first = (IFirst)ctx.getBean("theFirst");

springが具現化したインスタンス(bean)の参照を得るための処理です。この場合はidがtheFirstのインスタンスの参照を得ます。

この文ではspringが具現化したインスタンスをidで参照しています。これは本来のＤＩの原則に反するものです。ただ、mainメソッド又は類似の役割のメソッドに限定すれば、この方法を使わざるを得ない場合があります。こういう場合に限って使うべきです。ここでは、Starterの再利用性を考慮しなくてもよいのでこの方式を使っています。

５ int amount = first.calcAmount();

FirstクラスのcalcAmountメソッドを呼び出しています。

（説明終り）

２．５各クラスの処理

全体の処理については「２．２処理の概要」で説明しました。

この節では、Starterを除く各クラスのメソッドの処理ががspringを意識しないで作られていることを説明します。この点に関してはどのクラスも同じですので、FirstクラスのcalcAmountを見てみます。リスト２．５－１はこのメソッドのコードです。

リスト２．５－１ First. calcAmount

1 public int calcAmount(){ 2 System.out.println("First calcAmount starts."); 3 List<Integer> list = second.getList(); 4 int amount=0; 5 if(list!=null){ 6 for(Integer t : list){ 7 amount += t.intValue(); 8 } 9 } 10 return amount; 11 }

３行目で使っているsecondはspringの仕掛けで設定されます。しかし、このメソッドの中には、secondを設定する処理に関係した内容は何もありません。

２．６ spring例題１のまとめ

この例題で次のことが習得できました。

（１） springの使い方

（２）起動する処理を除くと、実装したメソッドにspringは影響しない。

３．spring例題２

３．１ spring例題２の概要

spring例題２ではｗｅｂアプリにspringを適用します。

母体として、webapp例題３（「解説：MVC＋３層 webアプリの作り方」の例題３）を使います。webapp例題３はＤＩを使ったｗｅｂアプリです。ただ、springは使わないで、Initializerクラスでspringもどきの処理をしました。ここをspringで対応するように変更します。

spring例題２の構造を図３．１－１に示します。

図３．１－１ spring例題２の構造

ActionからDataSourceまで層構造をしています。このうちServiceからDataSourceまではspring例題１と同じ仕掛けでクラス間を関連付け出来ます。

しかし、Actionについては、それと同じ方法が使えません。

Actionが他のクラスと違うところは、Actionを具現化するのはstrutsであるということです。そのためActionを具現化する時期や方法が隠蔽されています。だから、プログラムの起動時(＝springの起動時)に、springはActionのインスタンスにServiceの参照を設定できないのです。springはこの状況に対応する機能を提供しています。それは次の例題で説明します。この例題ではそれとは別の、図３．１－２に示す方法を使います。

図３．１－１ではデータ（利用者の要求）の処理の流れを核に描いていますので、図３．１－２に現れるRequestとControllerは略されています。これらは、利用者の要求を保持し、その要求を処理するActionに制御を移す役割を担います。Serviceの参照を設定する仕掛けを理解するには、この流れが必要ですので、図３．１－２にはRequestとControllerを含めています。

図３．１－２ ActionへServiceの参照を設定する方法

この方法は次の通りです。

（１）プログラムの起動時

InitializerはServiceの参照をサーブレットコンテキストに保存します。

（２） Action実行時

Actionの本来の処理の前に、サーブレットコンテキストからServiceの参照を取得する処理を入れます。

これは、親（ベース）のクラスを作って、そこで行うと通常のActionクラスでは、ＤＩと同じ効果でserviceを参照できます。

webapp例題３のInitializerクラスで実行していた実質的な処理を取り除き、spring例題２では、springを起動する処理だけにします。propertiesファイルは不要になます。その内容はspringのコンテキストｘｍｌに移します。

webapp例題３からspring例題２を作る具体的な方法は付録で説明します。

３．２ Initializerクラス

spring例題2のInitializerクラスをリスト３．２－１に示します。

リスト３．２－１ Initializerクラス

... 1 public class N03ExampleInitializer{ 2 private final static String keyToServiceImpl="jp.co.nsp_ltd.a0202.N03ExampleService"; 3 public void initProgram(ServletContext servletContext){ 4 ... 5 try{ 6 ApplicationContext context = new ClassPathXmlApplicationContext( "applicationContext.xml", this.getClass()); 7 BeanFactory factory = (BeanFactory)context; 8 IExampleService service = (IExampleService)factory.getBean("service"); 9 servletContext.setAttribute(keyToServiceImpl, service); 10 }catch(Exception e){ 11 System.out.println("ERROR:N03ExampleInitializer initProgram "); 12 } ... 13 } 14 }

実質的な処理は５～１０のtry句の中です。この部分だけ説明します。

（説明）

６ springを起動します。

７～８ Serviceのインスタンス参照を取り出します。spring例題１のStarterの処理と同じです。

９ Serviceのインスタンス参照をサーブレットコンテキストに設定します。そのキーは２行目で設定しています。キーには他のデータのキーと重ならないようにするため、Serviceの完全クラス名を使っています。

（説明終り）

webapp例題３では６行目の処理が、Initializerクラスの中に実装していました。

第7行～第9行の処理は各アクションにServiceの参照を設定するための準備として必要な処理です。springにそのための機能が備わっていますが、この例題ではまだ使いません。

３．３コンテキストｘｍｌ

リスト３．３－１コンテキストｘｍｌ

1 <beans> 2 <bean id="dataSource" class="jp.co.nsp_ltd.a01data.impl.ConnectionBuilder"> 3 <property name="driverClassName" value="sun.jdbc.odbc.JdbcOdbcDriver"/> 4 <property name="url" value="jdbc:odbc:Driver={Microsoft Text Driver (*.txt; *.csv)}; _ Dbq=C:/@/projEclipse/osss/struts-1.3.8/db/textdb;Extensions=txt;"/> 5 <property name="username" value=""/> 6 <property name="password" value=""/> 7 </bean> 8 <bean id="dbAccessor" class="jp.co.nsp_ltd.a01data.impl.DbAccessorDi"> 9 <property name="dataSource" ref="dataSource"/> 10 </bean> 11 <bean id="dao" class="jp.co.nsp_ltd.a0202.N03ExampleDao"> 12 <property name="dbAccessor" ref="dbAccessor"/> 13 <property name="dbTableName" value="table7.txt"/> 14 </bean> 15 <bean id="service" class="jp.co.nsp_ltd.a0202.N03ExampleService"> 16 <property name="dao" ref="dao"/> 17 </bean> 18 </beans>

spring例題１と同じ部分は略します。

（説明）

１～７データソースの定義。この例題では例題用のデータソースConnectionBuilderを使います。設定するプロパティとして次の４個があります。

driverClassName：DBMSのドライバークラス

url：DBのurl

username：DBのユーザ名

password：DBのパスワード

これらの値の型はすべて文字列です。定まった文字列の値(文字定数)はvalue属性で指定します。

８～１０ DbAccessorの定義。プロパティとしてはデータソースを設定します。

１１～１４ daoの定義。プロパティとして次の二つがあります。

DbAccessorのインスタンス参照

テーブル名称（型は文字列）

１５～１７ serviceの定義プロパティとしてdaoを設定します。

（説明終り）

参考までにwebapp例題３のpropertiesをリスト３．３－２に示します。該当する情報はプロパティ名から対応付けられると思いますので詳細は略します。webapp例題３のpropertiesでは、インスタンスの参照を設定するデータはありません。これはInitializerクラスのコードの中に組み込まれています。springのように汎用的なプログラムではこれもプロパティとして定義します。

リスト3.3－２ webapp例題３のproperties

1 jp.co.nsp_ltd.a0103.test= test_value 2 jp.co.nsp_ltd.a0103.dbTableName=table7.txt 3 jp.co.nsp_ltd.a0103.service=jp.co.nsp_ltd.a0103.N03ExampleService 4 jp.co.nsp_ltd.a0103.dao=jp.co.nsp_ltd.a0103.N03ExampleDao 5 jp.co.nsp_ltd.a0103.dbAccessor=jp.co.nsp_ltd.a01data.impl.DbAccessorDi 6 jp.co.nsp_ltd.a0103.dataSource=jp.co.nsp_ltd.a01data.impl.ConnectionBuilder 7 jp.co.nsp_ltd.a0103.driverClassName = sun.jdbc.odbc.JdbcOdbcDriver 8 jp.co.nsp_ltd.a0103.url=jdbc:odbc:Driver={Microsoft Text Driver (*.txt; *.csv)}; _ Dbq=C:/@/projEclipse/osss/struts-1.3.8/db/textdb;Extensions=txt; 9 jp.co.nsp_ltd.a0103.username= 10 jp.co.nsp_ltd.a0103.password=

４．spring例題３

４．１ spring例題３の概要

spring例題２を改善してspring例題３を作ります。その構成を図４．１－１に示します。

図４．１－１ spring例題３の構成

spring例題２では各アクションにServiceの参照を設定する処理を自前のInitializerクラスとActionクラスでしています。spring例題３ではこの処理をspringが提供するクラスにまかせます。結果として、Initializerクラスが不要になります。また、InitializeクラスのinitProgramを呼び出していた、ベースアクションに記述した処理も不要になります。

さらに、spring例題２ではlistenerを使ってspringを起動しましたが、spring例題３ではstrutsのｐｌｕｇ－ｉｎで起動します。このｐｌｕｇ－ｉｎはspringが提供します。

spring例題２からspring例題３を作る具体的な方法は付録で説明します。

４．２ベースアクションの変更

リスト４．２－１はspring例題２とspring例題３のベースアクションの違いを説明するリストです。

リスト４．２－１ベースアクション

... 1 public class N03ExampleBaseAction extends Action{ 2 private final static String keyToServiceImpl="jp.co.nsp_ltd.a0202.N03ExampleService"; 3 private IExampleService service; 4 public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws IOException, ServletException{ 5 javax.servlet.ServletContext servletContext = servlet.getServletContext(); 6 service = (IExampleService)servletContext.getAttribute(keyToServiceImpl); 7 return doAction(mapping, form, request, response); 8 } ... 9 protected IExampleService getService(){ 10 return service; 11 } 12 public void setService(IExampleService service){ 13 this.service = service; 14 } 15 }

spring例題２から削除された部分

２，５，６

これは、サーブレットコンテキストに保存されているserviceの参照を取り出してフィールドに設定する処理です。

spring例題２に追加された部分

12,13,14

これは、springがserviceの参照を設定するメソッド（setter）です。

まとめると自前のservice設定の処理は不要になって、代わりにspringがserviceを設定するためのメソッドを必要になります。

４．３ plug-inの定義

plug-inの機能はspringに専用の機能ではありません。plug-inはstrutsの機能です。strutsの起動時にするべき処理をするための仕掛けです。struts-configに定義します。

「plug-in」という用語は、「起動時にするべき処理をするための仕掛け」を意味する場合と、その仕掛けで起動されるクラスを意味する場合があります。「plug-in」の仕掛けで起動される「plug-inのクラス」はｗｅｂアプリの開発者が目的に応じて自由に開発できます。

通常はこの二つは混乱しないと思いますが、ここでは正確に書くと、strutsのplug-inの仕掛けで起動されるクラスの一つとして、springを初期化するクラスがspringに含まれています。spring例題２で使ったInitializeクラスとそれを起動したリスナーの機能をこれで代替できます。

具体的な指定法をリスト４．３－１に示します。

リスト４．３－１ plug-inの定義

1 <plug-in className= \ "org.springframework.web.struts.ContextLoaderPlugIn"> 2 <set-property property="contextConfigLocation" value="/WEB-INF/applicationContext_a0203.xml , _ /WEB-INF/action-servlet_a0203.xml "/> </plug-in>

（説明）

１ plug-in要素のclassNameは、springのplug-in用のクラスを指定します。

２ set-property要素は一般にplug-inクラスののプロパティを設定するものです。この場合は、springのコンテキストｘｍｌファイルを指定しています。spring例題２のapplicationContext.xmlに相当しますが、この例題では、二つのファイルを指定しています。内容については後の節で説明します。なお、これに対応するspring例題２の情報はInitializeクラスの中に書き込まれていました。

（説明終り）

４．４アクションのプロクシの設定

各アクションにServiceの参照を設定する処理は、ServiceにDaoを設定するのとは違った工夫が必要です。アクションクラスはstrutsによって具現化され、springで具現化する時期と結果(インスタンス)を管理できない事情があるからです。

こういう場合、springではプロクシを使った方法を使います。springは任意のクラスのプロクシをパラメータの指定で作る機能を備えています。その代表がトランザクションの処理です。これについてはトランザクションの処理で説明します。strutsのアクションのプロクシはトランザクションの場合と違って、strutsのアクションに固有のプロクシです。この節では以後、strutsのアクションのプロクシのことを単にプロクシと呼びます。

プロクシを使わない方法の説明は前の章を参照下さい。

注：プロクシを使わない方法が必ずしも劣っているとは限りません。特にActionのベースクラスをフレームワークが提供するベものでなく、独自に開発して使う場合は、spring例題２で使った、ベースアクションで該当する処理をする方法がむしろ簡潔です。［資料１］を参照下さい。

strutsのアクションのプロクシ(この節では、以後単にプロクシと呼びます)と関連するクラス（群）の関係を図４．４－１に示します。

strutsのcontorollerとｗｅｂアプリ開発者が作るアクションクラスの間にプロクシが入ります。

図４．４－１プロクシを使った場合のアクション周辺のクラス構成

strutsの環境定義(コンフィギュレーション)とspringのコンテキストxmlが協働して、図４．４－１の位置でプロクシが働くようにします。

リスト４．４－１はそのためのstrutsの環境定義です。また、リスト４．４－２は対応するspringのコンテキストｘｍｌの一部です。

リスト４．４－１ strutsのアクション用プロクシを設定するためのstruts設定

<action path="/r1_a0203Example" name="Example1ActionForm" validate="false" scope="request" type="org.springframework.web.struts.DelegatingActionProxy"> <forward name="success" path="/pages/v1_a01Example.jsp"/> </action>

リスト４．４－２ strutsのアクション用プロクシを設定するためのspring設定

<bean name="/r1_a0203Example" class="jp.co.nsp_ltd.a0203.N03Example1Action" scope="singleton"> <property name="service"> <ref bean="service"/> </property> </bean>

次の２点が注目すべき点です。

（１）strutsとspring間で対応を取るために次の値を等しくします。

（ａ）strutsのaction要素のpath属性

（ｂ）springのbean要素のname属性

リスト４．４－１とリスト４．４－２では/r1_a0203Exampleがこれに相当します。

（２）strutsのaction要素のtype属性には、実際のアクションのクラスではなく、プロクシのクラスを設定します（org.springframework.web.struts.DelegatingActionProxy）。代わりに、実際のアクションのクラスはspringのbean要素のclass属性に設定します。

以上の設定法から分かりますように、ｗｅｂの要求(request)が入ると、strutsのコントローラの働きでspringが提供するプロクシに制御が移ります。プロクシはＤＩの処理、つまりserviceの参照をアクションに設定する処理をします。

アクションはServiceやDaoと同じbean要素で定義されますので、ＤＩだけでなく他のプロパティの設定も出来ます。

プロクシに関するコンテキストｘｍｌのはこれまで使ったコンテキストｘｍｌに追加して書くことが出来ます。また、一般にコンテキストｘｍｌは分割することも出来ます。この例題では、アクションに関する設定とその他の設定とに分けました。前者はservlet-action.xml、後者はapplicationContext.xmlです(実際の名称は、例題を区分するためにファイル名称の基本部にバージョン番号が付いています)。これが、４．３－１で指定されているファイルです。

５．spring例題４

５．１ spring例題４の概要

これまでの例題では、トランザクションの処理については触れてきませんでした。実際にはDbAccessorの中にcommitとrollbackを呼び出す処理が入っています。spring例題４ではspringが提供するトランザクションの処理を組み入れます。

springはEJBサーバを代替する狙いを持っており、そのためににはEJBサーバが提供する機能を提供しなければなりません。これまでは、そのうちのＤＩについて見てきました。これはＪＮDIに対応する機能です。ＥＪＢ機能が提供するもう一つの大きな機能はトランザクション処理です。

母体になる例題としてspring例題２を使います。spring例題３を母体として使わない理由は、springのstruts用のplug-inは、strutsを使ったwebアプリ一つに対して一つしか使えないためです(plug-inの仕掛けそのものは複数個のplug-inクラスを起動できます)。

また、例題を簡潔にするために、spring例題２で使ったリスナーは使いません。実際のアプリでは、listener 又はplug-inを使うのがお勧めです。

spring例題４の構成を図５．１－１に示します。

図５．１－１ spring例題４の構成

spring例題２と違う点はトランザクションの処理が入った点とInitializerがActionから使われるところですです。トランザクションの処理については次節で説明します。Initializer がしていた処理はActionがします。その内容は次の通りです。

（１）起動時

ＤＩに関係した処理はしません。

（２） Action実行時

springがすでに起動（初期化）されたかどうか判定します。これはサーブレットにServiceの参照が設定されているか否かで判断します。

springが起動（初期化）されている場合は、取り出した値をそのまま使います。

springが起動（初期化）されていない場合は、Initializerを呼び出してspringを起動（初期化）します。その後、サーブレットコンテキストにServiceの参照を書き込みます。

この処理は、親（ベース）のクラスを作って、そこで行うと子のActionクラスでは、ＤＩを使ったのと同じ形でServiceを参照できます。

なお、DataSourceとして、DataSource interfaceを製品レベルで実装したDBCP(org.apache.tomcat.dbcp.dbcp.BasicDataSource)を使います。これはtomcatに付属しています。トランザクション処理を「まじめに」行うためには、これまでに使ってきたConnectionBuilderでは十分でないからです。また、ODBCのtext又はEXCELはトランザクションの処理が出来ませんのでMS ACCESSかHSQLDBに切り替えます(もちろんOracleやDB2が使える場合はそれを使っても結構です)。

５．２トランザクション処理

DBの処理は成功か失敗かのいずれかしか許されません。一部は成功、一部は失敗で完了する処理はありません。処理が成功したときはcommitしてDBへの更新を固定します。失敗のときはrollbackしてそれまでの変更を、変更しない状態に戻します。これをトランザクション処理と言います。

トランザクション処理の例をリスト５．２－１に示します。

リスト５．２－１トランザクションの処理

Transaction tx = TransactionFactory.getInstance(...); tx.beginTransaction(); ① try{ dao.addRecors(tx, ...); ② tx.commit(); ③ }catch (Exception e){ tx.rollback();③ log.error(...); } tx.endTransaction(); ④

これを図にすると、図５．２－１になります。丸付きの数字がリスト５．２－１の同じ番号の文に対応しています。

図５．２-１簡略したトランザクション処理の流れ

この図は主にServiceの周辺の処理を説明するためのものですので、DataSourceの周辺については簡略化しています。そのため正確ではありません。

アクションから要求されたサービス(処理)は次の順序で実行されます。

① トランザクションの開始をTransaction管理に宣言します。

② DBへのアクセスを含む処理をします。

③ commit/rollbackをTransactionクラスに依頼します。

④ トランザクションの終了をTransaction管理に宣言します。

この流れは簡略されていますが、重要なことは、業務ロジックとして意味のある処理は③だけであることです。他の処理は「障害」に対する処理です。図５．２－１の構成の場合、Serviceに「障害」処理が入り込みます。これを避けるために、本来の業務ロジックと「障害」処理を分離した図５．２－２の構成を考えます。

図５．２-２業務ロジックと「障害」処理の分離

この解説は、springを念頭に置いていますので、分離した一方の処理はproxyとして図５．２－２に記述しています。proxyとTransaction管理は業務ロジックに依存しない部分でspringが提供しています。proxyの部分とTransactionクラスの使い方(パラメータの設定法)を以降の節で説明します。

こうすると、Serviceクラスは業務ロジックだけ実装すれば済みます。これは、業務ロジックを簡潔に実装できるだけでなく、業務ロジックを実装するプログラマはトランザクション処理の知識がなくても済む利点があります。springの狙いの一つである再利用性から得られる利益に疑念を持つ方でも、この後者の利点から得られる利益は直接的ですので、疑いを入れる余地がないと思います。

５．３コンテキストｘｍｌ

springで定義するトランザクションに関するコンポーネントの関連を図５．３－１に示します。

図５．３－１トランザクションに関するコンポーネントの関連

トランザクション処理を含めない場合、serviceはServiceクラスを指していました。トランザクション処理を含める場合はserviceはServiceのプロクシを指します。こうすることでserviceを参照している他のbeanの定義をを変更しなくて済みます。

本来のServiceのidはtargetServiceに変更します。これはプロクシと接続されています。その他の従来からある関連は変わりません。

プロクシはServiceとトランザクション管理（DataSourceTransactionManagerクラス、id=transactionManager）と関連します。

トランザクション管理はdataSourceの関連を持ちます。

これを定義したコンテキストｘｍｌがリスト５．３－１です。

リスト５．３－１トランザクションに関するコンポネントの定義

1 <bean id="baseTransactionProxy" class="org.springframework.transaction.interceptor.TransactionProxyFactoryBean" abstract="true"> 2 <property name="transactionManager" ref="transactionManager"/> 3 <property name="transactionAttributes"> 4 <props> 5 <prop key="find*">PROPAGATION_REQUIRED,readOnly</prop> 6 <prop key="*">PROPAGATION_REQUIRED</prop> 7 </props> 8 </property> 9 </bean> 10 <bean id="service" parent="baseTransactionProxy"> 11 <property name="target" ref="serviceTarget"/> 12 </bean> 13 <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> 14 <property name="dataSource" ref="dataSource"/> 15 </bean>  ... ... 16 <bean id="serviceTarget" class="jp.co.nsp_ltd.a0204.N03ExampleService"> 17 <property name="dao" ref="dao"/> 18 </bean>

（説明）

１～９プロクシの定義。これは「親」に相当します。親子の構造は後で説明します。

このうち、３～７トランザクションの伝播の扱いとread only属性を設定します。

伝播の扱いについてはこの例題の範囲を超えていますので他の［資料２］を参照下さい。

１０～１２プロクシの「子」の定義。親子で一組のプロクシが定義されます。

１３～１5 トランザクション管理の定義

１6～１8 Serviceの定義。これは従来からあるものですがidをserviceからserviceTargetに変更しています。

（説明終り）

この中でプロクシは親子の関係で定義しています。この構造を図５．３－２に示します。

図５．３－２プロクシの親子関係

この例題では「子」は一つだけです。したがって必ずしも親子関係で定義する必要はありません。ただ、サービスが複数個になる場合は「子」も複数になりますので、それを定義する例として親子関係を定義しています。

５．４ DbAccessorの変更

springが提供するトランザクション処理を使うためには、これまで使ってきたDbAccessorを変更する必要があります。トランザクションに関する処理を取り除き、dataSourceから取得していたコネクションをspringを経由して取得する必要があります。

変更しなければならない具体的な処理は次の通りです。結果はダウンロードしたソースを参照してください。

（１）commit/rollbackの処理を取り除く。

（２）Exception発生時いったんそれをキャッチしてUnsupportedOperationExceptionを投げる。

springのトランザクション処理に頼るには、障害(rollbackする必要がある事象)が起きたときはService(プロクシ)で例外を投げる必要があるためです。

トランザクション処理としては、発生したExceptionをそのままなげてもかまいません。しかし、これらはchecked Exceptionなので、そのまま投げるとDbAccessorのinterfaceを変える必要が出てきます(throws ...を追加しなければなりません)。それで、ここではunchecked ExceptionのUnsupportedOperationExceptionを投げることにします。

（３）setAutoCommit(false)を入れる。(デフォルトはtrueに設定されている)

（４）重要：dataSoutce.getConnection()をDataSourceUtils.getConnection(dataSource)に変える。トランザクション処理をspringに頼るためには、独自で取得したコネクションは使えません。トランザクション管理で管理されたコネクションが必要です。そのためにDataSourceUtils.getConnectionを使わなければなりません。

（５） conn.close()を取る(理由：同上)

5.5 トランザクション処理のテスト用コード

トランザクション処理のテストをするために、わざとエラーになる処理を追加します。追加箇所は次の通りです。

（１） Action

新しいActionとしてExample1ErrorActionを追加します。ここから、Serviceの、エラーが起きるメソッドを呼び出します。

（２） Service

エラーが起きるメソッドを追加します。メソッド名はaddRecordToErrorとします。処理の内容は次の通りです。

2レコード追加する処理をします。最初のレコードの追加処理は正常に終了します。第2の追加はエラーで終わります。その結果、最初の追加はロールバックされて取り消されます。

（３） struts-config

Example1ErrorActionを呼び出すactionを追加します。

詳細は付録とダウンロードしたファイルを参照下さい。

６．spring例題５

６．１ spring例題５の概要

DbAccessorの処理をspringが提供するクラスJdbcTemplateに任せます。この結果DbAccessorは不要になります。この例題ではDbAccessorと同等の機能しか使いませんが、JdbcTemplateは実際のｗｅｂアプリで必要になる機能を多く備えています。

また、DbAccessorではコネクションを取るためにspringの提供するクラスをアクセスしていましたが、これはJdbcTemplateの中に入りますので、例題の開発者が直接コネクションを操作しなくて済みます。

spring例題５はspring例題４を母体に開発します。

spring例題５の構成を図６．１－１に示します。DbAccessorに代わってJdbcTemplateが入ります。コンポジションの代わりに親子関係(継承関係)を使います。もちろんコンポジションでも対応できます。その際に使うinterfaceはorg.springframework.jdbc.core.Interface.JdbcOperationsです。

図６．１－１ spring例題５の構成

６．２検索系の処理

JdbcTemplateの検索系の代表的なメソッドは次の二つです。

（１）queryForObject：(高々)１オブジェクトを戻す。

（２）query：複数のオブジェクトをＬｉｓｔで戻す。

具体的なオブジェクトの内容は、マップするクラスのメソッドをオーバライドして与えます。この方法はJdbcTemplateの名前から分かるように設計パターンTemplateの特徴です。

この具体的なコードをリスト６．２－１に示します。匿名のクラスを使うのが一般的です。

リスト６．２－１マッパーのオーバライド

1 List allData = jdbcTemplate.query(sql, 2 new RowMapper() { 3 public Object mapRow(ResultSet rs, int rowNum) throws SQLException { 4 String[] row; 5 ResultSetMetaData rsmd = rs.getMetaData(); 6 int numberOfColumns = rsmd.getColumnCount(); 7 int i; 8 row = new String[numberOfColumns]; 9 for(i=0;i<numberOfColumns;i++){ 10 row[i] = rs.getString(i+1); 11 } 12 return row; 13 } 14 });

（説明）

２ RowMapper(springが提供するクラス)を継承したクラス(匿名のクラス)を具現化

３匿名クラスの中にメソッドmapRowを定義します。これは元のクラスRowMapperのmapRowをオーバライドするものです。

(説明終り）

mapRowメソッドの具体的な内容はアプリケーションによって変わります。リスト６．２－１の例は検索結果(ResultSet)をStringクラスの配列に設定しています。こうすることで、ResultSetが開放できる状態に出来ます。

queryメソッドは複数行戻しですので、mapRowが行数の回数だけ呼び出されます。

queryForObjectは高々１オブジェクト戻しですので高々一度だけmapRowが呼び出されます。

６．２更新系の処理

更新・追加・削除はDbAccessorのインタフェースとほぼ同じで、sqlを引数にしてupdateメソッドを呼び出すだけです。

６．３トランザクション処理のテスト用コード

５．５と同じ方法でトランザクションをテストするコードを追加します。

７．資料

（１）George Franciscus,http://www.ibm.com/developerworks/java/library/j-sr2.html,

Get a better handle on Struts actions, with Spring, Three ways to integrate Struts applications with Spring アクションにserviceを設定するための方法

（２）トランザクションの伝播 ¶５．３

付録

付録Ａ． springを使う準備

Ａ．１環境を作る

springをダウンロードする。

解凍する。

spring-framework-2.0.5/dist/spring.jarをlibにコピー

spring-framework-2.0.5/lib/log4j/log4j-1.2.9をlibにコピー

spring-framework-2.0.5/samples/showcases/java5-dao/src/log4j.propertiesをソース(パッケージなし)にコピー

ついでに、commons-logging-1.0.4.jarをlibから削除し、

代わりにspring-framework-2.0.5/lib/jakarta-commons/commons-logging.jarをlibにコピー

これに伴って、eclipseのプロジェクトのlibraryプロパティを変更する。

commons-logging-1.0.4.jarを削除

spring.jarを追加

log4j-1.2.9を追加

commons-logging.jarを追加

Ａ．２確認

例題１を使って確認してください。

付録B． spring例題２の作成

webapp例題３をベースにして、Initializerクラスの処理のほとんどをspringに移します。

（１）パッケージを作る。${basePackage}.a0202

（２）新パッケージに${basePackage}.a0103の内容をコピーする。

新しいパッケージa0202を作り、webapp例題３をここにコピーします。webapp例題３のパッケージ(a0103)をすべてa0202に変更します。

（３）struts-config.xmlにactionを追加

（4）Action1の変更

(変更前) request.setAttribute("nextAction", "r2_n03Example"); (変更後) request.setAttribute("nextAction", "r2_a0202Example");

（5）Action2の変更

(変更前) request.setAttribute("nextAction", "r1_n03Example"); (変更後) request.setAttribute("nextAction", "r1_a0202Example");

（6）ExampleContextListenerを変更

(new N03ExampleInitializer()).initProgram(servletContext);

の下に次の文を追加する。jp.co.nsp_ltd.a0202.N03ExampleInitializerでも初期化する。

(new jp.co.nsp_ltd.a0202.N03ExampleInitializer()).initProgram(servletContext);

（7）N03ExampleBaseActionを変更

(変更前)private final static String keyToServiceImpl="jp.co.nsp_ltd.a0103.N03ExampleService"; (変更後)private final static String keyToServiceImpl="jp.co.nsp_ltd.a0202.N03ExampleService";

（8）N03ExampleInitializerを変更（１）

(変更前)private final static String keyToServiceImpl="jp.co.nsp_ltd.a0103.N03ExampleService"; (変更後)private final static String keyToServiceImpl="jp.co.nsp_ltd.a0202.N03ExampleService";

N03ExampleInitializerについてはさらに変更があります。

（9）確認

ここまでの変更を確認します。

http://localhost:8080/${contextbase}/r1_a0202Example.do

（10）applicationContext.xmlの作成

本文を参考にして下さい。

内容はダウンロードしたファイルを参考にして下さい。

（11）N03ExampleInitializerを変更（２）

本文を参考にして下さい。

内容はダウンロードしたファイルを参考にして下さい。

（１2）n03Example.propertiesを削除

（１3）確認

付録C．spring例題３の作成

アクションへのserviceの設定をspringにまかせます。

ｐｌｕｇ－ｉｎで初期化します。Actionへのserviceの設定をspringにまかせるにはplug-inで初期化する必要があります。

（１）パッケージを作ります。${basePackage}.a0203

（２）新パッケージに${basePackage}.a0202の内容をコピーする。

新しいパッケージa0203を作り、spring例題１をここにコピーします。spring例題１のパッケージ(a0202)をすべてa0203に変更します。

（３）struts-config.xmlにactionを追加

（４）struts-config.xml にplug-inの設定を追加

spring コンテキストを初期化するplug-inを設定します。

<plug-in className="org.springframework.web.struts.ContextLoaderPlugIn"> <set-property property="contextConfigLocation" value="/WEB-INF/applicationContext_a0203.xml ,/WEB-INF/action-servlet.xml "/> </plug-in>

（５）applicationContext_a0203.xmlの作成

applicationContext.xmlをWEB-INFの直下にコピーします。混乱する恐れがあるので名前をapplicationContext_a0203.xmlに変更します。

applicationContext_a0203.xmlの中にあるパッケージ名jp.co.nsp_ltd.a0202をすべてjp.co.nsp_ltd.a0203に変更してください。

serviceとdaoの2か所あります。

（６）action-servlet_a0203.xmlの作成

<bean name="/r1_a0203Example " class="jp.co.nsp_ltd.a0203.N03Example1Action " scope="singleton"> <property name="service"> <ref bean="service"/> </property> </bean> <bean name="/r2_a0203Example " class="jp.co.nsp_ltd.a0203.N03Example2Action " scope="singleton"> <property name="service"> <ref bean="service"/> </property> </bean>

（７）Action1の変更

(変更前) request.setAttribute("nextAction", "r2_a0202Example"); (変更後) request.setAttribute("nextAction", "r2_a0203Example");

（８）Action2の変更

(変更前) request.setAttribute("nextAction", "r1_a0202Example"); (変更後) request.setAttribute("nextAction", "r1_a0203Example");

（９）N03ExampleBaseActionの変更

serviceを設定するメソッド(setter）を追加します。

public void setService(IExampleService service){ this.service = service; }

（１０）N03ExampleInitializerを削除

付録D．例題４の作成

例題４ではトランザクション処理を追加します。

(１) MS ACCESS用DBを作ります。

textのデータをMS ACCESSに複写する手順は次の通りです。

textのデータをEXCELに複写します。(先頭の行を列名の行にします)

MS ACCESSを立ち上げます。

ファイル/新規作成ファイル名はtestDb.mdbとします。

データベースウインドウの新規作成をクリック

テーブルのインポートをクリック

インポート元のEXCELのファイルを選択し、さらにテーブルを選択

ワークシートインポートウイザードの中で

「ワークシート」をチェック

「先頭行をフィールド名として使う」をチェック

「新規テーブルに保存する」をチェック

「主キーを設定しない」をチェック

インポート先テーブル名「table7」

（２）DbAccessorDiTxの作成

DbAccessorDiを次の手順で変更してDbAccessorDiTxを作成します。

commit/rollbackの処理を取り除きます。

Exception発生時いったんそれをキャッチしてUnsupportedOperationExceptionを投げる処理にします。トランザクション処理をするためにはエラーがあったときにServiceでエラーを投げる必要があるためです。

ここは発生したExceptionをそのまま投げてもいいですが、それはchecked Exceptionなので投げることを明示的に宣言する必要があります。したがってシグネチャーを変える必要があります。これまでの例題ではexceptionを投げる仕様ではありませんでしたので、その部分の変更が必要になります。

setAutoCommit(false)を入れます。(デフォルトはtrueに設定されています)

重要：dataSoutce.getConnection()をDataSourceUtils.getConnection(dataSource)に変える(トランザクション処理をspringに頼るため)。connectionを独自で取るとトランザクションの処理が正しく出来なくなります。

conn.close()を取る(理由：同上)

（３）context.xmlの変更（１）

トランザクション処理のプロクシとトランザクション管理に関する設定を追加します。

<bean id="baseTransactionProxy" class="org.springframework.transaction.interceptor.TransactionProxyFactoryBean" abstract="true"> <property name="transactionManager" ref="transactionManager"/> <property name="transactionAttributes"> <props> <prop key="find*">PROPAGATION_REQUIRED,readOnly</prop> <prop key="*">PROPAGATION_REQUIRED</prop> </props> </property> </bean> <bean id="service" parent="baseTransactionProxy"> <property name="target" ref="serviceTarget"/> </bean> <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <property name="dataSource" ref="dataSource"/> </bean>

（４）context.xmlの変更（２）

textを使ったDBMSはトランザクションの処理ができませんので、MS ACCESSに変更します。

<bean id="dataSource" class="org.apache.tomcat.dbcp.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="sun.jdbc.odbc.JdbcOdbcDriver"/> <property name="url" value="jdbc:odbc:Driver={Microsoft Access Driver (*.mdb)};Dbq=C:/@/projEclipse/osss/struts-1.3.8/db/testDb.mdb;"/> <property name="username" value=""/> <property name="password" value=""/> </bean>

MS ACCESS でなくHSQLDBに変更する場合は次の内容です。

<bean id="dataSource" class="org.apache.tomcat.dbcp.dbcp.BasicDataSource" destroy-method="close"> <property name="driverClassName" value="org.hsqldb.jdbcDriver"/> <property name="url" value="jdbc:hsqldb:hsql://localhost:9001"/> <property name="username" value="sa"/> <property name="password" value=""/> </bean>

（５）context.xmlの変更（３）

dbAccessorのタイプをDbAccessorDiTxに変更する。

<bean id="dbAccessor" class="jp.co.nsp_ltd.a01data.impl.DbAccessorDiTx"> <property name="dataSource" ref="dataSource"/> </bean>

（６）N03ExampleServiceの変更

addRecordToErrorメソッドを追加します。このメソッドはDaoで例外を投げる処理内容にします。rollback処理を確認する目的です。

addRecordを使って２レコードを追加する処理を入れます。最初のレコードは正常に追加できる内容で、第2のレコードはデータの型が不正で追加できない内容とします。一部を示します。

public void addRecordToError(Example1Dto dto){ Example1Dto dto1 = new Example1Dto(); dto1.setPop1995("1"); ... dao.addRecord(dto1); dto1.setPop1995("a1"); // error data ... dao.addRecord(dto1); }

これに伴って、IServiceにaddRecodを追加します。

（７）テスト

バッチでテストします。

（８）初期化クラスを作る。

a0202．N03ExampleInitializerをa0204にコピーします。

keyToServiceImplを変更します。

(変更前) keyToServiceImpl="jp.co.nsp_ltd.a0202.N03ExampleService"; (変更後) keyToServiceImpl="jp.co.nsp_ltd.a0204.N03ExampleService";

（９）N03ExampleBaseActionの変更（１）

初期化処理を起動する処理を作ります。

(変更前) keyToServiceImpl="jp.co.nsp_ltd.a0202.N03ExampleService"; (変更後) keyToServiceImpl="jp.co.nsp_ltd.a0204.N03ExampleService";

初期化済みか否かを判断して、まだならば初期化する処理を追加します。

// this is a way just for test. if(service==null){ (new N03ExampleInitializer()).initProgram(servletContext); service = (IExampleService)servletContext.getAttribute(keyToServiceImpl); }

（１０）N03ExampleBaseActionの変更（２）

例外をキャッチする処理を入れます。

RuntimeExceptionだけキャッチします。

（１１）Action1の変更

(変更前) request.setAttribute("nextAction", "r2_a0203Example"); (変更後) request.setAttribute("nextAction", "r2_a0204Example");

（１２）Action２の変更

(変更前) request.setAttribute("nextAction", "r1_a0203Example"); (変更後) request.setAttribute("nextAction", "r1_a0204Example");

（１３）ErrorActionの追加

addRecordToErrorを呼び出すActionを追加します。

service.addRecordToError(null);

（１４）struts-configの変更（１）

アクションを追加

typeがorg.springframework.web.struts.DelegatingActionProxyではないことに注意してください。

（１３）struts-configの変更（２）

エラーがあった場合のglobal forwardを入れます。

<forward name="testError" path="/pages/testError.jsp"/>

付録 E．例題５の作成

JdbcTemplateを使ったトランザクション処理を追加します。

（１）Daoの変更

JdbcTemplateを使います。JdbcTemplateはDbAccessorに相当する機能を持っているのでDbAccessorを使わないでJdbcTemplateを使う処理に変更します。DbAccessorの場合と違って、JdbcTemplateをDaoが継承する形にします。

継承を定義する部分とマッパーを使っている部分だけ記載します。

... public class N03ExampleDao extends JdbcTemplate implements IExampleDao{ ... ... public Example1Dto findRecordByPrefecture(String prefecture){ String sql = "select \"都道府県\" AS prefecture, \"1995年\" AS pop1995, \"2000年\" AS pop2000, \"2005年\" AS pop2005, \"人口性比\" AS ratio, \"人口密度\" AS density from " + dbTableName ; ... Example1Dto dto= (Example1Dto)super.queryForObject(sql, new RowMapper() { public Object mapRow(ResultSet rs, int rowNum) throws SQLException { Example1Dto dto = new Example1Dto(); dto.setPrefecture(rs.getString("prefecture")); ... return dto; } }); return dto; }

（２）BaseActionを変更する。

a0202．N03ExampleInitializerをa0204にコピーします。

keyToServiceImplを変更します。

(変更前) keyToServiceImpl="jp.co.nsp_ltd.a0204.N03ExampleService"; (変更後) keyToServiceImpl="jp.co.nsp_ltd.a0205.N03ExampleService";

（３）初期化クラスを作る。

a0202．N03ExampleInitializerをa0204にコピーします。

keyToServiceImplを変更します。

(変更前) keyToServiceImpl="jp.co.nsp_ltd.a0204.N03ExampleService"; (変更後) keyToServiceImpl="jp.co.nsp_ltd.a0205.N03ExampleService";

（４）Action1の変更

(変更前) request.setAttribute("nextAction", "r2_a0204Example"); (変更後) request.setAttribute("nextAction", "r2_a0205Example");

（５）Action２の変更

(変更前) request.setAttribute("nextAction", "r1_a0204Example"); (変更後) request.setAttribute("nextAction", "r1_a0205Example");

（６）applicationContextを変更します。

DbAccessorを削除します。

DaoのpropertyのdbAccessorを削除し、dataSourceを追加します。

<bean id="dao" class="jp.co.nsp_ltd.a0205.N03ExampleDao"> <property name="dataSource" ref="dataSource"/> <property name="dbTableName" value="table7"/> </bean>

（７）struts-configを変更します。

アクションを追加します。エラーの処理は前の例題のものを共用できますので変更は不要です。

以上