Merge pull request #392 from 6QuizOnTheBlock/be/feat/#391-Code-smell-…

…refactoring

Be/feat/#391 code smell refactoring

backEnd/src/main/java/com/quiz/ourclass/domain/member/controller/MemberController.java

@@ -1,15 +1,21 @@
 package com.quiz.ourclass.domain.member.controller;
 
 import com.quiz.ourclass.domain.member.controller.docs.MemberControllerDocs;
+import com.quiz.ourclass.domain.member.dto.TokenDTO;
 import com.quiz.ourclass.domain.member.dto.request.DefaultImageRequest;
 import com.quiz.ourclass.domain.member.dto.request.DeveloperAtRtRequest;
 import com.quiz.ourclass.domain.member.dto.request.MemberSignInRequest;
 import com.quiz.ourclass.domain.member.dto.request.MemberSignUpRequest;
 import com.quiz.ourclass.domain.member.dto.request.MemberUpdateRequest;
 import com.quiz.ourclass.domain.member.dto.request.UpdateFcmTokenRequest;
+import com.quiz.ourclass.domain.member.dto.response.DefaultImagesResponse;
+import com.quiz.ourclass.domain.member.dto.response.MemberMeResponse;
+import com.quiz.ourclass.domain.member.dto.response.MemberUpdateResponse;
+import com.quiz.ourclass.domain.member.dto.response.OIDCPublicKeysResponse;
 import com.quiz.ourclass.domain.member.service.MemberService;
 import com.quiz.ourclass.domain.member.service.client.KakaoOicdClient;
 import com.quiz.ourclass.domain.quiz.dto.request.QuizStartRequest;
+import com.quiz.ourclass.domain.quiz.dto.response.QuizStartResponse;
 import com.quiz.ourclass.global.dto.MemberSimpleDTO;
 import com.quiz.ourclass.global.dto.ResultResponse;
 import io.swagger.v3.oas.annotations.Parameter;
@@ -26,7 +32,6 @@
 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.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
 @RestController
@@ -41,37 +46,31 @@ public class MemberController implements MemberControllerDocs {
     /*  1. 회원가입   */
     @PostMapping(value = "/", consumes = {MediaType.APPLICATION_JSON_VALUE,
         MediaType.MULTIPART_FORM_DATA_VALUE})
-    public ResponseEntity<ResultResponse<?>> signUp(@ModelAttribute MemberSignUpRequest request) {
+    public ResponseEntity<ResultResponse<TokenDTO>> signUp(
+        @ModelAttribute MemberSignUpRequest request) {
         return ResponseEntity.ok(ResultResponse.success(memberService.signUpProcess(request)));
     }
 
     /*  2. 로그인    */
     @PostMapping("/sign-in")
 
-    public ResponseEntity<ResultResponse<?>> signIn(@RequestBody MemberSignInRequest request) {
+    public ResponseEntity<ResultResponse<TokenDTO>> signIn(
+        @RequestBody MemberSignInRequest request) {
 
         return ResponseEntity.ok(ResultResponse.success(memberService.signInProcess(request)));
     }
 
     /* 4. 테스트용  */
     @GetMapping("/kakao-keys")
-    public ResponseEntity<ResultResponse<?>> getKakaoKeys() {
+    public ResponseEntity<ResultResponse<OIDCPublicKeysResponse>> getKakaoKeys() {
 
         return ResponseEntity.ok(ResultResponse.success(kakaoOicdClient.getKakaoOIDCOpenKeys()));
     }
 
-    /* 5. id-Token 받아서 Decoding 하기 */
-    @PostMapping("/decode-id-token")
-    public ResponseEntity<ResultResponse<?>> decodeIdToken(@RequestParam String idToken) {
-        log.info(idToken);
-//        return ResponseEntity.ok(ResultResponse.success(oicdUtil.getUnsignedTokenClaims(idToken,"https://kauth.kakao.com", "edbf10bd8627e6eb676872109e996a9e")));
-        return null;
-    }
-
-
     /* 6 개발자용 Access, RefreshToken 발급 */
     @PostMapping("/developer-At")
-    public ResponseEntity<ResultResponse<?>> getAtRt(@RequestBody DeveloperAtRtRequest request) {
+    public ResponseEntity<ResultResponse<TokenDTO>> getAtRt(
+        @RequestBody DeveloperAtRtRequest request) {
 
         return ResponseEntity.ok(
             ResultResponse.success(memberService.giveDeveloperAccessToken(request)));
@@ -88,7 +87,7 @@ public ResponseEntity<ResultResponse<Void>> saveFcmToken(
     /* 8. 기본 이미지 업데이트 */
 
     @PatchMapping("/default-image")
-    public ResponseEntity<ResultResponse<?>> updateDefaultImage(
+    public ResponseEntity<ResultResponse<String>> updateDefaultImage(
         @ModelAttribute DefaultImageRequest request) {
         return ResponseEntity.ok(
             ResultResponse.success(memberService.updateDefaultImage(request).getPhoto()));
@@ -97,39 +96,39 @@ public ResponseEntity<ResultResponse<?>> updateDefaultImage(
     /* 8. 기본 이미지 조회 */
 
     @GetMapping("/default-image")
-    public ResponseEntity<ResultResponse<?>> getDefaultImages() {
+    public ResponseEntity<ResultResponse<DefaultImagesResponse>> getDefaultImages() {
         return ResponseEntity.ok(ResultResponse.success(memberService.getDefaultImages()));
     }
 
     /* 9. 현 유저의 회원 정보 주기 */
     @GetMapping("/")
-    public ResponseEntity<ResultResponse<?>> rememberMe() {
+    public ResponseEntity<ResultResponse<MemberMeResponse>> rememberMe() {
 
         return ResponseEntity.ok(
             ResultResponse.success(memberService.rememberMe()));
     }
 
     /* 10. 멤버 프로필 이미지 수정 */
     @PatchMapping("/photo")
-    public ResponseEntity<ResultResponse<?>> updateProfile(
+    public ResponseEntity<ResultResponse<MemberUpdateResponse>> updateProfile(
         @ModelAttribute MemberUpdateRequest request) {
         return ResponseEntity.ok(ResultResponse.success(memberService.updateProfile(request)));
     }
 
     @PostMapping("/start")
-    public ResponseEntity<ResultResponse<?>> certificatingUser(
+    public ResponseEntity<ResultResponse<QuizStartResponse>> certificatingUser(
         @RequestBody QuizStartRequest request) {
         return ResponseEntity.ok(ResultResponse.success(memberService.certificatingUser(request)));
     }
 
     @DeleteMapping("/")
-    public ResponseEntity<ResultResponse<?>> deleteMe() {
+    public ResponseEntity<ResultResponse<Void>> deleteMe() {
         memberService.deleteMe();
         return ResponseEntity.ok(ResultResponse.success(null));
     }
 
     @GetMapping("/{id}")
-    public ResponseEntity<ResultResponse<?>> select(
+    public ResponseEntity<ResultResponse<MemberSimpleDTO>> select(
         @Parameter(name = "id", description = "멤버 PK 값", required = true, in = ParameterIn.PATH)
         @PathVariable(value = "id") Long id
     ) {

backEnd/src/main/java/com/quiz/ourclass/domain/member/controller/docs/MemberControllerDocs.java

@@ -1,12 +1,16 @@
 package com.quiz.ourclass.domain.member.controller.docs;
 
+import com.quiz.ourclass.domain.member.dto.TokenDTO;
 import com.quiz.ourclass.domain.member.dto.request.DefaultImageRequest;
 import com.quiz.ourclass.domain.member.dto.request.MemberSignInRequest;
 import com.quiz.ourclass.domain.member.dto.request.MemberSignUpRequest;
 import com.quiz.ourclass.domain.member.dto.request.MemberUpdateRequest;
 import com.quiz.ourclass.domain.member.dto.request.UpdateFcmTokenRequest;
+import com.quiz.ourclass.domain.member.dto.response.DefaultImagesResponse;
+import com.quiz.ourclass.domain.member.dto.response.MemberMeResponse;
 import com.quiz.ourclass.domain.member.dto.response.MemberUpdateResponse;
 import com.quiz.ourclass.domain.quiz.dto.request.QuizStartRequest;
+import com.quiz.ourclass.domain.quiz.dto.response.QuizStartResponse;
 import com.quiz.ourclass.global.dto.MemberSimpleDTO;
 import com.quiz.ourclass.global.dto.ResultResponse;
 import io.swagger.v3.oas.annotations.Operation;
@@ -40,7 +44,7 @@ public interface MemberControllerDocs {
                 description = "OIDC 토큰 인증에 실패했습니다.")
         })
     @PostMapping
-    ResponseEntity<ResultResponse<?>> signUp(MemberSignUpRequest request);
+    ResponseEntity<ResultResponse<TokenDTO>> signUp(MemberSignUpRequest request);
 
 
     @Operation(summary = "로그인",
@@ -55,7 +59,7 @@ public interface MemberControllerDocs {
                 description = "OIDC 토큰 인증에 실패했습니다.")
         })
     @PostMapping
-    ResponseEntity<ResultResponse<?>> signIn(MemberSignInRequest request);
+    ResponseEntity<ResultResponse<TokenDTO>> signIn(MemberSignInRequest request);
 
     @Operation(summary = "FCM 토큰 저장 및 갱신",
         description = "입력으로 들어오는 FCM 토큰을 저장 및 갱신 합니다.",
@@ -74,8 +78,17 @@ ResponseEntity<ResultResponse<Void>> saveFcmToken(
                 description = "기본 이미지 조회에 성공하였습니다."
             )
         })
+    @GetMapping("/default-image")
+    public ResponseEntity<ResultResponse<DefaultImagesResponse>> getDefaultImages();
+
+    @Operation(summary = "기본 이미지 정보 수정",
+        responses = {
+            @ApiResponse(responseCode = "200",
+                description = "기본 이미지 수정에 성공하였습니다."
+            )
+        })
     @PatchMapping("/default-image")
-    public ResponseEntity<ResultResponse<?>> updateDefaultImage(
+    public ResponseEntity<ResultResponse<String>> updateDefaultImage(
         @ModelAttribute DefaultImageRequest request);
 
     @Operation(summary = "현 유저의 회원정보 가져오기",
@@ -84,7 +97,7 @@ public ResponseEntity<ResultResponse<?>> updateDefaultImage(
                 description = "유저 정보 확인에 성공하였습니다.")
         })
     @GetMapping("/")
-    public ResponseEntity<ResultResponse<?>> rememberMe();
+    public ResponseEntity<ResultResponse<MemberMeResponse>> rememberMe();
 
     @Operation(summary = "프로필 이미지 수정",
         responses = {
@@ -94,7 +107,8 @@ public ResponseEntity<ResultResponse<?>> updateDefaultImage(
     )
 
     @PatchMapping("/photo")
-    public ResponseEntity<ResultResponse<?>> updateProfile(MemberUpdateRequest request);
+    public ResponseEntity<ResultResponse<MemberUpdateResponse>> updateProfile(
+        MemberUpdateRequest request);
 
     @Operation(summary = "멤버 조회", description = "ID 값에 해당하는 멤버 Simple 정보(id, name, iamgeUrl)를 조회합니다.",
         responses = {
@@ -104,14 +118,15 @@ public ResponseEntity<ResultResponse<?>> updateDefaultImage(
         }
     )
     @GetMapping("{id}")
-    ResponseEntity<ResultResponse<?>> select(
+    ResponseEntity<ResultResponse<MemberSimpleDTO>> select(
 
         @PathVariable(value = "id") Long id
     );
 
     @PostMapping("/start")
-    public ResponseEntity<ResultResponse<?>> certificatingUser(QuizStartRequest request);
+    public ResponseEntity<ResultResponse<QuizStartResponse>> certificatingUser(
+        QuizStartRequest request);
 
     @DeleteMapping("/")
-    public ResponseEntity<ResultResponse<?>> deleteMe();
+    public ResponseEntity<ResultResponse<Void>> deleteMe();
 }

backEnd/src/main/java/com/quiz/ourclass/domain/member/dto/request/MemberSignInRequest.java

@@ -1,6 +1,5 @@
 package com.quiz.ourclass.domain.member.dto.request;
 
-import lombok.Builder;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
 

backEnd/src/main/java/com/quiz/ourclass/domain/member/service/OidcService.java

@@ -3,13 +3,10 @@
 import com.quiz.ourclass.domain.member.dto.OIDCDecodePayload;
 import com.quiz.ourclass.domain.member.dto.OIDCPublicKeyDTO;
 import com.quiz.ourclass.domain.member.dto.response.OIDCPublicKeysResponse;
-import com.quiz.ourclass.domain.member.repository.MemberRepository;
 import com.quiz.ourclass.domain.member.service.client.KakaoOicdClient;
 import com.quiz.ourclass.domain.member.service.oidc.OidcUtilImpl;
 import com.quiz.ourclass.global.exception.ErrorCode;
 import com.quiz.ourclass.global.exception.GlobalException;
-import io.jsonwebtoken.Claims;
-import io.jsonwebtoken.Jws;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Value;
@@ -31,20 +28,23 @@ public class OidcService {
     private final KakaoOicdClient kakaoOicdClient;
 
     /*
-    * 1. 유효성 검증
-    * (1) 토큰 디코딩 -> (2) kid 값 알아내기 -> (3) kid 이용, RSA key 재료 얻어내기 -> RSA를 통한 유효성 검증
-    * */
+     * 1. 유효성 검증
+     * (1) 토큰 디코딩 -> (2) kid 값 알아내기 -> (3) kid 이용, RSA key 재료 얻어내기 -> RSA를 통한 유효성 검증
+     * */
 
-    public OIDCDecodePayload certificatingIdToken (String idToken)  {
+    public OIDCDecodePayload certificatingIdToken(String idToken) {
 
         // 해당 토큰의 서명 인증 할 수 있는 공개 키의 id (kid) 특정
         String kid = oicdUtil.getKidFromUnsignedTokenHeader(idToken, iss, aud);
         // 카카오 인증 서버에서 이번 주기에 사용한 공개키 목록 전체 받아오기 -> 캐시화 필요!!! 너무 많이 요청하면 차단 당함!
         OIDCPublicKeysResponse keys = kakaoOicdClient.getKakaoOIDCOpenKeys();
         // 이번 주에 카카오가 제공하는 공개키 중에 내 Resource Owner 의 id-token 인증 가능한 key 받아오기
-        OIDCPublicKeyDTO nowKey = keys.getKeys().stream().filter(key -> key.getKid().equals(kid)).findFirst().orElseThrow(null);
+        OIDCPublicKeyDTO nowKey = keys.getKeys().stream().filter(key -> key.getKid().equals(kid))
+            .findFirst().orElseThrow(null);
 
-        if(nowKey == null) throw new GlobalException(ErrorCode.CERTIFICATION_FAILED);
+        if (nowKey == null) {
+            throw new GlobalException(ErrorCode.CERTIFICATION_FAILED);
+        }
 
         // 해당 키로 서명 인증, 예외 안 터지고 인증 되면 Body 가져옴
         return oicdUtil.getOIDCTokenBody(idToken, nowKey.getN(), nowKey.getE());

backEnd/src/main/java/com/quiz/ourclass/domain/quiz/controller/QuizController.java

@@ -1,9 +1,12 @@
 package com.quiz.ourclass.domain.quiz.controller;
 
 import com.quiz.ourclass.domain.quiz.controller.docs.QuizControllerDocs;
+import com.quiz.ourclass.domain.quiz.dto.GamerDTO;
+import com.quiz.ourclass.domain.quiz.dto.QuizGameDTO;
 import com.quiz.ourclass.domain.quiz.dto.request.MakingQuizRequest;
 import com.quiz.ourclass.domain.quiz.service.QuizServiceImpl;
 import com.quiz.ourclass.global.dto.ResultResponse;
+import java.util.List;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.http.ResponseEntity;
@@ -23,24 +26,25 @@ public class QuizController implements QuizControllerDocs {
     public final QuizServiceImpl quizService;
 
     @PutMapping("")
-    public ResponseEntity<ResultResponse<?>> makingQuiz(@RequestBody MakingQuizRequest request) {
+    public ResponseEntity<ResultResponse<Void>> makingQuiz(@RequestBody MakingQuizRequest request) {
         quizService.makingQuiz(request);
         return ResponseEntity.ok(ResultResponse.success(null));
     }
 
     @GetMapping("/{orgId}")
-    public ResponseEntity<ResultResponse<?>> getQuizList(@PathVariable("orgId") long orgId) {
+    public ResponseEntity<ResultResponse<List<QuizGameDTO>>> getQuizList(
+        @PathVariable("orgId") long orgId) {
         return ResponseEntity.ok(ResultResponse.success(quizService.getQuizList(orgId)));
     }
 
     @GetMapping("/code/{quizGameId}")
-    public ResponseEntity<ResultResponse<?>> getQuizUrl(
+    public ResponseEntity<ResultResponse<String>> getQuizUrl(
         @PathVariable("quizGameId") long quizGameId) {
         return ResponseEntity.ok(ResultResponse.success(quizService.getQuizUrl(quizGameId)));
     }
 
     @GetMapping("/ranking/{quizGameId}")
-    public ResponseEntity<ResultResponse<?>> getRanking(
+    public ResponseEntity<ResultResponse<List<GamerDTO>>> getRanking(
         @PathVariable("quizGameId") long quizGameId) {
         return ResponseEntity.ok(ResultResponse.success(quizService.getRanking(quizGameId)));
     }

backEnd/src/main/java/com/quiz/ourclass/domain/quiz/controller/docs/QuizControllerDocs.java

@@ -1,5 +1,6 @@
 package com.quiz.ourclass.domain.quiz.controller.docs;
 
+import com.quiz.ourclass.domain.quiz.dto.GamerDTO;
 import com.quiz.ourclass.domain.quiz.dto.QuizGameDTO;
 import com.quiz.ourclass.domain.quiz.dto.request.MakingQuizRequest;
 import com.quiz.ourclass.global.dto.ResultResponse;
@@ -8,6 +9,7 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.tags.Tag;
+import java.util.List;
 import org.springframework.http.ResponseEntity;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -27,7 +29,7 @@ public interface QuizControllerDocs {
                 """, content = @Content)
         })
     @PutMapping("")
-    public ResponseEntity<ResultResponse<?>> makingQuiz(@RequestBody MakingQuizRequest request);
+    public ResponseEntity<ResultResponse<Void>> makingQuiz(@RequestBody MakingQuizRequest request);
 
 
     @Operation(summary = "퀴즈 리스트 불러오기",
@@ -38,7 +40,8 @@ public interface QuizControllerDocs {
                 content = @Content)
         })
     @GetMapping("/{orgId}")
-    public ResponseEntity<ResultResponse<?>> getQuizList(@PathVariable("orgId") long orgId);
+    public ResponseEntity<ResultResponse<List<QuizGameDTO>>> getQuizList(
+        @PathVariable("orgId") long orgId);
 
     @Operation(summary = "퀴즈 URL 생성 및 전송",
         responses = {
@@ -53,7 +56,7 @@ public interface QuizControllerDocs {
             @ApiResponse(responseCode = "403", description = "(message : \"해당 퀴즈의 [URL]을 생성할 권한이 없습니다.\")")
         })
     @GetMapping("/code/{quizGameId}")
-    public ResponseEntity<ResultResponse<?>> getQuizUrl(
+    public ResponseEntity<ResultResponse<String>> getQuizUrl(
         @PathVariable("quizGameId") long quizGameId);
 
     @Operation(summary = "퀴즈 게임 실시간 랭킹 보기",
@@ -62,6 +65,6 @@ public ResponseEntity<ResultResponse<?>> getQuizUrl(
                 content = @Content),
             @ApiResponse(responseCode = "400", description = "(message : \"해당 퀴즈는 종료되었습니다.\")")
         })
-    public ResponseEntity<ResultResponse<?>> getRanking(
+    public ResponseEntity<ResultResponse<List<GamerDTO>>> getRanking(
         @PathVariable("quizGameId") long quizGameId);
 }

backEnd/src/main/java/com/quiz/ourclass/domain/quiz/mapper/QuizGameMapper.java

@@ -23,7 +23,7 @@ public interface QuizGameMapper {
     @Transactional
     Quiz toQuiz(QuizGame quizGame, QuizDTO quizDTO);
 
-    QuizGameDTO toQuizGameDTO(QuizGame QuizGame);
+    QuizGameDTO toQuizGameDTO(QuizGame quizGame);
 
     FcmDTO toFcmDTO(String title, String body);
 

backEnd/src/main/java/com/quiz/ourclass/domain/quiz/service/QuizReceive.java

@@ -63,11 +63,12 @@ public void receivedQuestion(QuestionRequest request) {
     @KafkaListener(topics = ConstantUtil.QUIZ_ANSWER, containerFactory = "answerResponseContainerFactory")
     public void receivedAnswer(AnswerResponse response) {
         log.info("보내줘야할 답 상세={}", response.toString());
-
-        if (response.submit().replaceAll(" ", "").equals(response.ans().replaceAll(" ", ""))) {
+        // replaceAll 은 항상 정규 표현식을 컴파일하므로 성능 오버헤드가 발생할 수 있음
+        // replaceAll 은 정규 표현식을 사용하여 문자열을 대체하지만, replace는 정규 표현식을 사용하지 않고 단순히 문자열을 대체
+        if (response.submit().replace(" ", "").equals(response.ans().replaceAll(" ", ""))) {
 
             log.info(String.valueOf(
-                response.submit().replaceAll(" ", "").equals(response.ans().replaceAll(" ", ""))));
+                response.submit().replace(" ", "").equals(response.ans().replaceAll(" ", ""))));
 
             int score =
                 redisUtil