[Merge] main 브랜치로 병합

.gitignore

@@ -45,4 +45,7 @@ out/
 **/._.DS_Store
 
 application.yml
-build.gradle
+build.gradle
+
+/jacoco/**
+/jacoco/

README.md

@@ -177,3 +177,5 @@ feat/issue_num          feat/issue_num
     <summary>회고</summary>
     https://www.notion.so/bside/3f4a3606067143fbb54bd5e584afe762
 </details>
+
+

build.gradle

@@ -2,6 +2,42 @@ plugins {
 	id 'java'
 	id 'org.springframework.boot' version '3.3.2'
 	id 'io.spring.dependency-management' version '1.1.6'
+	id 'jacoco'
+}
+
+test {
+	useJUnitPlatform()
+	finalizedBy jacocoTestReport // test 작업이 끝나고 jacocoTestReport를 실행
+}
+
+jacoco {
+	toolVersion = '0.8.8'
+}
+
+jacocoTestReport {
+	reports {
+		html.required = true
+		xml.required = false
+		csv.required = false
+
+		html.destination file("jacoco/jacocoHtml")
+		xml.destination file("jacoco/jacoco.xml")
+	}
+
+	// dependsOn : 이 작업에 지정된 종속성을 추가
+	dependsOn test // jacocoTestReport 에 test라는 종속성을 추가
+	finalizedBy 'jacocoTestCoverageVerification'
+}
+
+jacocoTestCoverageVerification {
+	violationRules {
+
+		rule {
+			enabled = true
+			//코드 버커리지 체크 기준
+			element = 'CLASS'
+		}
+	}
 }
 
 group = 'com.softeer'
@@ -43,100 +79,9 @@ dependencies {
 	//DatatypeConverter
 	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
 
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
-	// Google Simple JSON
-	implementation "com.googlecode.json-simple:json-simple:1.1.1"
-
-	//DatatypeConverter
-	implementation group: 'javax.xml.bind', name: 'jaxb-api', version: '2.1'
-
 	// JPA 설정
 	implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
 
-
 	// MySql 설정
 	runtimeOnly 'com.mysql:mysql-connector-j'
 
@@ -152,6 +97,12 @@ dependencies {
 	// Bcrypt 설정
 	implementation 'org.mindrot:jbcrypt:0.4'
 
+	// Spring Cache 설정
+	implementation 'org.springframework.boot:spring-boot-starter-cache'
+
+	// Caffeine Cache 설정
+	implementation 'com.github.ben-manes.caffeine:caffeine:3.1.8'
+
 	compileOnly 'org.projectlombok:lombok'
 	annotationProcessor 'org.projectlombok:lombok'
 	testImplementation 'org.springframework.boot:spring-boot-starter-test'

src/main/java/com/softeer/backend/BackendApplication.java

@@ -3,6 +3,7 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.ConfigurationPropertiesScan;
+import org.springframework.cache.annotation.EnableCaching;
 import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
 import org.springframework.scheduling.annotation.EnableScheduling;
 

src/main/java/com/softeer/backend/bo_domain/admin/controller/AdminLoginController.java

@@ -1,5 +1,7 @@
 package com.softeer.backend.bo_domain.admin.controller;
 
+import com.softeer.backend.bo_domain.admin.dto.DrawSettingTestRequestDto;
+import com.softeer.backend.bo_domain.admin.dto.FcfsSettingTestRequestDto;
 import com.softeer.backend.bo_domain.admin.dto.login.AdminLoginRequestDto;
 import com.softeer.backend.bo_domain.admin.dto.login.AdminSignUpRequestDto;
 import com.softeer.backend.bo_domain.admin.service.AdminLoginService;
@@ -14,27 +16,38 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+/**
+ * 어드민 계정 로그인 및 로그아웃을 관리하는 컨트롤러 클래스
+ */
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/admin")
 public class AdminLoginController {
-
     private final AdminLoginService adminLoginService;
 
+    /**
+     * 어드민 계정 로그인을 처리하는 메서드
+     */
     @PostMapping("/login")
     ResponseDto<JwtTokenResponseDto> handleLogin(@Valid @RequestBody AdminLoginRequestDto adminLoginRequestDto) {
         JwtTokenResponseDto jwtTokenResponseDto = adminLoginService.handleLogin(adminLoginRequestDto);
 
         return ResponseDto.onSuccess(jwtTokenResponseDto);
     }
 
+    /**
+     * 어드민 계정 로그아웃을 처리하는 메서드
+     */
     @PostMapping("/logout")
     ResponseDto<Void> handleLogout(@Parameter(hidden = true) @AuthInfo Integer adminId) {
         adminLoginService.handleLogout(adminId);
 
         return ResponseDto.onSuccess();
     }
 
+    /**
+     * 어드민 계정 회원가입을 처리하는 메서드
+     */
     @PostMapping("/signup")
     ResponseDto<Void> handleSignUp(@Valid @RequestBody AdminSignUpRequestDto adminSignUpRequestDto) {
 
@@ -43,5 +56,25 @@ ResponseDto<Void> handleSignUp(@Valid @RequestBody AdminSignUpRequestDto adminSi
         return ResponseDto.onSuccess();
     }
 
+    /**
+     * 선착순 설정 정보를 바로 반영하게 하는 테스트용 메서드
+     */
+    @PostMapping("/fcfs/test")
+    ResponseDto<Void> setFcfsSetting(@RequestBody FcfsSettingTestRequestDto fcfsSettingTestRequestDto) {
+
+        adminLoginService.setFcfsSetting(fcfsSettingTestRequestDto);
+
+        return ResponseDto.onSuccess();
+    }
 
+    /**
+     * 추첨 설정 정보를 바로 반영하게 하는 테스트용 메서드
+     */
+    @PostMapping("/draw/test")
+    ResponseDto<Void> setDrawSetting(@RequestBody DrawSettingTestRequestDto drawSettingTestRequestDto) {
+
+        adminLoginService.setDrawSetting(drawSettingTestRequestDto);
+
+        return ResponseDto.onSuccess();
+    }
 }

src/main/java/com/softeer/backend/bo_domain/admin/controller/EventPageController.java

@@ -9,27 +9,38 @@
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
 
+/**
+ * 어드민 페이지의 이벤트 관리 컨트롤러 클래스
+ */
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/admin/event")
 public class EventPageController {
-
     private final EventPageService eventPageService;
 
+    /**
+     * 이벤트 페이지의 동적 정보 조회하는 메서드
+     */
     @GetMapping
     public ResponseDto<EventPageResponseDto> getEventPage() {
         EventPageResponseDto eventPageResponseDto = eventPageService.getEventPage();
 
         return ResponseDto.onSuccess(eventPageResponseDto);
     }
 
+    /**
+     * 선착순 이벤트의 시간 관련 속성을 업데이트하는 메서드
+     */
     @PostMapping("/fcfs")
     public ResponseDto<Void> updateFcfsEventTime(@Valid @RequestBody FcfsEventTimeRequestDto fcfsEventTimeRequestDto) {
         eventPageService.updateFcfsEventTime(fcfsEventTimeRequestDto);
 
         return ResponseDto.onSuccess();
     }
 
+    /**
+     * 추첨 이벤트의 시간 관련 속성을 업데이트하는 메서드
+     */
     @PostMapping("/draw")
     public ResponseDto<Void> updateDrawEventTime(@Valid @RequestBody DrawEventTimeRequestDto drawEventTimeRequestDto) {
         eventPageService.updateDrawEventTime(drawEventTimeRequestDto);

src/main/java/com/softeer/backend/bo_domain/admin/controller/IndicatorPageController.java

@@ -8,13 +8,19 @@
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+/**
+ * 어드민 페이지의 이벤트 지표를 처리하는 컨트롤러 클래스
+ */
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/admin")
 public class IndicatorPageController {
 
     private final IndicatorPageService indicatorPageService;
 
+    /**
+     * 이벤트 지표 데이터를 조회하는 메서드
+     */
     @GetMapping("/indicator")
     public ResponseDto<EventIndicatorResponseDto> getEventIndicator() {
         EventIndicatorResponseDto eventIndicatorResponseDto = indicatorPageService.getEventIndicator();

src/main/java/com/softeer/backend/bo_domain/admin/controller/WinnerPageController.java

@@ -1,26 +1,34 @@
 package com.softeer.backend.bo_domain.admin.controller;
 
-import com.softeer.backend.bo_domain.admin.dto.event.EventPageResponseDto;
 import com.softeer.backend.bo_domain.admin.dto.winner.*;
 import com.softeer.backend.bo_domain.admin.service.WinnerPageService;
 import com.softeer.backend.global.common.response.ResponseDto;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
 
+/**
+ * 어드민 페이지의 당첨 관리 페이지를 처리하는 컨트롤러 클래스
+ */
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/admin/winner")
 public class WinnerPageController {
     private final WinnerPageService winnerPageService;
 
+    /**
+     * 당첨 관리 페이지의 정보를 반환하는 메서드
+     */
     @GetMapping
     public ResponseDto<WinnerPageResponseDto> getWinnerPage() {
         WinnerPageResponseDto winnerPageResponseDto = winnerPageService.getWinnerPage();
 
         return ResponseDto.onSuccess(winnerPageResponseDto);
     }
 
+    /**
+     * 특정 라운드의 선착순 이벤트 당첨자를 반환하는 메서드
+     */
     @GetMapping("/fcfs/{round}")
     public ResponseDto<FcfsWinnerListResponseDto> getFcfsWinnerList(@PathVariable Integer round) {
 
@@ -29,6 +37,9 @@ public ResponseDto<FcfsWinnerListResponseDto> getFcfsWinnerList(@PathVariable In
         return ResponseDto.onSuccess(fcfsWinnerListResponseDto);
     }
 
+    /**
+     * 특정 등수의 추첨 이벤트 당첨자를 반환하는 메서드
+     */
     @GetMapping("/draw/{rank}")
     public ResponseDto<DrawWinnerListResponseDto> getDrawWinnerList(@PathVariable Integer rank) {
 
@@ -37,6 +48,9 @@ public ResponseDto<DrawWinnerListResponseDto> getDrawWinnerList(@PathVariable In
         return ResponseDto.onSuccess(drawWinnerListResponseDto);
     }
 
+    /**
+     * 선착순 당첨자 수를 수정하는 메서드
+     */
     @PostMapping("/fcfs")
     public ResponseDto<Void> updateFcfsWinnerNum(@Valid @RequestBody FcfsWinnerUpdateRequestDto fcfsWinnerUpdateRequestDto) {
 
@@ -45,13 +59,14 @@ public ResponseDto<Void> updateFcfsWinnerNum(@Valid @RequestBody FcfsWinnerUpdat
         return ResponseDto.onSuccess();
     }
 
+    /**
+     * 추첨 당첨자 수를 수정하는 메서드
+     */
     @PostMapping("/draw")
     public ResponseDto<Void> updateFcfsWinnerNum(@Valid @RequestBody DrawWinnerUpdateRequestDto drawWinnerUpdateRequestDto) {
 
         winnerPageService.updateDrawWinnerNum(drawWinnerUpdateRequestDto);
 
         return ResponseDto.onSuccess();
     }
-
-
 }

src/main/java/com/softeer/backend/bo_domain/admin/domain/Admin.java

@@ -6,6 +6,9 @@
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 
+/**
+ * 어드민 계정 정보 엔티티 클래스
+ */
 @Entity
 @NoArgsConstructor
 @AllArgsConstructor