Spring Boot AOP After Returning Advice

After returning is an advice in Spring AOP that invokes after the execution of join point complete (execute) normally. It does not invoke if an exception is thrown. We can implement after returning advice in an application by using @AfterReturning annotation. The annotation marks a function as an advice to be executed before the method covered by PointCut.

After returning advice runs when a matched method execution returns a value normally. The name that we define in the return attribute must correspond to the name of a parameter in the advice method. When a method returns a value, the value will be passed to the advice method as the corresponding argument value.

Let’s implement the after returning advice in an application.

Spring Boot After Returning Advice Example

Step 1: Open Spring Initializr http://start.spring.io.

Step 2: Provide the Group name. We have provided the Group name com.tutoraspire.

Step 3: Provide the Artifact Id. We have provided the Artifact Id aop-after-returning-advice-example.

Step 4: Add the Spring Web dependency.

Step 5: Click on the Generate button. When we click on the Generate button, it wraps all the specifications in a jar file and downloads it to the local system.

Step 6: Extract the downloaded jar file.

Step 7: Import the folder by using the following steps:

File -> Import -> Existing Maven Projects -> Next -> Browse the Folder aop-after-returning-advice-example -> Finish.

Step 8: Open the pom.xml file and add the following AOP dependency. It is a starter for aspect-oriented programming with Spring AOP and 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.tutoraspire</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>  

Step 9: Create a package with the name com.tutoraspire.model in src/main/java folder.

Step 10: Create a class with the name Account in the package com.tutoraspire.model.

In the Account class, do the following:

Defined two variables accountNumber and accountType of type String.
Right-click on the file -> Source -> Generate Constructor using Fields
Generate Getters.
Right-click on the file -> Source -> Generate Getters and Setters -> Select Getters -> Generate
Generate a toString()
Right-click on the file -> Source -> Generate toString()…

Account.java

  package com.tutoraspire.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 + “]”;  }  }  

Step 11: Create another package with the name com.tutoraspire.service.impl.

Step 12: In this package, create a class with the name AccountServiceImple.

In this class, we have defined account service.

AccountServiceImpl.java

  package com.tutoraspire.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.tutoraspire.model.Account;  @Service  public class AccountServiceImpl implements AccountService   {  //storing account detail in the HashMap  private static Map<String,Account> map = null;  static  {  map = new HashMap<>();  //adding account detail in the 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;  }  }  

Step 13: Create an interface with the name AccountService in the package com.tutoraspire.service.impl.

AccountService.java

  package com.tutoraspire.service.impl;  import com.tutoraspire.model.Account;  //creating interface that throws exception if the customer id not found   public interface AccountService   {  public abstract Account getAccountByCustomerId(String customerId)  throws Exception;  }  

Step 14: Create a package with the name com.tutoraspire.aspect.

Step 15: Create a class with the name AccountAspect in the package com.tutoraspire.aspect.

In this class, we have implemented the after returning advice by using the annotation @AfterReturning. We have also defined a method afterReturningAdvice() method.

Note: The name (account) that we define in the returning attribute must correspond to the name of a parameter in the advice method.

AccountAspect.java

  package com.tutoraspire.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.tutoraspire.model.Account;  @Aspect  @Component  public class AccountAspect   {  //implementing after returning advice  @AfterReturning(value=”execution(* com.tutoraspire.service.impl.AccountServiceImpl.*(..))”,returning=”account”)  public void afterReturningAdvice(JoinPoint joinPoint, Account account)  {  System.out.println(“After Returing method:”+joinPoint.getSignature());  System.out.println(account);  }  }  

Step 16: Open the AopAfterReturningAdviceExampleApplication.java file and add an annotation @EnableAspectJAutoProxy.

The annotation enables support for handling components marked with AspectJ’s @Aspect annotation. It is used with @Configuration annotation.

We have used the proxyTargetClass attribute of the annotation @EnableAspectJAutoProxy. The attribute proxyTargetClass=true allows us to use CGLIB (Code Generation Library) proxies instead of the default interface-based JDK proxy approach.

ConfigurableApplicationContext is an interface that provides facilities to configure an application context in addition to the application context client methods in the ApplicationContext.

AopAfterReturningAdviceExampleApplication.java

  package com.tutoraspire;  import org.springframework.boot.SpringApplication;  import org.springframework.boot.autoconfigure.SpringBootApplication;  import org.springframework.context.ConfigurableApplicationContext;  import org.springframework.context.annotation.EnableAspectJAutoProxy;  import com.tutoraspire.model.Account;  import com.tutoraspire.service.impl.AccountService;  import com.tutoraspire.service.impl.AccountServiceImpl;  @SpringBootApplication  //@EnableAspectJAutoProxy annotation enables support for handling the components marked with @Aspect annotation. It is similar to tag in the xml configuration.  @EnableAspectJAutoProxy(proxyTargetClass=true)  public class AopAfterReturningAdviceExampleApplication  {  public static void main(String[] args)    {  ConfigurableApplicationContext ac = SpringApplication.run(AopAfterReturningAdviceExampleApplication.class, args);  //Fetching the account object from the application context  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());  }  }  }  

After creating all the class and packages, the project directory looks like the following:

Step 17: Open the AopAfterReturningAdviceExampleApplication.java file and run it as Java Application. It shows the output, as shown below:

In the next section, we will understand after throwing advice.

Download AOP After Returning Advice Example Project

Next TopicAOP After Throwing Advice

Spring Boot AOP After Returning Advice

Spring Boot AOP After Returning Advice

Spring Boot After Returning Advice Example

Social Media Marketing Tutorial

Download and Install SPSS

You may also like