Introduction To Aspect Oriented Programming and Cross Cutting Concerns


Software applications are built in layers. There is common functionality that is sometimes needed across layers - logging, performance tracing etc.

How do you implement these common features?

You will learn?

  • What Is Aspect Oriented Programming?
  • What are the important concepts behind Aspect-Oriented Programming?
  • What are the situations where AOP is used?
  • Why is AOP needed?
  • What are the best Java frameworks to implement AOP?

What Is Aspect Oriented Programming?

In order to understand what Aspect Oriented Programming (AOP) is all about, let’s first talk about layered architecture, and something called cross-cutting concerns.

What is a Layered Architecture

Whenever we design and develop a large software application, we make use of a layered architecture. For instance, in a web application, it is quite common to see an architecture similar to the following:

image info

Here, we see that the application is organized into a Web layer, a Business layer, and a Data layer.

Understanding Cross Cutting Concerns

In a layered architecture, there are specific parts that are common to all these different layers. Such parts include:

  • Logging
  • Security
  • Performance
  • Auditing

All these features are applicable across layers, hence it makes sense to implement them in a common way.

Let’s say you want to implement logic to find out how much time each method takes to execute, in each of the three layers (Web, Business and Data) above.

That’s where AOP steps in.

An Example Of AOP

Let’s now look at a simple example where we apply AOP.


	@Component
	class HiByeService {
	  public void sayHi(String name) {
	    System.out.println("Hi " + name);
	  }
	
	  public void sayBye() {
	    System.out.println("Bye");
	  }
	
	  public String returnSomething() {
	    return "Hi Bye";
	  }
	}

The class HiByeService has a few methods such as sayHi(), sayBye() and returnSomething() defined within it.

We want to do a few computations by taking up each of these methods, by turn at the following stages:

  • Do something before the method begins execution
  • Do something after the method completes execution
  • Track how much time the method takes during its execution

Here we take HiByeService as a specific example to work with. The same could be done across several classes that make up such an application.

Let’s take each of these computations and look at them in some detail.

Doing Stuff Before Execution

Have a look at the following AOP code:


	@Aspect
	@Component
	class MyAspect {
	  @Before("execution(* HiByeService.*(..))")
	  public void before(JoinPoint joinPoint) {
	    System.out.print("Before ");
	    System.out.print(joinPoint.getSignature().getName());
	    System.out.println(Arrays.toString(joinPoint.getArgs()));
	  }

We first define an aspect with the annotation @Aspect for the class MyAspect. Within it is another annotation, @Before that describes the method before(). The idea of this aspect is that whatever logic lies in the before() body, is executed before any method of HiByeService is run. Note that in the @Before annotation, a package name could also be mentioned instead of a class name. This aspect would then be executed before any method in the entire package.

Doing Stuff After Execution

Similar to this, it is also possible to define an aspect to execute after every method within HiByeService is run:


	@AfterReturning(pointcut = "execution(* HiByeService.*(..))"
	                    , returning = "result")
	  public void after(JoinPoint joinPoint, Object result) {
	    System.out.print("After ");
	    System.out.print(joinPoint.getSignature().getName());
	    System.out.println(" result is " + result);
	  }
	}

For this, you need to define a method with an @AfterReturning annotation, defined above for the after() method. This method here takes an extra argument to store the result of execution of the method of HiByeService.

Doing Stuff Around Execution

An additional thing you can do is define an aspect around the execution of a method:


	@Around(value = "execution(* HiByeService.*(..))")
	public void around(ProceedingJoinPoint joinPoint) 
	                                      throws Throwable {
	  long startTime = new Date().getTime();
	  Object result = joinPoint.proceed();
	  long endTime = new Date().getTime();
	  System.out.print("Execution Time - " 
	                  + (endTime - startTime));
	}

Over here, we have made use of an annotation called @Around to decorate the around() method.

In this method body, we intercept the call to the method in HiByeService in the following manner:

  • We make note of the start time of execution
  • Allow the method to run its course
  • Finally, we make note of the end time of execution

We then output the computed execution time of that method.

How To Make Use Of AOP

At a high level, AOP allows you to intercept calls to methods, and perform logic around these calls. We have used annotations to decorate our computations within the aspect.

In our examples above, we have restricted ourselves to a single class. However, we could easily extend it to more classes or packages by varying the regular expression we use in the annotations.

For example, we could choose to intercept classes pertaining to the web layer, or classes across all three layers of the example web application.

Terms We Use In AOP

Let’s now look at some important terms we use when talking about AOP.

  • Point Cut : It refers to the regular expression that defines what methods need to be intercepted by this aspect. It essentially says where the logic within an aspect method is applicable.
  • Advice : This is nothing but the logic within the aspect method. It describes what we do when the Point Cut expression is matched.
  • Aspect: The combination of the Point Cut and the Advice
  • Join Point: This refers to the situation where a method’s execution has been intercepted, and the aspect is in execution
  • Weaving: The entire process of taking a method, intercepting its execution and applying an aspect to its execution. This is the functionality provided by the AOP framework. Examples of AOP frameworks are SpringAOP and AspectJ.

AOP In Summary

In this article, we looked at Aspect Oriented Programming (AOP). We talked about cross-cutting concerns, and described the situations where AOP can be used. In particular, we saw examples of how we can define a point cut, and define the logic of an aspect. We focused on how we can specify aspects to run before, after or around the execution of a method. We then examined the important terms that describe AOP concepts.

Do check out our video on this:

image info

Congratulations! You are reading an article from a series of 50+ articles on Spring, Spring Boot , Hibernate, Full Stack, Cloud and Microservices. We also have 20+ projects on our Github repository. For the complete series of 50+ articles and code examples, click here.

Join 300,000 Learners!

Learn Spring Boot in 10 Steps - FREE Course

Next Steps

Image

Image

Image Image

Image

Image

Image

Image

Image

Image

Image

Image

Image

Image

Image

Image

Related Posts

Spring Boot Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. This resources will help you learn and gain expertise at Spring Boot.

Spring and Spring Boot Video Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. Here's a list of video tutorials and courses for you

Software Design - Separation Of Concerns - with examples

Software architects and programmers love having Seperation of Concerns. What is it? Why is it important? Let's get started.

Object Oriented Software Design - Solid Principles - with examples

Software design is typically complex. Object oriented design takes it to the next level. There are a number of design patterns and other stuff to be aware of. Can we make things simple? What are the goals to aim for when you are doing object oriented design? SOLID Principles is a great starting point for Object Oriented Design.

Software Design - Open Closed Principle - with examples

Open Closed Principle is one of the SOLID Principles. You want your code to be easily extended. How do you achieve it with minimum fuss? Let's get started.

Software Design - What is Dependency Inversion Principle?

Dependency Inversion Principle is one of the important SOLID Principles. Dependency Inversion Principle is implemented by one of the most popular Java frameworks - Spring. What is it all about? How does it help you design good applications?

Introduction to Four Principles Of Simple Design

With agile and extreme programming, the focus is on keeping your design simple. How do you keep your design simple? How do you decide whether your code is good enough?

Software Design - Single Responsibility Principle - with examples

For me, Single Responsibility Principle is the most important design principle. What is Single Responsibility Principle? How do you use it? How does it help with making your software better? Let's get started.

REST API Best Practices - With Design Examples from Java and Spring Web Services

Designing Great REST API is important to have great microservices. How do you design your REST API? What are the best practices?

Designing REST API - What is Code First Approach?

Designing Great REST API is important to have great microservices. Code First approach focuses on generating the contract from code. Is it the best possible approach?