山崎屋のメモ: seasar2

2012年5月2日水曜日

seasar2 AOP

seasar2を使った、簡単なAOPのサンプルです。
seasar2に用意されているorg.seasar.framework.aop.interceptors.TraceInterceptorをアドバイス（インターセプタ）としてそのまま利用しています。
org.seasar.framework.aop.interceptors.TraceInterceptorは、ポイントカットとなるメソッドの前後にメソッド名や引数、戻り値をコンソールに出力してくれるアドバイス（インターセプタ）です。

今回のサンプルでは、log4jは使用していません。
log4jのjarは、クラスパスに置いていないので、自動でjava.util.logging.Loggerが使用されます。

org.seasar.framework.aop.interceptors.TraceInterceptorはデバッグレベルでログを出力します。
java.util.logging.LoggerのログレベルはFINEにしておいてください。
参考URL：http://www.alles.or.jp/~torutk/oojava/maneuver/2001/logging/logging.html

(1)パッケージ構成

（２）ソース

Driver.java package org.yama.study.aop.pk1;

import org.seasar.framework.container.S2Container;
import org.seasar.framework.container.factory.SingletonS2ContainerFactory;

public class Driver {
public static void main(String[] args) {
SingletonS2ContainerFactory.init();
S2Container container = SingletonS2ContainerFactory.getContainer();
ClassAImpl ca = (ClassAImpl) container.getComponent("classA");
ca.methodA();
ca.methodB();
}
}

ClassAImpl.java package org.yama.study.aop.pk1;

public class ClassAImpl {
public void methodA() {
System.out.println("Hello Aop from methodA!");
}
public void methodB() {
System.out.println("Hello Aop from methodB!");
}
}

app.dicon <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
"http://www.seasar.org/dtd/components24.dtd">
<components>
<component name="traceInterceptor"
class="org.seasar.framework.aop.interceptors.TraceInterceptor" />

<component name="classA" class="org.yama.study.aop.pk1.ClassAImpl">
<aspect>traceInterceptor</aspect>
</component>
</components>

main()を実行すると以下の実行結果が得られます。

実行結果（以下の出力以外に、seasar2本体のログが出力される場合もありますがテーマに関係ないので削除しました。）

普通: BEGIN org.yama.study.aop.pk1.ClassAImpl#methodA()
Hello Aop from methodA!
5 02, 2012 3:11:35 午後 org.seasar.framework.log.Logger debug
普通: END org.yama.study.aop.pk1.ClassAImpl#methodA() : null
5 02, 2012 3:11:35 午後 org.seasar.framework.log.Logger debug
普通: BEGIN org.yama.study.aop.pk1.ClassAImpl#methodB()
Hello Aop from methodB!
5 02, 2012 3:11:35 午後 org.seasar.framework.log.Logger debug
普通: END org.yama.study.aop.pk1.ClassAImpl#methodB() : null

メソッドの前後にログが出力されています。

続いてapp.diconを以下のように変更してみます。

app.dicon(修正後) <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
"http://www.seasar.org/dtd/components24.dtd">
<components>
<component name="traceInterceptor"
class="org.seasar.framework.aop.interceptors.TraceInterceptor" />

<component name="classA" class="org.yama.study.aop.pk1.ClassAImpl">
<aspect pointcut="methodA">traceInterceptor</aspect>
</component>
</components>

「<aspect pointcut="methodA">traceInterceptor</aspect>」の部分を修正しています。

すると、methodAの前後にだけアドバイスが織り込まれている（ウィービングされている）ことがわかります。

実行結果（以下の出力以外に、seasar2本体のログが出力される場合もありますがテーマに関係ないので削除しました。）

5 02, 2012 3:42:14 午後 org.seasar.framework.log.Logger debug
普通: BEGIN org.yama.study.aop.pk1.ClassAImpl#methodA()
Hello Aop from methodA!
5 02, 2012 3:42:14 午後 org.seasar.framework.log.Logger debug
普通: END org.yama.study.aop.pk1.ClassAImpl#methodA() : null
Hello Aop from methodB!

2012年4月30日月曜日

seasar2 コンポーネント自動登録

seasar2のコンポーネント自動登録の基本

初めて使ったときに悩んだのでメモ。

コンポーネントの自動登録を理解するために、最もシンプルにしたプロジェクトでサンプルを提示します。

１．自動登録を使用しない場合（プロジェクト名：ComponentManualRegisterSample1）

（１）パッケージ構成

（２）各ソース

ClassAImpl.java

package org.yama.study.pk1;

public class ClassAImpl {
public void say() {
System.out.println("Hello Manual Registar!");
}
}

Driver.java

package org.yama.study.pk1;

import org.seasar.framework.container.S2Container;
import org.seasar.framework.container.factory.SingletonS2ContainerFactory;

public class Driver {
public static void main(String[] args) {
SingletonS2ContainerFactory.init();
S2Container container = SingletonS2ContainerFactory.getContainer();
ClassAImpl ca = (ClassAImpl) container.getComponent("classA");
ca.say();
}
}

app.dicon

mainを実行した結果

Hello Manual Registar!

２．自動登録を使用した場合（プロジェクト名：ComponentAutoRegisterSample1）

（１）パッケージ構成

さっきと一緒

（２）各ソース

ClassAImpl.java

package org.yama.study.pk1;

public class ClassAImpl {
public void say() {
// ↓↓↓　出力の文言を変えただけ。コンポーネントの自動登録には影響しない　↓↓↓
System.out.println("Hello Auto Registar!");
}
}

Driver.java
（さっきと一緒）

app.dicon

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE components PUBLIC "-//SEASAR//DTD S2Container 2.4//EN"
"http://www.seasar.org/dtd/components24.dtd">
<components>
<component class="org.seasar.framework.container.autoregister.FileSystemComponentAutoRegister">
<property name="autoNaming">
<component class="org.seasar.framework.container.autoregister.DefaultAutoNaming"/>
</property>
<initMethod name="addClassPattern">
<arg>"org.yama.study.pk1"</arg>
<arg>".*Impl"</arg>
</initMethod>
</component>
</components>

mainを実行した結果

Hello Auto Registar!

３．いくつか解説

■自動登録する場合のapp.diconについて

app.dicon（抜粋）

<initMethod name="addClassPattern">
<arg>"org.yama.study.pk1"</arg>
<arg>".*Impl"</arg>
</initMethod>

1番目の引数は見てわかるとおり、自動登録するクラスのパッケージを指定しているが、
子供のパッケージも再帰的に検索するので、

<initMethod name="addClassPattern">
<arg>"org.yama.study"</arg>
<arg>".*Impl"</arg>
</initMethod>

や、

でも、同様の動きとなった。

ただし、これはだめだった。

デフォルトパッケージに自動登録したいクラスがあった場合、どうすればいいんだろう？
暇なときソースを追いかけてみるか。。。

■DefaultAutoNamingクラスの役割について

Driver.java（抜粋）

ClassAImpl ca = (ClassAImpl) container.getComponent("classA");

コンポーネントの自動登録をしない場合は、app.diconで明示的に「classA」という名前をコンポーネント名に設定している。一方、自動登録する場合には、「classA」というコンポーネント名は、どこにも設定していない。
にもかかわらず、「classA」というコンポーネント名が利用できるのは、app.diconで指定したDefaultAutoNamingクラスが、

app.dicon（抜粋）

自動でクラス名からコンポーネント名を導き出し、設定してるから。

サンプルの場合、以下のとおり。

・クラス名「org.yama.study.pk1.ClassAImpl」からパッケージ部分を除去し「ClassAImpl」という文字列を作成

↓

・「ClassAImpl」のImplを取り除き「ClassA」という文字列を作成

↓

・「ClassA」の先頭を小文字に変換し「classA」の出来上がり

この、変換ルールは、DefaultAutoNamingクラスのプロパティやメソッドで、ある程度変更可能。