SpringBoot AOP @AfterReturning
After returning是Spring AOP中的一个建议,通常在连接点执行完成(执行)后调用。如果引发异常,则不会调用。我们可以使用 @AfterReturning 批注在应用程序中返回建议后实施。注解将功能标记为要在PointCut覆盖的方法之前执行的建议。
在返回的建议运行之后,当匹配的方法执行正常返回值时,便会执行该建议。我们在return属性中定义的名称必须与advice方法中的参数名称相对应。当方法返回值时,该值将作为相应的参数值传递到通知方法。
让我们在应用程序中返回通知后实现。
SpringBoot AOP @AfterReturning
步骤1: 打开Spring Initializr http://start.spring.io 。
步骤2: 提供 Group 名称。我们提供了组名 com.nhooo。
步骤3: 提供了 Artifact Id。提供Artifact Id aop-after-returning-advice-example。
步骤4: 添加 Spring Web 依赖项。
步骤5: 点击 生成按钮。当我们单击"生成"按钮时,它将所有规范包装在 jar 文件中,并将其下载到本地系统。
步骤6: 提取
第7步: 使用以下步骤导入文件夹:
文件->导入->现有Maven项目->下一步->浏览文件夹 aop-returning-advice-example示例->完成。
步骤8: 打开 pom.xml 文件并添加以下 AOP 依赖项。它是使用 Spring AOP 和 AspectJ 进行面向方面编程的入门。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> </dependencies> pom.xml <?xml version="1.0" encoding="UTF-8"?> <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/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.nhooo</groupId> <artifactId>aop-after-returning-advice-example</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>aop-after-returning-advice-example</name> <description>Demo project for Spring Boot</description> <parent> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-parent</artifactId> <version>2.2.2.RELEASE</version> <relativePath/> <!-- lookup parent from repository --> </parent> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding> <java.version>1.8</java.version> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-aop</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> </project>
步骤9: 在 src/main/java 文件夹 中创建名称为 com.nhooo.model 的包。
步骤10: 在包 com.nhooo.model中创建一个名称为 Account 的类。
在"Account"类中,执行以下操作:
定义了两个类型为String的变量 accountNumber 和 accountType 。 右键单击文件->源->使用字段生成构造函数 生成Getters。
右键单击文件-> Source-> Generate Getters和Setters->选择Getters-> Generate 生成 toString()
右键单击文件->源->生成toString()...
Account.java
package com.nhooo.model; public class Account { private String accountNumber; private String accountType; public Account(String accountNumber, String accountType) { super(); this.accountNumber = accountNumber; this.accountType = accountType; } public String getAccountType() { return accountType; } public String getAccountNumber() { return accountNumber; } @Override public String toString() { return "Account [accountNumber=" + accountNumber+ ", accountType=" + accountType + "]"; } }
步骤11: 创建另一个名为 com.nhooo.service.impl的包。
步骤12: 在此程序包中,创建一个名称为 AccountServiceImple的类。
在该类中,我们定义了帐户服务。
AccountServiceImpl。 Java
package com.nhooo.service.impl; import java.util.HashMap; import java.util.Map; import java.util.Map.Entry; import java.util.Set; import org.springframework.stereotype.Service; import com.nhooo.model.Account; @Service public class AccountServiceImpl implements AccountService { //在 HashMap 中存储帐户细节 private static Map<String,Account> map = null; static { map = new HashMap<>(); //在map中添加帐户详细信息 map.put("M4546779", new Account("10441117000", "Saving Account")); map.put("K2434567", new Account("10863554577", "Current Account")); } @Override public Account getAccountByCustomerId(String customerId) throws Exception { if(customerId ==null) { throw new Exception("Invalid! Customer Id"); } Account account= null; Set<Entry<String, Account>> entrySet = map.entrySet(); for (Entry<String, Account> entry : entrySet) { if(entry.getKey().equals(customerId)) { account= entry.getValue(); } } return account; } }
步骤13: 在 com.nhooo.service.impl。包中创建名称为 AccountService 的接口。
AccountService.java
package com.nhooo.service.impl; import com.nhooo.model.Account; //正在创建一个接口,如果找不到客户id则引发异常 public interface AccountService { public abstract Account getAccountByCustomerId(String customerId) throws Exception; }
步骤14: 创建名称为 com.nhooo.aspect的包。
步骤15: 在包 com.nhooo.aspect 中创建一个名称为 AccountAspect 的类。
在该类中,我们使用注解 @AfterReturning。 我们还定义了 afterReturningAdvice()方法。
注意: 我们在 中定义的name(account) > returning 属性必须与 advice方法中的参数名称相对应。
AccountAspect.java
package com.nhooo.aspect; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.AfterReturning; import org.aspectj.lang.annotation.Aspect; import org.springframework.stereotype.Component; import com.nhooo.model.Account; @Aspect @Component public class AccountAspect { //implementing after returning advice @AfterReturning(value="execution(* com.nhooo.service.impl.AccountServiceImpl.*(..))",returning="account") public void afterReturningAdvice(JoinPoint joinPoint, Account account) { System.out.println("After Returing method:"+joinPoint.getSignature()); System.out.println(account); } }
步骤16: 打开 AopAfterReturningAdviceExampleApplication.java 文件并添加注解 @EnableAspectJAutoProxy。
注解支持处理带有AspectJ的 @Aspect 批注的组件。它与@Configuration批注一起使用。
我们使用了@EnableAspectJAutoProxy批注的 proxyTargetClass 属性。属性 proxyTargetClass = true 允许我们使用 CGLIB (代码生成库)代理,而不是默认的基于接口的JDK代理方法。
ConfigurableApplicationContext 是一个接口,除了ApplicationContext中的应用程序上下文客户端方法外,还提供了用于配置应用程序上下文的工具。
AopAfterReturningAdviceExampleApplication.java
package com.nhooo; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.context.ConfigurableApplicationContext; import org.springframework.context.annotation.EnableAspectJAutoProxy; import com.nhooo.model.Account; import com.nhooo.service.impl.AccountService; import com.nhooo.service.impl.AccountServiceImpl; @SpringBootApplication //@EnableSpectProxy注解支持处理用@Aspect注解标记的组件。它类似于xml配置中的标记。 @EnableAspectJAutoProxy(proxyTargetClass=true) public class AopAfterReturningAdviceExampleApplication { public static void main(String[] args) { ConfigurableApplicationContext ac = SpringApplication.run(AopAfterReturningAdviceExampleApplication.class, args); //从应用程序上下文获取account对象 AccountService accountService = ac.getBean("accountServiceImpl", AccountServiceImpl.class); Account account; try { account = accountService.getAccountByCustomerId("K2434567"); if(account != null) System.out.println(account.getAccountNumber()+"\t"+account.getAccountType()); } catch (Exception e) { System.out.println(e.getMessage()); } } }
创建所有类和包之后,项目目录如下所示:
步骤17: 打开 AopAfterReturningAdviceExampleApplication.java 文件并将其作为Java应用程序运行。它显示输出,如下所示:
在下一节中,我们将在提出建议后理解。