Spring-MVC/ステップ・バイ・ステップ/AOPの追加のバックアップ差分(No.12)

追加された行はこの色です。
削除された行はこの色です。
#freeze
[[Spring-MVC/ステップ・バイ・ステップ]]

2008/04/15からのアクセス回数 &counter;

#contents

Springの特徴は、なんと言ってもBean定義でAOPを使ってBeanの機能を簡単に拡張できることでしょう。

AOPは以下のような場合に有効です。
- OOPでは対応できない複数のルートクラスに跨る共通の処理を組み入れる場合
- ソースファイルの存在しない市販パッケージに別の機能を組み入れる場合
- 宣言的トランザクションのように特定の処理を適応する箇所をコンフィグファイルに定義してプログラムと分離したい場合

** AOPの用語の説明 [#o8eec54f]
AOPでは、聞き慣れない用語がたくさん出てきます。

ここでは、それらを簡潔に説明し、SpringでのAOPの特徴について説明します。
*** Aspect [#o51c30c3]
Aspectとは、adviceとjoinpointの組み合わせを指定するモジュール単位です。

*** Advice [#t2a184d0]
Adviceとは、pointcutによって指定されたjoinpointのどのタイミングで、どのような処理を
行うかを定義したものです。

*** Joinpoint [#m8175767]
Joinpointとは、プログラムの実行時にAdviceの割り込ませることが可能なコード上の位置を示します。

*** Pointcut [#h8425eec]
Pointcutでは、adviceを適応するjoinpointの条件を指定します。

*** SpringでのAOPの特徴 [#b7ec72e7]
pringのAOPは、プロキシーを使ってメソッドへの呼び出しを横取りするInterceptorとコンテナーのどの部分にInterceptorを適応するかを指定するAdvisorから構成されています。
従って、Springでは、fieldにはAspectを適応できません。

Spring でサポートされている adivceの種類を以下に示します。

| adivceの種類 | インタフェース | 適応箇所 |
| Before | org.springframework.aop.BeforeAdvice | メソッドが呼び出される前 |
| After-returing | org.springframework.aop.AfterReturningAdvice | リターンの直前 |
| After-throwing | org.springframework.aop.ThrowsAdvice | 例外を発行する直前 |
| Around | org.aopalliance.intercept.MethodInterceptor | メソッド呼び出しを横取りする |
| Introduction | org.springframework.aop.IntroductionInterceptor | Interceptorを使って新たなInterfaceを導入する |

** ログ出力のAdvice [#p9989823]
各メソッドの入り口と出口でログを出力するAOPを例にSpringのAOPについて説明します。

最初に各メソッドの呼び出し前とリターン直前にログを出力する EnterMethodLogAdvice と LeaveMethodLogAdvice を作成します。

*** EnterMethodLogAdvice [#de89046f]
メソッド呼び出し前の Advice(Before Advice)は、 インタフェース MethodBeforeAdvice を実装しなくてはなりません。

EnterMethodLogAdviceは、以下のようになります。

#pre{{
	public void before(Method method, Object[] args, Object target)
			throws Throwable {
		System.out.print("enter " + method.getName() + " args=(");
		if (args != null) {
			for (int i = 0; i < args.length; i++) {
				if (i != 0)
					System.out.print(", ");
				System.out.print(args[i]);
			}
			System.out.println(")");
		}
	}
}}

Bean定義は、
#pre{{
	<bean id="enterMethodLogAdvice" class="org.springframework.showcase.aop.EnterMethodLogAdvice"/>
}}
とします。

*** LeaveMethodLogAdvice [#s4e4f28d]
同様に、メソッドリターン直前の Advice(After Advice)は、 インタフェース AfterReturningAdvice を実装しなくてはなりません。
LeaveMethodLogAdviceのソースを以下に示します。EnterMethodLogAdviceと同様にメソッド名とリターン値を出力します。

#pre{{
	public void afterReturning(Object returnValue, Method method,
			Object[] args, Object target) throws Throwable {
		System.out.println("leave " + method.getName() + " return="
				+ (returnValue != null ? returnValue : "null"));
	}
}}

Bean定義は、
#pre{{
	<bean id="leaveMethodLogAdvice" class="org.springframework.showcase.aop.LeaveMethodLogAdvice"/>
}}
とします。

** Pointcut [#ta87f751]
Springでは、Pointcutを正規表現で指定するJdkRegexpMethodPointcutを提供しています。

これを使ってfindがメソッド名に付くメソッドにpointcutを
定義すると以下のようになります。

#pre{{
	<bean id="logPointcut" class="org.springframework.aop.support.JdkRegexpMethodPointcut">
		<property name="pattern" value=".*find.*"/>
	</bean>
}}


** Advisor [#qf6bbc80]
logEnterAdvisorとlogLeaveAdvisorは、adviceとpointcutを指定して、次のようになります。

#pre{{
	<bean id="logEnterAdvisor" class="org.springframework.aop.support.DefaultPointcutAdvisor">
		<property name="advice" ref="enterMethodLogAdvice"/>
		<property name="pointcut" ref="logPointcut"/>
	</bean>
	<bean id="logLeaveAdvisor" class="org.springframework.aop.support.DefaultPointcutAdvisor">
		<property name="advice" ref="leaveMethodLogAdvice"/>
		<property name="pointcut" ref="logPointcut"/>
	</bean>
}}

** DefaultAdvisorAutoProxyCreatorの定義 [#q49c657c]
最後にDefaultAdvisorAutoProxyCreatorをBean定義に追加し、自動的にAdvisorのProxyが生成されるようにします。

#pre{{
	<bean class="org.springframework.aop.framework.autoproxy.DefaultAdvisorAutoProxyCreator"/>
}}

#ref(applicationContext.xml);

** 実行 [#o0251524]
ブラウザーで実行すると、findAllメソッドの前後でenterとleaveのデバッグログが出力されます。

#pre{{
enter findAll args=()
leave findAll return=[org.springframework.showcase.coverc.domain.Recipe@a943af, 
org.springframework.showcase.coverc.domain.Recipe@6d50ae, 
org.springframework.showcase.coverc.domain.Recipe@cbf
}}



** コメント [#l056f56b]
この記事は、

#vote(おもしろかった[6],そうでもない[0],わかりずらい[0])
#vote(おもしろかった[6],そうでもない[0],わかりずらい[1])

皆様のご意見、ご希望をお待ちしております。

#comment_kcaptcha
Spring-MVC/ステップ・バイ・ステップ/AOPの追加 のバックアップ差分(No.12)

Spring-MVC/ステップ・バイ・ステップ/AOPの追加のバックアップ差分(No.12)
