Spring AOP + AspectJ annotation example

In this tutorial, we show you how to integrate AspectJ annotation with Spring AOP framework. In simple, Spring AOP + AspectJ allow you to intercept method easily.

Common AspectJ annotations :

  1. @Before – Run before the method execution
  2. @After – Run after the method returned a result
  3. @AfterReturning – Run after the method returned a result, intercept the returned result as well.
  4. @AfterThrowing – Run after the method throws an exception
  5. @Around – Run around the method execution, combine all three advices above.
Note
For Spring AOP without AspectJ support, read this build-in Spring AOP examples.

1. Directory Structure

See directory structure of this example.

directory structure of this example

2. Project Dependencies

To enable AspectJ, you need aspectjrt.jar, aspectjweaver.jar and spring-aop.jar. See following Maven pom.xml file.

AspectJ supported since Spring 2.0
This example is using Spring 3, but the AspectJ features are supported since Spring 2.0.

File : pom.xml


<project ...>

	<properties>
		<spring.version>3.0.5.RELEASE</spring.version>
	</properties>

	<dependencies>

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<version>${spring.version}</version>
		</dependency>

		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>${spring.version}</version>
		</dependency>

		<!-- Spring AOP + AspectJ -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-aop</artifactId>
			<version>${spring.version}</version>
		</dependency>

		<dependency>
			<groupId>org.aspectj</groupId>
			<artifactId>aspectjrt</artifactId>
			<version>1.6.11</version>
		</dependency>
		
		<dependency>
			<groupId>org.aspectj</groupId>
			<artifactId>aspectjweaver</artifactId>
			<version>1.6.11</version>
		</dependency>
		
	</dependencies>
</project>

3. Spring Beans

Normal bean, with few methods, later intercept it via AspectJ annotation.


package com.mkyong.customer.bo;

public interface CustomerBo {

	void addCustomer();
	
	String addCustomerReturnValue();
	
	void addCustomerThrowException() throws Exception;
	
	void addCustomerAround(String name);
}

package com.mkyong.customer.bo.impl;

import com.mkyong.customer.bo.CustomerBo;

public class CustomerBoImpl implements CustomerBo {

	public void addCustomer(){
		System.out.println("addCustomer() is running ");
	}
	
	public String addCustomerReturnValue(){
		System.out.println("addCustomerReturnValue() is running ");
		return "abc";
	}
	
	public void addCustomerThrowException() throws Exception {
		System.out.println("addCustomerThrowException() is running ");
		throw new Exception("Generic Error");
	}
	
	public void addCustomerAround(String name){
		System.out.println("addCustomerAround() is running, args : " + name);
	}
}

4. Enable AspectJ

In Spring configuration file, put “<aop:aspectj-autoproxy />“, and define your Aspect (interceptor) and normal bean.

File : Spring-Customer.xml


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

	<bean id="customerBo" class="com.mkyong.customer.bo.impl.CustomerBoImpl" />

	<!-- Aspect -->
	<bean id="logAspect" class="com.mkyong.aspect.LoggingAspect" />

</beans>

4. AspectJ @Before

In below example, the logBefore() method will be executed before the execution of customerBo interface, addCustomer() method.

Note
AspectJ “pointcuts” is used to declare which method is going to intercept, and you should refer to this Spring AOP pointcuts guide for full list of supported pointcuts expressions.

File : LoggingAspect.java


package com.mkyong.aspect;

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

@Aspect
public class LoggingAspect {

	@Before("execution(* com.mkyong.customer.bo.CustomerBo.addCustomer(..))")
	public void logBefore(JoinPoint joinPoint) {

		System.out.println("logBefore() is running!");
		System.out.println("hijacked : " + joinPoint.getSignature().getName());
		System.out.println("******");
	}

}

Run it


	CustomerBo customer = (CustomerBo) appContext.getBean("customerBo");
	customer.addCustomer();

Output


logBefore() is running!
hijacked : addCustomer
******
addCustomer() is running 

5. AspectJ @After

In below example, the logAfter() method will be executed after the execution of customerBo interface, addCustomer() method.

File : LoggingAspect.java


package com.mkyong.aspect;

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

@Aspect
public class LoggingAspect {

	@After("execution(* com.mkyong.customer.bo.CustomerBo.addCustomer(..))")
	public void logAfter(JoinPoint joinPoint) {

		System.out.println("logAfter() is running!");
		System.out.println("hijacked : " + joinPoint.getSignature().getName());
		System.out.println("******");

	}

}

Run it


	CustomerBo customer = (CustomerBo) appContext.getBean("customerBo");
	customer.addCustomer();

Output


addCustomer() is running 
logAfter() is running!
hijacked : addCustomer
******

6. AspectJ @AfterReturning

In below example, the logAfterReturning() method will be executed after the execution of customerBo interface, addCustomerReturnValue() method. In addition, you can intercept the returned value with the “returning” attribute.

To intercept returned value, the value of the “returning” attribute (result) need to be same with the method parameter (result).

File : LoggingAspect.java


package com.mkyong.aspect;

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

@Aspect
public class LoggingAspect {

   @AfterReturning(
      pointcut = "execution(* com.mkyong.customer.bo.CustomerBo.addCustomerReturnValue(..))",
      returning= "result")
   public void logAfterReturning(JoinPoint joinPoint, Object result) {

	System.out.println("logAfterReturning() is running!");
	System.out.println("hijacked : " + joinPoint.getSignature().getName());
	System.out.println("Method returned value is : " + result);
	System.out.println("******");

   }

}

Run it


	CustomerBo customer = (CustomerBo) appContext.getBean("customerBo");
	customer.addCustomerReturnValue();

Output


addCustomerReturnValue() is running 
logAfterReturning() is running!
hijacked : addCustomerReturnValue
Method returned value is : abc
******

7. AspectJ @AfterReturning

In below example, the logAfterThrowing() method will be executed if the customerBo interface, addCustomerThrowException() method is throwing an exception.

File : LoggingAspect.java


package com.mkyong.aspect;

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

@Aspect
public class LoggingAspect {

   @AfterThrowing(
      pointcut = "execution(* com.mkyong.customer.bo.CustomerBo.addCustomerThrowException(..))",
      throwing= "error")
    public void logAfterThrowing(JoinPoint joinPoint, Throwable error) {

	System.out.println("logAfterThrowing() is running!");
	System.out.println("hijacked : " + joinPoint.getSignature().getName());
	System.out.println("Exception : " + error);
	System.out.println("******");

    }
}

Run it


	CustomerBo customer = (CustomerBo) appContext.getBean("customerBo");
	customer.addCustomerThrowException();

Output


addCustomerThrowException() is running 
logAfterThrowing() is running!
hijacked : addCustomerThrowException
Exception : java.lang.Exception: Generic Error
******
Exception in thread "main" java.lang.Exception: Generic Error
	//...

8. AspectJ @Around

In below example, the logAround() method will be executed before the customerBo interface, addCustomerAround() method, and you have to define the “joinPoint.proceed();” to control when should the interceptor return the control to the original addCustomerAround() method.

File : LoggingAspect.java


package com.mkyong.aspect;

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

@Aspect
public class LoggingAspect {

   @Around("execution(* com.mkyong.customer.bo.CustomerBo.addCustomerAround(..))")
   public void logAround(ProceedingJoinPoint joinPoint) throws Throwable {

	System.out.println("logAround() is running!");
	System.out.println("hijacked method : " + joinPoint.getSignature().getName());
	System.out.println("hijacked arguments : " + Arrays.toString(joinPoint.getArgs()));
		
	System.out.println("Around before is running!");
	joinPoint.proceed(); //continue on the intercepted method
	System.out.println("Around after is running!");
		
	System.out.println("******");

   }
	
}

Run it


	CustomerBo customer = (CustomerBo) appContext.getBean("customerBo");
	customer.addCustomerAround("mkyong");

Output


logAround() is running!
hijacked method : addCustomerAround
hijacked arguments : [mkyong]
Around before is running!
addCustomerAround() is running, args : mkyong
Around after is running!
******

Conclusion

It’s always recommended to apply the least power AsjectJ annotation. It’s rather long article about AspectJ in Spring. for further explanations and examples, please visit the reference links below.

Anti annotation or using JDK 1.4 ?
No worry, AspectJ supported XML configuration also, read this Spring AOP + AspectJ XML example.

Download Source Code

Download it – Spring3-AOP-AspectJ-Example.zip (8 KB)

References

  1. AspectJ programming guide
  2. Spring AOP + AspectJ reference

About the Author

author image
mkyong
Founder of Mkyong.com, love Java and open source stuff. Follow him on Twitter, or befriend him on Facebook or Google Plus. If you like my tutorials, consider make a donation to these charities.

Comments

Leave a Reply

avatar
newest oldest most voted
Ron Kitay
Guest
Ron Kitay

An important note for @Around is missing here and that is that an @Around advice must also return the value from the call to joinPoint.proceed() – you should correct the sample or at least add a note about it

siddharth agarwal
Guest
siddharth agarwal

There is typo AfterThrowing —> AfterReturning

Cristian Daniel Ortiz
Guest
Cristian Daniel Ortiz

Hi i am a completely newbie in AOP what if i need to to fill some fields in a class before call another method some flags (update,delete,save) i use beforeAdvice

@Before(“execution(* com.mkyong.customer.bo.CustomerBo.addCustomer(..))”)
public void logBefore(JoinPoint joinPoint)
{

System.out.println(“logBefore() is running!”);
System.out.println(“hijacked : ” + joinPoint.getSignature().getName());
System.out.println(“******”);
}

and the method receives a parameter example

DAO.Student.update(Student studenToBeUpdated)

how can i access the Student to apply my flags befored saved??

Raeesaa
Guest
Raeesaa

I had a question. Is it possible to get method argument names in @Around advice?

Raeesaa
Guest
Raeesaa

Using java 7

Raushan Kumar Singh
Guest
Raushan Kumar Singh

I need to log method calling methods ?? Any tutorial on LTW .

Raushan Kumar Singh
Guest
Raushan Kumar Singh

What is the best method to log chained method! ?? I don’t know MAVEN so please any solution through spring

Julien
Guest
Julien

7. AspectJ @AfterReturning has to be 7. AspectJ @AfterThrowing

Amrut
Guest
Amrut
Hi, My main package folder is com.base and it has multiple folders like aspect, dao, web/controller, domain, service etc I want to apply this aspect for all the methods from all the classes under com.base folder. My spring config (web-servlet.xml) has I have created one logging aspect as below @Aspect public class LoggingAspect { /** 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.base.*.*(..))”) private void selectAll(){System.out.println(“logBefore() is running!”);} /** * This is the method which I would like to execute *… Read more »
Pavan
Guest
Pavan

The 7th point.. Please make it @AfterThrowing..6th and 7th both has @AfterReturning, a typo mistake..

Dee One
Guest
Dee One

do you have any idea how i can get the trace of the current running method? like i need to get the full text of the current method in a running program, not the name, signature etc.

Anuj Joshi
Guest
Anuj Joshi

I am getting an exception as:

java.lang.IllegalArgumentException: Can not set com.fasterxml.jackson.databind.ObjectMapper field in.dao.whooshbox.BaseDao.mapper to com.sun.proxy.$Proxy30

at sun.reflect.UnsafeFieldAccessorImpl.throwSetIllegalArgumentException(UnsafeFieldAccessorImpl.java:167)

at sun.reflect.UnsafeFieldAccessorImpl.throwSetIllegalArgumentException(UnsafeFieldAccessorImpl.java:171)

at sun.reflect.UnsafeObjectFieldAccessorImpl.set(UnsafeObjectFieldAccessorImpl.java:81)

at java.lang.reflect.Field.set(Field.java:764)

at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor$AutowiredFieldElement.inject(AutowiredAnnotationBeanPostProcessor.java:551)

at org.springframework.beans.factory.annotation.InjectionMetadata.inject(InjectionMetadata.java:87)

at org.springframework.beans.factory.annotation.AutowiredAnnotationBeanPostProcessor.postProcessPropertyValues(AutowiredAnnotationBeanPostProcessor.java:331)

Could you please help me figure out the issue.

duqi
Guest
duqi

Hi? The 7 should be @AfterThrowing

Kishore
Guest
Kishore

I have a question on enabling logging for different methods in classes of a module: Do I need to create bean object from context for each class intending to get logging. Is there any way I can enable logging for every method using aspectj without creating object through context. Also, incase of a method inside the same class. I would not need to create a object. I can simply call the method by name. How to enable logging for it?

Tarun Gupta
Guest
Tarun Gupta
I have one service method which calls the Dao method to fetch the record from the database. When i deploy the web application it is working fine and fetching the records from database but the moment i apply the around advice(which just have the sysout statements) on the service method, it is returning the null value. When i enabled the debug logger level i have noticed the below behavior 1. As per the logs, the dao method successfully loads the records from database 2. The aspect is also applied on the service method But I’m not sure, on applying aspect,… Read more »
Tarun Gupta
Guest
Tarun Gupta

This is resolved now. Some how the @Aspect and @Component annotation was applied on the loggingAspect class, as soon as i removed @component annotation, it worked!

JoonHo
Guest
JoonHo

great tutorial.. :)
thank, Mkyoung!!

Achilles Ram
Guest
Achilles Ram

i need one help from you, that is can we have one post about @Configurable please,, please explain me at nakirekantisaikumar@gmail.com

Mark
Guest
Mark

Please fix the section title on the page http://www.mkyong.com/spring3/spring-aop-aspectj-annotation-example/. The correct section title “7. AspectJ @AfterThrowing”

Marcello Zanelli
Guest
Marcello Zanelli

Great tutorial! :D

vijay
Guest
vijay

Thanks for putting all this together.

I have a one question in spring transaction management AOP is used and following XML configuration is used to manage transaction.

I don’t see any pointcut (Before/after/AfterReturning/AfterThrowing/Around) like . Please help me out to understand that how this transaction advise executes.

Thanks

Disabled Dating Service
Guest
Disabled Dating Service

I do believe all of the ideas you’ve introduced for your post. They’re very convincing and can certainly work.

Still, the posts are too brief for beginners. May you please extend them a bit from next time?

Thanks for the post.

hzxlb910
Guest
hzxlb910

good,thanks

Abhijit
Guest
Abhijit

There is very blog explain in very lucid manner to understand newbie
Keep it good work!
Thanks a lot :)

Ram
Guest
Ram

7. AspectJ @AfterReturning should be 7. AspectJ @AfterThrowing

Vinod Maladkar
Guest
Vinod Maladkar

Very good blog and nice example.

jagan
Guest
jagan

Hi Kyoung,

First of all, thanks a lot for publishing all this valuable information and aggregating on 1 web site. I visit your site frequently to clarify my knowledge. Now i have 1 question and the scenario is as follows:
org.abc.xyz.service.CounterService.activeCount()
and this service will be invoked from 2 execution paths:
1. org.abc.xyx.controllers.ABCController and
2. org.abc.xyz.controllers.XYZController

Now my question is can we have an aspect on activeCount for the execution path:- ABCController–>CounterService

thanks,
jagan

Greg
Guest
Greg

I have a question… how can these aspects work when the methods are called without it getting the instance from a bean…. As in…

Right now it works like this…
CustomerBo customer = (CustomerBo) appContext.getBean(“customerBo”);
customer.addCustomerAround(“mkyong”);

I want it make it work like this….
CustomerBo customer = new CustomerBoImpl();
customer.addCustomerAround(“mkyong”);

Anderson Nunes
Guest
Anderson Nunes

I think the appContext.getBean doesn’t returns the “real” bean, returns just a proxy, and in this proxy, when you call some method, it execute the joinpoints from the aspect after or before the method of real bean.

When you use new CustomerBoImpl(); you get the real bean, so this is not a proxy that will execute the joinpoints after or before the CustomerBoImpl methods.

Am I right? Did I understand it well?

Vanessa Schissato
Guest
Vanessa Schissato

Yeah…Im trying to figure out how to make it work..but it seems that we need to use only AspectJ for that

Look
Guest
Look

Its such as you read my mind! You appear to know a
lot about this, such as you wrote the e-book in it or something.
I think that you simply can do with some percent to drive the message home a bit, but instead
of that, that is great blog. An excellent read. I’ll certainly be back.

Jay Khimani
Guest
Jay Khimani

Thanks for sharing this concise tutorial. It was a great help. One question. Is there a way to define an aspect which intercepts annotated fields? For e.g. If I’ve below class

package com.jak.sandbox.aspect;

public class MyClass {
     @MyAnnotation
     private String myField;

     public void doSomething() {
          System.out.println("Saving the world");
     }
}

Now is it possible to define an aspect which will intercept the the field

myField

and invoke pointcut?

Himkar Dwivedi
Guest
Himkar Dwivedi
hi, this is really gr8 tutorial, I just follow all the steps and work fine for me, but I am facing issue in point number 6. I have a DAO class which has two method, addUser(user) and List getAllUsers() and I have one test call which create an user, add this user to db using DAO addUser method and after that it retrieve it. this unit test class works fine without adding this process, but if I add this, its giving error while retrieving the values I am getting null user list in Test class while in DAO class same… Read more »
Himkar Dwivedi
Guest
Himkar Dwivedi

even if I remove this method from “DaoLoggingAspect” class, I am getting same issue

Himkar Dwivedi
Guest
Himkar Dwivedi

the main problem is with the around function, after removing around it works fine. but still I don’t know why around cause issue her

Shanmugapriya
Guest
Shanmugapriya

Really an excellent example. Thank you very much.