Spring AOP - 快速指南



Spring AOP - 概述

Spring 框架的关键组件之一是面向切面编程 (AOP) 框架。面向切面编程需要将程序逻辑分解成称为所谓的关注点的不同部分。跨越应用程序多个点的函数称为横切关注点。这些横切关注点在概念上与应用程序的业务逻辑是分开的。日志记录、审计、声明式事务、安全、缓存等是各种常见的良好方面示例。

OOP 中模块化的关键单元是类,而在 AOP 中,模块化的单元是方面。依赖注入有助于将应用程序对象彼此解耦,而 AOP 则有助于将横切关注点与受其影响的对象解耦。AOP 就像 Perl、.NET、Java 等编程语言中的触发器。

Spring AOP 模块允许拦截器拦截应用程序。例如,当执行方法时,您可以在方法执行之前或之后添加额外的功能。

Spring AOP - 环境搭建

本章将指导您如何准备开发环境以开始使用 Spring 框架。在您设置 Spring 框架之前,它还将教您如何在您的机器上设置 JDK、Maven 和 Eclipse -

步骤 1 - 设置 Java 开发工具包 (JDK)

您可以从 Oracle 的 Java 网站下载最新版本的 SDK - Java SE 下载。您将在下载的文件中找到安装 JDK 的说明,请按照给定的说明安装和配置设置。最后设置 PATH 和 JAVA_HOME 环境变量以引用包含 java 和 javac 的目录,通常分别为 java_install_dir/bin 和 java_install_dir。

如果您正在运行 Windows 并已在 C:\jdk-11.0.11 中安装了 JDK,则必须在 C:\autoexec.bat 文件中添加以下行。

set PATH=C:\jdk-11.0.11;%PATH% 
set JAVA_HOME=C:\jdk-11.0.11 

或者,在 Windows NT/2000/XP 上,您需要右键单击“我的电脑”,选择“属性”→“高级”→“环境变量”。然后,您需要更新 PATH 值并单击“确定”按钮。

在 Unix(Solaris、Linux 等)上,如果 SDK 安装在 /usr/local/jdk-11.0.11 中并且您使用的是 C shell,则需要将以下内容放入您的 .cshrc 文件中。

setenv PATH /usr/local/jdk-11.0.11/bin:$PATH 
setenv JAVA_HOME /usr/local/jdk-11.0.11

或者,如果您使用集成开发环境 (IDE),如 Borland JBuilder、Eclipse、IntelliJ IDEA 或 Sun ONE Studio,则需要编译并运行一个简单的程序以确认 IDE 知道您已安装 Java 的位置。否则,您需要按照 IDE 文档中给出的说明进行正确的设置。

步骤 2 - 设置 Eclipse IDE

本教程中的所有示例均使用 Eclipse IDE 编写。因此,我们建议您在机器上安装最新版本的 Eclipse。

要安装 Eclipse IDE,请从 https://www.eclipse.org/downloads/ 下载最新的 Eclipse 二进制文件。下载安装后,将二进制分发版解压缩到一个方便的位置。例如,在 Windows 上的 C:\eclipse 中,或在 Linux/Unix 上的 /usr/local/eclipse 中,最后适当地设置 PATH 变量。

可以通过在 Windows 机器上执行以下命令启动 Eclipse,或者您只需双击 eclipse.exe

%C:\eclipse\eclipse.exe 

可以通过在 Unix(Solaris、Linux 等)机器上执行以下命令启动 Eclipse -

$/usr/local/eclipse/eclipse

成功启动后,如果一切正常,则应显示以下结果 -

Eclipse Home page

步骤 3 - 下载 Maven 存档

https://maven.apache.org/download.cgi 下载 Maven 3.8.4。

操作系统 存档名称
Windows apache-maven-3.8.4-bin.zip
Linux apache-maven-3.8.4-bin.tar.gz
Mac apache-maven-3.8.4-bin.tar.gz

步骤 4 - 解压缩 Maven 存档

将存档解压缩到您希望安装 Maven 3.8.4 的目录中。将从存档创建子目录 apache-maven-3.8.4。

操作系统 位置(根据您的安装可能有所不同)
Windows C:\Program Files\Apache Software Foundation\apache-maven-3.8.4
Linux /usr/local/apache-maven
Mac /usr/local/apache-maven

步骤 5 - 设置 Maven 环境变量

将 M2_HOME、M2、MAVEN_OPTS 添加到环境变量中。

操作系统 输出
Windows

使用系统属性设置环境变量。

M2_HOME=C:\Program Files\Apache Software Foundation\apache-maven-3.8.4 M2=%M2_HOME%\bin MAVEN_OPTS=-Xms256m -Xmx512m

Linux

打开命令终端并设置环境变量。

export M2_HOME=/usr/local/apache-maven/apache-maven-3.8.4 export M2=$M2_HOME/bin

export MAVEN_OPTS=-Xms256m -Xmx512m

Mac

打开命令终端并设置环境变量。

export M2_HOME=/usr/local/apache-maven/apache-maven-3.8.4

export M2=$M2_HOME/bin

export MAVEN_OPTS=-Xms256m -Xmx512m

步骤 6 - 将 Maven bin 目录位置添加到系统路径

现在将 M2 变量附加到系统路径。

操作系统 输出
Windows 将字符串 ;%M2% 附加到系统变量 Path 的末尾。
Linux export PATH=$M2:$PATH
Mac export PATH=$M2:$PATH

步骤 7 - 验证 Maven 安装

现在打开控制台并执行以下mvn命令。

操作系统 任务 命令
Windows 打开命令控制台 c:\> mvn --version
Linux 打开命令终端 $ mvn --version
Mac 打开终端 machine:~ joseph$ mvn --version

最后,验证上述命令的输出,它应如下所示 -

操作系统 输出
Windows

Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)

Maven 主目录:C:\Program Files\Apache Software Foundation\apache-maven-3.8.4

Java 版本:11.0.11,供应商:Oracle Corporation,运行时:C:\Program Files\Java\jdk11.0.11\

默认语言环境:en_IN,平台编码:Cp1252

操作系统名称:“windows 10”,版本:“10.0”,体系结构:“amd64”,系列:“windows”

Linux

Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)

Java 版本:11.0.11

Java 主目录:/usr/local/java-current/jre

Mac

Apache Maven 3.8.4 (9b656c72d54e5bacbed989b64718c159fe39b537)

Java 版本:11.0.11

Java 主目录:/Library/Java/Home/jre

Spring AOP - 核心概念

在我们开始使用 AOP 之前,让我们熟悉一下 AOP 概念和术语。这些术语并非特定于 Spring,而是与 AOP 相关。

序号 术语和描述
1

方面

一个模块,它具有一组提供横切需求的 API。例如,日志记录模块将被称为用于日志记录的 AOP 方面。应用程序可以根据需要拥有任意数量的方面。

2

连接点

这表示您可以在其中插入 AOP 方面的应用程序中的一个点。您也可以说,它是应用程序中使用 Spring AOP 框架采取操作的实际位置。

3

通知

这是在方法执行之前或之后要采取的实际操作。这是 Spring AOP 框架在程序执行期间调用的实际代码片段。

4

切点

这是一组一个或多个连接点,其中应执行通知。您可以使用表达式或模式指定切点,正如我们将在我们的 AOP 示例中看到的那样。

5

引入

引入允许您向现有类添加新方法或属性。

6

目标对象

被一个或多个方面建议的对象。此对象始终是代理对象。也称为建议对象。

7

织入

织入是将方面与其他应用程序类型或对象链接以创建建议对象的流程。这可以在编译时、加载时或运行时完成。

Spring AOP - 通知类型

Spring 方面可以与下表中提到的五种通知一起使用。

序号 通知和描述
1

before

在方法执行之前运行通知。

2

after

在方法执行之后运行通知,无论其结果如何。

3

after-returning

仅当方法成功完成时,在方法执行之后运行通知。

4

after-throwing

仅当方法通过抛出异常退出时,在方法执行之后运行通知。

5

around

在调用建议方法之前和之后运行通知。

Spring AOP - 实现

Spring 支持@AspectJ 注解样式方法和基于模式的方法来实现自定义方面。

基于 XML 模式

方面使用常规类以及基于 XML 的配置来实现。

要使用本节中描述的 AOP 命名空间标签,您需要导入 spring AOP 模式,如下所述 -

<?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>

声明方面

方面使用<aop:aspect>元素声明,并使用ref属性引用支持 bean,如下所示。

<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.tutorialspoint 包下 Student 类中 getName() 方法的执行。

<aop:config>
   <aop:aspect id = "myAspect" ref = "aBean">

   <aop:pointcut id = "businessService"
      expression = "execution(* com.tutorialspoint.Student.getName(..))"/>
   ...
   </aop:aspect>
</aop:config>

<bean id = "aBean" class = "...">
   ...
</bean>

声明通知

您可以在<aop:aspect>内使用<aop:{ADVICE NAME}>元素声明五个通知中的任何一个,如下所示。

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

      <!-- a before advice definition -->
      <aop:before pointcut-ref = "businessService" 
         method = "doRequiredTask"/>

      <!-- an after advice definition -->
      <aop:after pointcut-ref = "businessService" 
         method = "doRequiredTask"/>

      <!-- an after-returning advice definition -->
      <!--The doRequiredTask method must have parameter named retVal -->
      <aop:after-returning pointcut-ref = "businessService"
         returning = "retVal"
         method = "doRequiredTask"/>

      <!-- an after-throwing advice definition -->
      <!--The doRequiredTask method must have parameter named ex -->
      <aop:after-throwing pointcut-ref = "businessService"
        throwing = "ex"
         method = "doRequiredTask"/>

      <!-- an around advice definition -->
      <aop:around pointcut-ref = "businessService" 
         method = "doRequiredTask"/>
   ...
   </aop:aspect>
</aop:config>

<bean id = "aBean" class = "...">
   ...
</bean>

您可以对不同的通知使用相同的doRequiredTask或不同的方法。这些方法将定义为方面模块的一部分。

基于 @AspectJ

@AspectJ 指的是一种将切面声明为使用 Java 5 注解的普通 Java 类的方式。可以通过在基于 XML Schema 的配置文件中包含以下元素来启用 @AspectJ 支持。

<aop:aspectj-autoproxy/>

声明方面

切面类与任何其他普通 Bean 一样,可以像任何其他类一样拥有方法和字段,除了它们将使用 @Aspect 注解如下。

package org.xyz;

import org.aspectj.lang.annotation.Aspect;

@Aspect
public class AspectModule {
}

它们将在 XML 中像任何其他 Bean 一样配置,如下所示。

<bean id = "myAspect" class = "org.xyz.AspectModule">
   <!-- configure properties of aspect here as normal -->
</bean>

声明切点

切点有助于确定要使用不同通知执行的目标连接点(即方法)。在使用基于 @AspectJ 的配置时,切点声明有两个部分:

  • 确定我们感兴趣的确切方法执行的切点表达式。

  • 包含名称和任意数量参数的切点签名。方法的实际主体无关紧要,实际上应该为空。

以下示例定义了一个名为“businessService”的切点,它将匹配 com.xyz.myapp.service 包下所有类中可用方法的执行。

import org.aspectj.lang.annotation.Pointcut;

@Pointcut("execution(* com.xyz.myapp.service.*.*(..))") // expression 
private void businessService() {}  // signature

以下示例定义了一个名为“getname”的切点,它将匹配 com.tutorialspoint 包下 Student 类中 getName() 方法的执行。

import org.aspectj.lang.annotation.Pointcut;

@Pointcut("execution(* com.tutorialspoint.Student.getName(..))") 
private void getname() {}

声明通知

您可以使用 @{ADVICE-NAME} 注解声明任何五种通知,如下所示。这假设您已经定义了一个切点签名方法 businessService()。

@Before("businessService()")
public void doBeforeTask(){
   ...
}
@After("businessService()")
public void doAfterTask(){
   ...
}
@AfterReturning(Pointcut = "businessService()", returning = "retVal")
public void doAfterReturnningTask(Object retVal){
   // you can intercept retVal here.
   ...
}
@AfterThrowing(Pointcut = "businessService()", throwing = "ex")
public void doAfterThrowingTask(Exception ex){
   // you can intercept thrown exception here.
   ...
}
@Around("businessService()")
public void doAroundTask(){
   ...
}

您可以为任何通知定义内联切点。以下是为 before 通知定义内联切点的示例。

@Before("execution(* com.xyz.myapp.service.*.*(..))")
public doBeforeTask(){
   ...
}

Spring AOP - 基于 XML 的应用

在本章中,我们将使用 Spring AOP 框架编写实际的 AOP 应用程序。在开始使用 Spring-WS 框架编写您的第一个示例之前,您必须确保已正确设置 Spring AOP 环境,如 Spring Web Services - 环境设置 章中所述。

现在,继续编写一个简单的基于控制台的 Spring AOP 应用程序,它将演示 AOP 概念。

创建项目

步骤 1 - 打开命令控制台,转到 C:\MVN 目录并执行以下 mvn 命令。

C:\MVN>mvn archetype:generate -DgroupId=com.tutorialspoint 
-DartifactId=Student -DarchetypeArtifactId=maven-archetype-quickstart 
-DinteractiveMode=false

Maven 将开始处理并创建完整的 Java 应用程序项目结构。

[INFO] Scanning for projects...
[INFO]
[INFO] ------------------< org.apache.maven:standalone-pom >-------------------
[INFO] Building Maven Stub Project (No POM) 1
[INFO] --------------------------------[ pom ]---------------------------------
[INFO]
[INFO] >>> maven-archetype-plugin:3.2.0:generate (default-cli) > generate-sources @ standalone-pom >>>
[INFO]
[INFO] <<< maven-archetype-plugin:3.2.0:generate (default-cli) < generate-sources @ standalone-pom <<<
[INFO]
[INFO]
[INFO] --- maven-archetype-plugin:3.2.0:generate (default-cli) @ standalone-pom ---
[INFO] Generating project in Batch mode
[INFO] ----------------------------------------------------------------------------
[INFO] Using following parameters for creating project from Old (1.x) Archetype: maven-archetype-quickstart:1.0
[INFO] ----------------------------------------------------------------------------
[INFO] Parameter: basedir, Value: C:\MVN
[INFO] Parameter: package, Value: com.tutorialspoint
[INFO] Parameter: groupId, Value: com.tutorialspoint
[INFO] Parameter: artifactId, Value: Student
[INFO] Parameter: packageName, Value: com.tutorialspoint
[INFO] Parameter: version, Value: 1.0-SNAPSHOT
[INFO] project created from Old (1.x) Archetype in dir: C:\MVN\Student
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  13.388 s
[INFO] Finished at: 2021-12-27T20:18:26+05:30
[INFO] ------------------------------------------------------------------------

步骤 2 - 转到 C:/MVN 目录。您将看到一个创建的 Java 应用程序项目,名为 student(如 artifactId 中指定)。更新 POM.xml 以包含 Spring-AOP 依赖项。添加 MainApp.java、Student.java 和 Logging.java 文件。

POM.xml

<project xmlns = "http://maven.apache.org/POM/4.0.0" 
   xmlns:xsi = "http://www.w3.org/2001/XMLSchema-instance"
   xsi:schemaLocation = "http://maven.apache.org/POM/4.0.0 
   http://maven.apache.org/maven-v4_0_0.xsd">
   <modelVersion>4.0.0</modelVersion>
   <groupId>com.tutorialspoint</groupId>
   <artifactId>Student</artifactId>
   <packaging>jar</packaging>
   <version>1.0-SNAPSHOT</version>
   <name>Student</name>
   <url>http://maven.apache.org</url>

   <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <maven.compiler.source>1.7</maven.compiler.source>
      <maven.compiler.target>1.7</maven.compiler.target>
   </properties>

   <dependencies>
      <dependency>
         <groupId>junit</groupId>
         <artifactId>junit</artifactId>
         <version>4.11</version>
         <scope>test</scope>
      </dependency>
      <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-aop</artifactId>
         <version>5.3.14</version>
      </dependency>
      <dependency>
         <groupId>org.springframework</groupId>
         <artifactId>spring-context</artifactId>
         <version>5.3.14</version>
      </dependency>
      <dependency>
         <groupId>org.aspectj</groupId>
         <artifactId>aspectjweaver</artifactId>
         <version>1.9.7</version>
      </dependency>
   </dependencies>
</project>

以下是 Logging.java 文件的内容。

package com.tutorialspoint;

public class Logging {
   /** 
      * This is the method which I would like to execute
      * before a selected method execution.
   */
   public void beforeAdvice() {
      System.out.println("Going to setup student profile.");
   }
   /** 
      * This is the method which I would like to execute
      * after a selected method execution.
   */
   public void afterAdvice() {
      System.out.println("Student profile has been setup.");
   }
   /** 
      * This is the method which I would like to execute
      * when any method returns.
   */
   public void afterReturningAdvice(Object retVal){
      System.out.println("Returning:" + retVal.toString() );
   }
   /**
      * This is the method which I would like to execute
      * if there is an exception raised.
   */
   public void AfterThrowingAdvice(IllegalArgumentException ex) {
      System.out.println("There has been an exception: " + ex.toString());   
   }
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();
   }
}

步骤 3 - 在 src > main > resources 文件夹下添加配置文件 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.tutorialspoint.*.*(..))"/>
         <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.tutorialspoint.Student">
      <property name = "name"  value = "Zara" />
      <property name = "age"  value = "11"/>      
   </bean>

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

步骤 4 - 打开命令控制台,转到 C:\MVN 目录并执行以下 mvn 命令。

C:\MVN>Student> mvn package

Maven 将开始处理并下载所需的库。

C:\MVN\Student>mvn package
[INFO] Scanning for projects...
[INFO]
[INFO] ---------------------< com.tutorialspoint:Student >---------------------
[INFO] Building Student 1.0-SNAPSHOT
[INFO] --------------------------------[ jar ]---------------------------------
[INFO]
[INFO] --- maven-resources-plugin:2.6:resources (default-resources) @ Student ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] Copying 1 resource
[INFO]
[INFO] --- maven-compiler-plugin:3.1:compile (default-compile) @ Student ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- maven-resources-plugin:2.6:testResources (default-testResources) @ Student ---
[INFO] Using 'UTF-8' encoding to copy filtered resources.
[INFO] skip non existing resourceDirectory C:\MVN\Student\src\test\resources
[INFO]
[INFO] --- maven-compiler-plugin:3.1:testCompile (default-testCompile) @ Student ---
[INFO] Nothing to compile - all classes are up to date
[INFO]
[INFO] --- maven-surefire-plugin:2.12.4:test (default-test) @ Student ---
[INFO] Surefire report directory: C:\MVN\Student\target\surefire-reports

-------------------------------------------------------
 T E S T S
-------------------------------------------------------
Running com.tutorialspoint.AppTest
Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.093 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO]
[INFO] --- maven-jar-plugin:2.4:jar (default-jar) @ Student ---
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  4.213 s
[INFO] Finished at: 2021-12-27T20:42:00+05:30
[INFO] ------------------------------------------------------------------------
C:\MVN\Student>

在 Eclipse 中导入项目

步骤 1 - 打开 Eclipse。

步骤 2 - 选择 文件 → 导入 → 选项。

步骤 3 - 选择 Maven 项目选项。点击下一步按钮。

步骤 4 - 选择项目位置,使用 Maven 在其中创建 Student 项目的位置。

步骤 5 - 点击完成按钮。

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

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
Exception in thread "main" java.lang.IllegalArgumentException
	at com.tutorialspoint.Student.printThrowException(Student.java:25)
...

Spring AOP - 基于 XML 的切点

连接点

连接点表示应用程序中您可以插入 AOP 切面的一个点。您也可以说,它是应用程序中使用 Spring AOP 框架采取行动的实际位置。考虑以下示例:

  • 包中包含的所有方法类。

  • 类的特定方法。

切点

切点是一组一个或多个连接点,在这些连接点上应执行通知。您可以使用表达式或模式指定切点,正如我们将在 AOP 示例中看到的那样。在 Spring 中,切点有助于使用特定的连接点来应用通知。考虑以下示例:

  • expression = "execution(* com.tutorialspoint.*.*(..))"

  • expression = "execution(* com.tutorialspoint.Student.getName(..))"

语法

<aop:config>
   <aop:aspect id = "log" ref = "adviceClass">
      <aop:pointcut id = "PointCut-id" expression = "execution( expression )"/>    
   </aop:aspect>
</aop:config>

其中,

  • adviceClass - 包含通知方法的类的引用

  • PointCut-id - 切点的 ID

  • execution( expression ) - 涵盖要应用通知的方法的表达式。

为了理解上面提到的与连接点和切点相关的概念,让我们编写一个示例,该示例将实现一些切点。为了用一些通知编写我们的示例,让我们准备好一个正在运行的 Eclipse IDE,并使用以下步骤创建一个 Spring 应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

public class Logging { 
   /** 
      * This is the method which I would like to execute
      * before a selected method execution.
   */
   public void beforeAdvice(){
      System.out.println("Going to setup student profile.");
   }   
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();     
   }
}

以下是配置文件 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.tutorialspoint.*.*(..))"/>
         <aop:before pointcut-ref = "selectAll" method = "beforeAdvice"/>         
      </aop:aspect>
   </aop:config>

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

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

创建源文件和 Bean 配置文件后,运行应用程序。如果应用程序一切正常,它将打印以下消息。

Going to setup student profile.
Name : Zara
Going to setup student profile.
Age : 11

上面定义的 <aop:pointcut> 选择了 com.tutorialspoint 包下定义的所有方法。假设您希望在特定方法之前或之后执行您的通知,您可以定义您的切点以通过用实际的类和方法名称替换切点定义中的星号 (*) 来缩小您的执行范围。以下是一个修改后的 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.tutorialspoint.Student.getName(..))"/>
         <aop:before pointcut-ref = "selectAll" method = "beforeAdvice"/>         
      </aop:aspect>
   </aop:config>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Going to setup student profile.
Name : Zara
Age : 11 

Spring AOP - 基于 XML 的 Before 通知

Before 是一种通知类型,它确保通知在方法执行之前运行。以下是 before 通知语法。

语法

<aop:config>
   <aop:aspect id = "log" ref = "logging">
      <aop:pointcut id = "PointCut-id" expression = "execution( expression )"/>    
      <aop:before pointcut-ref = "PointCut-id" method = "methodName"/>
   </aop:aspect>
</aop:config>

其中,

  • PointCut-id - 切点的 ID。

  • methodName - 要在被调用函数之前调用的函数的名称。

为了理解上面提到的与 Before 通知相关的概念,让我们编写一个示例,该示例将实现 Before 通知。为了用一些通知编写我们的示例,让我们准备好一个正在运行的 Eclipse IDE,并使用以下步骤创建一个 Spring 应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

public class Logging {
   /** 
      * This is the method which I would like to execute
      * before a selected method execution.
   */
   public void beforeAdvice(){
      System.out.println("Going to setup student profile.");
   }   
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();     
   }
}

以下是配置文件 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.tutorialspoint.Student.getName(..))"/>
         <aop:before pointcut-ref = "selectAll" method = "beforeAdvice"/>
      </aop:aspect>
   </aop:config>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Going to setup student profile.
Name : Zara
Age : 11 

Spring AOP - 基于 XML 的 After 通知

After 是一种通知类型,它确保通知在方法执行之后运行。以下是 after 通知语法。

语法

<aop:config>
   <aop:aspect id = "log" ref = "logging">
      <aop:pointcut id = "PointCut-id" expression = "execution( expression )"/>    
      <aop:after pointcut-ref = "PointCut-id" method = "methodName"/>
   </aop:aspect>
</aop:config>

其中,

  • PointCut-id - 切点的 ID。

  • methodName - 要在被调用函数之后调用的函数的名称。

为了理解上面提到的与 After 通知相关的概念,让我们编写一个示例,该示例将实现 After 通知。为了用一些通知编写我们的示例,让我们准备好一个正在运行的 Eclipse IDE,并使用以下步骤创建一个 Spring 应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

public class Logging {
   /** 
      * This is the method which I would like to execute
      * after a selected method execution.
   */
   public void afterAdvice(){
      System.out.println("Student profile setup complete.");
   }   
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();     
   }
}

以下是配置文件 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.tutorialspoint.Student.getAge(..))"/>
         <aop:after pointcut-ref = "selectAll" method = "afterAdvice"/>
      </aop:aspect>
   </aop:config>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Name : Zara
Age : 11
Student profile setup complete.

Spring AOP - 基于 XML 的 After Returning 通知

After Returning 是一种通知类型,它确保通知仅在方法成功完成执行后运行。以下是 after returning 通知语法。

语法

<aop:config>
   <aop:aspect id = "log" ref = "logging">
      <aop:pointcut id = "PointCut-id" expression = "execution( expression )"/>    
      <aop:after-returning pointcut-ref = "PointCut-id" 
         returning = "retVal" method = "methodName"/>
   </aop:aspect>
</aop:config>

其中,

  • PointCut-id - 切点的 ID。

  • methodName - 要在被调用函数成功返回后调用的函数的名称。

为了理解上面提到的与 After Returning 通知相关的概念,让我们编写一个示例,该示例将实现 After Returning 通知。为了用一些通知编写我们的示例,让我们准备好一个正在运行的 Eclipse IDE,并使用以下步骤创建一个 Spring 应用程序:

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

public class Logging {
   /** 
      * This is the method which I would like to execute
      * when any method returns.
   */
   public void afterReturningAdvice(Object retVal){
      System.out.println("Returning:" + retVal.toString() );
   }
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 );
      System.out.println("Exception raised");
      throw new IllegalArgumentException();
      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 文件的内容。

package com.tutorialspoint;

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();     
   }
}

以下是配置文件 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.tutorialspoint.*.*(..))"/>
         <aop:after-returning pointcut-ref = "selectAll" 
            method = "afterReturningAdvice" returning = "retVal"/>         
      </aop:aspect>
   </aop:config>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Name : Zara
Returning : Name
Age : 11
Exception raised

Spring AOP - 基于 XML 的 After Throwing 通知

After-throwing 是一种通知类型,它确保通知仅在方法通过抛出异常退出时运行。以下是 after-throwing 通知语法。

语法

<aop:config>
   <aop:aspect id = "log" ref = "logging">
      <aop:pointcut id = "PointCut-id" expression = "execution( expression )"/>    
      <aop:after-throwing pointcut-ref = "PointCut-id" throwing = "ex" 
         method = "methodName"/>
   </aop:aspect>
</aop:config>

其中,

  • PointCut-id - 切点的 ID。

  • ex - 要抛出的异常。

  • methodName - 当被调用函数抛出异常并退出时要调用的函数的名称。

为了理解上面提到的与 After Throwing 通知相关的概念,让我们编写一个示例,该示例将实现 After Throwing 通知。为了用一些通知编写我们的示例,让我们准备好一个正在运行的 Eclipse IDE,并使用以下步骤创建一个 Spring 应用程序:

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

public class Logging {
   /**
      * This is the method which I would like to execute
      * if there is an exception raised.
   */
   public void afterThrowingAdvice(IllegalArgumentException ex) {
      System.out.println("There has been an exception: " + ex.toString());   
   } 
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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.printThrowException();     
   }
}

以下是配置文件 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.tutorialspoint.*.*(..))"/>
         <aop:after-throwing pointcut-ref = "selectAll" 
            throwing = "ex" method = "afterThrowingAdvice"/>         
      </aop:aspect>
   </aop:config>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Exception raised
There has been an exception: java.lang.IllegalArgumentException
Exception in thread "main" java.lang.IllegalArgumentException
   at com.tutorialspoint.Student.printThrowException(Student.java:25)
...

Spring AOP - 基于 XML 的 Around 通知

Around 是一种通知类型,它确保通知在方法执行之前和之后运行。以下是 around 通知语法。

语法

<aop:config>
   <aop:aspect id = "log" ref = "logging">
      <aop:pointcut id = "PointCut-id" expression = "execution( expression )"/>    
      <aop:around pointcut-ref = "PointCut-id" method = "methodName"/>
   </aop:aspect>
</aop:config>

其中,

  • PointCut-id - 切点的 ID。

  • methodName - 要在被调用函数之前调用的函数的名称。

为了理解上面提到的与 Around 通知相关的概念,让我们编写一个示例,该示例将实现 Around 通知。为了用一些通知编写我们的示例,让我们准备好一个正在运行的 Eclipse IDE,并使用以下步骤创建一个 Spring 应用程序:

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;
import org.aspectj.lang.ProceedingJoinPoint;

public class Logging {
   /** 
      * This is the method which I would like to execute
      * around a selected method execution.
   */
   public String aroundAdvice(ProceedingJoinPoint jp) throws Throwable{
      System.out.println("Around advice");
      Object[] args = jp.getArgs();
      if(args.length>0){
         System.out.print("Arguments passed: " );
         for (int i = 0; i < args.length; i++) {
            System.out.print("arg "+(i+1)+": "+args[i]);
         }
      }
      Object result = jp.proceed(args);
      System.out.println("Returning " + result);
      return result.toString();
   }
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();    
   }
}

以下是配置文件 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 = "selectName" 
            expression = "execution(* com.tutorialspoint.Student.getName(..))"/>
         <aop:around pointcut-ref = "selectName" method = "aroundAdvice"/>
      </aop:aspect>
   </aop:config>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Around advice
Name : Zara
Returning Zara

Spring AOP - 基于注解的应用

让我们编写一个使用基于注解的配置实现通知的示例。为此,让我们准备好一个正在运行的 Eclipse IDE,并使用以下步骤创建一个 Spring 应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;
import org.aspectj.lang.annotation.Pointcut;

@Aspect
public class Logging {
   /** Following is the definition for a Pointcut to select
      *  all the methods available. So advice will be called
      *  for all the methods.
   */
   @Pointcut("execution(* com.tutorialspoint.*.*(..))")
   private void selectAll(){}

   /** 
      * This is the method which I would like to execute
      * before a selected method execution.
   */
   @Before("selectAll()")
   public void beforeAdvice(){
      System.out.println("Going to setup student profile.");
   }  
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();   
   }
}

以下是配置文件 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:aspectj-autoproxy/>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Going to setup student profile.
Name : Zara
Going to setup student profile.
Age : 11

Spring AOP - 基于注解的切点

连接点

连接点表示应用程序中您可以插入 AOP 切面的一个点。您也可以说,它是应用程序中使用 Spring AOP 框架采取行动的实际位置。考虑以下示例:

  • 包中包含的所有方法类。

  • 类的特定方法。

切点

切点是一组一个或多个连接点,在这些连接点上应执行通知。您可以使用表达式或模式指定切点,正如我们将在 AOP 示例中看到的那样。在 Spring 中,切点有助于使用特定的连接点来应用通知。考虑以下示例:

  • @Pointcut("execution(* com.tutorialspoint.*.*(..))")

  • @Pointcut("execution(* com.tutorialspoint.Student.getName(..))")

语法

@Aspect
public class Logging {
   @Pointcut("execution(* com.tutorialspoint.*.*(..))")
   private void selectAll(){}
}

其中,

  • @Aspect - 将类标记为包含通知方法的类。

  • @Pointcut - 将函数标记为切点

  • execution( expression ) - 涵盖要应用通知的方法的表达式。

为了理解上面提到的与连接点和切点相关的概念,让我们编写一个示例,该示例将实现一些切点。为了用一些通知编写我们的示例,让我们准备好一个正在运行的 Eclipse IDE,并使用以下步骤创建一个 Spring 应用程序:

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.annotation.Before;

@Aspect
public class Logging {
   /** Following is the definition for a PointCut to select
      *  all the methods available. So advice will be called
      *  for all the methods.
   */
   @Pointcut("execution(* com.tutorialspoint.*.*(..))")
   private void selectAll(){}

   /** 
      * This is the method which I would like to execute
      * before a selected method execution.
   */
   @Before("selectAll()")
   public void beforeAdvice(){
      System.out.println("Going to setup student profile.");
   }  
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();     
   }
}

以下是配置文件 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:aspectj-autoproxy/>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Going to setup student profile.
Name : Zara
Going to setup student profile.
Age : 11

上面定义的 @Pointcut 使用表达式选择 com.tutorialspoint 包下定义的所有方法。@Before 通知使用上面定义的切点作为参数。实际上,beforeAdvice() 方法将在上面切点涵盖的每个方法之前被调用。

Spring AOP - 基于注解的 Before 通知

@Before 是一种通知类型,它确保通知在方法执行之前运行。以下是 @Before 通知语法。

语法

@Pointcut("execution(* com.tutorialspoint.Student.getName(..))")
private void selectGetName(){}

@Before("selectGetName()")
public void beforeAdvice(){
   System.out.println("Going to setup student profile.");
} 

其中,

  • @Pointcut - 将函数标记为切点

  • execution( expression ) - 涵盖要应用通知的方法的表达式。

  • @Before - 将函数标记为在切点涵盖的方法之前执行的通知。

为了理解上面提到的与@Before Advice相关的概念,让我们编写一个实现@Before Advice的示例。为了编写包含少量Advice的示例,让我们准备一个可用的Eclipse IDE,并使用以下步骤创建一个Spring应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.annotation.Before;

@Aspect
public class Logging {

   /** Following is the definition for a Pointcut to select
      *  all the methods available. So advice will be called
      *  for all the methods.
   */
   @Pointcut("execution(* com.tutorialspoint.Student.getName(..))")
   private void selectGetName(){}
   /** 
      * This is the method which I would like to execute
      * before a selected method execution.
   */
   @Before("selectGetName()")
   public void beforeAdvice(){
      System.out.println("Going to setup student profile.");
   }  
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();     
   }
}

以下是配置文件 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:aspectj-autoproxy/>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Going to setup student profile.
Name : Zara
Age : 11

上面定义的@Pointcut使用表达式来选择在com.tutorialspoint包下类(class)中定义的getAge()方法。@After advice使用上面定义的Pointcut作为参数。实际上,afterAdvice()方法将在Pointcut覆盖的每个方法之前被调用。

Spring AOP - 基于注解的After Advice

@After是一种Advice类型,它确保Advice在方法执行之后运行。以下是@After advice的语法。

语法

@Pointcut("execution(* com.tutorialspoint.Student.getAge(..))")
private void selectGetName(){}

@After("selectGetAge()")
public void afterAdvice(){
   System.out.println("Student profile setup completed.");
} 

其中,

  • @Pointcut - 将函数标记为切点

  • execution( expression ) - 涵盖要应用通知的方法的表达式。

  • @After - 将函数标记为Advice,以便在Pointcut覆盖的方法之前执行。

为了理解上面提到的与@After Advice相关的概念,让我们编写一个实现@After Advice的示例。为了编写包含少量Advice的示例,让我们准备一个可用的Eclipse IDE,并使用以下步骤创建一个Spring应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.annotation.After;

@Aspect
public class Logging {
   /** Following is the definition for a Pointcut to select
      *  all the methods available. So advice will be called
      *  for all the methods.
   */
   @Pointcut("execution(* com.tutorialspoint.Student.getAge(..))")
   private void selectGetAge(){}

   /** 
      * This is the method which I would like to execute
      * after a selected method execution.
   */
   @After("selectGetAge()")
   public void afterAdvice(){
      System.out.println("Student profile setup completed.");
   }  
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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();     
   }
}

以下是配置文件 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:aspectj-autoproxy/>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Name : Zara
Age : 11
Student profile setup completed.

上面定义的@Pointcut使用表达式来选择在com.tutorialspoint包下类(class)中定义的getAge()方法。@After advice使用上面定义的Pointcut作为参数。实际上,afterAdvice()方法将在Pointcut覆盖的每个方法之前被调用。

基于注解的After Returning Advice

@AfterReturning是一种Advice类型,它确保Advice在方法成功执行之后运行。以下是@AfterReturning advice的语法。

语法

@AfterReturning(Pointcut = "execution(* com.tutorialspoint.Student.*(..))", returning = "retVal")
public void afterReturningAdvice(JoinPoint jp, Object retVal){
   System.out.println("Method Signature: "  + jp.getSignature());  
   System.out.println("Returning:" + retVal.toString() );
}

其中,

  • @AfterReturning - 将函数标记为Advice,以便在Pointcut覆盖的方法之后执行,前提是方法成功返回。

  • Pointcut - 提供表达式来选择一个函数。

  • execution( expression ) - 涵盖要应用通知的方法的表达式。

  • returning - 要返回的变量的名称。

为了理解上面提到的与@AfterReturning Advice相关的概念,让我们编写一个实现@AfterReturning Advice的示例。为了编写包含少量Advice的示例,让我们准备一个可用的Eclipse IDE,并使用以下步骤创建一个Spring应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.JoinPoint;  
import org.aspectj.lang.annotation.AfterReturning; 

@Aspect
public class Logging {
   /** 
      * This is the method which I would like to execute
      * after a selected method execution.
   */
   @AfterReturning(Pointcut = "execution(* com.tutorialspoint.Student.*(..))", returning = "retVal")
   public void afterReturningAdvice(JoinPoint jp, Object retVal){
      System.out.println("Method Signature: "  + jp.getSignature());  
      System.out.println("Returning:" + retVal.toString() );
   }
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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.getAge();     
   }
}

以下是配置文件 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:aspectj-autoproxy/>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Age : 11
Method Signature: Integer com.tutorialspoint.Student.getAge()  
Returning 11

Spring AOP - 基于注解的After Throwing Advice

@AfterThrowing是一种Advice类型,它确保如果方法抛出异常,则运行Advice。以下是@AfterThrowing advice的语法。

语法

@AfterThrowing(Pointcut = "execution(* com.tutorialspoint.Student.*(..))", throwing = "error")
public void afterThrowingAdvice(JoinPoint jp, Throwable error){
   System.out.println("Method Signature: "  + jp.getSignature());  
   System.out.println("Exception: "+error);  
}

其中,

  • @AfterThrowing - 将函数标记为Advice,以便在Pointcut覆盖的方法之后执行,前提是方法抛出异常。

  • Pointcut - 提供表达式来选择一个函数。

  • execution( expression ) - 涵盖要应用通知的方法的表达式。

  • throwing - 要返回的异常的名称。

为了理解上面提到的与@AfterThrowing Advice相关的概念,让我们编写一个实现@AfterThrowing Advice的示例。为了编写包含少量Advice的示例,让我们准备一个可用的Eclipse IDE,并使用以下步骤创建一个Spring应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.JoinPoint;  
import org.aspectj.lang.annotation.AfterThrowing;  

@Aspect
public class Logging {
   /** 
      * This is the method which I would like to execute
      * after a selected method execution throws exception.
   */
   @AfterThrowing(Pointcut = "execution(* com.tutorialspoint.Student.*(..))", throwing = "error")
   public void afterThrowingAdvice(JoinPoint jp, Throwable error){
      System.out.println("Method Signature: "  + jp.getSignature());  
      System.out.println("Exception: "+error);  
   }
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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.printThrowException();     
   }
}

以下是配置文件 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:aspectj-autoproxy/>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Exception raised
Method Signature: void com.tutorialspoint.Student.printThrowException()
Exception: java.lang.IllegalArgumentException
Exception in thread "main" java.lang.IllegalArgumentException
   
   at com.tutorialspoint.Student.printThrowException(Student.java:25)
   ...

Spring AOP - 基于注解的Around Advice

@Around是一种Advice类型,它确保Advice可以在方法执行之前和之后运行。以下是@Around advice的语法。

语法

@Pointcut("execution(* com.tutorialspoint.Student.getAge(..))")
private void selectGetName(){}

@Around("selectGetAge()")
public void aroundAdvice(ProceedingJoinPoint proceedingJoinPoint){
   System.out.println("Around advice");
   Object[] args = jp.getArgs();
   if(args.length>0){
      System.out.print("Arguments passed: " );
      for (int i = 0; i < args.length; i++) {
         System.out.print("arg "+(i+1)+": "+args[i]);
      }
   }
   Object result = jp.proceed(args);
   System.out.println("Returning " + result);
   return result.toString();   
}

其中,

  • @Pointcut - 将函数标记为切点

  • execution( expression ) - 涵盖要应用通知的方法的表达式。

  • @Around - 将函数标记为Advice,以便在Pointcut覆盖的方法之前执行。

为了理解上面提到的与@Around Advice相关的概念,让我们编写一个实现@Around Advice的示例。为了编写包含少量Advice的示例,让我们准备一个可用的Eclipse IDE,并使用以下步骤创建一个Spring应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.ProceedingJoinPoint; 

@Aspect
public class Logging {
   /** Following is the definition for a Pointcut to select
      *  all the methods available. So advice will be called
      *  for all the methods.
   */
   @Pointcut("execution(* com.tutorialspoint.Student.getAge(..))")
   private void selectGetAge(){}

   /** 
      * This is the method which I would like to execute
      * around a selected method execution.
   */
   @Around("selectGetAge()")
   public void aroundAdvice(ProceedingJoinPoint proceedingJoinPoint) throws Throwable{
      System.out.println("Around advice");
      Object[] args = proceedingJoinPoint.getArgs();
      if(args.length>0){
         System.out.print("Arguments passed: " );
         for (int i = 0; i < args.length; i++) {
            System.out.print("arg "+(i+1)+": "+args[i]);
         }
      }
      Object result = proceedingJoinPoint.proceed(args);
      System.out.println("Returning " + result);
   }
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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 文件的内容。

package com.tutorialspoint;

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.getAge();     
   }
}

以下是配置文件 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:aspectj-autoproxy/>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Around advice
Age : 11
Returning 11

Spring AOP - 代理

到目前为止,我们已经使用<aop:config>< aop:aspectj-autoproxy>声明了Aspect。我们也可以以编程方式创建代理,并使用代理对象以编程方式调用Aspect。

语法

//Create object to be proxied
Student student = new Student();

//Create the Proxy Factory
AspectJProxyFactory proxyFactory = new AspectJProxyFactory(student);

//Add Aspect class to the factory
proxyFactory.addAspect(Logging.class);

//Get the proxy object
Student proxyStudent = proxyFactory.getProxy();

//Invoke the proxied method.
proxyStudent.getAge();

其中,

  • AspectJProxyFactory - 用于创建代理对象的工厂类。

  • Logging.class - 包含Advice的Aspect的类。

  • Student - 要被Advice的业务类。

为了理解上面提到的与代理相关的概念,让我们编写一个实现代理的示例。为了编写包含少量Advice的示例,让我们准备一个可用的Eclipse IDE,并使用以下步骤创建一个Spring应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.PointCut;
import org.aspectj.lang.annotation.Before;

@Aspect
public class Logging {
   /** Following is the definition for a PointCut to select
      *  all the methods available. So advice will be called
      *  for all the methods.
   */
   @PointCut("execution(* com.tutorialspoint.Student.getAge(..))")
   private void selectGetAge(){}

   /** 
      * This is the method which I would like to execute
      * before a selected method execution.
   */
   @Before("selectGetAge()")
   public void beforeAdvice(){
      System.out.println("Going to setup student profile.");
   }  
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

public class Student {
   private Integer age;
   public void setAge(Integer age) {
      this.age = age;
   }
   public Integer getAge() {
      System.out.println("Age : " + age );
      return age;
   }   
}

以下是 MainApp.java 文件的内容。

package com.tutorialspoint;

import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.aop.aspectj.annotation.AspectJProxyFactory;

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

      Student student = (Student) context.getBean("student");

      //Create the Proxy Factory
      AspectJProxyFactory proxyFactory = new AspectJProxyFactory(student);

      //Add Aspect class to the factory
      proxyFactory.addAspect(Logging.class);

      //Get the proxy object
      Student proxyStudent = proxyFactory.getProxy();

      //Invoke the proxied method.
      proxyStudent.getAge();
   }
}

以下是配置文件 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 ">

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Going to setup student profile.
Age : 11

Spring AOP - 自定义注解

根据Pointcut表达式,它们可能会应用于某些不打算应用Advice的其他Bean。例如,考虑以下表达式。

execution(* com.tutorialspoint.*.getAge(..)) 

添加了一个新的Spring Bean,它具有getAge()方法,Advice将开始应用于它,尽管这可能并非预期。为了实现这一点,我们可以创建一个自定义注解,并将其注释到要应用Advice的方法上。

@Before("@annotation(com.tutorialspoint.Loggable)")

为了理解上面提到的与@Before Advice相关的概念,让我们编写一个实现@Before Advice的示例。为了编写包含少量Advice的示例,让我们准备一个可用的Eclipse IDE,并使用以下步骤创建一个Spring应用程序。

步骤 描述
1 更新在 Spring AOP - 应用程序 章下创建的项目 Student
2 更新 Bean 配置并运行应用程序,如下所述。

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

package com.tutorialspoint;

import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Before;

@Aspect
public class Logging {
   /** 
      * This is the method which I would like to execute
      * before a selected method execution.
   */
   @Before("@annotation(com.tutorialspoint.Loggable)")
   public void beforeAdvice(){
      System.out.println("Going to setup student profile.");
   }  
}

以下是Loggable.java文件的内容:

package com.tutorialspoint;
public @interface Loggable {
}

以下是 Student.java 文件的内容。

package com.tutorialspoint;

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;
   }
   @Loggable
   public String getName() {
      System.out.println("Name : " + name );
      return name;
   }
   public void printThrowException(){
      System.out.println("Exception raised");
      throw new IllegalArgumentException();
   }
}

以下是 MainApp.java 文件的内容。

package com.tutorialspoint;

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();     
   }
}

以下是配置文件 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:aspectj-autoproxy/>

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

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

运行项目

创建源文件和配置文件后,运行您的应用程序。右键点击应用程序中的 MainApp.java 并使用 以 Java 应用程序运行 命令。如果应用程序一切正常,它将打印以下消息。

Going to setup student profile.
Name : Zara
Age : 11
广告