[Spring Boot][Total-Back-Office Project] AOP, Annotation을 이용한 API 요청 이용자 정보 가져오기 feat.MyBatis & Test Code(JUnit 5)

 

 

 

 

 

스프링 부트 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 (어노테이션) 이란?

 

 

 

        📦 Data Base 구조

Data Base 구조

 

 

 

 

 

 

    🔽  소스 코드 분석

        📦 UserAccessInfoAspect.java

Code를 분석하기 전 AOP 관련하여 지난 글과 공통된 사항은 이 곳에서 보다 자세히 확인하실 수 있어요.

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

 

UserAccessInfoAspect 31 ~ 51번째 줄

최초 43번째 줄에 요청 정보를 가져오기 위한 처리를 해 주었어요.
해당 코드는 Spring Framework의 WebUtils Class를 사용하여 HttpServletRequest 객체를 가져오는 부분이에요.

HttpServletRequest는 Java Servlet API의 일부로 Web Application에서 Client의 HTTP 요청에 대한 정보를 캡슐화하는 Interface랍니다.

WebUtils.getNativeRequest()는 스프링 프레임워크에서 제공하는 유틸리티 메소드로 HttpServletRequest 객체를 가져오는데 사용되고 있어요.

해당 메소드의 두 번째 인자로 HttpServletRequest.class를 전달하여 반환하려는 객체 Type을 명시하고 있어요.

주니가 이렇게 사용한 이유는 스프링 프레임워크가 HttpServletRequest의 wrapper인 Request 객체를 사용하지 않고, 직접 HttpServletRequest 객체를 다루기 위함이에요.

예를 들어 HttpServletRequest의 기능만으로 충분한 상황이거나, 스프링 프레임워크의 기능을 사용하지 않는 특정 부분에서 HttpServletRequest를 사용해야 할 때가 그 예가 될 거 같아요.

즉, 이 코드를 통해 요청 이용자의 정보를 가져오기 위해 사용하는 부분이에요.


45번째 줄과 46번째 줄에는 이용자의 접속 일시를 가져오기 위해 사용한 부분이에요.
45번째 줄에 yyyy-mm-dd HH(24시간 표기):mm:ss로 접속 일시에 대한 Format을 지정해 주고, 46번째 줄에서 Date 객체를 통해 System.currentTimeMillis() 매개변수로 전달하는데 이는 1970년 1월 1일 00:00:00 GMT(그리니치 표준시)로 부터 현재까지 경과한 시간을 ms(밀리초) 단위로 접속 일시를 전달하기 위함이고, Date Class의 생성자를 사용하여 특정 날짜와 시간을 나타내는 Date 객체를 생성하고, 이 때 전달된 값은 Date 객체가 나타내는 시간을 ms 단위로 나타내기 위해 사용하여 주었어요.

결국 현재 시간을 밀리초 단위로 받아와서 그 값을 사용하여 해당 시간을 나타내는 Date 객체를 생성하기 위해 사용한 것이에요.

참고로 Java 8부터는 java.time.LocalDateTime 혹은 java.time.ZonedDateTime 등이 제공되며, 이를 사용하는 것이 더 좋은 방법일 수도 있어요.

왜냐하면 Date Class는 이전 버전의 날짜와 시간 API이기 때문에 가능하면 java.time Package를 사용하여 날짜와 시간을 다루는게 좋기 때문이에요.

그런 뒤 split()을 통해 공백을 기준으로 두 개의 배열이 만들어지게 하고, 첫번째 배열에는 날짜값이 두번째 배열에는 시간값이 담길 수 있도록 해 주었어요.

 

UserAccessInfoAspect 54 ~ 83번째 줄

이제 위에서 가져온 이용자 접속 정보와 접속 일시를 Data Base에 저장하기 위한 Logic을 구현해 주었어요.

최초 54 ~ 60번째 줄까지 접속 이용자 정보 비즈니스 로직의 save()에 이용자 접속 정보를 담은 요청 DTO를 Builder Pattern으로 전달해 줍니다.

이 때, 55번째 줄에 현재 구동중인 서버 정보를 전달해 주게 되는데, 해당 코드는 아래와 같아요.

Environment 60 ~ 84번째 줄

해당 메소드는 Exception이 발생하거나, 요청 이용자 정보를 저장할 때, 구동 Application의 서버 정보를 가져오기 위한 메소드에요.

66번째 줄에 SpringApplication 객체를 생성하는데, 해당 객체는 스프링 부트 애플리케이션을 실행하는 데 사용되는 클래스에요. 이 클래스에 SystemInfo.class를 매개 변수로 전달하는데, 이는 스프링 부트 애플리케이션의 메인 클래스를 나타낸답니다.

setWebApplicationType(WebApplicationType.None)은 스프링 부트 애플리케이션을 웹 애플리케이션이 아닌 일반 애플리케이션으로 동작하도록 설정하는 부분이에요. 웹 애플리케이션에서는 웹 서버와 연동하는 등의 추가 설정이 필요하지만, 이 설정을 통해 웹 서버를 사용하지 않고, 일반적인 자바 애플리케이션처럼 동작하게 하기 위해 사용하여 주었어요.

ManagementFactory.getRuntimeMXBean()에서 ManagementFactory 클래스는 자바 Management Extensions(JMX) API를 제공하는데, getRuntimeMXBean()은 JVM의 Runtime System 정보를 제공하는 RuntimeMXBean 인터페이스 객체를 반환하게 된답니다.

그런 뒤 서버 정보를 수집하게 해 주었어요.

∙ runtimeMXBean.getVmName(): JVM(자바 가상 머신) 이름과 버전 정보 가져오기 위해 사용.

∙ System.getProperty(): System Property를 이용하여 운영체제(OS) 이름, 버전, 아키텍처 정보 가져오기 위해 사용.
∙ InetAddress.getLocalHost().getHostAddress(): InetAddress 클래스를 사용하여
   Local Host IP 주소 가져오기 위해 사용.
   (이 때, UnknownHostException이 발생할 수 있기 때문에 80번째 줄에 catch 절을 통해 예외 처리)

∙ ServerInfo.builder()...build(): ServerInfo 클래스의 빌더 패턴을 사용하여 서버 정보를 구성하고 반환 받기 위해 사용.

80번째 줄에 예외 처리 부분은 IP 주소를 가져올 때 발생하는 UnknownHostException을 캐치하여 ServerInfoException이라는 주니가 만든 커스텀 예외를 던지도록 하여 주었어요. 해당 예외는 이 메소드를 호출하는 곳에서 처리할 수 있도록 하여 주었어요.

이렇게 해서 스프링 부트를 사용하여 서버의 정보를 수집하고, 이를 ServerInfo 객체로 빌드하여 반환하도록 해 준 것이에요.

서버의 운영체제, JVM 정보, 서버의 IP 주소 등을 수집하고, 웹 애플리케이션이 아니더라도 일반적인 자바 애플리케이션으로 동작하도록 해 준 부분이에요.

UserRequestTotalInfoSaveRequestDto

UserAccessInfoAspect 54번째 줄에서 비즈니스 로직에 해당 DTO를 빌더 패던으로 값을 넣어 전달한다고 했어요.

해당 DTO는 위와 같이 필요한 객체들을 담게 되어 있는데, 서버 정보, 이용자 요청 일시 DTO, 요청 이용자 정보 요청 DTO (WAS 순서 번호, 접속 일시 순서 번호, 이용자 IP, 이용자 접속 위치 정보, 이용자 환경 정보), 요청 이용자 요청 정보 DTO (WAS 순서 번호, 접속 일시 순서 번호, 이용자 순서 번호, 요청 헤더 정보, 쿠키 정보, 요청 파라미터 정보, 요청 바디 정보)를 받도록 해 주었어요.

ServerInfo

DataCreatedDateTimeRequestDto

ConnectedUserInfoSaveRequestDto (접속 이용자 정보 담기 위한 DTO)

 

 

ConnectedUserRequestInfoSaveRequestDto (이용자 접속 요청 정보 담기 위한 DTO)

 

 

 

UserAccessInfoAspect 54 ~ 83번째 줄

다시 위의 코드를 분석해 보면 56번재 줄에 이용자 접속 일시 정보를 담기 위해 DataCreatedDateTimeRequestDTO를 UserRequestTotalInfoSaveRequestDto 객체에 빌더 패턴으로 전달하는데, 이 때, DataCreatedDateTimeRequestDto 객체 역시 빌더 패턴을 사용하여 46번째 splitNowDateTime 배열에 담긴 날짜값과 시간값을 각각 전달해 주었어요.

62번째 부터 69번째 줄까지는 요청 이용자 정보를 저장하기 위한 로직인데, 이 때, CryptoUtil 클래스를 사용하여 이용자 주요 정보를 암호화 하도록 하였어요.

CryptoUtil 229 ~ 241번째 줄

해당 코드는 주니가 만든 Data-Aes-Secret Library를 Jitpack을 통해 오픈 소스로 공개한 코드를 사용하였고, 이를 통해 AES 256으로 암호화 하여 주요 이용자 정보를 데이터 베이스에 저장할 수 있도록 해 준 부분이에요.

해당 내용에 대해서는 이 곳에 자세히 준비 해 두었어요.

GitHub - JunyHarang-Open-Source-project/Data-Aes-Secret: 주요 Data AES 알고리즘을 통한 암 / 복호화 Library

728x90

위의 코드를 분석해 보면 userInfoEncrypt()는 ConnectedUserInfoSaveRequestDto 객체를 매개 변수로 전달 받게 되요.

그리고, 각각의 암호화가 필요하다고 생각되는 부분 (이용자 IP, 이용자 접속 위치 정보, 이용자 접속 환경)을 AES 256으로 암호화 하도록 해 주었고, DataSecret.base64Encoder()에 암호화에 필요한 cipherKey값을 전달하여 암호화 될 수 있도록 해 준 뒤 Setter를 통해 다시 해당 DTO에 값을 저장하고, 이 객체를 반환하도록 하였어요.

그렇게 암호화가 된 이용자 정보를 UserRequestTotalInfoSaveRequestDto에 담길 수 있도록 해 주었답니다.

UserAccessInfoAspect 54 ~ 83번째 줄

마지막으로 70 ~ 78번째 줄에 요청 이용자 정보를 담기 위한 DTO를 빌더 패턴으로 저장하게 되는데, 이 때도 역시 암호화를 해서 저장할 수 있도록 해 주었어요.

CryptoUtil 282 ~ 311번째 줄

userRequestInfoEncryp()는 ConnectedUserRequestInfoSaveRequestDto를 매개 변수로 받게 되는데, 최초 해당 객체 Null Check를 해주고, Null 이라면 주니가 만든 CryptoException이 터질 수 있도록 하였어요.

Null이 아니라면 요청 헤더, 쿠키 정보, 요청 파라미터 정보, 요청 바디 정보 암호화 하도록 하고, 암호화 된 정보가 담긴 DTO 객체를 반환하도록 해 주었답니다.

 

 

 

 

        📦 UserAccessInfoCheck.java

이제 해당 AOP를 사용하고 싶은 곳에 사용할 수 있도록 어노테이션을 만들어 주어야 해요.

UserAccessInfoCheck.java

주니는 위와 같이 Method에서 사용할 수 있는 어노테이션을 만들어 주었고, 해당 어노테이션을 Runtime에서 지속적으로 요청 이용자 정보를 가져올 수 있도록 설정해 주었어요.

        📦 ConnectedUserInfoService.java

ConnectedUserInfoService Interface save()

ConnectedUserInfoServiceImpl 55 ~ 94번째 줄

이제 이 곳에서 본격적으로 이용자 접속 정보를 데이터 베이스에 저장하기 위한 여정이 시작되요.

save()는 UserRequestTotalInfoSaveRequestDto 객체를 매개 변수로 받게 되고, 72번째 줄에 해당 객체가 Null인지를 확인하고, Null이면 주니가 만든 ConnectedUserException이 터지도록 해 주었어요.

요청 이용자 정보를 저장할 때, 위에서 서버 정보, 접속 일시, 접속 이용자 정보, 이용자 요청 정보를 각각 나누어서 객체에 저장했는데, 이유는 데이터 베이스 테이블을 분리하였기 때문이에요.

Data Base 구조

 

위와 같이 서버 정보, 접속 일시, 접속 이용자 정보, 이용자 요청 정보를 각각 테이블을 분리해서 받게 해주었고,
이 이유로 78 ~ 86번째 줄까지 각각의 정보를 저장할 수 있는 메소드를 만들고 처리해 주었어요.

해당 메소드들이 모두 작동되어 각각의 정보가 데이터 베이스에 저장되면 PK 값을 반환받게 되고, 해당 PK 값을 resultMap에 각각 담아 반환 시켜 준답니다.

 

 

 

processServerInfosaver()

최초 서버 정보 저장을 위한 메소드에 대해 알아볼게요.

ConnectedUserInfoServiceImpl 170 ~ 197번째 줄

해당 메소드는 서버 정보를 담은 ServerInfo 객체를 매개 변수로 받고 있어요.

최초 해당 객체가 Null인지 확인하고, Null이라면 주니가 만든 ServerInfoException이 터지도록 해 주었어요.

Null이 아니라면 ServerInfoDAO.serverID()를 통해 ServerInfo 객체에 담긴 서버 IP 주소를 매개 변수로 전달하여 데이터 베이스에 저장된 동일 서버 IP가 있는지를 찾고, 있다면 해당 정보의 PK 값을 반환하도록 하였어요.

ServerInfoDaoImpl.java findByServerID()

ServerManagementMapper.java

위와 같이 MyBatis를 이용하여 서버 IP주소를 통해 내부 서버 PK 값을 반환 받도록 만들어 주었어요.

 

ConnectedUserInfoServiceImpl 170 ~ 197번째 줄

다시 위 코드를 분석해 보면 185번째 줄에 해당 ID 값이 있는지를 확인하고, 없다면 ServerInfo 객체에 저장된 서버 정보를 저장할 수 있도록 serverInfoDAO.save()에 ServerInfoVo.toVo()를 매개 변수로 전달하는데, toVo()에는 다시 ServerInfoSaveRequestDto의 빌더 패턴을 이용하여 서버 이름, JVM 정보, 서버 OS 정보, IP 정보, 구동 환경 정보를 저장하여 전달해 주었어요.

아래 데이터 베이스 저장이 끝나면 반환 받은 PK 값을 반환하게 되고, 만약 185번째 줄에 이미 해당 정보가 있어 ID가 있었다고 한다면 해당 ID 값이 반환되도록 처리해 주었어요.

ServerInfoSaveRequestDto

ServerInfoVo

이제 DAO와 Mapper는 어떻게 처리했는지 분석해 볼게요.

ServerInfoDaoImpl 1 ~ 31번째 줄

ServerManagementMapper 1 ~ 23번째 줄

ServerManagementMapper.xml

위와 같이 Mapper.xml을 이용하여 SQL문을 작성해 주었고, ServerInfoVo 객체를 전달 받아 각각의 값들을 저장 시켜 주었고, userGenerateKeys와 keyProperty를 통해 저장된 데이터 PK 값 반환되도록 해 주었어요.

 

 

 

processOccurrenceInfoDateTimeSave()

이번에는 이용자 요청 일시를 저장하는 메소드에요.

ConnectedUserInfoServiceImpl 199 ~ 229 번째 줄

이 메소드도 위와 같이 먼저 매개 변수로 전달된 객체에 대한 Null Check 진행을 한 뒤 Null이 아닐 경우 occurrenceDataDateTimeManagementDAO.findByOccurrenceInfoDateTime()에게 매개 변수로 DataCreatedDateTimeRequestDto에 담긴 이용자 요청 일시를 전달해 주어 해당 정보가 저장 되어 있는지를 확인해 주었어요.

OccurrenceDataDateTimeManagementDaoImpl findByOccurrenceInfoDateTime()

OccurrenceDataDateTimeManagementMapper findByOccurrenceInfoDateTime()

위와 같이 SQL 문을 작성해 주었는데, SQL Select 문을 통해 최초 max()를 사용하여 조건을 만족하는 레코드들 중에서 data_created_date_time_id 열 (PK)의 최대값을 찾도록 하여 주었어요.

왜냐하면 많은 이용자가 요청했을 때, 중복되는 일시가 많을 수도 있을 것이고, 그랬을 때, max()를 쓰지 않으면 여러 PK 값이 조회 되기 때문이에요.

주니는 data_created_date_time 테이블에서 특정 날짜와 시간에 해당하는 data_created_date와 data_created_time의 조건을 만족하는 레코드들 중에서 data_created_date_time_id 열의 최대값을 가져오고 싶어 위와 같이 SQL문을 작성해 주었어요.

이 때, #{createdDate}와 #{createdTime}은 SQL 쿼리의 매개 변수로 실제 실행될 때, 이러한 매개 변수를 실제 값으로 바인딩하여 쿼리가 실행되고, 이렇게 하면 동적으로 원하는 날짜와 시간에 해당하는 PK의 최대값을 얻을 수 있어요.

결과적으로 createdDate가 2023-07-16이고, createdTime이 12:00:00라고 가정할 때, 해당 쿼리는 "2023-07 -16" 날짜와 "12:00:00" 시간에 해당하는 레코드들 중에서 PK 값의 최대값을 반환하게 될 거에요.

 

ConnectedUserInfoServiceImpl 199 ~ 229 번째 줄

다시 이 곳으로 돌아와서 데이터 베이스에서 조회된 PK값이 있는지를 확인하고, 없다면 해당 접속 일시를 데이터 베이스에 저장하기 위한 로직을 구현해 주었어요.

위와 마찬가지로 저장 성공하면 저장 레코드의 PK 값을 반환하고, 데이터 베이스 조회 시 PK 값이 있었을 땐 그 PK 값이 반환 되도록 처리해 주었어요.

 

OccurrenceDataDateTimeManagementDao save()

OccurrenceDataDateTimeManagementDaoImpl save()

참고로 DAO에서 한가지 로직이 있는데, 데이터 베이스에 저장한 뒤 반환된 PK 값이 Null이거나, 0인지를 확인하고, 아니라면 DataCreatedDateTimeVo에 저장된 PK 값을 반환하게 해 주었고, 맞다면 Custom Exception이 터지게 해 주었어요.

 

OccurrenceDataDateTimeManagementMapper save()

OccurenceDataDateTimeManagementMapper.xml

서버 저장때와 마찬가지로 PK 값이 반환되도록 하면서 접속 일시가 저장되도록 해 주었는데, 16번째 줄 부터 18번째 줄에 내용은 MyBatis를 이용해서 새로운 레코드를 데이터 베이스에 삽입할 때, 자동으로 생성된 PK 값을 가져오기 위해 작성한 부분이에요.

∙ <selectKey>: MyBatis의 SQL 매퍼에서 자동 생성된 PK 값을 가져오기 위해 사용하는 태그.
                            INSERT 문 실행 뒤 특정 SQL문을 실행하여 자동 생성된 PK 값 조회를 위해 사용.
∙ keyProperty: 이 속성은 가져온 PK 값을 매핑할 자바 객체의 프로퍼티 지정.
∙ resultType: 가져온 PK 값을 매핑할 자바 객체 데이터 타입 지정.
                        위 코드에서는 java.lang.Long 즉, Long wrapper 자료형 타입으로 PK 값 반환.
∙ order="AFTER": 이 속성은 자동 생성된 PK 값을 조회하는 SQL 문 실행 순서 지정.
                                 AFTER 설정 시 INSERT 문이 실행된 뒤에 SELECT LAST_INSERT_ID() 실행.
∙ SELECT LAST_INSERT_ID(): MySQL 계열 데이터 베이스에서 자동 생성된 PK 값 조회 함수.
                                                      LAST_INSERT_ID()는 직전 삽입된 자동 생성된 PK 값을 반환하며,
                                                      이 값은 주로 AUTO_INCREMENT 등과 같은 자동 증가 키를 가진 테이블에서 사용.

 

 

 

processUserInfoSave()

이번에는 요청 이용자 정보를 저장하는 메소드에 대해 분석해 볼게요.

ConnetedUserInfoServiceImpl 231 ~ 266번째 줄

해당 메소드는 요청 이용자 정보를 담은 ConnectedUserInfoSaveRequestDto 객체와 내부 서버 정보 PK 값, 접속 일시 PK값을 매개 변수로 받고 있어요.

242 ~ 251번째 줄까지 각각의 매개 변수로 전달된 값에 대한 Null Check를 진행하고, Null이 아니라면 252번째 줄 부터 로직이 진행되요.

 최초 이용자 IP를 이용해서 해당 이용자 정보가 이미 데이터 베이스에 저장 되어 있는지를 확인하는 로직을 구현해 주었어요.
이 때,  전달된 IP 문자열에 Double Quotation(쌍 따옴표)에 감싸져 있기 때문에 해당 특수문자를 지우기 위해 replace()를 사용하여 주었어요.

 

UserInfoDatoImpl findByUserIP()

UserManagementMapper findByUserIP()

위와 같이 이용자 IP 주소를 통해서 conneted_user 테이블에 값을 조회하는데, 이 때, PK 값을 가져오게 하고, 동일 IP가 여러개 조회될 수 있기 때문에 마지막 값을 가져오기 위해 max()를 사용해 주었어요.

이렇게 조회된 PK 값을 반환하도록 해 주었답니다.

 

ConnetedUserInfoServiceImpl 231 ~ 266번째 줄

 

다시 비즈니스 로직 부분을 보면 256번째 줄에 if문을 통해 이용자 IP를 이용해서 조회된 PK 값이 있는지를 확인하고, 없다면 ConnectedUserInfoSaveRequestDto에 저장된 정보를 암호화 하여 ConnectedUserInfoVo.toVo()를 통해 Value Object로 변환하고, 이를 UserInfoDAO의 connectedUserSave()에 전달해 주었고, 저장이 완료되면 반환된 PK 값을 반환하게 해 주었어요.

UserInfoDaoImpl connectedUserSave()

 

UserManagementMapper connectedUserSave()

 

UserManagementMapper.xml 1 ~ 19번째 줄

위와 같이 접속 이용자 정보를 데이터 베이스에 저장할 수 있도록 해 주었어요.

ConnectedUserInfoServiceImpl 268 ~ 278번째 줄

만약 이용자 접속 IP를 데이터 베이스에서 조회했을 때, 값이 조회된다면 해당 else 절을 타게 되고, 이 때는 기존에 저장 되어 있던 요청 이용자 정보를 Update 하기 위한 로직을 구현해 두었어요.

최초 UpdateUserInfo 객체를 만드는데, 이 때, 데이터 베이스에서 조회된 이용자 IP 주소에 해당 하는 PK 값과 접속 일시 저장 PK 값을 매개 변수로 전달해 주었어요.

그리고, 데이터 베이스 로직이 끝나면 해당 PK 값을 반환할 수 있도록 해 주었어요.

UpdateUserInfo.java

위 클래스는 이용자 접속 정보에 대한 PK 값과 접속 일시 PK 값을 담고 있는 객체에요.

이렇게 만들어진 UpdateUserInfo 객체를 데이터 베이스에서 처리하기 위해 매개 별수로 전달해 주었어요.

UserInfoDaoImpl updateCount()

해당 로직은 동일 정보로 요청을 날린 이용자가 있을 때, 이용자 정보를 데이터 베이스에 중복 저장하지 않고, 접속 횟수를 카운트하기 위한 것이에요.

Mapper를 통해 반환된 Update된 데이터 PK 값이 Null인지를 확인하고, Null이 아니면 해당 PK 값을 반환해 줍니다.

UserManagementMapper updateCount()

UserManagementMapper.xml 43 ~ 53번째 줄

위와 같이 Update SQL문을 사용하여 updateUserInfo 객체에 담긴 요청 이용자 정보 PK 값에 해당하는 connected_user_count 레코드를 1 증가 시켜 주도록 해 주었어요.

그런 뒤 48번째 줄에서 updateUserInfo 객체에 저장된 접속 일시가 Null 이거나, 비어 있는지 확인하고, 아니라면 마지막 접속 일시 정보로 업데이트 하기 위해 data_created_date_time_id 레코드 값을 새로 전달된 값으로 바꿔 주었어요. 

 

 

 

processUserRequestInfoSave()

마지막으로 요청 이용자 요청 정보 저장을 위한 메소드에 대해 분석해 볼게요.

ConnectedUserInfoServiceImpl 280 ~ 317 번째

해당 메소드는 요청 이용자 요청 정보를 담은 Dto와 이용자 요청 일시 PK 값, 접속 이용자 정보 PK 값을 매개 변수로 받고 있어요.

290 ~ 302번째 줄까지 각각의 매개 변수에 대해 Null Check를 진행하게 되고, Null이 아니라면 302번째 줄에 else 절을 타게 되요.

그런 뒤 내부 서버 정보 PK 값, 이용자 요청 일시 정보 PK 값, 요청 이용자 정보 PK 값, 요청 헤더, 쿠키, 요청 파라미터, 요청 바디값을 ConnectedUserRequestInfoSaveRequestDto에 담고, 305번째 줄에 데이터 베이스 저장을 위해 Value Object로 변환한 뒤 이를 DAO의 findByRequestInfoSave()로 전달해 주었어요.

UserInfoDaoImpl findByRequestInfoSave()

UserManagementMapper findByRequestInfoSave()

 

 

위와 같이 Insert 문을 이용해서 저장해 준 뒤 저장된 레코드의 PK 값을 반환하게 해 주었어요.

 

 

 

 

 

    🔽  테스트 코드 분석

        📦 ConnectedUserInfoControllerTest

위에서 작성한 비즈니스 로직에 대한 테스트 코드를 살펴볼게요.

package com.giggalpeople.backoffice.api.user.service.impl;

import static com.giggalpeople.backoffice.api.user.model.dto.enumtype.UserInfoSearchType.CONNECTED_USER_REQUEST_ID;
import static com.giggalpeople.backoffice.common.enumtype.CrewGrade.GENERAL_CREW;
import static com.giggalpeople.backoffice.common.enumtype.CrewGrade.TEAM_LEADER;
import static com.giggalpeople.backoffice.common.enumtype.ErrorCode.NOT_EXIST_CONNECTED_USER;
import static com.giggalpeople.backoffice.common.enumtype.ErrorCode.NO_AUTHORIZATION;
import static com.giggalpeople.backoffice.common.enumtype.ErrorCode.PARAMETER_NULL;
import static org.assertj.core.api.Assertions.assertThat;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertThrows;

import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
import java.util.stream.IntStream;

import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.MethodOrderer;
import org.junit.jupiter.api.Order;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.TestMethodOrder;
import org.junit.jupiter.api.extension.ExtendWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.jdbc.Sql;
import org.springframework.test.context.junit.jupiter.SpringExtension;
import org.springframework.transaction.annotation.Transactional;

import com.giggalpeople.backoffice.api.common.database.dao.OccurrenceDataDateTimeManagementDao;
import com.giggalpeople.backoffice.api.common.model.Criteria;
import com.giggalpeople.backoffice.api.common.model.dto.request.DataCreatedDateTimeRequestDto;
import com.giggalpeople.backoffice.api.common.model.vo.DataCreatedDateTimeVo;
import com.giggalpeople.backoffice.api.server.database.dao.ServerInfoDao;
import com.giggalpeople.backoffice.api.server.model.dto.request.ServerInfoSaveRequestDto;
import com.giggalpeople.backoffice.api.server.model.vo.ServerInfoVo;
import com.giggalpeople.backoffice.api.user.database.dao.UserInfoDao;
import com.giggalpeople.backoffice.api.user.exception.ConnectedUserException;
import com.giggalpeople.backoffice.api.user.model.dto.enumtype.UserInfoSearchType;
import com.giggalpeople.backoffice.api.user.model.dto.request.ConnectedUserInfoSaveRequestDto;
import com.giggalpeople.backoffice.api.user.model.dto.request.UserInfoDetailSearchRequestDto;
import com.giggalpeople.backoffice.api.user.model.dto.request.UserInfoSearchDto;
import com.giggalpeople.backoffice.api.user.model.dto.request.UserRequestTotalInfoSaveRequestDto;
import com.giggalpeople.backoffice.api.user.model.dto.response.UserInfoDetailResponseDto;
import com.giggalpeople.backoffice.api.user.model.dto.response.UserInfoListResponseDto;
import com.giggalpeople.backoffice.api.user.model.vo.ConnectedUserInfoVo;
import com.giggalpeople.backoffice.api.user.request_info.model.dto.request.ConnectedUserRequestInfoSaveRequestDto;
import com.giggalpeople.backoffice.api.user.request_info.model.vo.UserRequestInfoVo;
import com.giggalpeople.backoffice.api.user.service.ConnectedUserInfoService;
import com.giggalpeople.backoffice.common.constant.DefaultListResponse;
import com.giggalpeople.backoffice.common.constant.DefaultResponse;
import com.giggalpeople.backoffice.common.database.DataBaseManagerMapper;
import com.giggalpeople.backoffice.common.entity.ServerInfo;
import com.giggalpeople.backoffice.common.enumtype.GiggalPeopleServerNames;
import com.giggalpeople.backoffice.common.env.exception.ServerInfoException;

@TestMethodOrder(MethodOrderer.OrderAnnotation.class)
@ExtendWith(SpringExtension.class)
@SpringBootTest
@Sql(executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD, scripts = "classpath:/init/database/schema.sql")
@Sql(executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD, scripts = "classpath:/init/database/data.sql")
class ConnectedUserInfoServiceImplTest {

	@Autowired
	ConnectedUserInfoService connectedUserInfoService;

	@Autowired
	UserInfoDao userInfoDAO;

	@Autowired
	ServerInfoDao serverInfoDAO;

	@Autowired
	OccurrenceDataDateTimeManagementDao occurrenceDataDateTimeManagementDAO;

	@Autowired
	DataBaseManagerMapper dataBaseManagerMapper;

	DataCreatedDateTimeVo dataCreatedDateTimeVo;

	ServerInfo serverInfo;
	ServerInfoVo serverInfoVo;

	ConnectedUserInfoVo userInfoVO;

	UserInfoSearchDto searchForUserId;

	UserInfoSearchDto searchForUserConnectedDateRange;

	UserInfoSearchDto searchForUserConnectedDate;

	UserInfoSearchDto searchForServerName;

	UserInfoSearchDto searchForServerIp;

	UserInfoSearchDto searchForUserIp;

	DataCreatedDateTimeRequestDto dataCreatedDateTimeRequestDto;

	ServerInfoSaveRequestDto serverInfoSaveRequestDto;

	ConnectedUserInfoSaveRequestDto connectedUserInfoSaveRequestDto;

	ConnectedUserRequestInfoSaveRequestDto connectedUserRequestInfoSaveRequestDto;

	UserRequestInfoVo userRequestInfoVo;

	UserRequestTotalInfoSaveRequestDto userRequestTotalInfoSaveRequestDto;

	UserInfoDetailSearchRequestDto userInfoDetailSearchRequestDto;

	Criteria criteria;

	List<UserInfoListResponseDto> userInfoList;

	@BeforeEach
	void beforeTestSetup() {
		this.userRequestTotalInfoSaveRequestDto = initializedMockModels();

		initializedMockSearchRequestDto();
	}

	/**
	 * <b>가짜 검색 요청 DTO를 만들기 위한 Method</b>
	 */
	private void initializedMockSearchRequestDto() {
		SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
		String[] splitNowDateTime = simpleDateFormat.format(new Date(System.currentTimeMillis())).split(" ");

		initializedMockSearchUserIdRequestDto();
		initializedMockSearchUserConnectedDateRangeRequestDto(splitNowDateTime[0]);
		initializedMockSearchUserConnectedDateRequestDto(splitNowDateTime[0]);
		initializedMockSearchServerNameRequestDto();
		initializedMockSearchServerIpRequestDto();
		initializedMockSearchUserIpRequestDto();
		initializedMockDetailRequestDto();
		initializedMockCriteria();
		initializedMockUserInfo(splitNowDateTime);
	}

	@Test
	@Order(0)
	@DisplayName("요청 이용자 정보 Data Base 저장 테스트")
	void save() {
		//given
		DefaultResponse<Map<String, Long>> responseInfo = connectedUserInfoService.save(
			userRequestTotalInfoSaveRequestDto);

		//when
		System.out.println("응답 값 : " + responseInfo);

		//then
		assertThat(responseInfo.getStatusCode()).isEqualTo(201);
		assertThat(responseInfo.getMessage()).isEqualTo("생성 성공");
	}

	@Test
	@Order(1)
	@DisplayName("요청 이용자 정보 Data Base 저장 시 내부 서버 정보 Null 값 입력으로 인한 문제 테스트")
	void causedByServerInfoSaveFailure() {
		//given
		UserRequestTotalInfoSaveRequestDto userRequestTotalInfoSaveRequestErrorStatusDto = createErrorStatusDto(
			"serverInfo");
		//when
		ServerInfoException serverInfoException = assertThrows(ServerInfoException.class, () -> {
			connectedUserInfoService.save(
				userRequestTotalInfoSaveRequestErrorStatusDto);
		});

		// then
		assertEquals(PARAMETER_NULL.getMessage(String.valueOf(NullPointerException.class)),
			serverInfoException.getMessage());
	}

	@Test
	@Order(2)
	@DisplayName("요청 이용자 정보 Data Base 저장 시 Data 발생 일시 Null 값 입력으로 인한 문제 테스트")
	void causedByOccurrenceDateTimeSaveFailure() {
		//given
		UserRequestTotalInfoSaveRequestDto userRequestTotalInfoSaveRequestErrorStatusDto = createErrorStatusDto(
			"occurrenceDateTime");
		//when
		ConnectedUserException connectedUserException = assertThrows(ConnectedUserException.class, () -> {
			connectedUserInfoService.save(
				userRequestTotalInfoSaveRequestErrorStatusDto);
		});

		// then
		assertEquals(PARAMETER_NULL.getMessage(String.valueOf(NullPointerException.class)),
			connectedUserException.getMessage());
	}

	@Test
	@Order(3)
	@DisplayName("요청 이용자 정보 Data Base 저장 시 요청 이용자 정보 Null로 인한 문제 테스트")
	void causedByUserInfoSaveFailure() {
		//given
		UserRequestTotalInfoSaveRequestDto userRequestTotalInfoSaveRequestErrorStatusDto = createErrorStatusDto(
			"userInfo");
		//when
		ConnectedUserException connectedUserException = assertThrows(ConnectedUserException.class, () -> {
			connectedUserInfoService.save(
				userRequestTotalInfoSaveRequestErrorStatusDto);
		});

		// then
		assertEquals(PARAMETER_NULL.getMessage(String.valueOf(NullPointerException.class)),
			connectedUserException.getMessage());
	}

	@Test
	@Order(4)
	@DisplayName("요청 이용자 정보 Data Base 저장 시 이용자 요청 정보 Null로 인한 문제 테스트")
	void causedByUserRequestInfoSaveFailure() {
		//given
		UserRequestTotalInfoSaveRequestDto userRequestTotalInfoSaveRequestErrorStatusDto = createErrorStatusDto(
			"userInfo");
		//when
		ConnectedUserException connectedUserException = assertThrows(ConnectedUserException.class, () -> {
			connectedUserInfoService.save(
				userRequestTotalInfoSaveRequestErrorStatusDto);
		});

		// then
		assertEquals(PARAMETER_NULL.getMessage(String.valueOf(NullPointerException.class)),
			connectedUserException.getMessage());
	}

	@Test
	@Order(5)
	@DisplayName("요청 이용자 정보 Data Base 저장 시 저장 DTO 값 Null 일 경우 문제 테스트")
	void saveNotNull() {
		//given
		//when
		ConnectedUserException connectedUserException = Assertions.assertThrows(ConnectedUserException.class,
			() -> connectedUserInfoService.save(null));

		//then
		assertEquals(PARAMETER_NULL.getMessage(), connectedUserException.getMessage());
	}

	@Test
	@Order(6)
	@DisplayName("Application 요청 이용자 및 요청 정보 기본 목록 조회 테스트")
	@Transactional
	void toDiscordAllUserInfoFind() {
		//given
		IntStream.rangeClosed(1, 11).forEach(count -> {
			System.out.println(
				"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));
		});

		UserInfoSearchDto userInfoSearchDto = new UserInfoSearchDto();
		userInfoSearchDto.setInputSearchType(null);
		userInfoSearchDto.setSearchWord(null);

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			criteria, userInfoSearchDto);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(7)
	@DisplayName("Application 요청 이용자 정보 및 요청 정보 기본 목록 조회 시 결과 하나 테스트")
	@Sql(executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD, scripts = "classpath:/init/database/schema.sql")
	void toDiscordAllUserInfoFindOneThing() {
		//given
		dataBaseManagerMapper.initializeAutoIncrement("log");
		dataBaseManagerMapper.initializeAutoIncrement("connected_user_request_info");
		dataBaseManagerMapper.initializeAutoIncrement("connected_user");
		dataBaseManagerMapper.initializeAutoIncrement("server_info");
		dataBaseManagerMapper.initializeAutoIncrement("data_created_date_time");

		System.out.println(
			"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));

		UserInfoSearchDto userInfoSearchDto = new UserInfoSearchDto();
		userInfoSearchDto.setInputSearchType(null);
		userInfoSearchDto.setSearchWord(null);

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			criteria, userInfoSearchDto);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(8)
	@DisplayName("Application 요청 이용자 정보 및 요청 정보 Paging 처리 목록 조회 테스트")
	@Transactional
	void toDiscordAllUserInfoFindPaging() {
		//given
		IntStream.rangeClosed(1, 11).forEach(count -> {
			System.out.println(
				"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));
		});

		Criteria requestPaging = new Criteria();
		requestPaging.setPage(3);
		requestPaging.setPerPageNum(5);

		UserInfoSearchDto userInfoSearchDto = new UserInfoSearchDto();
		userInfoSearchDto.setInputSearchType(null);
		userInfoSearchDto.setSearchWord(null);

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			requestPaging, userInfoSearchDto);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
		assertThat(responseInfo.getPagination().getCriteria().getPage()).isEqualTo(3);
		assertThat(responseInfo.getPagination().getCriteria().getPerPageNum()).isEqualTo(5);
		assertThat(responseInfo.getPagination().getTotalCount()).isEqualTo(11);
	}

	@Test
	@Order(9)
	@DisplayName("요청 이용자 정보 및 요청 정보 목록 조회 시 검색 결과 없을 때, 문제 사항 테스트")
	@Transactional
	@Sql(executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD, scripts = "classpath:/init/database/schema.sql")
	void totalSearchNotFound() {
		//given
		dataBaseManagerMapper.initializeAutoIncrement("log");
		dataBaseManagerMapper.initializeAutoIncrement("connected_user_request_info");
		dataBaseManagerMapper.initializeAutoIncrement("connected_user");
		dataBaseManagerMapper.initializeAutoIncrement("server_info");
		dataBaseManagerMapper.initializeAutoIncrement("data_created_date_time");

		UserInfoSearchDto userInfoSearchDto = new UserInfoSearchDto();
		userInfoSearchDto.setInputSearchType(null);
		userInfoSearchDto.setSearchWord(null);

		//when
		ConnectedUserException connectedUserException = Assertions.assertThrows(ConnectedUserException.class,
			() -> connectedUserInfoService.toDiscordAllUserInfoFind(criteria, userInfoSearchDto));

		//then
		assertEquals(NOT_EXIST_CONNECTED_USER.getMessage(), connectedUserException.getMessage());
	}

	@Test
	@Order(10)
	@DisplayName("요청 이용자 정보 및 요청 정보 목록 조회 시 이용자 순서 번호를 통해 검색 테스트")
	void totalUserInfoIdSearch() {
		//given
		IntStream.rangeClosed(1, 11).forEach(count -> {
			System.out.println(
				"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));
		});

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			criteria, searchForUserId);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(11)
	@DisplayName("요청 이용자 정보 및 요청 정보 목록 조회 시 접속일 범위를 통해 검색 했을 때, 일치하는 Data가 몇 개 있는지 알기 위한 테스트")
	void totalUserInfoConnectedDateRangeSearchCount() {
		//given
		IntStream.rangeClosed(1, 11).forEach(count -> {
			System.out.println(
				"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));
		});

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			criteria, searchForUserConnectedDateRange);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(12)
	@DisplayName("요청 이용자 정보 및 요청 정보 목록 조회 시 접속일 검색 했을 때, 일치하는 Data가 몇 개 있는지 알기 위한 테스트")
	void totalUserInfoConnectedDateSearchCount() {
		//given
		IntStream.rangeClosed(1, 11).forEach(count -> {
			System.out.println(
				"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));
		});

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			criteria, searchForUserConnectedDate);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(13)
	@DisplayName("요청 이용자 정보 및 요청 정보 목록 조회 시 내부 서버 이름 검색 했을 때, 일치하는 Data가 몇 개 있는지 알기 위한 테스트")
	void totalUserInfoServerNameSearchCount() {
		//given
		IntStream.rangeClosed(1, 11).forEach(count -> {
			System.out.println(
				"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));
		});

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			criteria, searchForServerName);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(14)
	@DisplayName("요청 이용자 정보 및 요청 정보 목록 조회 시 내부 서버 IP 검색 했을 때, 일치하는 Data가 몇 개 있는지 알기 위한 테스트")
	void totalUserInfoServerIpSearchCount() {
		//given
		IntStream.rangeClosed(1, 11).forEach(count -> {
			System.out.println(
				"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));
		});

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			criteria, searchForServerIp);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(9)
	@DisplayName("요청 이용자 정보 및 요청 정보 목록 조회 시 이용자 IP 검색 했을 때, 일치하는 Data가 몇 개 있는지 알기 위한 테스트")
	void totalUserInfoUserIpSearchCount() {
		//given
		System.out.println(
			"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(
				userRequestTotalInfoSaveRequestDto));

		//when
		DefaultListResponse<List<UserInfoListResponseDto>> responseInfo = connectedUserInfoService.toDiscordAllUserInfoFind(
			criteria, this.searchForUserIp);

		//then
		System.out.println("Paging 처리 결과 : " + responseInfo.getPagination());
		System.out.println("Data Base에서 찾은 Data 내역 : " + responseInfo.getData());
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(15)
	@DisplayName("요청 이용자 정보 및 요청 정보 검색 목록 조회 시 검색 결과 없을 때, 문제 사항 테스트")
	@Transactional
	@Sql(executionPhase = Sql.ExecutionPhase.BEFORE_TEST_METHOD, scripts = "classpath:/init/database/schema.sql")
	void totalUserInfoSearchNotFound() {
		//given
		dataBaseManagerMapper.initializeAutoIncrement("log");
		dataBaseManagerMapper.initializeAutoIncrement("connected_user_request_info");
		dataBaseManagerMapper.initializeAutoIncrement("connected_user");
		dataBaseManagerMapper.initializeAutoIncrement("server_info");
		dataBaseManagerMapper.initializeAutoIncrement("data_created_date_time");

		//when
		ConnectedUserException connectedUserException = Assertions.assertThrows(ConnectedUserException.class,
			() -> connectedUserInfoService.toDiscordAllUserInfoFind(criteria, searchForUserIp));

		//then
		assertEquals(NOT_EXIST_CONNECTED_USER.getMessage(), connectedUserException.getMessage());
	}

	@Test
	@Order(16)
	@DisplayName("요청 이용자 정보 및 요청 정보 상세 조회 테스트")
	void toDiscordDetailConnectedUserInfoFind() {
		//given
		System.out.println(
			"Service Logic 저장 상태 여부 확인 : " + connectedUserInfoService.save(userRequestTotalInfoSaveRequestDto));

		UserInfoDetailSearchRequestDto userInfoDetailSearchRequestDto = new UserInfoDetailSearchRequestDto();
		userInfoDetailSearchRequestDto.setConnectedUserRequestInfoID("1");
		userInfoDetailSearchRequestDto.setCrewGrade(TEAM_LEADER);

		//when
		DefaultResponse<UserInfoDetailResponseDto> responseInfo = connectedUserInfoService.toDiscordDetailConnectedUserInfoFind(
			userInfoDetailSearchRequestDto);

		//then
		assertThat(responseInfo.getStatusCode()).isEqualTo(200);
		assertThat(responseInfo.getMessage()).isEqualTo("성공");
	}

	@Test
	@Order(17)
	@DisplayName("요청 이용자 정보 및 요청 정보 상세 조회 시 권한 없는 크루가 조회 요청 시 문제 테스트")
	void toDiscordDetailConnectedUserInfoUnAuthorizedFind() {
		//given
		UserInfoDetailSearchRequestDto userInfoDetailSearchRequestDto = new UserInfoDetailSearchRequestDto();
		userInfoDetailSearchRequestDto.setConnectedUserRequestInfoID("1");
		userInfoDetailSearchRequestDto.setCrewGrade(GENERAL_CREW);

		//when
		ConnectedUserException connectedUserException = Assertions.assertThrows(ConnectedUserException.class,
			() -> connectedUserInfoService.toDiscordDetailConnectedUserInfoFind(userInfoDetailSearchRequestDto));

		//then
		assertEquals(NO_AUTHORIZATION.getMessage(), connectedUserException.getMessage());
	}

	@Test
	@Order(18)
	@DisplayName("요청 이용자 정보 및 요청 정보 상세 조회 시 결과 값 없을 때, 문제 테스트")
	void toDiscordDetailConnectedUserInfoNotFind() {
		//given
		UserInfoDetailSearchRequestDto userInfoDetailSearchRequestDto = new UserInfoDetailSearchRequestDto();
		userInfoDetailSearchRequestDto.setConnectedUserRequestInfoID("99999999");
		userInfoDetailSearchRequestDto.setCrewGrade(TEAM_LEADER);

		//when
		ConnectedUserException connectedUserException = Assertions.assertThrows(ConnectedUserException.class,
			() -> connectedUserInfoService.toDiscordDetailConnectedUserInfoFind(userInfoDetailSearchRequestDto));

		//then
		assertEquals(NOT_EXIST_CONNECTED_USER.getMessage(), connectedUserException.getMessage());
	}

	/**
	 * <b>이용자 정보 저장 간 관계 테이블 정보 저장 시 문제를 발생 시킬 요인을 만들 Method</b>
	 * @param errorCause 각 Test Case에서 상황별로 동작할 수 있게 이용할 Keyword
	 * @return 이용자 정보 저장을 위한 문제 있는 요청 DTO
	 */
	private UserRequestTotalInfoSaveRequestDto createErrorStatusDto(String errorCause) {
		switch (errorCause) {
			case "serverInfo":
				return UserRequestTotalInfoSaveRequestDto.builder()
					.serverInfo(null)
					.dataCreatedDateTimeRequestDTO(dataCreatedDateTimeRequestDto)
					.connectedUserInfoSaveRequestDTO(connectedUserInfoSaveRequestDto)
					.connectedUserRequestInfoSaveRequestDTO(connectedUserRequestInfoSaveRequestDto)
					.build();
			case "occurrenceDateTime":
				return UserRequestTotalInfoSaveRequestDto.builder()
					.serverInfo(serverInfo)
					.dataCreatedDateTimeRequestDTO(null)
					.connectedUserInfoSaveRequestDTO(connectedUserInfoSaveRequestDto)
					.connectedUserRequestInfoSaveRequestDTO(connectedUserRequestInfoSaveRequestDto)
					.build();
			case "userInfo":
				return UserRequestTotalInfoSaveRequestDto.builder()
					.serverInfo(serverInfo)
					.dataCreatedDateTimeRequestDTO(dataCreatedDateTimeRequestDto)
					.connectedUserInfoSaveRequestDTO(null)
					.connectedUserRequestInfoSaveRequestDTO(connectedUserRequestInfoSaveRequestDto)
					.build();
			default:
				return UserRequestTotalInfoSaveRequestDto.builder()
					.serverInfo(serverInfo)
					.dataCreatedDateTimeRequestDTO(dataCreatedDateTimeRequestDto)
					.connectedUserInfoSaveRequestDTO(connectedUserInfoSaveRequestDto)
					.connectedUserRequestInfoSaveRequestDTO(null)
					.build();
		}
	}

	/**
	 * <b>Test에 사용될 DTO, VO를 만들기 위한 Method</b>
	 * @return 이용자 요청 정보와 서버 정보 등을 포함한 요청 DTO 객체
	 */
	private UserRequestTotalInfoSaveRequestDto initializedMockModels() {
		this.dataCreatedDateTimeVo = initializedCreateDateTime();
		this.serverInfoVo = initializedServerInfo();
		this.userInfoVO = initializedConnectedUserInfo();
		this.userRequestInfoVo = initializedConnectedUserRequestInfo();

		return UserRequestTotalInfoSaveRequestDto.builder()
			.serverInfo(serverInfo)
			.dataCreatedDateTimeRequestDTO(dataCreatedDateTimeRequestDto)
			.connectedUserInfoSaveRequestDTO(connectedUserInfoSaveRequestDto)
			.connectedUserRequestInfoSaveRequestDTO(connectedUserRequestInfoSaveRequestDto)
			.build();
	}

	/**
	 * <b>이용자 요청 정보를 만들기 위한 Method</b>
	 * @return 이용자 요청 정보 Value Object
	 */
	private UserRequestInfoVo initializedConnectedUserRequestInfo() {
		this.connectedUserRequestInfoSaveRequestDto = ConnectedUserRequestInfoSaveRequestDto.builder()
			.internalServerID(1L)
			.dataCreatedDateTimeID(1L)
			.connectedUserID(1L)
			.userCookiesArray(null)
			.userCookies("내용 없음")
			.requestHeader("\"sec-fetch-mode\" : \"cors\",\n")
			.requestParameter("\"perPageNum\" : \"10\",\n" + "\"displayPageNum\" : \"10\",\n"
				+ "\"inputSearchType\" : \"USER_CONNECTED_DATE\",\n" + "\"endDate\" : \"2023-06-01\",\n"
				+ "\"page\" : \"1\",\n" + "\"startDate\" : \"2023-01-01\"")
			.requestBody("")
			.build();

		return UserRequestInfoVo.toVo(connectedUserRequestInfoSaveRequestDto);
	}

	/**
	 * <b>이용자 접속 정보를 만들기 위한 Method</b>
	 * @return 이용자 요청 정보를 담은 Value Object
	 */
	private ConnectedUserInfoVo initializedConnectedUserInfo() {
		this.connectedUserInfoSaveRequestDto = ConnectedUserInfoSaveRequestDto.builder()
			.internalServerID(1L)
			.dataCreatedDateTimeID(1L)
			.userIP("127.0.0.1")
			.userLocation(
				"\"reason\" : \"ReservedIPAddress\",\n" + "\"reserved\" : \"true\",\n"
					+ "\"ip\" : \"127.0.0.1\",\n"
					+ "\"error\" : \"true\",\n" + "\"version\" : \"IPv4\"\n")
			.userEnvironment("\"Mozilla/5.0\"")
			.build();

		return ConnectedUserInfoVo.toVO(connectedUserInfoSaveRequestDto);
	}

	/**
	 * <b>이용자 접속 및 요청일시를 만들기 위한 Method</b>
	 * @return 접속 및 요청 일시를 담은 Value Object
	 */
	private DataCreatedDateTimeVo initializedCreateDateTime() {
		SimpleDateFormat simpleDateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
		String[] splitNowDateTime = simpleDateFormat.format(new Date(System.currentTimeMillis())).split(" ");

		this.dataCreatedDateTimeRequestDto = DataCreatedDateTimeRequestDto.builder()
			.createdDate(splitNowDateTime[0])
			.createdTime(splitNowDateTime[1])
			.build();

		return DataCreatedDateTimeVo.toVO(dataCreatedDateTimeRequestDto);
	}

	/**
	 * <b>내부 서버 정보 만들기 위한 Method</b>
	 * @return 내부 서버 정보 담은 Value Object
	 */
	private ServerInfoVo initializedServerInfo() {
		this.serverInfo = ServerInfo.builder()
			.serverName(GiggalPeopleServerNames.GIGGAL_TOTAL_BACK_OFFICE.getDescription())
			.vmInfo("OpenJDK 64-Bit")
			.osInfo("Mac OS")
			.serverIP("192.168.20.254")
			.serverEnvironment("dev")
			.build();

		this.serverInfoSaveRequestDto = ServerInfoSaveRequestDto.builder()
			.serverName(serverInfo.getServerName())
			.serverVmInfo(serverInfo.getVmInfo())
			.serverOsInfo(serverInfo.getOsInfo())
			.serverIP(serverInfo.getServerIP())
			.serverEnvironment(serverInfo.getServerEnvironment())
			.build();

		return ServerInfoVo.toVo(serverInfoSaveRequestDto);
	}

	/**
	 * <b>상세 조회 요청 DTO 만들기 위한 Method</b>
	 */
	private void initializedMockDetailRequestDto() {
		this.userInfoDetailSearchRequestDto = new UserInfoDetailSearchRequestDto();
		this.userInfoDetailSearchRequestDto.setConnectedUserRequestInfoID("1");
		this.userInfoDetailSearchRequestDto.setCrewGrade(TEAM_LEADER);
	}

	/**
	 * <b>가짜 이용자 정보를 만들기 위한 Method</b>
	 * @param splitNowDateTime 접속 일시를 공백 기준으로 나누어 담긴 배열
	 */
	private void initializedMockUserInfo(String[] splitNowDateTime) {
		this.userInfoList = new ArrayList<>();
		IntStream.rangeClosed(1, 11).forEach(count -> {
			this.userInfoList.add(UserInfoListResponseDto.builder()
				.connectedUserRequestInfoID((long)count)
				.connectedDateTime(splitNowDateTime[0] + " " + splitNowDateTime[1])
				.serverName(GiggalPeopleServerNames.GIGGAL_TOTAL_BACK_OFFICE.getDescription())
				.userIP("127.0.0." + count)
				.build());
		});
	}

	/**
	 * <b>Paging 처리를 위한 Criteria 객체를 만들기 위한 Method</b>
	 */
	private void initializedMockCriteria() {
		this.criteria = new Criteria();
		this.criteria.setPage(1);
		this.criteria.setPerPageNum(10);
		this.criteria.setPageMoveButtonNum(10);
	}

	/**
	 * <b>이용자 IP 주소를 통해 검색하고자 할 때, 사용하기 위한 요청 객체 DTO</b>
	 */
	private void initializedMockSearchUserIpRequestDto() {
		this.searchForUserIp = new UserInfoSearchDto();
		this.searchForUserIp.setInputSearchType(UserInfoSearchType.USER_IP);
		this.searchForUserIp.setSearchWord("127.0.0.1");
	}

	/**
	 * <b>내부 서버 IP 주소를 통해 검색하고자 할 때, 사용하기 위한 요청 객체 DTO</b>
	 */
	private void initializedMockSearchServerIpRequestDto() {
		this.searchForServerIp = new UserInfoSearchDto();
		this.searchForServerIp.setInputSearchType(UserInfoSearchType.SERVER_IP);
		this.searchForServerIp.setSearchWord("192.168.20.254");
	}

	/**
	 * <b>내부 서버 이름을 통해 검색하고자 할 때, 사용하기 위한 요청 객체 DTO</b>
	 */
	private void initializedMockSearchServerNameRequestDto() {
		this.searchForServerName = new UserInfoSearchDto();
		this.searchForServerName.setInputSearchType(UserInfoSearchType.SERVER_NAME);
		this.searchForServerName.setSearchWord("통합관리서버");
	}

	/**
	 * <b>이용자 접속일 통해 검색하고자 할 때, 사용하기 위한 요청 객체 DTO</b>
	 */
	private void initializedMockSearchUserConnectedDateRequestDto(String searchDate) {
		this.searchForUserConnectedDate = new UserInfoSearchDto();
		this.searchForUserConnectedDate.setInputSearchType(UserInfoSearchType.USER_CONNECTED_DATE);
		this.searchForUserConnectedDate.setDate(searchDate);
	}

	/**
	 * <b>이용자 접속일 범위 검색하고자 할 때, 사용하기 위한 요청 객체 DTO</b>
	 */
	private void initializedMockSearchUserConnectedDateRangeRequestDto(String nowDate) {
		this.searchForUserConnectedDateRange = new UserInfoSearchDto();
		this.searchForUserConnectedDateRange.setInputSearchType(UserInfoSearchType.USER_CONNECTED_DATE);
		this.searchForUserConnectedDateRange.setStartDate("2023-01-01");
		this.searchForUserConnectedDateRange.setEndDate(nowDate);
	}

	/**
	 * <b>이용자 접속 순서 번호 검색하고자 할 때, 사용하기 위한 요청 객체 DTO</b>
	 */
	private void initializedMockSearchUserIdRequestDto() {
		this.searchForUserId = new UserInfoSearchDto();
		this.searchForUserId.setInputSearchType(CONNECTED_USER_REQUEST_ID);
		this.searchForUserId.setSearchWord("1");
	}
}

전체 테스트 코드는 위와 같아요.

최초 클래스 이름 위에 사용한 Annotation 부터 알아볼게요.

∙ @TestMethodOrder(MethodOrderer.OrderAnnotaion.class): 해당 어노테이션은 테스트 메소드의 실행 순서 지정을 위해 사용.
    - MethodOrderer.OrderAnnotaion.class를 사용하면 @Order를 사용하여 테스트 메소드의 실행 순서 지정 가능.

∙ @ExtendWith(SpringExtension.class): JUnit5에서 스프링 테스트 컨텍스트 프레임워크와 JUnit 5를 통합하여 테스트
    수행할 때 명시. 스프링 부트 테스트를 실행할 때, SpringExtension 클래스가 JUnit 5와 함께 사용 되어 스프링 테스트 컨텍스트
     프레임워크와의 통합 지원.

∙ @SpringBootTest: 스프링 부트 애플리케이션의 통합 테스트를 위해 명시. 스프링 부트 애플리케이션 컨텍스트를 로드하여 테스트에 사
    용할 수 있게 하기 위해 사용. 기본적으로 모든 Bean을 로드하지만, 특정 구성 클래스를 지정하여 로드할 수도 있음.
    즉, 실제 애플리케이션을 로컬 위에 올려 Listening Port 주소가 Listening 되어 지고, 실제 데이터 베이스와 연결이 붙어지는 상태에서
    진행되는 Live 테스트를 하기 위해 명시.

즉 위의 어노테이션들은 스프링 테스트 컨텍스트 프레임워크와 JUnit 5를 함께 사용하는 테스트를 위한 설정으로 @TestMethodOrder를 통해 테스트 메소드의 실행 순서를 지정하고, @ExtendWith를 통해
스프링 테스트 컨텍스트 프레임워크와 JUnit 5를 통합하며, @SpringBootTest로 스프링 부트 애플리케이션의 컨텍스트를 로드하여 테스트를 수행하기 위해 사용한 것이에요.

 

ConnectedUserInfoServiceImplTest 120 ~ 125번째 줄

위 코드는 @BeforeEach를 통해 각 테스트 메소드가 실행되기 전에 실행되어야 하는 메소드를 지정하기 위해 사용하여 주었어요.

테스트 클래스 내의 각 테스트 메소드는 독립적으로 실행되어야 하기 때문에, 각 테스트 메소드 실행 전 초기화 작업이나, 설정 작업이 필요할 때 많이 사용한답니다.

해당 어노테이션이 붙은 메소드는 테스트 메소드가 실행되기 전 매번 호출되게 되요. 그렇기 때문에 해당 어노테이션이 적용된 메소드는 테스트 메소드들 간의 독립성을 보장하면서 공통적인 준비 작업에 사용되어야 해요.

주니는 beforeTestSetup()을 통해 initalizedMockModles()를 호출하고, 반환된 값을 인스턴스 변수 userRequestTotalInfoSaveRequestDto에 담아 주었어요.

this는 현재 인스턴스를 가르키는 키워드로 클래스 내부에서 사용되며, 인스턴스 변수와 메소드를 구분하기 위해 사용해요.
주니는 클래스 내부에서 인스턴스 변수에 접근하기 위해 위와 같이 this 키워드를 써 주었는데, 만약 클래스 내의 메소드나, 생성자에서 인스턴스 변수와 지역 변수의 이름이 같아 충돌할 경우 this를 붙여 인스턴스 변수임을 명시하여 구분해 줄 수 있어요.

ConnectedUserInfoServiceImplTest 599 ~ 615번째 줄

해당 메소드는 각 테스트 메소드에서 사용될 DTO와 VO를 만들기 위한 메소드에요.

604 ~ 607번째 줄까지 각각의 VO 객체를 만들기 위한 메소드를 호출하게 되고, 반환되는 객체를 인스턴스 변수로 저장해 주고 있어요.

ConnectedUserInfoServiceImplTest initializedCreateDateTime()

위 메소드는 yyyy-MM-dd 형식의 날짜값 (이용자 요청 날짜값)과 HH:mm:ss 형식의 시간값 (이용자 요청 시간값)을 공백을 기준으로 분리한 뒤 splitNowDateTime 문자열 배열 첫번째에 날짜값을 넣고, 두번째에 시간값을 넣어준 뒤 이를 빌더 패턴을 이용하여 DataCreatedDateTimeRequestDto 객체에 넣어주고, 해당 값을 인스턴스 변수 dataCreatedDateTimeRequestDto에 넣어준 뒤 toVO()를 이용하여 DTO 값을 VO 값으로 변환하여 반환하여 주었어요.

ConnectedUserInfoServiceImplTest initializedServerInfo()

위 메소드는 테스트를 위한 서버 정보를 하드 코딩하여 넣어 주는 부분이에요.

이렇게 해서 686~692번째 줄을 통해 DTO 객체를 만들어 인스턴스 변수에 넣어주고, 694번째 줄에 toVo()를 통해 DTO를 VO로 바꾸어 반환하게 해 주었어요.

ConnectedUserInfoServiceImplTest initializedConnectedUserInfo()

위 메소드는 테스트를 위한 요청 이용자 정보를 담기 위한 정보를 하드 코딩하여 넣어주는 부분이에요.

643 ~ 652번째 줄까지 DTO 객체를 만들어 인스턴스 변수에 넣어주고, 653번째 줄을 통해 VO를 반환하여 주었어요.

ConnectedUserInfoServiceImplTest initializedConnectedUserRequestInfo()

위 메소드 역시 622 ~ 633번째 줄을 통해 하드 코딩하여 이용자의 요청 정보를 DTO 객체에 넣어 객체화 한 뒤 인스턴스 변수에 객체를 넣어주고, 635번째 줄을 통해 VO로 변환하여 반환하여 주었어요.

ConnectedUserInfoServiceImplTest 599 ~ 615번째 줄

다시 이 곳으로 돌아와서 609 ~ 614번째 줄까지 내부 서버 정보를 담은 객체와 요청 일시를 담은 DTO 객체, 요청 이용자 정보를 담은 DTO 객체, 요청 이용자의 요청 정보를 담은 DTO를 UserRequestTotalInfoSaveReqeuestDto 객체에 넣어 최종적으로 반환하도록 하였어요.

ConnectedUserInfoServiceImplTest 120 ~ 125번째 줄

그런 뒤 124번째 줄에 initializedMockSearchRequestDto()를 호출하여 검색 테스트 시 사용할 초기값들을 설정하기 위한 메소드를 호출해 주었어요.



이제 본격적으로 저장 관련 테스트 코드를 분석해 볼게요.

ConnectedUserInfoServiceImplTest save()

위의 테스트 메소드는 JUnit 5를 이용하여 connectedUserInfoService.save()를 테스트 하는 코드에요.

∙ @Test: 해당 메소드가 테스트 메소드임을 명시하기 위해 사용. 해당 어노테이션이 붙은 메소드들은 테스트 실행
    대상으로 인식.

∙ @Order(0): 해당 어노테이션은 테스트 메소드의 실행 순서 지정 시 사용. JUnit 5에서 사용할 수 있는 어노테이션 중
    하나로, 정수 값을 가지며, 값이 작을수록 먼저 실행된다.

∙ @DisplayName(): 해당 어노테이션은 테스트 메소드의 이름을 지정하기 위해 사용. JUnit 5에서는 테스트 메소드의
    이름을 명시적으로 지정하여 더 읽기 쉽고 명확한 이름을 부여할 수 있도록 돕는다. 

∙// given, //when, //then: 테스트 메소드의 테스트 전략 중 하나인 Given-When-Then을 표현한 것으로 테스트 전략은
  주어진 상황(Given)에서 특정 동작(When)을 실행하고, 예상한 결과 (Then)을 검증하는 패턴을 따르겠다는 것을 명시하기
  위해 사용.

∙ assertThat(): 테스트 결과 검증 메소드로 특정 조건을 만족하는지 확인하기 위해 사용. 위 테스트에서는
   responseInfo 객체의 getStatusCode()와 getMessage()를 사용하여 결과값을 검증.

   - isEqualTo(): 검증 메소드 중 하나로 예상한 값과 매개 변수 값이 서로 동일한지 확인하기 위해 사용.
      assertThat(responseInfo.getStatusCode()).isEqualTo(201)는 connectedUserInfoService.save()를 호출하여
      얻어진 반환값이 담긴 responseInfo 변수에 값에 HTTP Status Code가 201인지를 확인하기 위하여 명시.

      assertThat(responseInfo.getMessage()).isEqualTo("생성 성공"): connectedUserInfoService.save()를
      호출하여 얻어진 반환값이 담긴 responseInfo 변수에 값에 Message가 "생성 성공"과 같은지 확인하기 위하여 명시.

 

테스트 성공

위와 같이 테스트 성공하였어요.

ConnectedUserInfoServiceImplTest causedByServerInfoSaveFailure()

위 테스트 메소드는 요청 이용자 정보 데이터 베이스 저장 시 내부 서버 정보가 Null이여서 문제가 발생하는 상황을 테스트 한 것이에요.

166번째 줄을 보면 createErrorStatusDto()를 호출할 때, 문자열 serverInfo를 전달해 주었어요.

ConnectedUserInfoServiceImplTest createErrorStatusDto()

그 이유는 위와 같이 switch 문에서 문자열을 분기하여 처리 하기 때문이에요.

serverInfo 문자열이 전달되면 569 ~ 574번째 줄을 통해 UserRequestTotalInfoSaveRequestDto 객체를 만드는데, 이 때, 서버 정보에 Null 값을 넣어 반환하여 주었어요.

 

ConnectedUserInfoServiceImplTest causedByServerInfoSaveFailure()

다시 위 테스트 메소드로 돌아가서 보면 서버 정보가 Null 값인 UserRequestTotalInfoSaveRequestDto 객체를 가지고, 아래 내용을 처리하여 예외 처리 테스트를 진행한 것이에요.

∙ assertThrows(ServerInfoException.class, () -> {}): 이 메소드는 특정 코드 블록 (() -> {})을 실행할 때,
    지정한 예외가 발생하는지 검증하기 위해 사용. 위 코드에서는 Custom Exception ServerInfoException이 터지는지
    확인하기 위해 사용.

∙ connectedUserInfoService.save(): 메소드를 호출하여 서버 정보가 Null인
    UserRequestTotalInfoSaveRequestErrorSatusDto를 전달하여 이용자 요청 정보 등을 저장하기 위한 시도.

∙ assertThrows 메소드의 반환값: assertThrows는 예외를 받아오거나, 예외가 발생하지 않을 겨우 테스트가 실패하게
   되는데, 해당 예외 객체를 반환하기 위해 사용. 따라서 ServerInfoException이 발생하면 해당 예외 객체
   serverInfoException 변수에 Exception 객체를 담아 저장. 

 

테스트 성공

주니는 위와 같은 방식으로 이용자 요청 접속 일시가 Null일 때, 요청 이용자 정보가 Null일 때, 요청 이용자가 요청한 정보가 Null 일 때, 그리고, UserRequestTotalInfoSaveRequestDto 객체 자체가 Null 일 때를 각각 테스트 하여 주었고,
모두 성공 하였어요.

DAO와 Mapper 테스트 역시 위와 같은 방법으로 테스트를 진행해 주었어요.

 

 

    🔽 테스트

        📦 정상 작동 여부

테스트를 위해 Swagger를 이용해서 이용자 요청 정보 목록을 조회하는 API를 호출해 볼게요.

Target API Controller

대상 Controller 54번째에 주니가 만든 이용자 요청 정보를 수집하는 어노테이션을 명시해 주었어요.

 

지난 글에서 만들었던 API 동작 소요 시간 확인 AOP로 인해 500 Error가 반환된걸 확인 할 수 있어요.

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

 

[2023-07-17] [00:20:43.415] [WARN] 4506 [GlobalAPIExceptionAdvisor.java] handleTimeTraceException (117) : {}
com.giggalpeople.backoffice.common.exception.TimeTraceException: Method 동작 시간 검증 완료 : Warning!! 기준치보다 동작 시간이 높게 측정 되고 있습니다!!execution(DefaultResponse com.giggalpeople.backoffice.api.record.controller.ErrorRecordManagementController.logSave(TotalErrorRecordSaveRequestDto)) Method 동작 시간은 606ms (0.606)초 입니다.
	at com.giggalpeople.backoffice.common.aop.TimeTraceAop.longTimeExceptionHandler(TimeTraceAop.java:130)
	at com.giggalpeople.backoffice.common.aop.TimeTraceAop.execute(TimeTraceAop.java:61)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at org.springframework.aop.aspectj.AbstractAspectJAdvice.invokeAdviceMethodWithGivenArgs(AbstractAspectJAdvice.java:634)
	at org.springframework.aop.aspectj.AbstractAspectJAdvice.invokeAdviceMethod(AbstractAspectJAdvice.java:624)
	at org.springframework.aop.aspectj.AspectJAroundAdvice.invoke(AspectJAroundAdvice.java:72)
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:175)
	at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.proceed(CglibAopProxy.java:763)
	at org.springframework.aop.interceptor.ExposeInvocationInterceptor.invoke(ExposeInvocationInterceptor.java:97)
	at org.springframework.aop.framework.ReflectiveMethodInvocation.proceed(ReflectiveMethodInvocation.java:186)
	at org.springframework.aop.framework.CglibAopProxy$CglibMethodInvocation.proceed(CglibAopProxy.java:763)
	at org.springframework.aop.framework.CglibAopProxy$DynamicAdvisedInterceptor.intercept(CglibAopProxy.java:708)
	at com.giggalpeople.backoffice.api.record.controller.ErrorRecordManagementController$$EnhancerBySpringCGLIB$$1c2d7a41.logSave(<generated>)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
	at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
	at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
	at java.base/java.lang.reflect.Method.invoke(Method.java:566)
	at org.springframework.web.method.support.InvocableHandlerMethod.doInvoke(InvocableHandlerMethod.java:205)
	at org.springframework.web.method.support.InvocableHandlerMethod.invokeForRequest(InvocableHandlerMethod.java:150)
	at org.springframework.web.servlet.mvc.method.annotation.ServletInvocableHandlerMethod.invokeAndHandle(ServletInvocableHandlerMethod.java:117)
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.invokeHandlerMethod(RequestMappingHandlerAdapter.java:895)
	at org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter.handleInternal(RequestMappingHandlerAdapter.java:808)
	at org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter.handle(AbstractHandlerMethodAdapter.java:87)
	at org.springframework.web.servlet.DispatcherServlet.doDispatch(DispatcherServlet.java:1071)
	at org.springframework.web.servlet.DispatcherServlet.doService(DispatcherServlet.java:964)
	at org.springframework.web.servlet.FrameworkServlet.processRequest(FrameworkServlet.java:1006)
	at org.springframework.web.servlet.FrameworkServlet.doPost(FrameworkServlet.java:909)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:696)
	at org.springframework.web.servlet.FrameworkServlet.service(FrameworkServlet.java:883)
	at javax.servlet.http.HttpServlet.service(HttpServlet.java:779)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:227)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
	at org.apache.tomcat.websocket.server.WsFilter.doFilter(WsFilter.java:53)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
	at com.giggalpeople.backoffice.common.filter.MDCFilter.doFilterInternal(MDCFilter.java:47)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
	at com.giggalpeople.backoffice.common.filter.ServletWrappingFilter.doFilterInternal(ServletWrappingFilter.java:26)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
	at org.springframework.web.filter.RequestContextFilter.doFilterInternal(RequestContextFilter.java:100)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
	at org.springframework.web.filter.FormContentFilter.doFilterInternal(FormContentFilter.java:93)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
	at org.springframework.web.filter.CharacterEncodingFilter.doFilterInternal(CharacterEncodingFilter.java:201)
	at org.springframework.web.filter.OncePerRequestFilter.doFilter(OncePerRequestFilter.java:117)
	at org.apache.catalina.core.ApplicationFilterChain.internalDoFilter(ApplicationFilterChain.java:189)
	at org.apache.catalina.core.ApplicationFilterChain.doFilter(ApplicationFilterChain.java:162)
	at org.apache.catalina.core.StandardWrapperValve.invoke(StandardWrapperValve.java:177)
	at org.apache.catalina.core.StandardContextValve.invoke(StandardContextValve.java:97)
	at org.apache.catalina.authenticator.AuthenticatorBase.invoke(AuthenticatorBase.java:541)
	at org.apache.catalina.core.StandardHostValve.invoke(StandardHostValve.java:135)
	at org.apache.catalina.valves.ErrorReportValve.invoke(ErrorReportValve.java:92)
	at org.apache.catalina.core.StandardEngineValve.invoke(StandardEngineValve.java:78)
	at org.apache.catalina.connector.CoyoteAdapter.service(CoyoteAdapter.java:360)
	at org.apache.coyote.http11.Http11Processor.service(Http11Processor.java:399)
	at org.apache.coyote.AbstractProcessorLight.process(AbstractProcessorLight.java:65)
	at org.apache.coyote.AbstractProtocol$ConnectionHandler.process(AbstractProtocol.java:891)
	at org.apache.tomcat.util.net.NioEndpoint$SocketProcessor.doRun(NioEndpoint.java:1784)
	at org.apache.tomcat.util.net.SocketProcessorBase.run(SocketProcessorBase.java:49)
	at org.apache.tomcat.util.threads.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1191)
	at org.apache.tomcat.util.threads.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:659)
	at org.apache.tomcat.util.threads.TaskThread$WrappingRunnable.run(TaskThread.java:61)
	at java.base/java.lang.Thread.run(Thread.java:829)

 

Server 정보

 

이용자 요청 날짜와 시각

 

요청 이용자 정보

요청 이용자 요청 정보

요청 이용자 정보와 요청 정보는 위와 같이 암호화 되서 저장되는 것을 확인할 수 있어요.

요청 이용자 정보 목록 조회

API 소요 시간 확인 부분에 Exception 처리 부를 주석하고 위와 같이 호출해보면 데이터 베이스 값이 나오는 걸 확인할 수 있어요.

이용자 상세 조회

상세 조회를 하면 위와 같이 이용자 접속 정보를 확인할 수 있답니다.

 

 

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

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