Merge pull request #25 from moodTRBL/main

로깅 가독성 증가, 자동완성 swagger 문서 추가

Author: moodTRBL

.idea/discord.xml

@@ -16,6 +16,7 @@ import org.springframework.web.bind.annotation.RequestMapping
 class MemberController @Autowired constructor(
     private val memberService: MemberService
 ) : MemberControllerSwagger {
+
     @PostMapping("/sign-in")
     override fun signIn(
         @RequestBody signInRequest: SignInRequest

src/main/kotlin/com/deterior/domain/member/controller/MemberController.kt

@@ -18,21 +18,20 @@ import org.springframework.web.bind.annotation.RequestMapping
 @RequestMapping("/api/auto-complete")
 class AutoCompleteController @Autowired constructor(
     private val autoCompleteService: AutoCompleteService
-) {
+) : AutoCompleteSwagger {
     @GetMapping("/get-string/{input}")
-    fun getAutoCompleteString(
+    override fun getAutoCompleteString(
         @PathVariable input: String,
-        //@RequestBody autoCompleteGetRequest: AutoCompleteGetRequest
     ): ResponseEntity<AutoCompleteGetResponse> {
         val result = autoCompleteService.getAutoComplete(input)
         return ResponseEntity.ok(result.toResponse())
     }
 
     @PostMapping("/update-string")
-    fun updateAutoCompleteString(
-        @RequestBody autoCompleteUpdateRequest: AutoCompleteUpdateRequest
+    override fun updateAutoCompleteString(
+        input: String
     ): ResponseEntity<AutoCompleteUpdateResponse> {
-        autoCompleteService.updateAutoComplete(autoCompleteUpdateRequest.input)
-        return ResponseEntity.ok(autoCompleteUpdateRequest.toResponse())
+        autoCompleteService.updateAutoComplete(input)
+        return ResponseEntity.ok(AutoCompleteUpdateResponse(input))
     }
 }

src/main/kotlin/com/deterior/global/controller/AutoCompleteController.kt

@@ -0,0 +1,21 @@
+package com.deterior.global.controller
+
+import com.deterior.global.dto.AutoCompleteGetResponse
+import com.deterior.global.dto.AutoCompleteUpdateRequest
+import com.deterior.global.dto.AutoCompleteUpdateResponse
+import io.swagger.v3.oas.annotations.Operation
+import io.swagger.v3.oas.annotations.Parameter
+import io.swagger.v3.oas.annotations.tags.Tag
+import org.springframework.http.ResponseEntity
+import org.springframework.web.bind.annotation.PathVariable
+import org.springframework.web.bind.annotation.RequestBody
+
+@Tag(name = "자동완성 API")
+interface AutoCompleteSwagger {
+
+    @Operation(summary = "자동완성 문자열 가져오기", description = "키워드의 단어로 시작하는 문자열들을 검색량 순으로 가져옵니다.")
+    fun getAutoCompleteString(input: String): ResponseEntity<AutoCompleteGetResponse>
+
+    @Operation(summary = "자동완성 문자열 추가", description = "자동완성될 문자열을 추가합니다.")
+    fun updateAutoCompleteString(@Parameter(description = "추가할 문자열", required = true) input: String): ResponseEntity<AutoCompleteUpdateResponse>
+}

src/main/kotlin/com/deterior/global/controller/AutoCompleteSwagger.kt

@@ -1,5 +1,8 @@
 package com.deterior.global.dto
 
+import io.swagger.v3.oas.annotations.media.Schema
+
+@Schema(description = "자동완성 문자열 추가 DTO")
 data class AutoCompleteUpdateRequest(
     val input: String,
 ) {

src/main/kotlin/com/deterior/global/dto/AutoCompleteUpdateRequest.kt

@@ -49,7 +49,8 @@ class LoggerAspect {
             responseBody = objectMapper.writeValueAsString(response),
             processingTime = processingTime,
         )
-        log.info(objectMapper.writeValueAsString(logDto))
+        val str = formatLog(objectMapper.writeValueAsString(logDto))
+        log.info(str)
         return result
     }
 
@@ -61,17 +62,9 @@ class LoggerAspect {
         return params
     }
 
-    private fun formatRequest(request: ContentCachingRequestWrapper): String =
-        request.contentAsByteArray.toString(Charsets.UTF_8)
-            .replace(Regex("\\s+"), "")
-            .replace(Regex("\\{"), "\\{\n\t")
-            .replace(Regex("\\}"), "\n\t\\}")
-            .replace(Regex(","), ",\n\t")
-
-    private fun formatResponse(response: ContentCachingResponseWrapper) =
-        response.contentAsByteArray.toString(Charsets.UTF_8)
-            .replace(Regex("\\s+"), "")
-            .replace(Regex("\\{"), "\\{\n\t")
-            .replace(Regex("\\}"), "\n\t\\}")
-            .replace(Regex(","), ",\n\t")
+    private fun formatLog(str: String): String =
+        str.split(",")
+            .map { it.replace("\\", "") }
+            .map { if(it.length > 150) it.substring(0, 150) + "..." else it }
+            .joinToString(",\n")
 }

src/main/kotlin/com/deterior/global/log/LoggerAspect.kt

@@ -17,7 +17,7 @@ class MailService @Autowired constructor(
     private val javaMailSender: JavaMailSender,
     private val mailCheckDao: MailCheckDao,
     private val applicationProperties: ApplicationProperties
-){
+) {
     fun sendMail(mailDto: MailDto) {
         val mailType = mailDto.type
         val receiverMail = mailDto.receiverMail

src/main/kotlin/com/deterior/global/service/MailService.kt

@@ -0,0 +1,15 @@
+package com.deterior.util
+
+import io.kotest.core.spec.style.FunSpec
+import org.springframework.boot.test.context.SpringBootTest
+
+@SpringBootTest
+class LogConvertTest : FunSpec({
+    test(", 마다 건너뛰기") {
+        val log = """ uuid":"c28d5890-17d4-41ff-8210-53bb41b71080","method":"eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ1c2VybmFtZSIsImF1dGgiOiJVU0VSIiwiZXhwIjoxNzQwNDk2MjYxfQ.dDLY9Ck_6318dXYKeSy8TE0WFBODzUfnDk25AkDggMgddddddddddddddddddddddddddddddddddddddddd","url":"/api/member/sign-in","clientIp":"0:0:0:0:0:0:0:1","params": okay"""
+        val result = log.split(",")
+            .map { if(it.length > 150) it.substring(0, 150) + "..." else it }
+            .joinToString(",\n")
+        println(result)
+    }
+})