https://github.com/avidee007/custom-logger-advice

Custom annotation to separate logging concerns from business layer. Works with spring AOP to perform advice to custom annotation to do console and database logging.
https://github.com/avidee007/custom-logger-advice

annotations generics-in-java rest-api spring-aop spring-boot spring-data-jpa

Last synced: 28 days ago
JSON representation

Custom annotation to separate logging concerns from business layer. Works with spring AOP to perform advice to custom annotation to do console and database logging.

• Host: GitHub
• URL: https://github.com/avidee007/custom-logger-advice
• Owner: avidee007
• Created: 2024-09-16T12:15:27.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-16T13:01:05.000Z (4 months ago)
• Last Synced: 2024-10-16T18:34:03.672Z (3 months ago)
• Topics: annotations, generics-in-java, rest-api, spring-aop, spring-boot, spring-data-jpa
• Language: Java
• Homepage:
• Size: 51.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Custom Logger Advice Service

**Problem**

Sometimes we need to push request details in a database for tracking purposes,

and this can be an overhead to API performance.

This requires additional handling of database persistence logic which can slow and

cause issues to overall API performance.

**Solution**

* Custom annotation `@LoggerAdvice` to separate logging concern from service/business layer code.

* This annotation has **logToDb** flag which can decide whether logs push logs to database table.

* This annotation uses spring AOP, to do logging as advice to `@LoggerAdvice` annotation.

* When logToDb is set to true it persists the request entity asynchronously to do persistence in

  separate thread to avoid any API performance issues.

**How to use @LoggerAdvice:**

This is method level annotation can be applied to any method to use it.

`@LoggerAdvice

 public void methodWithOutDbLogging() {

   // actual method code logic

}`

`@LoggerAdvice(logToDb = true)

 public void methodWithDbLogging() {

   // actual method code logic

}`

**Custom Logger Advice Service was built with below components**

* spring-web: To build RESTFul api.

* spring-aop: To build logger advice for @LoggerAdvice annotation

* spring-data-jpa: To do persistence of entities in database.

* postreSQL: Database

* Junit and Mockito: For unit testing