原文： https://howtodoinjava.com/spring-aop/aspectj-after-returning-annotation-example/

在这个 Spring aop 示例中，我们将学习使用 Aspectj @AfterReturning注解。 @AfterReturning带注解的方法在方法（与切入点表达式匹配）正常执行后运行，并且不会引发任何错误/异常。

在此示例中，我们将创建简单的 spring 应用程序，添加日志记录切面，然后基于在@AfterReturning注解中传递的切入点信息来调用切面方法。

AspectJ @AfterReturning注解用法

例如，如果方法返回时没有抛出异常，则在连接点正常完成之后执行 AspectJ @AfterReturning通知。

  1. @Aspect
  2. public class LoggingAspect {
  4.     @AfterReturning("execution(* com.howtodoinjava.app.service.impl.EmployeeManagerImpl.*(..))")
  5.     public void logAroundAllMethods() { ... }
  7.     @AfterReturning(pointcut="execution(* com.howtodoinjava.app.service.impl.EmployeeManagerImpl.getEmployeeById(..))", returning="retVal") 
  8.     public void logAroundGetEmployee(Object retVal) { ... }
  9. }

有时您需要访问从方法返回的实际返回值，您可以使用@AfterReturning注解中的returning属性获得该返回值。

returning属性中使用的名称必须与建议方法中的参数名称相对应。 当方法执行返回时，该返回值将作为相应的参数值传递到通知方法。

请注意，任何returning子句也将匹配限制为仅返回指定类型（在此情况下为Object或子类型，将匹配任何返回值）的值的那些方法执行。

项目结构

Spring AOP AspectJ `@AfterReturning`注解示例 - 图1

Spring AOP 项目结构

Spring AOP AspectJ Maven 依赖关系

我添加了 spring 核心，spring aop 和 Aspectj 依赖项。

  1. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2.     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd;
  3.     <modelVersion>4.0.0</modelVersion>
  4.     <groupId>com.howtodoinjava</groupId>
  5.     <artifactId>SpringAOPExamples</artifactId>
  6.     <version>0.0.1-SNAPSHOT</version>
  7.     <name>Spring AOP Examples</name>
  8.     <dependencies>
  9.         <dependency>
  10.             <groupId>org.springframework</groupId>
  11.             <artifactId>spring-context</artifactId>
  12.             <version>4.3.2.RELEASE</version>
  13.         </dependency>
  14.         <dependency>
  15.             <groupId>org.springframework</groupId>
  16.             <artifactId>spring-context-support</artifactId>
  17.             <version>4.3.2.RELEASE</version>
  18.         </dependency>
  19.         <dependency>
  20.             <groupId>org.springframework</groupId>
  21.             <artifactId>spring-aop</artifactId>
  22.             <version>4.3.2.RELEASE</version>
  23.         </dependency>
  24.         <dependency>
  25.             <groupId>org.aspectj</groupId>
  26.             <artifactId>aspectjrt</artifactId>
  27.             <version>1.8.9</version>
  28.         </dependency>
  29.         <dependency>
  30.             <groupId>org.aspectj</groupId>
  31.             <artifactId>aspectjweaver</artifactId>
  32.             <version>1.8.9</version>
  33.         </dependency>
  34.     </dependencies>
  35. </project>

启用 AspectJ 支持

在 XML 配置文件中，您可以添加aop:aspectj-autoproxy元素以启用@AspectJ注解支持。

  1. <beans xmlns="http://www.springframework.org/schema/beans"
  2.     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3.     xmlns:aop="http://www.springframework.org/schema/aop"
  4.     xsi:schemaLocation="http://www.springframework.org/schema/beans
  5.     http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
  6.     http://www.springframework.org/schema/aop
  7.     http://www.springframework.org/schema/aop/spring-aop-3.0.xsd ">
  9.     <!-- Enable @AspectJ annotation support  -->
  10.     <aop:aspectj-autoproxy />
  12.     <!-- Employee manager -->
  13.     <bean id="employeeManager" class="com.howtodoinjava.app.service.impl.EmployeeManagerImpl" />
  15.     <!-- Logging Aspect -->
  16.     <bean id="loggingAspect" class="com.howtodoinjava.app.aspect.LoggingAspect" />
  18. </beans>

需要执行切面的服务方法

EmployeeManager.java和EmployeeManagerImpl.java

  1. public interface EmployeeManager 
  2. {
  3.     public EmployeeDTO getEmployeeById(Integer employeeId);
  5.     public List<EmployeeDTO> getAllEmployee();
  7.     public void createEmployee(EmployeeDTO employee);
  9.     public void deleteEmployee(Integer employeeId);
  11.     public void updateEmployee(EmployeeDTO employee);
  12. }
  14. public class EmployeeManagerImpl implements EmployeeManager 
  15. {
  16.     public EmployeeDTO getEmployeeById(Integer employeeId) 
  17.     {
  18.         System.out.println("Method getEmployeeById() called");
  19.         return new EmployeeDTO();
  20.     }
  22.     public List<EmployeeDTO> getAllEmployee() 
  23.     {
  24.         System.out.println("Method getAllEmployee() called");
  25.         return new ArrayList<EmployeeDTO>();
  26.     }
  28.     public void createEmployee(EmployeeDTO employee)
  29.     {
  30.         System.out.println("Method createEmployee() called");
  31.     }
  33.     public void deleteEmployee(Integer employeeId) 
  34.     {
  35.         System.out.println("Method deleteEmployee() called");
  36.     }
  38.     public void updateEmployee(EmployeeDTO employee) 
  39.     {
  40.         System.out.println("Method updateEmployee() called");
  41.     }
  42. }

编写 AspectJ 注解的类和方法

用切入点信息编写 aspectj 注解的类和方法。

  1. @Aspect
  2. public class LoggingAspect {
  4.     @AfterReturning("execution(* com.howtodoinjava.app.service.impl.EmployeeManagerImpl.*(..))")
  5.     public void logAfterReturningAllMethods() throws Throwable 
  6.     {
  7.         System.out.println("****LoggingAspect.logAfterReturningAllMethods() ");
  8.     }
  10.     @AfterReturning(pointcut="execution(* com.howtodoinjava.app.service.impl.EmployeeManagerImpl.getEmployeeById(..))", returning="retVal") 
  11.     public void logAfterReturningGetEmployee(Object retVal) throws Throwable 
  12.     {
  13.         System.out.println("****LoggingAspect.logAfterReturningGetEmployee() ");
  14.         System.out.println(((EmployeeDTO)retVal).getId());
  15.     }
  17.     @AfterReturning("execution(* com.howtodoinjava.app.service.impl.EmployeeManagerImpl.createEmployee(..))")
  18.     public void logAfterReturningCreateEmployee() throws Throwable 
  19.     {
  20.         System.out.println("****LoggingAspect.logAfterReturningCreateEmployee() ");
  21.     }
  22. }

测试 Spring AspectJ 的配置和执行

现在，我们来测试以上配置的切面是否在给定的切入点信息上执行。

  1. import org.springframework.context.ApplicationContext;
  2. import org.springframework.context.support.ClassPathXmlApplicationContext;
  4. import com.howtodoinjava.app.model.EmployeeDTO;
  5. import com.howtodoinjava.app.service.EmployeeManager;
  7. public class TestMain 
  8. {
  9.     @SuppressWarnings("resource")
  10.     public static void main(String[] args) {
  12.         ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
  13.         EmployeeManager manager = (EmployeeManager) context.getBean("employeeManager");
  15.         manager.getEmployeeById(1);
  16.         manager.createEmployee(new EmployeeDTO());
  17.     }
  18. }
  1. Method getEmployeeById() called
  3. ****LoggingAspect.logAfterReturningAllMethods() 
  4. ****LoggingAspect.logAfterReturningGetEmployee() 
  6. null //As there is no employee id as of now
  8. Method createEmployee() called
  10. ****LoggingAspect.logAfterReturningAllMethods() 
  11. ****LoggingAspect.logAfterReturningCreateEmployee()

明确切面建议在相关连接点上执行。

学习愉快！

参考文献：

Spring AOP 参考

@AfterReturning注解

@Aspect注解

AspectJ 注解配置示例

不同切入点表达式以及示例