Spring Boot AOP Before Advice
Before advice is used in Aspect-Oriented Programming to achieve the cross-cutting. It is an advice type which ensures that an advice runs before the method execution. We use @Before annotation to implement the before advice.
Let’s understand before advice through an example.
Spring Boot Before 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-before-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-before-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.
pom.xml
Step 9: Open AopBeforeAdviceExampleApplication.java file and add an annotation @EnableAspectJAutoProxy.
It enables support for handling components marked with AspectJ’s @Aspect annotation. It is used with @Configuration annotation. We can control the type of proxy by using the proxyTargetClass attribute. Its default value is false.
AopBeforeAdviceExampleApplication.java
Step 10: Create a package with the name com.tutoraspire.model.
Step 11: Create a model class under the package com.tutoraspire.model. We have created a class with the name Employee. In the class, define the following:
- Define three variables empId, firstName, and secondName of type String.
- Generate Getters and Setters.
- Create a default
Employee.java
Step 12: Create a package with the name com.tutoraspire.controller.
Step 13: Create a controller class under the package com.tutoraspire.controller. We have created a class with the name EmployeeController.
In the controller class, we have defined the two mappings one for adding an employee and the other for removing an employee.
EmployeeController.java
Step 14: Create a package with the name com.tutoraspire.service.
Step 15: Create a Service class under the package com.tutoraspire.service. We have created a class with the name EmployeeService.
In the Service class, we have defined two methods createEmployee and deleteEmployee.
EmployeeService.java
Step 16: Create a package with the name com.tutoraspire.aspect.
Step 17: Create an aspect class under the package com.tutoraspire.aspect. We have created a class with the name EmployeeServiceAspect.
In the aspect class, we have defined the before advice logic.
EmployeeServiceAspect.java
In the above class:
- execution(expression): The expression is a method on which advice is to be applied.
- @Before: It marks a function as an advice to be executed before method that covered by PointCut.
After creating all the modules, the project directory looks like the following:
We have set-up all the modules. Now we will run the application.
Step 18: Open the eAopBeforeAdviceExampleApplication.java file and run it as Java Application.
Step 19: Open the browser and invoke the following URL : http://localhost:8080/add/employee?empId={id}&firstName={fname}&secondName={sname}
In the above URL, /add/employee is the mapping that we have created in the Controller class. We have used two separators (?) and (&) for separating two values.
In the above output, we have assigned emId 101, firstName=Tim, and secondName=cook.
Let’s have a look at the console. We see that before invoking the createEmployee() method of EmployeeService class, the method beforeAdvice() of EmployeeServiceAspect class invokes, as shown below.
Similarly, we can also remove an employee by invoking the URL http://localhost:8080/remove/employee?empId=101. It returns a message Employee removed, as shown in the following figure.
In this section, we have learned the working of before advice. In the next section, we will learn the working of after advice and implement it in an apllication.