5.7 用ProxyFactoryBean建立AOP代理

 

5.7  用ProxyFactoryBean建立AOP代理

使用Spring提供的類org.springframework.aop.framework.ProxyFactoryBean是建立AOP的最基本的方式。

5.7.1  使用ProxyFactoryBean代理目標類的所有方法

在Spring中，ProxyFactoryBean是在XML中進行配置的，它的範例程式碼如下：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"

 "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

<bean id="log" class="com.gc.action.LogAround"/>

<bean id="timeBook" class="com.gc.action.TimeBook"/>

<!--設定代理類-->

<bean id="logProxy" class="org.springframework.aop.framework.ProxyFactoryBean">

        <!--這裡代理的是介面-->

<property name="proxyInterfaces">

            <value>com.gc.impl.TimeBookInterface</value>

        </property>

               <!--程式中的Advice-->

        <property name="target">

            <ref bean="timeBook"/>

        </property>

               <!--是ProxyFactoryBean要代理的目標類-->

        <property name="interceptorNames">

            <list>

                <value>log</value>

            </list>

        </property>

    </bean>

</beans>

代碼說明：

  ●       id為log的Bean，是程式中的Advice。

  ●       id為timeBook的Bean，是ProxyFactoryBean要代理的目標類。

  ●       id為logProxy的Bean，就是ProxyFactoryBean。

  ●       ProxyFactoryBean的proxyInterfaces屬性，指明要代理的介面。

  ●       ProxyFactoryBean的target屬性，指明要代理的目標類，這個目標類實現了上面proxyInterfaces屬性指定的介面。

  ●       ProxyFactoryBean的interceptorNames屬性，指明要在代理的目標類中插入的Adivce。

  ●       ProxyFactoryBean還有一個proxyTargetClass屬性，如果這個屬性被設定為“true”，說明ProxyFactoryBean要代理的不是介面類，而是要使用CGLIB方式來進行代理，後面會詳細講解使用CGLIB方式來進行代理。

%注意：ProxyFactoryBean的proxyInterfaces屬性只支援使用字串的方式進行注入，不支援使用Bean的依賴方式進行注入。

5.7.2  使用ProxyFactoryBean代理目標類的指定方法

在上面的樣本中，Advice會代理目標類的所有方法。如果要代理目標類的指定方法，則需要使用Spring提供的org.springframework.aop.support.RegexpMethodPointcutAdvisor類。代理目標類的指定方法的範例程式碼如下：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"

 "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

<bean id="log" class="com.gc.action.LogAround"/>

<bean id="timeBook" class="com.gc.action.TimeBook"/>

<!--代理目標類的指定方法-->

<bean id="logAdvisor"class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">

        <property name="advice">

            <ref bean="log"/>

        </property>

               <!--指定要代理的方法-->

        <property name="patterns">

            <value>.*doAuditing.* </value>

        </property>

    </bean>

<!--設定代理類-->

<bean id="logProxy" class="org.springframework.aop.framework.ProxyFactoryBean">

        <property name="proxyInterfaces">

            <value>com.gc.impl.TimeBookInterface</value>

        </property>

        <property name="target">

            <ref bean="timeBook"/>

        </property>

        <property name="interceptorNames">

            <list>

                <value>logAdvisor</value>

            </list>

        </property>

    </bean>

</beans>

代碼說明：

  ●       在id為logAdvisor的Bean中設定Advice和要指定的方法。

  ●       把id為logProxy的Bean的interceptorNames屬性值改為logAdvisor。

  ●       logAdvisor的advice屬性指定Advice。

  ●       logAdvisor的patterns屬性指定要代理的方法。“.doAuditing”表示只有doAuditing()方法才使用指定的Advice。

patterns屬性值使用的是Regex，關於Regex的使用，下節將會進行講解。

%注意：因為要使用Regex，所以要把spring-framework-2.0-m1/lib/oro目錄下的
jakarta-oro-2.0.8.jar加入到ClassPath下，加入方法可參考第2章。

5.7.3  Regex簡介

Regex最早是由數學家Stephen Kleene於1956年在對自然語言的遞增研究成果的基礎上提出來的。Regex並非一門專用語言，但它可用於在一個檔案中尋找字元。下面把幾個常用的進行一下講解：

（1）“.”，可以用來匹配任何一個字元。比如：Regex為“g.f”，它就會匹配“gaf”、“g1f”、“g*f”和“g #f”等。

（2）“[]”，只有[]裡指定的字元才能匹配。比如：Regex為“g[abc]f”，它就只能匹配“gaf”、“gbf”和“gcf”，而不會匹配“g1f”、“g*f”和“g#f”等。

（3）“*”，表示匹配次數，可以任意次，用來確定緊靠該符號左邊的符號出現的次數。比如：Regex為“g.*f”，它能匹配“gaf”、“gaaf”、“gf”和“g*f”等。

（4）“?”，可以匹配0或1次，用來確定緊靠該符號左邊的符號出現的次數。比如：Regex為“g.?f”，它能匹配“gaf”“g*f”等。

（5）“/”，是Regex的串連符。比如：Regex為“g./-f”，它能匹配“g-f”、“ga-f”和“g*-f”等。

上面的樣本中，只對TimeBook類的doAuditing()方法有效，如果要對TimeBook類中所有以do開頭的方法有效，可以這樣設定“.*do.*”，範例程式碼如下：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"

 "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

<bean id="log" class="com.gc.action.LogAround"/>

<bean id="timeBook" class="com.gc.action.TimeBook"/>

<!--代理目標類的指定方法-->

<bean id="logAdvisor"class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">

        <property name="advice">

            <ref bean="log"/>

        </property>

          /*對所有以do開頭的方法有效*/

        <property name="patterns">

            <value>.*do.* </value>

        </property>

    </bean>

<!--設定代理類-->

<bean id="logProxy" class="org.springframework.aop.framework.ProxyFactoryBean">

        <property name="proxyInterfaces">

            <value>com.gc.impl.TimeBookInterface</value>

        </property>

        <property name="target">

            <ref bean="timeBook"/>

        </property>

               <!--指定要代理的類-->

        <property name="interceptorNames">

            <list>

                <value>logAdvisor</value>

            </list>

        </property>

    </bean>

</beans>

上述代碼對TimeBook類中所有以do開頭的方法都有效。如果要對TimeBook類中所有方法有效，可以這樣設定“.*com/.gc/.impl/.TimeBookInterface.*”，範例程式碼如下：

<?xml version="1.0" encoding="UTF-8"?>

<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN"

 "http://www.springframework.org/dtd/spring-beans.dtd">

<beans>

<bean id="log" class="com.gc.action.LogAround"/>

<bean id="timeBook" class="com.gc.action.TimeBook"/>

<!--代理目標類的指定方法-->

<bean id="logAdvisor"class="org.springframework.aop.support.RegexpMethodPointcutAdvisor">

        <property name="advice">

            <ref bean="log"/>

        </property>

           /*注意包路徑的定義*/

        <property name="patterns">

            <value> .*com/.gc/.impl/.TimeBookInterface.*</value>

        </property>

    </bean>

<!--設定代理類-->

<bean id="logProxy" class="org.springframework.aop.framework.ProxyFactoryBean">

        <property name="proxyInterfaces">

            <value>com.gc.impl.TimeBookInterface</value>

        </property>

        <property name="target">

            <ref bean="timeBook"/>

        </property>

               <!--指定要代理的類-->

        <property name="interceptorNames">

            <list>

                <value>logAdvisor</value>

            </list>

        </property>

    </bean>

</beans>

上述代碼對TimeBook類中所有的方法都有效。

%注意：包的路徑要用“/”串連符來表示“.”不是Regex的“.”。