[Spring Boot][Total-Back-Office Project] AOP, Annotation을 이용한 API 동작 시간 측정

 

 

 

 

스프링 부트 3 백엔드 개발자 되기 : 자바 편

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

 

🗂 목차

🧑‍💻 코딩

✅  [Spring Boot][Total-Back-Office Project] AOP, Annotation을 이용한 API 동작 시간 측정
✅ [Spring Boot][Total-Back-Office Project] AOP, Annotation을 이용한 API 요청 이용자 정보 가져오기 feat.MyBatis & Test Code(JUnit 5) (https://junyharang.tistory.com/457)
✅ [Spring Boot][Total-Back-Office Project] Log Back을 이용한 Discord에 Exception 정보 보내기 및 Data Base  저장 feat.MyBatis & Test Code(JUnit 5) - ① Log Back 설정
✅ [Spring Boot][Total-Back-Office Project] Log Back을 이용한 Discord에 Exception 정보 보내기 및 Data Base 저장 feat.MyBatis & Test Code(JUnit 5) - ② 디스코드로 로그 정보 발송
✅ [Spring Boot][Total-Back-Office Project] Log Back을 이용한 Discord에 Exception 정보 보내기 및 Data Base 저장 feat.MyBatis & Test Code(JUnit 5) - ③ 로그 및 요청 이용자, 요청 정보 데이터 베이스에 저장

 

🚚 배포

⚠️ 아래 목차 중 몇몇개의 링크가 걸리지 않는 문제로 글 맨 하단에 다음 글로 이동할 수 있게 해 두었습니다.

✅ [CI/CD] Jenkins와 Gitea 연동
✅ [CI/CD] Jenkins Trigger 정보 Discord로 보내기
✅ [CI/CD] 정적 코드 분석 툴 SonarQube와 Jenkins 연동
✅ [CI/CD] SonarQube를 통해 Code Convention 적용
✅ [DevOps] JAVA Gradle JaCoCo (Code coverage) 설정하기 
✅ [DevOps] JAVA Gradle JaCoCo (Code coverage) 설정하기 (추가)(https://junyharang.tistory.com/392)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ① Application Linuxt(Ubuntu)에 SSH를 이용한 파일 전송
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ② Create Docker Image And BackUp
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (① Application 도커 존재 여부 확인)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (② Application Docker Run)(https://junyharang.tistory.com/406)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ③ Application Server Docker Job (③ Application Docker Health Check)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (① NGINX 각 종 설정) 
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (② NGINX Docker 존재 여부 확인) 
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (③ NGINX Docker Run & Health Check)
✅ [CI/CD] Jenkins + Docker를 이용한 무중단 배포 - ④ NGINX Server Docker Job (③ NGINX 재 설정)

 

 

 

 

💾 Git Hub Repository : https://github.com/junyharang-personal-project/junyss-total-back-office

GitHub - junyharang-personal-project/junyss-total-back-office: [Back-Office] 디스코드 봇과 Logback, AOP 등을 이용하

 

 

 




 

 

🚀 AOP, Annotation을 이용한 API 동작 시간 측정

    🔽  개요

        📦 소개

최근 주니가 진행한 프로젝트에서 AOP와 Annotation을 만들어 API 동작 시간을 측정할 수 있도록 만들어 보았어요.
이에 대해 정리하고, 공유해보고자 합니다.

 

AOP란?

AOP에 대한 내용은 이 곳과 이 곳에 정리해 두었어요.

[Spring] Spring AOP; 스프링 AOP 개념 정리

반응형

[Spring Boot] AOP

 

Annotation이란?

어노테이션에 대한 내용은 이 곳에 정리해 두었어요.

[Java] Annotation (어노테이션) 이란?

 

 

 

 

    🔽  소스 코드 분석

        📦 TimeTraceAop.java

최초 AOP Class를 먼저 확인해 볼게요.

TimeTraceAop.java 1 ~ 23번째 줄

최초 21번째 줄 Annotation은 부가적 기능에 대한 내용들을 모듈화 할 때 사용하는 것으로 공통으로 적용할 기능을 구현할 때 명시해 주고 있어요. 즉, 해당 Class가 부가 기능에 대한 Class라는 것을 알려주는 Annotaion이에요.

그리고 @Component는 AOP를 Spring Bean에 등록하기 위해 명시해 주었어요. 이는 @Aspect를 명시했다고 해서
자동으로 Spring Bean에 등록되지 않기 때문에 따로 Bean 등록을 위해 사용해 준 것이에요. 이 방법 외에도 SpringConfig의 @Bean을 사용하여 등록할 수도 있어요.

 

 

TimeTraceAop.java 25 ~ 56번째 줄

32번째 줄에 @Around 어노테이션은 대상 Entity Method 실행 전, 후 또는 예외 발생 시점에 공통 기능 수행하기 위해 명시한 것이에요. 이 부분은 Advice의 한 종류로 핵심 관심사의 실패 여부와 상관없이 실행되도록 하는 Advice를 의미해요.

만약 특정 Directory 전체에 적용하고 싶다면 아래와 같이 사용할 수 있어요.

💡 참고 사항
@Around의 execution

// hello.hellospring 밑에 모든 내용에 아래 Method 모두 적용
@Around("execution(* hello.hellospring..*(..))")

여기서 execution은 접근 제어자, 반환형 Package를 포함한 Class 경로에 대한 메소드 매개 변수를 넣어 줄 수 있어요.

첫번째에 명시 된 [*]은 접근 제어자와 반환형 모두 상관하지 않고, 적용하겠다는 의미이고, hello는 Project Directory 중 java 밑에 있는 Package 이름이며, 그 다음은 hellospring일 때, hello 밑에 모든 Directory에 대해 아래 명시된 기능을 실행하겠다는 의미이고, [(..)]은 Method Parameter가 몇 개가 존재하던지 상관 없이 실행하겠다는 의미에요.

728x90

@annotion(....) 의미는 해당 어노테이션을 사용한 메소드에 @Around를 적용 시키겠다는 의미에요.
즉, 주니가 정의한 ....ExecutionTimeCheck이라는 어노테이션으로 메소드의 실행 시간을 체크하겠다는 의미에요.

excute() 매개 변수로 ProceedingJoinPoint 객체를 매개 변수로 전달해 주었어요.
ProceedingJoinPoint는 스프링 AOP에서 사용되는 Interface로 AOP 적용 메소드의 실행을 제어하고,
추가 동작을 삽입할 수 있는 기능을 제공해요.

ProceedingJoinPoint 객체는 @Around가 적용된 메소드에 매개변수로 전달되는데, 이 객체를 통해 AOP가 적용된 메소드의 실행을 직접 제어할 수 있게 된답니다.

ProceedingJoinPoint 인터페이스에는 다양한 메소드가 있어요.
그 중에서 가장 중요한 메소드는 proceed()인데, 이 친구는 AOP가 적용된 메소드의 실제 실행을 호출하는 역할을 하고 있어요. 또한, object를 반환하고, AOP가 적용된 메소드의 반환값을 가져올 수도 있도록 해준답니다.
또한, ProceedingJoinPoint 객체를 통해 AOP가 적용된 메소드의 매개 변수 값을 가져오거나, 변경할 수도 있어요.
예를 들어 joinPoint.getArgs()를 통해 메소드의 매개 변수 값을 가져올 수도 있답니다.

정리하면 ProceedingJoinPoint 객체는 AOP가 적용된 메소드의 실행을 제어하고, 해당 메소드의 매개 변수 값이나,
반환값 등에 접근할 수 있는 기능을 제공하는 인터페이스랍니다.

34번째 줄에서 최초 메소드 동작 시간을 잡기 위해 System.currentTimeMillis()를 통해 ms 단위의 시작 시간을 startTime 변수에 담아 주었어요.

그런 뒤 joinPoint.toString()를 통해 ProceedingJoinPoint 객체의 문자열 표현 반환을 받게 되는데, 이를 통해 ProceedingJoinPoint 객체에 대한 정보가 포함된 문자열을 반환 받을 수 있어요.

즉, 주니는 AOP가 적용된 메소드의 시그니처 및 매개 변수값을 출력하기 위해 사용하여 주었어요.

그런 뒤 41번째 줄에서 proceed()의 내용을 반환하게 해 주어 AOP가 적용된 메소드의 실행을 호출하고, 해당 메소드의 반환값을 반환하게 해 주었어요.

44번째 줄에서는 임의로 정한 500ms가 넘으면 동작 시간이 오래 걸린다는 판단을 하기 위한 변수이고, 45번째 줄은 5000ms를 넘으면 코드 리팩터링이 필요하다고 판단할 수 있는 기준값을 잡아준 변수에요.

그런 뒤 46번째 줄에서 동작이 끝난 ms를 잡게 해주고, 47번째 줄에서 끝난 ms에서 시작 ms를 빼 progressMethodMsTime 변수에 담아 주었어요.

48번째 줄에서는 현재 기동되고 있는 Application 구동 환경을 체크하기 위해 사용한 부분이에요.

그리고, 50 ~ 56번째 줄을 통해 동작 소요 시간을 출력할 수 있도록 처리해 주었어요.
55번째 줄에서는 소수점 3번째 자리까지 ms 단위를 반올림 한 뒤 1000으로 나누어 즉, 초 단위로 변환하여 출력될 수 있도록 한 것이에요.

 

TimeTraceAop.java 58 ~ 80번째 줄

58번째 줄에서 동작 소요 ms 기준 보다 현재 구동 소요 시간이 크거나 같거나, 혹은 코드 리팩터링이 필요한 기준 ms 보다 작으면 해당 분기문이 진행되도록 하였어요.

그런 뒤 60번째 줄에서 Application 구동 환경이 로컬인지 개발 환경인지를 체크하고, 맞다면 longTimeExceptionHandler() 를 호출하여 ProceedingJoinPoint 객체와 구동 소요 시간 값을 전달해 줍니다.

만약 운영 환경이라면 longTimeExceptionHandler()는 호출되지 않고,
해당 내용만 log의 warnning Level로 출력하게 처리 해 주었어요.

TimeTraceAop.java 82 ~ 103번째 줄

이 곳에서는 구동 소요 시간이 위험 기준 시간 보다 높다면 log의 error Level로 출력하게 하기 위한 곳이고, 역시 운영 환경이거나, 로컬 환경에서만 veryLongTimeExceptionHanlder()를 호출하여 ProceedingJoinPoint 객체와 구동 소요 시간 값을 전달해 주었어요.

TimeTraceAop.java 117 ~ 149번째 줄

위에서 각각 호출했던 메소드들이에요.

최초 longTimeExceptionHanlder()는 Exception을 던지게 되는데, TimeTraceException을 터트리게 되고,
해당 메소드 동작 소요 시간이 500ms 이상 소요된다는 것을 알려주기 위한 메소드에요.


마찬가지로 veryLongTimeExceptionHandler() TimeTraceException을 터트려서
위험이라고 판단될 소요 시간 보다 더 오래 걸림을 알려주기 위해 처리한 부분이에요.

다른 글에서 작성할 예정인 Log Back을 이용하여 주니는 Exception에 대한 내용을 디스코드로 받고 있는데,
이를 위해서 처리해 준 부분이에요.

 

 

 

        📦 ExecutionTimeCheck.java

ExecutionTimeCheck.java

어노테이션을 이렇게 만들어 주었어요.

@Target을 통해 메소드에서 사용하겠다고 정의 해주고, @Retention을 통해
해당 어노테이션이 Runtime 까지 유지 되도록 설정하여 시간 측정을 원하는 Method에 사용할 수 있도록 설정해 주었어요.

        📦 어노테이션 명시

 

그런 뒤 22번째 줄과 같이 Controller Method에 해당 어노테이션을 명시해 주면 LogbackTest()가 동작할 때,
API 동작 시간을 측정할 수 있게 된답니다.

[2023-07-15] [17:36:04.472] [INFO] 3735 [DirectJDKLog.java] log (173) : Initializing Spring DispatcherServlet 'dispatcherServlet'
[2023-07-15] [17:36:04.473] [INFO] 3735 [FrameworkServlet.java] initServletBean (525) : Initializing Servlet 'dispatcherServlet'
[2023-07-15] [17:36:04.474] [INFO] 3735 [FrameworkServlet.java] initServletBean (547) : Completed initialization in 1 ms
[2023-07-15] [17:36:04.478] [INFO] 3735 [ServletWrappingFilter.java] doFilterInternal (25) : url : /api/test/web-hook
[2023-07-15] [17:36:05.143] [INFO] 3735 [TimeTraceAop.java] execute (36) : Method 동작 시간 확인 시작 : execution(String com.giggalpeople.backoffice.api.webhook.test.WebHookTestController.logbackTest())의 동작 시간 확인합니다.
[2023-07-15] [17:36:05.146] [INFO] 3735 [WebHookTestController.java] logbackTest (29) : Discord 및 Console LogBack Test 중 입니다! 출력 Error 단계를 확인 하겠습니다! 
Info 단계 Log 출력입니다! 
[2023-07-15] [17:36:05.146] [WARN] 3735 [WebHookTestController.java] logbackTest (31) : Discord 및 Console LogBack Test 중 입니다! 출력 Error 단계를 확인 하겠습니다! 
warning 단계 Log 출력 입니다!
[2023-07-15] [17:36:05.148] [ERROR] 3735 [WebHookTestController.java] logbackTest (32) : Discord 및 Console LogBack Test 중 입니다! 출력 Error 단계를 확인 하겠습니다! 
error 단계 Log 출력 입니다!
[2023-07-15] [17:36:05.152] [INFO] 3735 [TimeTraceAop.java] execute (50) : Method 동작 시간 검증 완료 : execution(String com.giggalpeople.backoffice.api.webhook.test.WebHookTestController.logbackTest()) Method 동작 시간은 6ms (0.006)초 입니다.
[2023-07-15] [17:36:05.153] [INFO] 3735 [TimeTraceAop.java] execute (106) : Method 동작 시간 검증 완료 : execution(String com.giggalpeople.backoffice.api.webhook.test.WebHookTestController.logbackTest()) Method 동작 시간은 6ms (0.006)초 입니다.

 
위와 같이 콘솔에서 출력되는 걸 확인할 수 있어요.

 

 

 

 

 

스프링 부트 3 백엔드 개발자 되기 : 자바 편

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."