> For the complete documentation index, see [llms.txt](https://www.pranaypourkar.co.in/the-programmers-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://www.pranaypourkar.co.in/the-programmers-guide/spring/spring-features/spring-aop/around-advice.md).
# Around Advice
Details as well as Examples covering Around Advice.
Around advice wraps around the target method invocation. It allows to control the method invocation, including modifying the method arguments, skipping method execution, or replacing the method result. Some of the use cases are described below.
**Caching**: Helpful in manual cache checking if the requested data is available in the cache before proceeding with the method execution.
**Security Checks**: Useful in performing authentication and authorization checks before allowing access.
**Logging**: Can be used in calculating execution time.
**Sample Example**
Scenario 1: Log method execution time using custom annotation.
Create a custom annotation
***LogExecutionTime.java***
```java
package org.example.logging;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.METHOD) // Annotation will be applicable on methods only
@Retention(RetentionPolicy.RUNTIME) // Annotation will be available to the JVM at runtime
public @interface LogExecutionTime {
}
```
Create Aspect class
***LoggingAspect.java***
```java
package org.example.logging;
import lombok.SneakyThrows;
import lombok.extern.slf4j.Slf4j;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.stereotype.Component;
import java.time.OffsetDateTime;
@Slf4j
@Aspect
@Component
public class LoggingAspect {
@SneakyThrows
@Around("@annotation(LogExecutionTime)")
public Object logExecutionTime(ProceedingJoinPoint joinPoint) {
log.info("Started - {}", OffsetDateTime.now());
// Perform custom logic before method execution
// Proceed with the method execution
final Object proceed = joinPoint.proceed();
// Perform custom logic after method execution
log.info("Completed - {}", OffsetDateTime.now());
return proceed;
}
}
```
Create controller class
***DataApi.java***
```java
package org.example.controller;
import lombok.RequiredArgsConstructor;
import org.example.Model.InputData;
import org.example.Model.OutputData;
import org.example.logging.LogExecutionTime;
import org.example.service.DataService;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequiredArgsConstructor
@RequestMapping("/data")
public class DataApi {
private final DataService dataService;
@LogExecutionTime
@PostMapping("/extract")
public ResponseEntity getData(@RequestBody InputData inputData) {
return new ResponseEntity<>(
dataService.extractData(inputData),
HttpStatus.OK
);
}
}
```
Run the application, execute the API and observe the logs
Output
{% hint style="info" %}
Note: The code snippet given in this page is just for understanding and does not contain complete code. (For e.g. missing service class code snippet)
{% endhint %}
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.
Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:
```
GET https://www.pranaypourkar.co.in/the-programmers-guide/spring/spring-features/spring-aop/around-advice.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
