Spring AOP @Around Advice Type Example

Welcome readers, in this tutorial, we will explore the @Around annotation of the spring aop module.

1. Introduction

Want to master Spring Framework ?
Subscribe to our newsletter and download the Spring Framework Cookbook right now!
In order to help you master the leading and innovative Java framework, we have compiled a kick-ass guide with all its major features and use cases! Besides studying them online you may download the eBook in PDF format!

Thank you!

We will contact you soon.

1.1 Aspect-Oriented Programming (AOP) in spring

It is object-oriented programming that enables developers to address the crosscutting concerns such as authentication, transaction, security or logging management in an application. It breaks the application logic into distinct parts (known as Concerns). There are five types of advice (Represents an action taken by an aspect at a joinpoint) in spring aop i.e.

To understand the above concept, let us open the eclipse ide and implement the @Around annotation in the spring aop module using spring boot.

2. Spring AOP @Around Advice Type Example

Here is a systematic guide for implementing this tutorial.

2.1 Tools Used

We are using Eclipse Kepler SR2, JDK 8, and Maven.

2.2 Project Structure

In case you are confused about where you should create the corresponding files or folder, let us review the project structure of the spring boot application.

Fig. 1: Application Structure

2.3 Project Creation

This section will demonstrate how to create a Java-based Maven project with Eclipse. In Eclipse IDE, go to File -> New -> Maven Project.

Fig. 2: Create a Maven Project

In the New Maven Project window, it will ask you to select a project location. By default, ‘Use default workspace location’ will be selected. Select the ‘Create a simple project (skip archetype selection)’ checkbox and just click on the next button to proceed.

Fig. 3: Project Details

It will ask you to ‘Enter the group and the artifact id for the project’. We will input the details as shown in the below image. The version number will be by default: 0.0.1-SNAPSHOT.

Fig. 4: Archetype Parameters

Click on Finish and the creation of a maven project is completed. If you observe, it has downloaded the maven dependencies and a pom.xml file will be created. It will have the following code:


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

We can start adding the dependency that developers want like spring boot, aop etc. Let us start building the application!

3. Creating a Spring Boot application

Below are the steps involved in developing the application.

3.1 Maven Dependency

Here, we specify the dependency for the spring boot and aop. Maven will automatically resolve the other dependencies. The updated file will have the following code.


<project xmlns="http://maven.apache.org/POM/4.0.0"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<name>Springboot aop around advice annotation tutorial</name>
	<description>A tutorial to demonstrate the around advice annotation in spring aop module</description>
	<!-- spring boot parent dependency jar. -->
		<!-- spring boot jar. -->
		<!-- to implement aop in a spring boot application. -->

3.2 Java Classes

Following classes are required to understand the Around advice.

3.2.1 Bank Service class

Let us write a service class that has a method that displays the account balance. This class is annotated with the @Service annotation.


package com.ducat.springboot.aop.service;
import org.springframework.stereotype.Service;
public class Mybank {
	public void displayBalance(String accNum) {
		System.out.println(":::: Inside displayBalance() method ::::");
		if(accNum.equals("12345")) {
			System.out.println("Total balance in the given account number is= XXXXX");
		} else {
			System.out.println("Account number mismatch.");

3.2.2 Employee Aspect class

Let us write the aspect class where we will define a pointcut expression and the @Around annotation to meet the cross-cutting concern of our application. This class is annotated with @Aspect and @Component annotations.


package com.ducat.springboot.aop.aspects;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.stereotype.Component;
// @Aspect annotation enables the spring aop functionality in an application. Tells the developer that this class has advice methods.
public class Myemployeeaspect {
	// Pointcut definition to display all the available methods i.e. the advice will be called for all the methods.
	@Pointcut(value= "execution(* com.ducat.springboot.aop.service.Mybank.*(..))")
	private void logDisplayingBalance() { }
	// @Around annotation declares the around advice which is applied before and after the method matching with a pointcut expression.
	@Around(value= "logDisplayingBalance()")
	public void aroundAdvice(ProceedingJoinPoint pjp) throws Throwable {
		System.out.println("Inside aroundAdvice() method...." + " Inserted before= " + pjp.getSignature().getName() + " method");
		try {
		} finally {
			// Do something useful.
		System.out.println("Inside aroundAdvice() method...." + " Inserted after= " + pjp.getSignature().getName() + " method");

3.2.3 Implementation/Main Class

Let us write the implementation/main class involved in this application. This class is the entry point of the spring boot application containing @SpringBootApplication, @EnableAspectJAutoProxy annotations, and the static main method.


package com.ducat.springboot.aop;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import com.ducat.springboot.aop.service.Mybank;
// @EnableAspectJAutoProxy annotation enables support for handling the components marked with @Aspect annotation. It is similar to  tag in the xml configuration.
public class Myapplication {
	public static void main(String[] args) {
		ConfigurableApplicationContext context = SpringApplication.run(Myapplication.class, args);
		// Fetching the employee object from the application context.
		Mybank bank = context.getBean(Mybank.class);
		// Displaying balance in the account.
		String accnumber = "12345";
		// Closing the context object.

4. Run the Application

To execute the application, right click on the Myapplication.java class, Run As -> Java Application.

Fig. 5: Run the Application

5. Project Demo

The code shows the following logs as the output of this tutorial.

2019-02-20 10:29:57.982  INFO 8972 --- [           main] com.ducat.springboot.aop.Myapplication   : Started Myapplication in 1.062 seconds (JVM running for 1.483)
Inside aroundAdvice() method.... Inserted before= displayBalance method
:::: Inside displayBalance() method :::
Total balance in the given account number= XXXXX
Inside aroundAdvice() method.... Inserted after= displayBalance method

That is all for this tutorial and I hope the article served you whatever you were looking for. Happy Learning and do not forget to share!

6. Conclusion

In this section, developers learned how to create a simple spring aop application. That is all for this tutorial and I hope the article served you whatever you were looking for. Happy Learning and do not forget to share!

Developers can download the sample application as an Eclipse project in the Downloads section.

7. Download the Eclipse Project

This was an example of Around advice in the spring aop module.

You can download the full source code of this example here: Spring AOP @Around Advice Type Example
Exit mobile version