教程 > Spring 框架 > Spring 教程 阅读：9

Spring 基于 XML 架构的 AOP

返回 Spring AOP

要使用本节中描述的 AOP 命名空间标签，需要按照描述导入 springAOP 模式

<?xml version = "1.0" encoding = "UTF-8"?>
<beans xmlns = "http://www.springframework.org/schema/beans"
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance" 
   xmlns:aop = "http://www.springframework.org/schema/aop"
   xsi:schemaLocation = "http://www.springframework.org/schema/beans
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd 
   http://www.springframework.org/schema/aop 
   http://www.springframework.org/schema/aop/spring-aop-3.0.xsd ">

   <!-- bean definition & AOP specific configuration -->

</beans>

你还需要在你的应用程序的 CLASSPATH 中使用以下 AspectJ 库文件。这些库文件在一个 AspectJ 装置的 ‘lib’ 目录中是可用的，否则你可以在 Internet 中下载它们。(注：aspectjweaver.jar 已包含其他包)

  • aspectjrt.jar
  • aspectjweaver.jar
  • aspectj.jar
  • aopalliance.jar

附上官网下载地址：http://www.eclipse.org/aspectj/downloads.php

本站也提供aspectj-1.8.13.jar版本的下载 https://pan.baidu.com/s/1E3_1rFBkxd1TOic9nwHong 提取码: ahil

声明一个 aspect

一个 aspect 是使用 元素声明的，支持的 bean 是使用 ref 属性引用的，如下所示：

<aop:config>
   <aop:aspect id="myAspect" ref="aBean">
   ...
   </aop:aspect>
</aop:config>
<bean id="aBean" class="...">
...
</bean>

这里“aBean”将被配置和依赖注入，就像我们在前面章节中看到的任何其他 Spring bean 一样。

声明一个切入点

一个切入点有助于确定使用不同建议执行的感兴趣的连接点（即方法）。在处理基于配置的 XML 架构时，切入点将会按照如下所示定义：

<aop:config>
   <aop:aspect id="myAspect" ref="aBean">
   <aop:pointcut id="businessService"
      expression="execution(* com.xyz.myapp.service.*.*(..))"/>
   ...
   </aop:aspect>
</aop:config>
<bean id="aBean" class="...">
...
</bean>

下面的示例定义了一个名为 “businessService” 的切入点，该切入点将与 com.jiyik 包下的 Student 类中的 getName() 方法相匹配：

<aop:config>
   <aop:aspect id="myAspect" ref="aBean">
   <aop:pointcut id="businessService"
      expression="execution(* com.jiyik.Student.getName(..))"/>
   ...
   </aop:aspect>
</aop:config>
<bean id="aBean" class="...">
...
</bean>

声明通知

你可以在<aop:aspect>中使用<aop:{通知类型名}>元素声明任意五种类型的通知，如下：

<aop:config>
   <aop:aspect id="myAspect" ref="aBean">
      <aop:pointcut id="businessService"
         expression="execution(* com.xyz.myapp.service.*.*(..))"/>
      <!-- 前置通知定义 -->
      <aop:before pointcut-ref="businessService" 
         method="doRequiredTask"/>
      <!-- 后置通知定义 -->
      <aop:after pointcut-ref="businessService" 
         method="doRequiredTask"/>
      <!-- 返回后的通知定义 -->
      <!-- doRequiredTask 方法必须具有名为 retVal 的参数 -->
      <aop:after-returning pointcut-ref="businessService"
         returning="retVal"
         method="doRequiredTask"/>
      <!-- 抛异常后的通知定义 -->
      <!-- doRequiredTask 方法必须有名为 ex 的参数 -->
      <aop:after-throwing pointcut-ref="businessService"
         throwing="ex"
         method="doRequiredTask"/>
      <!-- 环绕通知定义 -->
      <aop:around pointcut-ref="businessService" 
         method="doRequiredTask"/>
   ...
   </aop:aspect>
</aop:config>
<bean id="aBean" class="...">
...
</bean>

你可以对不同的建议使用相同的 doRequiredTask 或者不同的方法。这些方法将会作为 aspect 模块的一部分来定义。

基于 XML 架构的AOP 的示例

为了理解上面提到的基于 AOP 的 XML 架构的概念，让我们编写一个示例，可以实现几个建议。为了在我们的示例中使用几个建议

  1. 使用我们 Spring第一个示例 中的项目 FirstSpring。
  2. 在项目中添加 Spring AOP 指定的库文件 aspectjrt.jar， aspectjweaver.jar 和 aspectj.jar。
  3. 在 com.tutorialspoint 包下创建 Java 类 Logging， Student 和 MainApp。
  4. 在 src 文件夹下创建 Beans 配置文件 Beans.xml。
  5. 最后一步是创建所有 Java 文件和 Bean 配置文件的内容，并且按如下解释的那样运行应用程序。

下面是 Logging.java 文件的内容。 这实际上是一个方面模块的示例，它定义了要在各个点调用的方法。

Logging.java

package com.jiyik;

public class Logging {
    /**
     * 这是在选定的方法执行之前想要执行的方法。
     */
    public void beforeAdvice(){
        System.out.println("Going to setup student profile.");
    }

    /**
     * 这是在选定的方法执行之后想要执行的方法。
     */
    public void afterAdvice(){
        System.out.println("Student profile has been setup.");
    }

    /**
     * 这是当任何方法返回时想要执行的方法。
     */
    public void afterReturningAdvice(Object retVal) {
        System.out.println("Returning:" + retVal.toString() );
    }

    /**
     * 这是当出现异常时想要执行的方法。
     */
    public void AfterThrowingAdvice(IllegalArgumentException ex){
        System.out.println("There has been an exception: " + ex.toString());
    }
}

以下是 Student.java 文件的内容

Student.java

package com.jiyik;

public class Student {
    private Integer age;
    private String name;

    public void setAge(Integer age) {
        this.age = age;
    }
    public Integer getAge() {
        System.out.println("Age : " + age );
        return age;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getName() {
        System.out.println("Name : " + name );
        return name;
    }
    public void printThrowException(){
        System.out.println("Exception raised");
        throw new IllegalArgumentException();
    }
}

以下是 MainApp.java 文件的内容

MainApp.java

package com.jiyik;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

public class MainApp {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("Beans.xml");

        Student student = (Student) context.getBean("student");
        student.getName();
        student.getAge();
        student.printThrowException();
    }
}

以下是配置文件Beans.xml

Beans.xml

<?xml version = "1.0" encoding = "UTF-8"?>
<beans xmlns = "http://www.springframework.org/schema/beans"
       xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop = "http://www.springframework.org/schema/aop"
       xsi:schemaLocation = "http://www.springframework.org/schema/beans
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd 
   http://www.springframework.org/schema/aop 
   http://www.springframework.org/schema/aop/spring-aop-3.0.xsd ">

    <aop:config>
        <aop:aspect id = "log" ref = "logging">
            <aop:pointcut id = "selectAll"
                          expression = "execution(* com.jiyik.*.*(..))"/>

            <aop:before pointcut-ref = "selectAll" method = "beforeAdvice"/>
            <aop:after pointcut-ref = "selectAll" method = "afterAdvice"/>
            <aop:after-returning pointcut-ref = "selectAll"
                                 returning = "retVal" method = "afterReturningAdvice"/>

            <aop:after-throwing pointcut-ref = "selectAll"
                                throwing = "ex" method = "AfterThrowingAdvice"/>
        </aop:aspect>
    </aop:config>

    <!-- Definition for student bean -->
    <bean id = "student" class = "com.jiyik.Student">
        <property name = "name" value = "Zara" />
        <property name = "age" value = "11"/>
    </bean>

    <!-- Definition for logging aspect -->
    <bean id = "logging" class = "com.jiyik.Logging"/>

</beans>

完成源代码和 bean 配置文件后，让我们运行应用程序。 如果应用程序一切正常，它将打印以下消息

Going to setup student profile.
Name : Zara
Student profile has been setup.
Returning:Zara
Going to setup student profile.
Age : 11
Student profile has been setup.
Returning:11
Going to setup student profile.
Exception raised
Student profile has been setup.
There has been an exception: java.lang.IllegalArgumentException
.....
other exception content

让我们来解释一下上面定义的在 com.jiyik 中 选择所有方法的 。让我们假设一下，你想要在一个特殊的方法之前或者之后执行你的建议，你可以通过替换使用真实类和方法名称的切入点定义中的星号（*）来定义你的切入点来缩短你的执行。

<?xml version = "1.0" encoding = "UTF-8"?>
<beans xmlns = "http://www.springframework.org/schema/beans"
       xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
       xmlns:aop = "http://www.springframework.org/schema/aop"
       xsi:schemaLocation = "http://www.springframework.org/schema/beans
   http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
   http://www.springframework.org/schema/aop
   http://www.springframework.org/schema/aop/spring-aop-3.0.xsd ">

    <aop:config>
        <aop:aspect id = "log" ref = "logging">
            <aop:pointcut id = "selectAll" expression = "execution(* com.jiyik.Student.getName(..))"/>
            <aop:before pointcut-ref = "selectAll" method = "beforeAdvice"/>
            <aop:after pointcut-ref = "selectAll" method = "afterAdvice"/>
        </aop:aspect>
    </aop:config>

    <!-- Definition for student bean -->
    <bean id = "student" class = "com.jiyik.Student">
        <property name = "name" value = "Zara" />
        <property name = "age" value = "11"/>
    </bean>

    <!-- Definition for logging aspect -->
    <bean id = "logging" class = "com.jiyik.Logging"/>

</beans>

如果使用这些配置更改执行示例应用程序，它将打印以下消息

Going to setup student profile.
Name : Zara
Student profile has been setup.
Age : 11
Exception raised
.....
other exception content

返回 Spring AOP

查看笔记

扫码一下
查看教程更方便