From a7bb7f29c67e535abe07224a65269ec4dc6d97f8 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Fri, 14 Feb 2025 23:01:32 +0900 Subject: [PATCH 01/37] inititialize spring boot project --- .gitattributes | 3 + .gitignore | 117 ++++++++ build.gradle | 30 +++ gradle/wrapper/gradle-wrapper.properties | 7 + gradlew | 252 ++++++++++++++++++ gradlew.bat | 94 +++++++ settings.gradle | 1 + .../KtbBeDevAssignmentApplication.java | 13 + .../dev/assignment/ServletInitializer.java | 13 + src/main/resources/application.properties | 1 + .../KtbBeDevAssignmentApplicationTests.java | 13 + 11 files changed, 544 insertions(+) create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 build.gradle create mode 100644 gradle/wrapper/gradle-wrapper.properties create mode 100755 gradlew create mode 100644 gradlew.bat create mode 100644 settings.gradle create mode 100644 src/main/java/org/ktb/dev/assignment/KtbBeDevAssignmentApplication.java create mode 100644 src/main/java/org/ktb/dev/assignment/ServletInitializer.java create mode 100644 src/main/resources/application.properties create mode 100644 src/test/java/org/ktb/dev/assignment/KtbBeDevAssignmentApplicationTests.java diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..8af972c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +/gradlew text eol=lf +*.bat text eol=crlf +*.jar binary diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ecfc6f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,117 @@ +HELP.md +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store + +### Windows ### +Thumbs.db + +### Log files ### +*.log +logs/ + +### Local configuration ### +application-local.yml +application-local.properties + +### Java ### +*.class +*.jar +*.war +*.ear +*.zip +*.tar.gz +*.rar + +### JPA Generate ### +generated/ + +### QueryDSL ### +/src/main/generated/ + +### Private Keys ### +*.pem +*.key +*.p12 +*.pfx + +### JWT ### +*.jks + +### Environment Variables ### +.env +.env.* + +### Test Coverage Reports ### +jacoco/ + +### Docker ### +docker-compose.override.yml + +### Database ### +*.db +*.sqlite +h2db/ +*.h2.db + +### Redis ### +*.rdb +dump.rdb + +### Node (프론트엔드 포함된 경우) ### +node_modules/ +npm-debug.log +yarn-debug.log +yarn-error.log +package-lock.json +yarn.lock + +### Code Coverage ### +/coverage/ +.coverage +coverage.xml +*.cover + +### Spring Boot DevTools ### +.restart + +### Temp files ### +*.tmp +*.temp +*~ \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..8381496 --- /dev/null +++ b/build.gradle @@ -0,0 +1,30 @@ +plugins { + id 'java' + id 'war' + id 'org.springframework.boot' version '3.4.2' + id 'io.spring.dependency-management' version '1.1.7' +} + +group = 'org.ktb' +version = '0.0.1-SNAPSHOT' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +repositories { + mavenCentral() +} + +dependencies { + implementation 'org.springframework.boot:spring-boot-starter-web' + providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat' + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..e18bc25 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.12.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..f5feea6 --- /dev/null +++ b/gradlew @@ -0,0 +1,252 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9d21a21 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..d8b4cc0 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'be-dev-assignment' diff --git a/src/main/java/org/ktb/dev/assignment/KtbBeDevAssignmentApplication.java b/src/main/java/org/ktb/dev/assignment/KtbBeDevAssignmentApplication.java new file mode 100644 index 0000000..55ff18a --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/KtbBeDevAssignmentApplication.java @@ -0,0 +1,13 @@ +package org.ktb.dev.assignment; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class KtbBeDevAssignmentApplication { + + public static void main(String[] args) { + SpringApplication.run(KtbBeDevAssignmentApplication.class, args); + } + +} diff --git a/src/main/java/org/ktb/dev/assignment/ServletInitializer.java b/src/main/java/org/ktb/dev/assignment/ServletInitializer.java new file mode 100644 index 0000000..010193a --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/ServletInitializer.java @@ -0,0 +1,13 @@ +package org.ktb.dev.assignment; + +import org.springframework.boot.builder.SpringApplicationBuilder; +import org.springframework.boot.web.servlet.support.SpringBootServletInitializer; + +public class ServletInitializer extends SpringBootServletInitializer { + + @Override + protected SpringApplicationBuilder configure(SpringApplicationBuilder application) { + return application.sources(KtbBeDevAssignmentApplication.class); + } + +} diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties new file mode 100644 index 0000000..6d5c71f --- /dev/null +++ b/src/main/resources/application.properties @@ -0,0 +1 @@ +spring.application.name=ktb-be-dev-assignment diff --git a/src/test/java/org/ktb/dev/assignment/KtbBeDevAssignmentApplicationTests.java b/src/test/java/org/ktb/dev/assignment/KtbBeDevAssignmentApplicationTests.java new file mode 100644 index 0000000..e2478a9 --- /dev/null +++ b/src/test/java/org/ktb/dev/assignment/KtbBeDevAssignmentApplicationTests.java @@ -0,0 +1,13 @@ +package org.ktb.dev.assignment; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class KtbBeDevAssignmentApplicationTests { + + @Test + void contextLoads() { + } + +} From 6640c7a3cea811aa0bbd4ea5e38e5ba73536ee4e Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 01:54:14 +0900 Subject: [PATCH 02/37] fix: build type (war -> jar) --- build.gradle | 2 -- 1 file changed, 2 deletions(-) diff --git a/build.gradle b/build.gradle index 8381496..65b7c9a 100644 --- a/build.gradle +++ b/build.gradle @@ -1,6 +1,5 @@ plugins { id 'java' - id 'war' id 'org.springframework.boot' version '3.4.2' id 'io.spring.dependency-management' version '1.1.7' } @@ -20,7 +19,6 @@ repositories { dependencies { implementation 'org.springframework.boot:spring-boot-starter-web' - providedRuntime 'org.springframework.boot:spring-boot-starter-tomcat' testImplementation 'org.springframework.boot:spring-boot-starter-test' testRuntimeOnly 'org.junit.platform:junit-platform-launcher' } From 702abec2c9901c65e50be406059e243203d41dfa Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 03:32:47 +0900 Subject: [PATCH 03/37] =?UTF-8?q?feat:=20MVC=20=EC=95=84=ED=82=A4=ED=85=8D?= =?UTF-8?q?=EC=B2=98=20=EA=B5=AC=EC=A1=B0=20=EC=84=A4=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 프로젝트 기본 구조 확립 - 도메인 레이어 (domain) 추가 - 프레젠테이션 레이어 (presentation) 구성 - 공통 응답 및 예외 처리 모듈 (core) 생성 - 웹 설정을 위한 common.config 패키지 추가 아키텍처 구조: - domain: 도메인 엔티티 클래스 - presentation: API 컨트롤러 및 DTO - repository: 데이터 접근 계층 - service: 비즈니스 로직 계층 - core: 공통 응답, 예외 처리 --- .../java/org/ktb/dev/assignment/common/config/WebConfig.java | 4 ++++ .../org/ktb/dev/assignment/core/response/ApiResponse.java | 4 ++++ .../java/org/ktb/dev/assignment/core/response/ErrorCode.java | 4 ++++ .../org/ktb/dev/assignment/core/response/ErrorResponse.java | 4 ++++ src/main/java/org/ktb/dev/assignment/domain/Company.java | 4 ++++ .../java/org/ktb/dev/assignment/domain/StocksHistory.java | 4 ++++ .../assignment/presentation/v1/controller/StockPriceApi.java | 5 +++++ .../presentation/v1/controller/StockPriceController.java | 4 ++++ .../presentation/v1/dto/getStockByCompanyCodeRequest.java | 4 ++++ .../presentation/v1/dto/getStockByCompanyCodeResponse.java | 4 ++++ .../org/ktb/dev/assignment/repository/CompanyRepository.java | 4 ++++ .../dev/assignment/repository/StocksHistoryRepository.java | 4 ++++ .../org/ktb/dev/assignment/service/StockPriceService.java | 4 ++++ 13 files changed, 53 insertions(+) create mode 100644 src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/response/ApiResponse.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/response/ErrorCode.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java create mode 100644 src/main/java/org/ktb/dev/assignment/domain/Company.java create mode 100644 src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java create mode 100644 src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java create mode 100644 src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java create mode 100644 src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeRequest.java create mode 100644 src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeResponse.java create mode 100644 src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java create mode 100644 src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java create mode 100644 src/main/java/org/ktb/dev/assignment/service/StockPriceService.java diff --git a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java new file mode 100644 index 0000000..1b9f8b3 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.common.config; + +public class WebConfig { +} diff --git a/src/main/java/org/ktb/dev/assignment/core/response/ApiResponse.java b/src/main/java/org/ktb/dev/assignment/core/response/ApiResponse.java new file mode 100644 index 0000000..fa39569 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/response/ApiResponse.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.core.response; + +public class ApiResponse { +} diff --git a/src/main/java/org/ktb/dev/assignment/core/response/ErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/response/ErrorCode.java new file mode 100644 index 0000000..338ee58 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/response/ErrorCode.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.core.response; + +public class ErrorCode { +} diff --git a/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java new file mode 100644 index 0000000..5b16004 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.core.response; + +public class ErrorResponse { +} diff --git a/src/main/java/org/ktb/dev/assignment/domain/Company.java b/src/main/java/org/ktb/dev/assignment/domain/Company.java new file mode 100644 index 0000000..58f0cc5 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/domain/Company.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.domain; + +public class Company { +} diff --git a/src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java b/src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java new file mode 100644 index 0000000..c42a718 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.domain; + +public class StocksHistory { +} diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java new file mode 100644 index 0000000..a79647b --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java @@ -0,0 +1,5 @@ +package org.ktb.dev.assignment.presentation.v1.controller; + +public interface StockPriceApi { + +} diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java new file mode 100644 index 0000000..039af7a --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.presentation.v1.controller; + +public class StockPriceController implements StockPriceApi { +} diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeRequest.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeRequest.java new file mode 100644 index 0000000..3af390f --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeRequest.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.presentation.v1.dto; + +public class getStockByCompanyCodeRequest { +} diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeResponse.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeResponse.java new file mode 100644 index 0000000..cba512d --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeResponse.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.presentation.v1.dto; + +public class getStockByCompanyCodeResponse { +} diff --git a/src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java b/src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java new file mode 100644 index 0000000..6d3020b --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.repository; + +public class CompanyRepository { +} diff --git a/src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java b/src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java new file mode 100644 index 0000000..673129c --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.repository; + +public class StocksHistoryRepository { +} diff --git a/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java b/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java new file mode 100644 index 0000000..4fb37a1 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java @@ -0,0 +1,4 @@ +package org.ktb.dev.assignment.service; + +public class StockPriceService { +} From 382c1c72575388f48bf6e5eab44545bbf2bcca70 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 03:35:48 +0900 Subject: [PATCH 04/37] =?UTF-8?q?fix:=20DTO=20naming=20rule=20=EB=B3=80?= =?UTF-8?q?=EA=B2=BD=20(=EC=B2=AB=EA=B8=80=EC=9E=90=20=EB=8C=80=EB=AC=B8?= =?UTF-8?q?=EC=9E=90=EB=A1=9C=20=ED=86=B5=EC=9D=BC)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...ompanyCodeRequest.java => GetStockByCompanyCodeRequest.java} | 2 +- ...panyCodeResponse.java => GetStockByCompanyCodeResponse.java} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename src/main/java/org/ktb/dev/assignment/presentation/v1/dto/{getStockByCompanyCodeRequest.java => GetStockByCompanyCodeRequest.java} (55%) rename src/main/java/org/ktb/dev/assignment/presentation/v1/dto/{getStockByCompanyCodeResponse.java => GetStockByCompanyCodeResponse.java} (55%) diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeRequest.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeRequest.java similarity index 55% rename from src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeRequest.java rename to src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeRequest.java index 3af390f..50c631d 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeRequest.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeRequest.java @@ -1,4 +1,4 @@ package org.ktb.dev.assignment.presentation.v1.dto; -public class getStockByCompanyCodeRequest { +public class GetStockByCompanyCodeRequest { } diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeResponse.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java similarity index 55% rename from src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeResponse.java rename to src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java index cba512d..e256f5b 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/getStockByCompanyCodeResponse.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java @@ -1,4 +1,4 @@ package org.ktb.dev.assignment.presentation.v1.dto; -public class getStockByCompanyCodeResponse { +public class GetStockByCompanyCodeResponse { } From 182c1e6e1114b87b3295b71e6aae6b651044b7e5 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 04:46:18 +0900 Subject: [PATCH 05/37] fix: add prefix in root Project name (ktb-) --- settings.gradle | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/settings.gradle b/settings.gradle index d8b4cc0..f8a8f87 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1 +1 @@ -rootProject.name = 'be-dev-assignment' +rootProject.name = 'ktb-be-dev-assignment' From b66dd7c47219905da93a05466b5944c5ff5e2895 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 04:47:25 +0900 Subject: [PATCH 06/37] =?UTF-8?q?feat:=20API=20=EB=AC=B8=EC=84=9C=ED=99=94?= =?UTF-8?q?=EB=A5=BC=20=EC=9C=84=ED=95=9C=20springdoc-openapi=20=EC=9D=98?= =?UTF-8?q?=EC=A1=B4=EC=84=B1=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 3 +++ 1 file changed, 3 insertions(+) diff --git a/build.gradle b/build.gradle index 65b7c9a..714adf3 100644 --- a/build.gradle +++ b/build.gradle @@ -21,6 +21,9 @@ dependencies { implementation 'org.springframework.boot:spring-boot-starter-web' testImplementation 'org.springframework.boot:spring-boot-starter-test' testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + + // springdoc + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' } tasks.named('test') { From 69a64e7c49e7b4fc221bc0f68066ae84a41948e5 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 04:51:47 +0900 Subject: [PATCH 07/37] =?UTF-8?q?feat:=20WebConfig.java=20Cors=20=EC=84=A4?= =?UTF-8?q?=EC=A0=95=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../assignment/common/config/WebConfig.java | 22 +++++++++++++++++-- 1 file changed, 20 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java index 1b9f8b3..f34b64f 100644 --- a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java +++ b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java @@ -1,4 +1,22 @@ package org.ktb.dev.assignment.common.config; -public class WebConfig { -} +import org.springframework.context.annotation.Configuration; +import org.springframework.web.servlet.config.annotation.CorsRegistry; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +/* + * 프로트엔드 포트에 맞게 CORS 설정 수정 필요 ! + * author : hyuk.kim (김상혁) + */ +@Configuration +public class WebConfig implements WebMvcConfigurer { + + @Override + public void addCorsMappings(CorsRegistry registry) { + registry.addMapping("/api/**") + .allowedOrigins("http://localhost:3000") + .allowedMethods("GET", "POST", "PUT", "DELETE") + .allowedHeaders("*") + .allowCredentials(true); + } +} \ No newline at end of file From 4fd9a898672291b6a490b97d99c1b5b8cf55c5f8 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 19:04:27 +0900 Subject: [PATCH 08/37] =?UTF-8?q?feat:=20DB=20=EC=A1=B0=ED=9A=8C=EB=A5=BC?= =?UTF-8?q?=20=EC=9C=84=ED=95=9C=20jpa=20=EC=9D=98=EC=A1=B4=EC=84=B1=20?= =?UTF-8?q?=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/build.gradle b/build.gradle index 714adf3..2e79abe 100644 --- a/build.gradle +++ b/build.gradle @@ -24,6 +24,10 @@ dependencies { // springdoc implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' + + // jpa + implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.4.2' + } tasks.named('test') { From b75e951fa4a86cda98b0fb606017fa4c15ea104d Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 19:04:52 +0900 Subject: [PATCH 09/37] =?UTF-8?q?fix=20:=20=EC=A3=BC=EC=84=9D=20=ED=95=A0?= =?UTF-8?q?=EC=9D=BC=20=ED=83=9C=EA=B7=B8=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../java/org/ktb/dev/assignment/common/config/WebConfig.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java index f34b64f..f0cb407 100644 --- a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java +++ b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java @@ -5,7 +5,7 @@ import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; /* - * 프로트엔드 포트에 맞게 CORS 설정 수정 필요 ! + * !!할일 : 프로트엔드 포트에 맞게 CORS 설정 수정 필요 ! * author : hyuk.kim (김상혁) */ @Configuration From b704cd1ef45562e9ae1965662fc702b9af27c4fe Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 19:18:13 +0900 Subject: [PATCH 10/37] =?UTF-8?q?feat:=20lombok=20=EC=9D=98=EC=A1=B4?= =?UTF-8?q?=EC=84=B1=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/build.gradle b/build.gradle index 2e79abe..1116ee4 100644 --- a/build.gradle +++ b/build.gradle @@ -22,9 +22,11 @@ dependencies { testImplementation 'org.springframework.boot:spring-boot-starter-test' testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + //lombok + compileOnly 'org.projectlombok:lombok:1.18.36' + // springdoc implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' - // jpa implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.4.2' From 1bfa4eb147b21b2682d5acee146e298e2ba65a2d Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 19:19:02 +0900 Subject: [PATCH 11/37] =?UTF-8?q?fix:=20=EC=84=B1=EA=B3=B5=20=EC=9D=91?= =?UTF-8?q?=EB=8B=B5=20=ED=81=B4=EB=9E=98=EC=8A=A4=20=EC=9D=B4=EB=A6=84=20?= =?UTF-8?q?=EB=B3=80=EA=B2=BD=20ApiResponse=20->=20SuccessResponse?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../core/response/{ApiResponse.java => SuccessResponse.java} | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) rename src/main/java/org/ktb/dev/assignment/core/response/{ApiResponse.java => SuccessResponse.java} (61%) diff --git a/src/main/java/org/ktb/dev/assignment/core/response/ApiResponse.java b/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java similarity index 61% rename from src/main/java/org/ktb/dev/assignment/core/response/ApiResponse.java rename to src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java index fa39569..37652a0 100644 --- a/src/main/java/org/ktb/dev/assignment/core/response/ApiResponse.java +++ b/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java @@ -1,4 +1,4 @@ package org.ktb.dev.assignment.core.response; -public class ApiResponse { +public class SuccessResponse { } From 0ed5355cf5eb267b1526c5bf17fa47e1d99816f8 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 19:41:16 +0900 Subject: [PATCH 12/37] =?UTF-8?q?fix:=20ErrorCode=20=EA=B5=AC=ED=98=84=20?= =?UTF-8?q?=EB=B0=8F=20=EC=9C=84=EC=B9=98=20=EB=B3=80=EA=B2=BD=20response?= =?UTF-8?q?=20->=20exception?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../ktb/dev/assignment/core/exception/ErrorCode.java | 11 +++++++++++ .../ktb/dev/assignment/core/response/ErrorCode.java | 4 ---- 2 files changed, 11 insertions(+), 4 deletions(-) create mode 100644 src/main/java/org/ktb/dev/assignment/core/exception/ErrorCode.java delete mode 100644 src/main/java/org/ktb/dev/assignment/core/response/ErrorCode.java diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/ErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/exception/ErrorCode.java new file mode 100644 index 0000000..98a9d7a --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/exception/ErrorCode.java @@ -0,0 +1,11 @@ +package org.ktb.dev.assignment.core.exception; + +import java.io.Serializable; + +public interface ErrorCode extends Serializable { + int getStatus(); + + String getCode(); + + String getMessage(); +} \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/response/ErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/response/ErrorCode.java deleted file mode 100644 index 338ee58..0000000 --- a/src/main/java/org/ktb/dev/assignment/core/response/ErrorCode.java +++ /dev/null @@ -1,4 +0,0 @@ -package org.ktb.dev.assignment.core.response; - -public class ErrorCode { -} From a49ecf07166528809215e169bcd56657576059db Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 19:41:54 +0900 Subject: [PATCH 13/37] =?UTF-8?q?feat:=20SwaggerConfig=20=EA=B5=AC?= =?UTF-8?q?=ED=98=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../common/config/SwaggerConfig.java | 46 +++++++++++++++++++ 1 file changed, 46 insertions(+) create mode 100644 src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java diff --git a/src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java new file mode 100644 index 0000000..84386ea --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java @@ -0,0 +1,46 @@ +package org.ktb.dev.assignment.common.config; + +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.info.Info; +import io.swagger.v3.oas.models.servers.Server; +import org.springdoc.core.models.GroupedOpenApi; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class SwaggerConfig { + + /* + * 백엔드 사전과제 API 문서 + * 버전 : v1 + * 서버 : localhost:8080 + * 설명 : 개발용 서버 + */ + @Bean + public OpenAPI openAPI() { + Info info = new Info() + .title("백엔드 사전과제 API 문서") + .version("v1") + .description("API 명세서"); + + Server devServer = new Server() + .url("http://localhost:8080") + .description("개발용 서버"); + + return new OpenAPI() + .info(info) + .addServersItem(devServer); + } + + /* + * !!할일 : API 구현 후 그룹화 진행 필요!! + * author : hyuk.kim (김상혁) + */ + @Bean + public GroupedOpenApi stockV1Api() { + return GroupedOpenApi.builder() + .group("거래 API") + .pathsToMatch("/api/stock/**") + .build(); + } +} From db637d42bf4d3a391871fb9b35396975bc987378 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 19:42:22 +0900 Subject: [PATCH 14/37] =?UTF-8?q?feat:=20=EC=9D=91=EB=8B=B5=20=ED=98=95?= =?UTF-8?q?=EC=8B=9D=20=ED=86=B5=EC=9D=BC=20-=20=EC=84=B1=EA=B3=B5=20?= =?UTF-8?q?=EC=9D=91=EB=8B=B5=20:=20SuccessResponse=20-=20=EC=8B=A4?= =?UTF-8?q?=ED=8C=A8=20=EC=9D=91=EB=8B=B5=20:=20ErrorResponse?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../core/response/ErrorResponse.java | 43 +++++++++++++++++++ .../core/response/SuccessResponse.java | 37 +++++++++++++++- 2 files changed, 78 insertions(+), 2 deletions(-) diff --git a/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java index 5b16004..2703d88 100644 --- a/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java +++ b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java @@ -1,4 +1,47 @@ package org.ktb.dev.assignment.core.response; +import com.fasterxml.jackson.annotation.JsonInclude; +import io.swagger.v3.oas.annotations.media.Schema; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.RequiredArgsConstructor; +import org.ktb.dev.assignment.core.exception.ErrorCode; +import org.springframework.validation.FieldError; + +import java.util.List; + +@Getter +@Schema(description = "실패 Response") +@RequiredArgsConstructor(access = AccessLevel.PRIVATE) public class ErrorResponse { + + @Schema(description = "성공 여부", defaultValue = "false") + private final boolean success = false; + private final ErrorInfo data; + + public static ErrorResponse of(ErrorCode errorCode) { + return new ErrorResponse(new ErrorInfo(errorCode.getCode(), errorCode.getMessage(), null)); + } + + public static ErrorResponse of(ErrorCode errorCode, List validationErrorList) { + return new ErrorResponse(new ErrorInfo(errorCode.getCode(), errorCode.getMessage(), validationErrorList)); + } + + public static ErrorResponse of(ErrorCode errorCode, String additionalMessage) { + return new ErrorResponse(new ErrorInfo(errorCode.getCode(), + errorCode.getMessage() + " : " + additionalMessage, null)); + } + + public record ValidationError(String field, String message) { + + public static ValidationError of(final FieldError fieldError) { + return new ValidationError(fieldError.getField(), fieldError.getDefaultMessage()); + } + } + + private record ErrorInfo(String code, + String message, + @JsonInclude(JsonInclude.Include.NON_EMPTY) + List errors) { + } } diff --git a/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java b/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java index 37652a0..40f70c1 100644 --- a/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java +++ b/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java @@ -1,4 +1,37 @@ package org.ktb.dev.assignment.core.response; -public class SuccessResponse { -} +import com.fasterxml.jackson.annotation.JsonInclude; +import io.swagger.v3.oas.annotations.media.Schema; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; + +@Getter +@Schema(description = "성공 Response") +@NoArgsConstructor(access = AccessLevel.PRIVATE) +public class SuccessResponse { + + @Schema(description = "성공 여부", defaultValue = "true") + private final boolean success = true; + + @JsonInclude(JsonInclude.Include.NON_NULL) + private T data; + + public static SuccessResponse of(T data) { + SuccessResponse successResponse = new SuccessResponse<>(); + + successResponse.data = data; + + return successResponse; + } + + public static SuccessResponse ofNoData() { + return new SuccessResponse<>(); + } + + public ResponseEntity> asHttp(HttpStatus httpStatus) { + return ResponseEntity.status(httpStatus).body(this); + } +} \ No newline at end of file From c2be0a26bd8e3f65a84df43d13d1738f18f1e5cc Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 19:51:12 +0900 Subject: [PATCH 15/37] =?UTF-8?q?feat:=20CustomErrorCode=20=EA=B5=AC?= =?UTF-8?q?=ED=98=84=20-=20=EC=9A=94=EA=B5=AC=EC=82=AC=ED=95=AD=EC=97=90?= =?UTF-8?q?=20=EC=A0=81=ED=9E=8C=20=EC=97=90=EB=9F=AC=EB=A5=BC=20=EB=AF=B8?= =?UTF-8?q?=EB=A6=AC=20=EA=B5=AC=ED=98=84,=20=EC=9D=B4=ED=9B=84=20?= =?UTF-8?q?=EC=88=98=EC=A0=95=ED=95=B4=EC=84=9C=20=EC=82=AC=EC=9A=A9=20?= =?UTF-8?q?=EC=98=88=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../core/exception/CustomErrorCode.java | 56 +++++++++++++++++++ 1 file changed, 56 insertions(+) create mode 100644 src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java new file mode 100644 index 0000000..c95e4fa --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java @@ -0,0 +1,56 @@ +package org.ktb.dev.assignment.core.exception; + +import lombok.RequiredArgsConstructor; + +@RequiredArgsConstructor +public enum CustomErrorCode implements ErrorCode { + /* + **요구사항에 적힌 커스텀 에러 목록!** + * 초과 시 429 Too Many Requests 등의 상태 코드를 반환하고 에러 메시지에 제한 정보(몇 초 내 N건)를 담아주면 좋습니다. + * 필수 파라미터 누락, 유효성 검사, API 키 누락 등 다양한 케이스를 테스트해주세요. + * 유효성 검사를 통해 고객에게 어떻게 호출해야 하는지 직간접적으로 안내할 수 있도록 합니다. + * 만약 요청에 키가 없다고 판단 될 경우 400, 값이 아래 API Key가 아닌 경우, 403 에러를 반환해주시기 바랍니다. + * 마찬가지로 Endopoint에서 필수 파라미터로 정의하신 파라미터가 오지 않을 경우 400 에러를 반환해주시면 되며, + * 존재하지 않는 API를 호출 할 경우, 404 에러를 반환해주시기 바랍니다. + */ + + // 400 Bad Request + MISSING_REQUIRED_PARAMETER(400, "E001", "필수 파라미터가 누락되었습니다."), + INVALID_PARAMETER_VALUE(400, "E002", "잘못된 파라미터 값입니다."), + MISSING_API_KEY(400, "E003", "API 키가 누락되었습니다."), + INVALID_REQUEST_BODY(400, "E004", "잘못된 요청 본문입니다."), + + // 403 Forbidden + INVALID_API_KEY(403, "E101", "유효하지 않은 API 키입니다."), + ACCESS_DENIED(403, "E102", "접근이 거부되었습니다."), + + // 404 Not Found + API_NOT_FOUND(404, "E201", "요청한 API를 찾을 수 없습니다."), + RESOURCE_NOT_FOUND(404, "E202", "요청한 리소스를 찾을 수 없습니다."), + + // 429 Too Many Requests + RATE_LIMIT_EXCEEDED(429, "E301", "요청 제한을 초과했습니다. {limit}건/{duration}초 제한"), + + // 500 Internal Server Error + INTERNAL_SERVER_ERROR(500, "E901", "서버 내부 오류가 발생했습니다."); + + + private final int status; + private final String code; + private final String message; + + @Override + public int getStatus() { + return status; + } + + @Override + public String getCode() { + return code; + } + + @Override + public String getMessage() { + return message; + } +} \ No newline at end of file From 41c74dc57185ffc3bab9f36bfb6a57634bba5105 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 20:54:56 +0900 Subject: [PATCH 16/37] =?UTF-8?q?feat:=20Error=20=EC=B2=98=EB=A6=AC=20?= =?UTF-8?q?=EB=B0=A9=EC=8B=9D=20=ED=86=B5=EC=9D=BC=20-=20BusinessException?= =?UTF-8?q?=20-=20CustomErrorCode=20-=20GlobalExceptionHandler?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../core/exception/BusinessException.java | 30 +++++++ .../core/exception/CustomErrorCode.java | 1 + .../exception/GlobalExceptionHandler.java | 78 +++++++++++++++++++ 3 files changed, 109 insertions(+) create mode 100644 src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java b/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java new file mode 100644 index 0000000..7dd2136 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java @@ -0,0 +1,30 @@ +package org.ktb.dev.assignment.core.exception; + +import lombok.Getter; + +@Getter +public class BusinessException extends RuntimeException { + + private final ErrorCode errorCode; + + /* + * 에러 코드만 반환 + */ + public BusinessException(ErrorCode errorCode) { + super(errorCode.getMessage()); + this.errorCode = errorCode; + } + + /* + * 에러 코드 + 반환 + */ + public BusinessException(ErrorCode errorCode, Throwable throwable) { + super(errorCode.getMessage(), throwable); + this.errorCode = errorCode; + } + + public BusinessException(ErrorCode errorCode, String message) { + super(message); + this.errorCode = errorCode; + } +} diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java index c95e4fa..9f802a3 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java @@ -19,6 +19,7 @@ public enum CustomErrorCode implements ErrorCode { INVALID_PARAMETER_VALUE(400, "E002", "잘못된 파라미터 값입니다."), MISSING_API_KEY(400, "E003", "API 키가 누락되었습니다."), INVALID_REQUEST_BODY(400, "E004", "잘못된 요청 본문입니다."), + INVALID_INPUT_VALUE(400, "E005", "잘못된 입력값입니다."), // 403 Forbidden INVALID_API_KEY(403, "E101", "유효하지 않은 API 키입니다."), diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java new file mode 100644 index 0000000..713ab99 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java @@ -0,0 +1,78 @@ +package org.ktb.dev.assignment.core.exception; + +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; +import org.ktb.dev.assignment.core.response.ErrorResponse; +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatusCode; +import org.springframework.http.ResponseEntity; +import org.springframework.validation.BindException; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.context.request.WebRequest; +import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; + +import java.util.List; +import java.util.stream.Collectors; + +/** + * 전역 예외 처리를 담당하는 핸들러 + */ +@RestControllerAdvice +@Slf4j +public class GlobalExceptionHandler extends ResponseEntityExceptionHandler { + + /** + * 비즈니스 예외 처리 + */ + @ExceptionHandler(BusinessException.class) + public ResponseEntity handleBusinessException(BusinessException ex) { + log.error("[BusinessException] {}", ex.getMessage(), ex); + return handleExceptionInternal(ex.getErrorCode()); + } + + /** + * 유효성 검증(@Valid) 예외 처리 + * NotNull은 우선 무시! + */ + @Override + @NonNull + protected ResponseEntity handleMethodArgumentNotValid( + @NonNull MethodArgumentNotValidException ex, + @NonNull HttpHeaders headers, + @NonNull HttpStatusCode status, + @NonNull WebRequest request) { + + log.error("[ValidationException] {}", ex.getMessage(), ex); + return handleValidationExceptionInternal(ex); + } + + /** + * 예상치 못한 예외 처리 + */ + @ExceptionHandler(Exception.class) + public ResponseEntity handleAllException(Exception ex) { + log.error("[UnexpectedException] {}", ex.getMessage(), ex); + return handleExceptionInternal(CustomErrorCode.INTERNAL_SERVER_ERROR); + } + + // 에러 응답 생성 + private ResponseEntity handleExceptionInternal(ErrorCode errorCode) { + return ResponseEntity.status(errorCode.getStatus()) + .body(ErrorResponse.of(errorCode)); + } + + // 유효성 검증 에러 응답 생성 + private ResponseEntity handleValidationExceptionInternal(BindException bindException) { + List validationErrorList = bindException + .getBindingResult() + .getFieldErrors() + .stream() + .map(ErrorResponse.ValidationError::of) + .collect(Collectors.toList()); + + return ResponseEntity.status(CustomErrorCode.INVALID_INPUT_VALUE.getStatus()) + .body(ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrorList)); + } +} \ No newline at end of file From 88abfef16b4fd49f8e11d494699f077dcbe63389 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 21:02:10 +0900 Subject: [PATCH 17/37] =?UTF-8?q?feat:=20mysql=20driver=20=EC=9D=98?= =?UTF-8?q?=EC=A1=B4=EC=84=B1=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 3 +++ 1 file changed, 3 insertions(+) diff --git a/build.gradle b/build.gradle index 1116ee4..c5bffe3 100644 --- a/build.gradle +++ b/build.gradle @@ -27,8 +27,11 @@ dependencies { // springdoc implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' + // jpa implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.4.2' + // MySQL Driver + implementation 'com.mysql:mysql-connector-j' } From 6b5947c3bcab24058faf329fe1f2ca3384a758ad Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 23:13:09 +0900 Subject: [PATCH 18/37] =?UTF-8?q?feat:=20lombok=20=EC=96=B4=EB=85=B8?= =?UTF-8?q?=ED=85=8C=EC=9D=B4=EC=85=98=20=ED=94=84=EB=A1=9C=EC=84=B8?= =?UTF-8?q?=EC=84=9C=20=EC=9D=98=EC=A1=B4=EC=84=B1=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/build.gradle b/build.gradle index c5bffe3..f5a8e53 100644 --- a/build.gradle +++ b/build.gradle @@ -22,16 +22,14 @@ dependencies { testImplementation 'org.springframework.boot:spring-boot-starter-test' testRuntimeOnly 'org.junit.platform:junit-platform-launcher' - //lombok - compileOnly 'org.projectlombok:lombok:1.18.36' - // springdoc - implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' + compileOnly 'org.projectlombok:lombok:1.18.36' //lombok + annotationProcessor 'org.projectlombok:lombok' // lombok 어노테이션 프로세서 - // jpa - implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.4.2' - // MySQL Driver - implementation 'com.mysql:mysql-connector-j' + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' // springdoc + + implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.4.2' // jpa + implementation 'com.mysql:mysql-connector-j' // MySQL Driver } From 86d6fb30940cd57dc69d6de7c494e9d40e8d47fc Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sat, 15 Feb 2025 23:13:56 +0900 Subject: [PATCH 19/37] =?UTF-8?q?feat:=20Database=20=EC=97=B0=EA=B2=B0=20?= =?UTF-8?q?=EC=B6=94=EA=B0=80=20=EB=B0=8F=20properties=20->=20yml=20?= =?UTF-8?q?=ED=8C=8C=EC=9D=BC=ED=99=95=EC=9E=A5=EC=9E=90=20=EB=B3=80?= =?UTF-8?q?=EA=B2=BD=20-=20max-connection=205=EB=A1=9C=20=EC=A0=9C?= =?UTF-8?q?=ED=95=9C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/resources/application.properties | 1 - src/main/resources/application.yml | 29 +++++++++++++++++++++++ 2 files changed, 29 insertions(+), 1 deletion(-) delete mode 100644 src/main/resources/application.properties create mode 100644 src/main/resources/application.yml diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties deleted file mode 100644 index 6d5c71f..0000000 --- a/src/main/resources/application.properties +++ /dev/null @@ -1 +0,0 @@ -spring.application.name=ktb-be-dev-assignment diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..ff1a1dc --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,29 @@ +spring: + application: + name: ktb-be-dev-assignment + + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + url: jdbc:mysql://${RDS_ENDPOINT}:${RDS_PORT}/${DATABASE_NAME}?serverTimezone=UTC&characterEncoding=UTF-8 + username: ${DB_USERNAME} + password: ${DB_PASSWORD} + hikari: + maximum-pool-size: 5 + minimum-idle: 1 + idle-timeout: 30000 + + jpa: + database-platform: org.hibernate.dialect.MySQLDialect + hibernate: + ddl-auto: none + properties: + hibernate: + format_sql: true + show_sql: true + default_batch_fetch_size: 100 + open-in-view: false + +logging: + level: + org.hibernate.SQL: debug + org.hibernate.type: trace \ No newline at end of file From dc3c45f2b822a8a374f0b24cf126d4a861c43ab5 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 00:24:40 +0900 Subject: [PATCH 20/37] =?UTF-8?q?feat:=20GlobalExceptionHandler=20?= =?UTF-8?q?=EB=82=A0=EC=A7=9C=20=EA=B4=80=EB=A0=A8=20=EA=B8=80=EB=A1=9C?= =?UTF-8?q?=EB=B2=8C=20=EC=97=90=EB=9F=AC=20=EC=B2=98=EB=A6=AC=20=EC=B6=94?= =?UTF-8?q?=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../exception/GlobalExceptionHandler.java | 30 ++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java index 713ab99..abc8429 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java +++ b/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java @@ -11,8 +11,11 @@ import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; import org.springframework.web.context.request.WebRequest; +import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; +import java.time.LocalDate; +import java.time.format.DateTimeParseException; import java.util.List; import java.util.stream.Collectors; @@ -34,7 +37,6 @@ public ResponseEntity handleBusinessException(BusinessException ex) { /** * 유효성 검증(@Valid) 예외 처리 - * NotNull은 우선 무시! */ @Override @NonNull @@ -48,6 +50,32 @@ protected ResponseEntity handleMethodArgumentNotValid( return handleValidationExceptionInternal(ex); } + /** + * 날짜 형식 변환 실패 예외 처리 + */ + @ExceptionHandler(MethodArgumentTypeMismatchException.class) + protected ResponseEntity handleMethodArgumentTypeMismatch( + MethodArgumentTypeMismatchException ex) { + log.error("[DateFormatException] {}", ex.getMessage(), ex); + + // 날짜 형식 에러인 경우에만 특정 메시지 처리 + if (LocalDate.class.isAssignableFrom(ex.getRequiredType())) { + return handleExceptionInternal(CustomErrorCode.INVALID_DATE_FORMAT); + } + + return handleExceptionInternal(CustomErrorCode.INVALID_INPUT_VALUE); + } + + /** + * 날짜 파싱 실패 예외 처리 + */ + @ExceptionHandler(DateTimeParseException.class) + protected ResponseEntity handleDateTimeParseException( + DateTimeParseException ex) { + log.error("[DateParseException] {}", ex.getMessage(), ex); + return handleExceptionInternal(CustomErrorCode.INVALID_DATE_FORMAT); + } + /** * 예상치 못한 예외 처리 */ From 46a2c36b3b327b9258de8f303d119ee94ef89d8a Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 00:24:46 +0900 Subject: [PATCH 21/37] =?UTF-8?q?feat:=20GlobalExceptionHandler=20?= =?UTF-8?q?=EB=82=A0=EC=A7=9C=20=EA=B4=80=EB=A0=A8=20=EA=B8=80=EB=A1=9C?= =?UTF-8?q?=EB=B2=8C=20=EC=97=90=EB=9F=AC=20=EC=B2=98=EB=A6=AC=20=EC=B6=94?= =?UTF-8?q?=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../org/ktb/dev/assignment/core/exception/CustomErrorCode.java | 1 + 1 file changed, 1 insertion(+) diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java index 9f802a3..0b1b29f 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java @@ -20,6 +20,7 @@ public enum CustomErrorCode implements ErrorCode { MISSING_API_KEY(400, "E003", "API 키가 누락되었습니다."), INVALID_REQUEST_BODY(400, "E004", "잘못된 요청 본문입니다."), INVALID_INPUT_VALUE(400, "E005", "잘못된 입력값입니다."), + INVALID_DATE_FORMAT(400, "C003", "날짜 형식이 올바르지 않습니다. (yyyy-MM-dd 형식으로 입력해주세요)"), // 403 Forbidden INVALID_API_KEY(403, "E101", "유효하지 않은 API 키입니다."), From 8898e8959c109501715d64f9d69b7aebdb8971a4 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 02:14:44 +0900 Subject: [PATCH 22/37] =?UTF-8?q?feat:=20spring-boot-starter-validation=20?= =?UTF-8?q?=EC=9D=98=EC=A1=B4=EC=84=B1=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 1 + .../v1/controller/StockPriceApi.java | 45 +++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/build.gradle b/build.gradle index f5a8e53..6ec7417 100644 --- a/build.gradle +++ b/build.gradle @@ -22,6 +22,7 @@ dependencies { testImplementation 'org.springframework.boot:spring-boot-starter-test' testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + implementation 'org.springframework.boot:spring-boot-starter-validation:3.4.2' compileOnly 'org.projectlombok:lombok:1.18.36' //lombok annotationProcessor 'org.projectlombok:lombok' // lombok 어노테이션 프로세서 diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java index a79647b..8f18ae2 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java @@ -1,5 +1,50 @@ package org.ktb.dev.assignment.presentation.v1.controller; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.responses.ApiResponses; +import io.swagger.v3.oas.annotations.tags.Tag; +import jakarta.validation.constraints.*; +import org.ktb.dev.assignment.core.response.SuccessResponse; +import org.ktb.dev.assignment.presentation.v1.dto.GetStockByCompanyCodeResponse; +import org.springframework.format.annotation.DateTimeFormat; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestParam; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.media.Schema; + +import java.time.LocalDate; + +@Tag(name = "주가 조회 API", description = "주가 정보를 조회") public interface StockPriceApi { + @Operation(summary = "기업의 주가 조회 API", description = "기간 내 특정 기업의 주가 정보를 조회") + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공적으로 기업 주가 조회가 완료되었습니다.") + }) + @GetMapping("/api/v1/stocks/{companyCode}/prices") + ResponseEntity> getStockByCompany( + @Parameter(description = "기업 코드 (최대 10자리)") + @PathVariable("companyCode") + @Size(max = 10, message = "기업코드는 10자리 이하여야 합니다") + @Pattern(regexp = "^[A-Z0-9]+$", message = "기업코드는 영문 대문자와 숫자만 허용됩니다") + String companyCode, + + @Parameter(description = "조회 시작 날짜 (yyyy-MM-dd)") + @RequestParam("startDate") + @DateTimeFormat(pattern = "yyyy-MM-dd") + @NotNull(message = "시작 날짜는 필수입니다") + @Past(message = "시작 날짜는 과거 날짜여야 합니다") + LocalDate startDate, + + @Parameter(description = "조회 종료 날짜 (yyyy-MM-dd)") + @RequestParam("endDate") + @DateTimeFormat(pattern = "yyyy-MM-dd") + @NotNull(message = "종료 날짜는 필수입니다") + @PastOrPresent(message = "종료 날짜는 과거나 현재 날짜여야 합니다") + LocalDate endDate + ); + } From c2cb04ca43368f503b41fa9ba3fe741fed915594 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 02:15:05 +0900 Subject: [PATCH 23/37] =?UTF-8?q?feat:=20=ED=8A=B9=EC=A0=95=20=EA=B8=B0?= =?UTF-8?q?=EC=97=85=EC=9D=98=20=EC=A3=BC=EA=B0=80(=EC=A2=85=EA=B0=80)=20?= =?UTF-8?q?=EC=A0=95=EB=B3=B4=EB=A5=BC=20=EC=A1=B0=ED=9A=8C=ED=95=98?= =?UTF-8?q?=EC=97=AC=20=EC=9D=91=EB=8B=B5=EC=9D=84=20=EC=A3=BC=EB=8A=94=20?= =?UTF-8?q?API=20=EA=B5=AC=ED=98=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../common/config/SwaggerConfig.java | 3 +- .../core/exception/CustomErrorCode.java | 1 + .../ktb/dev/assignment/domain/Company.java | 16 ++++++++ .../dev/assignment/domain/StocksHistory.java | 26 ++++++++++++ .../v1/controller/StockPriceController.java | 28 +++++++++++++ .../v1/dto/GetStockByCompanyCodeRequest.java | 4 -- .../v1/dto/GetStockByCompanyCodeResponse.java | 22 +++++++++- .../presentation/v1/dto/StockPriceDto.java | 8 ++++ .../repository/CompanyRepository.java | 13 +++++- .../repository/StocksHistoryRepository.java | 24 ++++++++++- .../assignment/service/StockPriceService.java | 41 +++++++++++++++++++ 11 files changed, 177 insertions(+), 9 deletions(-) delete mode 100644 src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeRequest.java create mode 100644 src/main/java/org/ktb/dev/assignment/presentation/v1/dto/StockPriceDto.java diff --git a/src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java index 84386ea..0894033 100644 --- a/src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java +++ b/src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java @@ -40,7 +40,8 @@ public OpenAPI openAPI() { public GroupedOpenApi stockV1Api() { return GroupedOpenApi.builder() .group("거래 API") - .pathsToMatch("/api/stock/**") + .pathsToMatch("/api/v1/**") + .packagesToScan("org.ktb.dev.assignment.presentation.v1") .build(); } } diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java index 0b1b29f..e7d942d 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java @@ -29,6 +29,7 @@ public enum CustomErrorCode implements ErrorCode { // 404 Not Found API_NOT_FOUND(404, "E201", "요청한 API를 찾을 수 없습니다."), RESOURCE_NOT_FOUND(404, "E202", "요청한 리소스를 찾을 수 없습니다."), + COMPANY_NOT_FOUND(404, "E203", "해당 기업 코드를 찾을 수 없습니다."), // 429 Too Many Requests RATE_LIMIT_EXCEEDED(429, "E301", "요청 제한을 초과했습니다. {limit}건/{duration}초 제한"), diff --git a/src/main/java/org/ktb/dev/assignment/domain/Company.java b/src/main/java/org/ktb/dev/assignment/domain/Company.java index 58f0cc5..16a2b09 100644 --- a/src/main/java/org/ktb/dev/assignment/domain/Company.java +++ b/src/main/java/org/ktb/dev/assignment/domain/Company.java @@ -1,4 +1,20 @@ package org.ktb.dev.assignment.domain; +import jakarta.persistence.*; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +@Entity +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) public class Company { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + @Column(name = "company_code") + private String companyCode; + + @Column(name = "company_name") + private String companyName; } diff --git a/src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java b/src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java index c42a718..d226d47 100644 --- a/src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java +++ b/src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java @@ -1,4 +1,30 @@ package org.ktb.dev.assignment.domain; +import jakarta.persistence.*; +import lombok.AccessLevel; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import java.time.LocalDate; + +@Entity +@Getter +@NoArgsConstructor(access = AccessLevel.PROTECTED) public class StocksHistory { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + @Column(name = "company_code") + private String companyCode; + @Column(name = "trade_date") + private LocalDate tradeDate; + @Column(name = "open_price") + private float openPrice; + @Column(name = "high_price") + private float highPrice; + @Column(name = "low_price") + private float lowPrice; + @Column(name = "close_price") + private float closePrice; + private float volume; } diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java index 039af7a..70f1575 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java @@ -1,4 +1,32 @@ package org.ktb.dev.assignment.presentation.v1.controller; +import jakarta.validation.constraints.Size; +import org.ktb.dev.assignment.core.response.SuccessResponse; +import org.ktb.dev.assignment.presentation.v1.dto.GetStockByCompanyCodeResponse; +import org.ktb.dev.assignment.service.StockPriceService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.format.annotation.DateTimeFormat; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.PathVariable; +import org.springframework.web.bind.annotation.RequestParam; +import org.springframework.web.bind.annotation.RestController; + +import java.time.LocalDate; + +@RestController public class StockPriceController implements StockPriceApi { + private final StockPriceService stockPriceService; + + public StockPriceController(StockPriceService stockPriceService) { + this.stockPriceService = stockPriceService; + } + + @Override + public ResponseEntity> getStockByCompany( + String companyCode, LocalDate startDate, LocalDate endDate) { + return SuccessResponse.of( + stockPriceService.getStockByCompany(companyCode, startDate, endDate) + ).asHttp(HttpStatus.OK); + } } diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeRequest.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeRequest.java deleted file mode 100644 index 50c631d..0000000 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeRequest.java +++ /dev/null @@ -1,4 +0,0 @@ -package org.ktb.dev.assignment.presentation.v1.dto; - -public class GetStockByCompanyCodeRequest { -} diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java index e256f5b..a1d5b56 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java @@ -1,4 +1,22 @@ package org.ktb.dev.assignment.presentation.v1.dto; -public class GetStockByCompanyCodeResponse { -} +import io.swagger.v3.oas.annotations.media.Schema; + +import java.util.List; + +@Schema(name="GetStockByCompanyCodeResponse", description ="기업 별 기간 내 주식 정보 조회 결과") +public record GetStockByCompanyCodeResponse( + @Schema(description = "기업명", requiredMode = Schema.RequiredMode.REQUIRED) + String companyName, + + @Schema(description = "주가 정보 목록", requiredMode = Schema.RequiredMode.REQUIRED) + List stockPrices +) { + public record StockPriceInfo( + @Schema(description = "거래일", requiredMode = Schema.RequiredMode.REQUIRED) + String tradeDate, + + @Schema(description = "가격", requiredMode = Schema.RequiredMode.REQUIRED) + float closingPrice + ) {} +} \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/StockPriceDto.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/StockPriceDto.java new file mode 100644 index 0000000..6ec4924 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/StockPriceDto.java @@ -0,0 +1,8 @@ +package org.ktb.dev.assignment.presentation.v1.dto; + +import java.time.LocalDate; + +public record StockPriceDto( + LocalDate tradeDate, + float closePrice +) {} diff --git a/src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java b/src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java index 6d3020b..05e6ca8 100644 --- a/src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java +++ b/src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java @@ -1,4 +1,15 @@ package org.ktb.dev.assignment.repository; -public class CompanyRepository { +import org.ktb.dev.assignment.domain.Company; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.jpa.repository.Query; +import org.springframework.data.repository.query.Param; +import org.springframework.stereotype.Repository; + +import java.util.Optional; + +@Repository +public interface CompanyRepository extends JpaRepository { + @Query("SELECT c.companyName FROM Company c WHERE c.companyCode = :companyCode") + Optional findCompanyNameByCode(@Param("companyCode") String companyCode); } diff --git a/src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java b/src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java index 673129c..680f018 100644 --- a/src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java +++ b/src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java @@ -1,4 +1,26 @@ package org.ktb.dev.assignment.repository; -public class StocksHistoryRepository { +import org.ktb.dev.assignment.domain.StocksHistory; +import org.ktb.dev.assignment.presentation.v1.dto.StockPriceDto; +import org.springframework.data.jpa.repository.JpaRepository; +import org.springframework.data.jpa.repository.Query; +import org.springframework.data.repository.query.Param; +import org.springframework.stereotype.Repository; + +import java.time.LocalDate; +import java.util.List; + +@Repository +public interface StocksHistoryRepository extends JpaRepository { + + @Query("SELECT new org.ktb.dev.assignment.presentation.v1.dto.StockPriceDto(sh.tradeDate, sh.closePrice) " + + "FROM StocksHistory sh " + + "WHERE sh.companyCode = :companyCode " + + "AND sh.tradeDate BETWEEN :startDate AND :endDate " + + "ORDER BY sh.tradeDate") + List findStockPricesByCompanyAndDateRange( + @Param("companyCode") String companyCode, + @Param("startDate") LocalDate startDate, + @Param("endDate") LocalDate endDate + ); } diff --git a/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java b/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java index 4fb37a1..ad825ea 100644 --- a/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java +++ b/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java @@ -1,4 +1,45 @@ package org.ktb.dev.assignment.service; +import org.ktb.dev.assignment.core.exception.BusinessException; +import org.ktb.dev.assignment.core.exception.CustomErrorCode; +import org.ktb.dev.assignment.presentation.v1.dto.GetStockByCompanyCodeResponse; +import org.ktb.dev.assignment.presentation.v1.dto.StockPriceDto; +import org.ktb.dev.assignment.repository.CompanyRepository; +import org.ktb.dev.assignment.repository.StocksHistoryRepository; +import org.springframework.stereotype.Service; + +import java.time.LocalDate; +import java.util.List; + +@Service public class StockPriceService { + private final CompanyRepository companyRepository; + private final StocksHistoryRepository stocksHistoryRepository; + + public StockPriceService( + CompanyRepository companyRepository, + StocksHistoryRepository stocksHistoryRepository) { + this.companyRepository = companyRepository; + this.stocksHistoryRepository = stocksHistoryRepository; + } + + public GetStockByCompanyCodeResponse getStockByCompany(String companyCode, LocalDate startDate, LocalDate endDate) { + String companyName = companyRepository.findCompanyNameByCode(companyCode) + .orElseThrow(() -> new BusinessException( + CustomErrorCode.RESOURCE_NOT_FOUND, + String.format("기업 코드 %s를 찾을 수 없습니다.", companyCode) + )); + + List stockPriceDtoList = stocksHistoryRepository + .findStockPricesByCompanyAndDateRange(companyCode, startDate, endDate); + + List stockPriceInfos = stockPriceDtoList.stream() + .map(sp -> new GetStockByCompanyCodeResponse.StockPriceInfo( + sp.tradeDate().toString(), + sp.closePrice() + )) + .toList(); + + return new GetStockByCompanyCodeResponse(companyName, stockPriceInfos); + } } From e3e1c3ae40c2cfc8ac25868f60040f357c15d277 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 02:19:51 +0900 Subject: [PATCH 24/37] =?UTF-8?q?feat:=20=ED=98=B8=ED=99=98=EB=90=98?= =?UTF-8?q?=EB=8A=94=20=EB=B2=84=EC=A0=84=20=ED=99=95=EC=9D=B8=20=EC=A3=BC?= =?UTF-8?q?=EC=84=9D=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 1 + 1 file changed, 1 insertion(+) diff --git a/build.gradle b/build.gradle index 6ec7417..3b87c48 100644 --- a/build.gradle +++ b/build.gradle @@ -17,6 +17,7 @@ repositories { mavenCentral() } +// 호환되는 버전 확인 : https://docs.spring.io/spring-boot/appendix/dependency-versions/coordinates.html# dependencies { implementation 'org.springframework.boot:spring-boot-starter-web' testImplementation 'org.springframework.boot:spring-boot-starter-test' From e742507593f90b1f9ae959a6c7213259e2682056 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 04:19:05 +0900 Subject: [PATCH 25/37] =?UTF-8?q?fix=20:=20=EA=B8=80=EB=A1=9C=EB=B2=8C=20?= =?UTF-8?q?=EC=97=90=EB=9F=AC=20=EC=BD=94=EB=93=9C=20=EC=B2=98=EB=A6=AC=20?= =?UTF-8?q?=EB=B0=A9=EC=8B=9D=20=EC=88=98=EC=A0=95=20=EB=B0=8F=20=EC=9C=84?= =?UTF-8?q?=EC=B9=98=20=EC=9D=B4=EB=8F=99?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../GlobalExceptionHandler.java | 67 ++++++++++++++++++- .../core/exception/CustomErrorCode.java | 2 +- .../core/response/ErrorResponse.java | 22 ++++-- .../assignment/service/StockPriceService.java | 2 +- 4 files changed, 83 insertions(+), 10 deletions(-) rename src/main/java/org/ktb/dev/assignment/core/{exception => Handler}/GlobalExceptionHandler.java (57%) diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java similarity index 57% rename from src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java rename to src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java index abc8429..2498ba9 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/GlobalExceptionHandler.java +++ b/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java @@ -1,8 +1,13 @@ -package org.ktb.dev.assignment.core.exception; +package org.ktb.dev.assignment.core.Handler; +import jakarta.validation.ConstraintViolationException; import lombok.NonNull; import lombok.extern.slf4j.Slf4j; +import org.ktb.dev.assignment.core.exception.BusinessException; +import org.ktb.dev.assignment.core.exception.CustomErrorCode; +import org.ktb.dev.assignment.core.exception.ErrorCode; import org.ktb.dev.assignment.core.response.ErrorResponse; +import org.springframework.beans.TypeMismatchException; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatusCode; import org.springframework.http.ResponseEntity; @@ -32,7 +37,7 @@ public class GlobalExceptionHandler extends ResponseEntityExceptionHandler { @ExceptionHandler(BusinessException.class) public ResponseEntity handleBusinessException(BusinessException ex) { log.error("[BusinessException] {}", ex.getMessage(), ex); - return handleExceptionInternal(ex.getErrorCode()); + return handleExceptionInternal(ex.getErrorCode(), ex.getMessage()); } /** @@ -76,6 +81,54 @@ protected ResponseEntity handleDateTimeParseException( return handleExceptionInternal(CustomErrorCode.INVALID_DATE_FORMAT); } + /** + * Bean Validation 관련 예외 처리 (@NotNull, @Past 등) + */ + @ExceptionHandler(ConstraintViolationException.class) + protected ResponseEntity handleConstraintViolation( + ConstraintViolationException ex) { + log.error("[ConstraintViolationException] {}", ex.getMessage(), ex); + + List validationErrorList = ex.getConstraintViolations() + .stream() + .map(violation -> ErrorResponse.ValidationError.of( + extractFieldName(violation.getPropertyPath().toString()), + violation.getMessage(), + violation.getInvalidValue() + )) + .collect(Collectors.toList()); + + return ResponseEntity.status(CustomErrorCode.INVALID_INPUT_VALUE.getStatus()) + .body(ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrorList)); + } + + /** + * 날짜 형식 변환 실패 예외 처리 - 메시지 개선 + */ + @Override + protected ResponseEntity handleTypeMismatch( + @NonNull TypeMismatchException ex, + @NonNull HttpHeaders headers, + @NonNull HttpStatusCode status, + @NonNull WebRequest request) { + + log.error("[TypeMismatchException] {}", ex.getMessage(), ex); + + if (ex.getRequiredType() != null && LocalDate.class.isAssignableFrom(ex.getRequiredType())) { + List validationErrorList = List.of( + ErrorResponse.ValidationError.of( + ex.getPropertyName(), + "날짜 형식은 'yyyy-MM-dd'이어야 합니다", + ex.getValue() + ) + ); + return ResponseEntity.status(CustomErrorCode.INVALID_DATE_FORMAT.getStatus()) + .body(ErrorResponse.of(CustomErrorCode.INVALID_DATE_FORMAT, validationErrorList)); + } + + return handleExceptionInternal(CustomErrorCode.INVALID_INPUT_VALUE); + } + /** * 예상치 못한 예외 처리 */ @@ -90,6 +143,10 @@ private ResponseEntity handleExceptionInternal(ErrorCode errorCode) { return ResponseEntity.status(errorCode.getStatus()) .body(ErrorResponse.of(errorCode)); } + private ResponseEntity handleExceptionInternal(ErrorCode errorCode, String message) { + return ResponseEntity.status(errorCode.getStatus()) + .body(ErrorResponse.of(errorCode, message)); + } // 유효성 검증 에러 응답 생성 private ResponseEntity handleValidationExceptionInternal(BindException bindException) { @@ -103,4 +160,10 @@ private ResponseEntity handleValidationExceptionInternal(BindException b return ResponseEntity.status(CustomErrorCode.INVALID_INPUT_VALUE.getStatus()) .body(ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrorList)); } + + // 필드명 추출 헬퍼 메소드 + private String extractFieldName(String propertyPath) { + String[] parts = propertyPath.split("\\."); + return parts[parts.length - 1]; + } } \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java index e7d942d..eed3897 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java @@ -29,7 +29,7 @@ public enum CustomErrorCode implements ErrorCode { // 404 Not Found API_NOT_FOUND(404, "E201", "요청한 API를 찾을 수 없습니다."), RESOURCE_NOT_FOUND(404, "E202", "요청한 리소스를 찾을 수 없습니다."), - COMPANY_NOT_FOUND(404, "E203", "해당 기업 코드를 찾을 수 없습니다."), + COMPANY_NOT_FOUND(404, "E203", "기업 코드 %s를 찾을 수 없습니다."), // 429 Too Many Requests RATE_LIMIT_EXCEEDED(429, "E301", "요청 제한을 초과했습니다. {limit}건/{duration}초 제한"), diff --git a/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java index 2703d88..96a0fd0 100644 --- a/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java +++ b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java @@ -27,15 +27,25 @@ public static ErrorResponse of(ErrorCode errorCode, List valida return new ErrorResponse(new ErrorInfo(errorCode.getCode(), errorCode.getMessage(), validationErrorList)); } - public static ErrorResponse of(ErrorCode errorCode, String additionalMessage) { - return new ErrorResponse(new ErrorInfo(errorCode.getCode(), - errorCode.getMessage() + " : " + additionalMessage, null)); + public static ErrorResponse of(ErrorCode errorCode, String message) { + return new ErrorResponse(new ErrorInfo(errorCode.getCode(), message, null)); } - public record ValidationError(String field, String message) { - + public record ValidationError( + String field, + String message, + @JsonInclude(JsonInclude.Include.NON_NULL) + Object rejectedValue + ) { public static ValidationError of(final FieldError fieldError) { - return new ValidationError(fieldError.getField(), fieldError.getDefaultMessage()); + return new ValidationError( + fieldError.getField(), + fieldError.getDefaultMessage(), + fieldError.getRejectedValue() + ); + } + public static ValidationError of(String field, String message, Object rejectedValue) { + return new ValidationError(field, message, rejectedValue); } } diff --git a/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java b/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java index ad825ea..34804e7 100644 --- a/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java +++ b/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java @@ -26,7 +26,7 @@ public StockPriceService( public GetStockByCompanyCodeResponse getStockByCompany(String companyCode, LocalDate startDate, LocalDate endDate) { String companyName = companyRepository.findCompanyNameByCode(companyCode) .orElseThrow(() -> new BusinessException( - CustomErrorCode.RESOURCE_NOT_FOUND, + CustomErrorCode.COMPANY_NOT_FOUND, String.format("기업 코드 %s를 찾을 수 없습니다.", companyCode) )); From 4ca90eb797ae96738502e44ffa6bbf3e9f26b4f3 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 05:02:20 +0900 Subject: [PATCH 26/37] =?UTF-8?q?fix=20:=20=EA=B8=80=EB=A1=9C=EB=B2=8C=20?= =?UTF-8?q?=EC=97=90=EB=9F=AC=20=EC=BD=94=EB=93=9C=20=EC=B2=98=EB=A6=AC=20?= =?UTF-8?q?=EB=B0=A9=EC=8B=9D=20=EC=88=98=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../core/Handler/GlobalExceptionHandler.java | 203 +++++++++--------- .../v1/controller/StockPriceApi.java | 2 + .../v1/controller/StockPriceController.java | 1 + 3 files changed, 106 insertions(+), 100 deletions(-) diff --git a/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java index 2498ba9..8f7c6ed 100644 --- a/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java +++ b/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java @@ -7,12 +7,11 @@ import org.ktb.dev.assignment.core.exception.CustomErrorCode; import org.ktb.dev.assignment.core.exception.ErrorCode; import org.ktb.dev.assignment.core.response.ErrorResponse; -import org.springframework.beans.TypeMismatchException; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatusCode; import org.springframework.http.ResponseEntity; -import org.springframework.validation.BindException; import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.MissingServletRequestParameterException; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.RestControllerAdvice; import org.springframework.web.context.request.WebRequest; @@ -24,144 +23,148 @@ import java.util.List; import java.util.stream.Collectors; -/** - * 전역 예외 처리를 담당하는 핸들러 - */ @RestControllerAdvice @Slf4j public class GlobalExceptionHandler extends ResponseEntityExceptionHandler { + private static final String LOG_FORMAT = "[{}] {}"; + /** * 비즈니스 예외 처리 */ @ExceptionHandler(BusinessException.class) - public ResponseEntity handleBusinessException(BusinessException ex) { - log.error("[BusinessException] {}", ex.getMessage(), ex); - return handleExceptionInternal(ex.getErrorCode(), ex.getMessage()); + public ResponseEntity handleBusinessException(BusinessException ex) { + log.error(LOG_FORMAT, "BusinessException", ex.getMessage(), ex); + return createErrorResponse( + ex.getErrorCode(), + ErrorResponse.of(ex.getErrorCode(), ex.getMessage()) + ); } /** - * 유효성 검증(@Valid) 예외 처리 + * 필수값 누락 예외처리 */ @Override - @NonNull - protected ResponseEntity handleMethodArgumentNotValid( - @NonNull MethodArgumentNotValidException ex, - @NonNull HttpHeaders headers, - @NonNull HttpStatusCode status, - @NonNull WebRequest request) { - - log.error("[ValidationException] {}", ex.getMessage(), ex); - return handleValidationExceptionInternal(ex); + protected ResponseEntity handleMissingServletRequestParameter( + MissingServletRequestParameterException ex, + HttpHeaders headers, + HttpStatusCode status, + WebRequest request) { + + log.error(LOG_FORMAT, "MissingParameterException", ex.getMessage(), ex); + + List validationErrors = List.of( + ErrorResponse.ValidationError.of( + ex.getParameterName(), + String.format("필수 파라미터 %s가 누락되었습니다", ex.getParameterName()), + null + ) + ); + + return createErrorResponse( + CustomErrorCode.INVALID_INPUT_VALUE, + ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrors) + ); } /** - * 날짜 형식 변환 실패 예외 처리 + * API 검증 관련 모든 예외를 처리하는 통합 핸들러 */ - @ExceptionHandler(MethodArgumentTypeMismatchException.class) - protected ResponseEntity handleMethodArgumentTypeMismatch( - MethodArgumentTypeMismatchException ex) { - log.error("[DateFormatException] {}", ex.getMessage(), ex); - - // 날짜 형식 에러인 경우에만 특정 메시지 처리 - if (LocalDate.class.isAssignableFrom(ex.getRequiredType())) { - return handleExceptionInternal(CustomErrorCode.INVALID_DATE_FORMAT); + @ExceptionHandler({ + ConstraintViolationException.class, + DateTimeParseException.class, + MethodArgumentTypeMismatchException.class + }) + protected ResponseEntity handleValidationExceptions(Exception ex) { + log.error(LOG_FORMAT, "ValidationException", ex.getMessage(), ex); + + List validationErrors; + + if (ex instanceof ConstraintViolationException cve) { + validationErrors = cve.getConstraintViolations() + .stream() + .map(violation -> ErrorResponse.ValidationError.of( + extractFieldName(violation.getPropertyPath().toString()), + violation.getMessage(), + violation.getInvalidValue() + )) + .collect(Collectors.toList()); + } else if (ex instanceof MethodArgumentTypeMismatchException matme) { + String field = matme.getName(); + String message = matme.getRequiredType() != null + && LocalDate.class.isAssignableFrom(matme.getRequiredType()) + ? "날짜 형식은 'yyyy-MM-dd'이어야 합니다" + : "잘못된 형식입니다"; + + validationErrors = List.of( + ErrorResponse.ValidationError.of(field, message, matme.getValue()) + ); + } else if (ex instanceof DateTimeParseException dtpe) { + validationErrors = List.of( + ErrorResponse.ValidationError.of( + "date", + "날짜 형식은 'yyyy-MM-dd'이어야 합니다", + dtpe.getParsedString() + ) + ); + } else { + validationErrors = List.of( + ErrorResponse.ValidationError.of( + "unknown", + "잘못된 입력값입니다", + null + ) + ); } - return handleExceptionInternal(CustomErrorCode.INVALID_INPUT_VALUE); - } - - /** - * 날짜 파싱 실패 예외 처리 - */ - @ExceptionHandler(DateTimeParseException.class) - protected ResponseEntity handleDateTimeParseException( - DateTimeParseException ex) { - log.error("[DateParseException] {}", ex.getMessage(), ex); - return handleExceptionInternal(CustomErrorCode.INVALID_DATE_FORMAT); - } - - /** - * Bean Validation 관련 예외 처리 (@NotNull, @Past 등) - */ - @ExceptionHandler(ConstraintViolationException.class) - protected ResponseEntity handleConstraintViolation( - ConstraintViolationException ex) { - log.error("[ConstraintViolationException] {}", ex.getMessage(), ex); - - List validationErrorList = ex.getConstraintViolations() - .stream() - .map(violation -> ErrorResponse.ValidationError.of( - extractFieldName(violation.getPropertyPath().toString()), - violation.getMessage(), - violation.getInvalidValue() - )) - .collect(Collectors.toList()); - - return ResponseEntity.status(CustomErrorCode.INVALID_INPUT_VALUE.getStatus()) - .body(ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrorList)); + return (ResponseEntity) createErrorResponse( + CustomErrorCode.INVALID_INPUT_VALUE, + ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrors) + ); } /** - * 날짜 형식 변환 실패 예외 처리 - 메시지 개선 + * @Valid, @Validated 어노테이션 검증 실패 처리 */ @Override - protected ResponseEntity handleTypeMismatch( - @NonNull TypeMismatchException ex, + protected ResponseEntity handleMethodArgumentNotValid( + MethodArgumentNotValidException ex, @NonNull HttpHeaders headers, @NonNull HttpStatusCode status, @NonNull WebRequest request) { - log.error("[TypeMismatchException] {}", ex.getMessage(), ex); + log.error(LOG_FORMAT, "MethodArgumentNotValidException", ex.getMessage(), ex); - if (ex.getRequiredType() != null && LocalDate.class.isAssignableFrom(ex.getRequiredType())) { - List validationErrorList = List.of( - ErrorResponse.ValidationError.of( - ex.getPropertyName(), - "날짜 형식은 'yyyy-MM-dd'이어야 합니다", - ex.getValue() - ) - ); - return ResponseEntity.status(CustomErrorCode.INVALID_DATE_FORMAT.getStatus()) - .body(ErrorResponse.of(CustomErrorCode.INVALID_DATE_FORMAT, validationErrorList)); - } + List validationErrors = ex.getBindingResult() + .getFieldErrors() + .stream() + .map(ErrorResponse.ValidationError::of) + .collect(Collectors.toList()); - return handleExceptionInternal(CustomErrorCode.INVALID_INPUT_VALUE); + return createErrorResponse( + CustomErrorCode.INVALID_INPUT_VALUE, + ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrors) + ); } /** * 예상치 못한 예외 처리 */ @ExceptionHandler(Exception.class) - public ResponseEntity handleAllException(Exception ex) { - log.error("[UnexpectedException] {}", ex.getMessage(), ex); - return handleExceptionInternal(CustomErrorCode.INTERNAL_SERVER_ERROR); - } - - // 에러 응답 생성 - private ResponseEntity handleExceptionInternal(ErrorCode errorCode) { - return ResponseEntity.status(errorCode.getStatus()) - .body(ErrorResponse.of(errorCode)); - } - private ResponseEntity handleExceptionInternal(ErrorCode errorCode, String message) { - return ResponseEntity.status(errorCode.getStatus()) - .body(ErrorResponse.of(errorCode, message)); + public ResponseEntity handleAllException(Exception ex) { + log.error(LOG_FORMAT, "UnexpectedException", ex.getMessage(), ex); + return (ResponseEntity) createErrorResponse( + CustomErrorCode.INTERNAL_SERVER_ERROR, + ErrorResponse.of(CustomErrorCode.INTERNAL_SERVER_ERROR) + ); } - // 유효성 검증 에러 응답 생성 - private ResponseEntity handleValidationExceptionInternal(BindException bindException) { - List validationErrorList = bindException - .getBindingResult() - .getFieldErrors() - .stream() - .map(ErrorResponse.ValidationError::of) - .collect(Collectors.toList()); - - return ResponseEntity.status(CustomErrorCode.INVALID_INPUT_VALUE.getStatus()) - .body(ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrorList)); + private ResponseEntity createErrorResponse(ErrorCode errorCode, T body) { + return ResponseEntity + .status(errorCode.getStatus()) + .body(body); } - // 필드명 추출 헬퍼 메소드 private String extractFieldName(String propertyPath) { String[] parts = propertyPath.split("\\."); return parts[parts.length - 1]; diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java index 8f18ae2..c9d3df5 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java @@ -9,6 +9,7 @@ import org.ktb.dev.assignment.presentation.v1.dto.GetStockByCompanyCodeResponse; import org.springframework.format.annotation.DateTimeFormat; import org.springframework.http.ResponseEntity; +import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestParam; @@ -18,6 +19,7 @@ import java.time.LocalDate; @Tag(name = "주가 조회 API", description = "주가 정보를 조회") +@Validated public interface StockPriceApi { @Operation(summary = "기업의 주가 조회 API", description = "기간 내 특정 기업의 주가 정보를 조회") diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java index 70f1575..6d54422 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java @@ -8,6 +8,7 @@ import org.springframework.format.annotation.DateTimeFormat; import org.springframework.http.HttpStatus; import org.springframework.http.ResponseEntity; +import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; From bd16056d7296810c7cdcfee99342ab243cd6b17e Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 05:38:37 +0900 Subject: [PATCH 27/37] =?UTF-8?q?feat:=20API=5FKEY=20=EA=B2=80=EC=A6=9D=20?= =?UTF-8?q?=EA=B5=AC=ED=98=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../assignment/common/config/WebConfig.java | 50 +++++++++++++++++++ src/main/resources/application.yml | 6 ++- 2 files changed, 55 insertions(+), 1 deletion(-) diff --git a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java index f0cb407..ca686e6 100644 --- a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java +++ b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java @@ -1,16 +1,34 @@ package org.ktb.dev.assignment.common.config; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import jakarta.validation.Valid; +import lombok.extern.slf4j.Slf4j; +import org.ktb.dev.assignment.core.exception.BusinessException; +import org.ktb.dev.assignment.core.exception.CustomErrorCode; +import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Configuration; +import org.springframework.web.servlet.HandlerInterceptor; import org.springframework.web.servlet.config.annotation.CorsRegistry; +import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; +import java.util.Arrays; + /* * !!할일 : 프로트엔드 포트에 맞게 CORS 설정 수정 필요 ! * author : hyuk.kim (김상혁) */ +@Slf4j @Configuration public class WebConfig implements WebMvcConfigurer { + private static final String HEADER_API_KEY = "x-api-key"; + private static final String PARAM_API_KEY = "apikey"; + + @Value("${api.key.secret}") + private String API_KEY; + @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/api/**") @@ -19,4 +37,36 @@ public void addCorsMappings(CorsRegistry registry) { .allowedHeaders("*") .allowCredentials(true); } + + @Override + public void addInterceptors(InterceptorRegistry registry) { + registry.addInterceptor(new HandlerInterceptor() { + @Override + public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) { + // 헤더에서 API 키 확인 + String headerApiKey = request.getHeader(HEADER_API_KEY); + // 파라미터에서 API 키 확인 + String paramApiKey = request.getParameter(PARAM_API_KEY); + + // 둘 다 없는 경우 + if (headerApiKey == null && paramApiKey == null) { + response.setStatus(HttpServletResponse.SC_BAD_REQUEST); + throw new BusinessException(CustomErrorCode.MISSING_API_KEY); + } + + // 키 검증 + if (headerApiKey != null && headerApiKey.equals(API_KEY)) { + return true; + } + + if (paramApiKey != null && paramApiKey.equals(API_KEY)) { + return true; + } + + // 여기까지 왔다면 키가 불일치 + response.setStatus(HttpServletResponse.SC_FORBIDDEN); + throw new BusinessException(CustomErrorCode.INVALID_API_KEY); + } + }).addPathPatterns("/api/**"); + } } \ No newline at end of file diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index ff1a1dc..ee6843b 100644 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -23,7 +23,11 @@ spring: default_batch_fetch_size: 100 open-in-view: false +api: + key: + secret: ${API_SECRET_KEY} + logging: level: org.hibernate.SQL: debug - org.hibernate.type: trace \ No newline at end of file + org.hibernate.type: trace From 9bef816ca96b5c8cfbe9b0ea4eea6df9647a0aaa Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 16:31:10 +0900 Subject: [PATCH 28/37] =?UTF-8?q?fix:=20=EC=97=90=EB=9F=AC=20=EC=B2=98?= =?UTF-8?q?=EB=A6=AC=20=EB=B0=A9=EC=8B=9D=20=EC=97=85=EB=8D=B0=EC=9D=B4?= =?UTF-8?q?=ED=8A=B8=20=EC=9E=AC=EC=82=AC=EC=9A=A9=EC=84=B1=EC=9D=84=20?= =?UTF-8?q?=EB=86=92=EC=9D=B4=EA=B8=B0=20=EC=9C=84=ED=95=B4=20=EA=B8=B0?= =?UTF-8?q?=EC=A1=B4=20CustomErrorCode=EC=97=90=EC=84=9C=20Code,=20Message?= =?UTF-8?q?=20=EB=B6=84=EB=A6=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../core/Handler/GlobalExceptionHandler.java | 6 +-- .../core/exception/BusinessException.java | 19 +++++---- .../core/exception/CustomErrorCode.java | 40 +++++++++++-------- .../core/exception/CustomErrorMessage.java | 40 +++++++++++++++++++ 4 files changed, 79 insertions(+), 26 deletions(-) create mode 100644 src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorMessage.java diff --git a/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java index 8f7c6ed..5798389 100644 --- a/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java +++ b/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java @@ -71,9 +71,9 @@ protected ResponseEntity handleMissingServletRequestParameter( * API 검증 관련 모든 예외를 처리하는 통합 핸들러 */ @ExceptionHandler({ - ConstraintViolationException.class, - DateTimeParseException.class, - MethodArgumentTypeMismatchException.class + ConstraintViolationException.class, // @Valid @NotNull + DateTimeParseException.class, // 날짜 문자열 파싱 에러 + MethodArgumentTypeMismatchException.class // 파라미터 타입 변환 실패 }) protected ResponseEntity handleValidationExceptions(Exception ex) { log.error(LOG_FORMAT, "ValidationException", ex.getMessage(), ex); diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java b/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java index 7dd2136..237343b 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java +++ b/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java @@ -7,24 +7,29 @@ public class BusinessException extends RuntimeException { private final ErrorCode errorCode; - /* - * 에러 코드만 반환 - */ + // 에러 코드만 반환 public BusinessException(ErrorCode errorCode) { super(errorCode.getMessage()); this.errorCode = errorCode; } - /* - * 에러 코드 + 반환 - */ + // 에러 코드 + Throwable 반환 public BusinessException(ErrorCode errorCode, Throwable throwable) { super(errorCode.getMessage(), throwable); this.errorCode = errorCode; } + // 에러 코드 + 메시지 반환 public BusinessException(ErrorCode errorCode, String message) { super(message); this.errorCode = errorCode; } -} + + // 에러 코드 + 메시지 포맷팅을 위한 args 반환 + public BusinessException(ErrorCode errorCode, Object... args) { + super(errorCode instanceof CustomErrorCode ? + ((CustomErrorCode) errorCode).formatMessage(args) : + errorCode.getMessage()); + this.errorCode = errorCode; + } +} \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java index eed3897..eea72a0 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java @@ -2,6 +2,8 @@ import lombok.RequiredArgsConstructor; +import java.text.MessageFormat; + @RequiredArgsConstructor public enum CustomErrorCode implements ErrorCode { /* @@ -15,32 +17,30 @@ public enum CustomErrorCode implements ErrorCode { */ // 400 Bad Request - MISSING_REQUIRED_PARAMETER(400, "E001", "필수 파라미터가 누락되었습니다."), - INVALID_PARAMETER_VALUE(400, "E002", "잘못된 파라미터 값입니다."), - MISSING_API_KEY(400, "E003", "API 키가 누락되었습니다."), - INVALID_REQUEST_BODY(400, "E004", "잘못된 요청 본문입니다."), - INVALID_INPUT_VALUE(400, "E005", "잘못된 입력값입니다."), - INVALID_DATE_FORMAT(400, "C003", "날짜 형식이 올바르지 않습니다. (yyyy-MM-dd 형식으로 입력해주세요)"), + MISSING_REQUIRED_PARAMETER(400, "E001", CustomErrorMessage.MISSING_PARAMETER), + INVALID_PARAMETER_VALUE(400, "E002", CustomErrorMessage.INVALID_PARAMETER), + MISSING_API_KEY(400, "E003", CustomErrorMessage.MISSING_API_KEY), + INVALID_REQUEST_BODY(400, "E004", CustomErrorMessage.INVALID_REQUEST_BODY), + INVALID_INPUT_VALUE(400, "E005", CustomErrorMessage.INVALID_INPUT), + INVALID_DATE_FORMAT(400, "E006", CustomErrorMessage.INVALID_DATE_FORMAT), // 403 Forbidden - INVALID_API_KEY(403, "E101", "유효하지 않은 API 키입니다."), - ACCESS_DENIED(403, "E102", "접근이 거부되었습니다."), + INVALID_API_KEY(403, "E101", CustomErrorMessage.INVALID_API_KEY), // 404 Not Found - API_NOT_FOUND(404, "E201", "요청한 API를 찾을 수 없습니다."), - RESOURCE_NOT_FOUND(404, "E202", "요청한 리소스를 찾을 수 없습니다."), - COMPANY_NOT_FOUND(404, "E203", "기업 코드 %s를 찾을 수 없습니다."), + API_NOT_FOUND(404, "E201", CustomErrorMessage.API_NOT_FOUND), + RESOURCE_NOT_FOUND(404, "E202", CustomErrorMessage.RESOURCE_NOT_FOUND), + COMPANY_NOT_FOUND(404, "E203", CustomErrorMessage.COMPANY_NOT_FOUND), // 429 Too Many Requests - RATE_LIMIT_EXCEEDED(429, "E301", "요청 제한을 초과했습니다. {limit}건/{duration}초 제한"), + RATE_LIMIT_EXCEEDED(429, "E301", CustomErrorMessage.RATE_LIMIT_EXCEEDED), // 500 Internal Server Error - INTERNAL_SERVER_ERROR(500, "E901", "서버 내부 오류가 발생했습니다."); - + INTERNAL_SERVER_ERROR(500, "E901", CustomErrorMessage.INTERNAL_SERVER_ERROR); private final int status; private final String code; - private final String message; + private final CustomErrorMessage messageTemplate; @Override public int getStatus() { @@ -54,6 +54,14 @@ public String getCode() { @Override public String getMessage() { - return message; + return messageTemplate.getMessage(); + } + + public String getMessage(Object... args) { + return messageTemplate.formatMessage(args); + } + + public String formatMessage(Object... args) { + return MessageFormat.format(getMessage(), args); } } \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorMessage.java b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorMessage.java new file mode 100644 index 0000000..bb66d22 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorMessage.java @@ -0,0 +1,40 @@ +package org.ktb.dev.assignment.core.exception; + +import lombok.RequiredArgsConstructor; + +import java.text.MessageFormat; + +@RequiredArgsConstructor +public enum CustomErrorMessage { + // 400 Bad Request + MISSING_PARAMETER("필수 파라미터가 누락되었습니다"), + INVALID_PARAMETER("잘못된 파라미터 값입니다"), + MISSING_API_KEY("API 키가 누락되었습니다"), + INVALID_REQUEST_BODY("잘못된 요청 본문입니다"), + INVALID_INPUT("잘못된 입력값입니다"), + INVALID_DATE_FORMAT("날짜 형식이 올바르지 않습니다. (yyyy-MM-dd 형식으로 입력해주세요)"), + + // 403 Forbidden + INVALID_API_KEY("유효하지 않은 API 키입니다"), + + // 404 Not Found + API_NOT_FOUND("요청한 API를 찾을 수 없습니다"), + RESOURCE_NOT_FOUND("요청한 리소스를 찾을 수 없습니다"), + COMPANY_NOT_FOUND("기업 코드 {0}를 찾을 수 없습니다"), + + // 429 Too Many Requests + RATE_LIMIT_EXCEEDED("요청 제한을 초과했습니다. {0}건/{1}초 제한"), + + // 500 Internal Server Error + INTERNAL_SERVER_ERROR("서버 내부 오류가 발생했습니다"); + + private final String messagePattern; + + public String getMessage() { + return messagePattern; + } + + public String formatMessage(Object... args) { + return MessageFormat.format(messagePattern, args); + } +} \ No newline at end of file From 212bcb5d0e434c6084102ca68c6ebeeb6dc73157 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 16:50:42 +0900 Subject: [PATCH 29/37] =?UTF-8?q?fix:=20=EC=97=90=EB=9F=AC=20=EC=B2=98?= =?UTF-8?q?=EB=A6=AC=20=EB=B0=A9=EC=8B=9D=20=EC=97=85=EB=8D=B0=EC=9D=B4?= =?UTF-8?q?=ED=8A=B8=20GlobalExceptionHandler=EC=9D=98=20=EB=B3=B5?= =?UTF-8?q?=EC=9E=A1=ED=95=9C=20=EB=A1=9C=EC=A7=81=EC=9D=84=20=EC=A4=84?= =?UTF-8?q?=EC=9D=B4=EA=B8=B0=20=EC=9C=84=ED=95=9C=20=EC=A0=84=EB=9E=B5=20?= =?UTF-8?q?=EB=B0=A9=EC=8B=9D=20=EC=82=AC=EC=9A=A9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../GlobalExceptionHandler.java | 117 +++++++----------- .../ValidationExceptionHandler.java | 40 ++++++ .../strategy/ConstraintViolationStrategy.java | 30 +++++ .../strategy/DateTimeParseStrategy.java | 21 ++++ .../strategy/DefaultExceptionStrategy.java | 21 ++++ .../strategy/ExceptionStrategy.java | 8 ++ .../strategy/TypeMismatchStrategy.java | 30 +++++ 7 files changed, 193 insertions(+), 74 deletions(-) rename src/main/java/org/ktb/dev/assignment/core/{Handler => handler}/GlobalExceptionHandler.java (56%) create mode 100644 src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/ConstraintViolationStrategy.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/DateTimeParseStrategy.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/DefaultExceptionStrategy.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/ExceptionStrategy.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/TypeMismatchStrategy.java diff --git a/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java similarity index 56% rename from src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java rename to src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java index 5798389..7e2f023 100644 --- a/src/main/java/org/ktb/dev/assignment/core/Handler/GlobalExceptionHandler.java +++ b/src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java @@ -1,11 +1,13 @@ -package org.ktb.dev.assignment.core.Handler; +package org.ktb.dev.assignment.core.handler; import jakarta.validation.ConstraintViolationException; import lombok.NonNull; +import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.ktb.dev.assignment.core.exception.BusinessException; import org.ktb.dev.assignment.core.exception.CustomErrorCode; import org.ktb.dev.assignment.core.exception.ErrorCode; +import org.ktb.dev.assignment.core.handler.validation.ValidationExceptionHandler; import org.ktb.dev.assignment.core.response.ErrorResponse; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatusCode; @@ -18,16 +20,17 @@ import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; -import java.time.LocalDate; import java.time.format.DateTimeParseException; import java.util.List; import java.util.stream.Collectors; @RestControllerAdvice @Slf4j +@RequiredArgsConstructor public class GlobalExceptionHandler extends ResponseEntityExceptionHandler { private static final String LOG_FORMAT = "[{}] {}"; + private final ValidationExceptionHandler validationExceptionHandler; /** * 비즈니스 예외 처리 @@ -35,14 +38,37 @@ public class GlobalExceptionHandler extends ResponseEntityExceptionHandler { @ExceptionHandler(BusinessException.class) public ResponseEntity handleBusinessException(BusinessException ex) { log.error(LOG_FORMAT, "BusinessException", ex.getMessage(), ex); + return createErrorResponse(ex.getErrorCode(), + ErrorResponse.of(ex.getErrorCode(), ex.getMessage())); + } + + /** + * 유효성 검증 예외 처리 + */ + @ExceptionHandler({ + ConstraintViolationException.class, + DateTimeParseException.class, + MethodArgumentTypeMismatchException.class + }) + protected ResponseEntity handleValidationExceptions(Exception ex) { + log.error(LOG_FORMAT, "ValidationException", ex.getMessage(), ex); + + /* + Required type: List + Provided: ErrorResponse + + */ + List validationErrors = + validationExceptionHandler.handleException(ex); + return createErrorResponse( - ex.getErrorCode(), - ErrorResponse.of(ex.getErrorCode(), ex.getMessage()) + CustomErrorCode.INVALID_INPUT_VALUE, + ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrors) ); } /** - * 필수값 누락 예외처리 + * 필수값 누락 예외 처리 */ @Override protected ResponseEntity handleMissingServletRequestParameter( @@ -56,75 +82,19 @@ protected ResponseEntity handleMissingServletRequestParameter( List validationErrors = List.of( ErrorResponse.ValidationError.of( ex.getParameterName(), - String.format("필수 파라미터 %s가 누락되었습니다", ex.getParameterName()), + CustomErrorCode.MISSING_REQUIRED_PARAMETER.formatMessage(ex.getParameterName()), null ) ); return createErrorResponse( - CustomErrorCode.INVALID_INPUT_VALUE, - ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrors) - ); - } - - /** - * API 검증 관련 모든 예외를 처리하는 통합 핸들러 - */ - @ExceptionHandler({ - ConstraintViolationException.class, // @Valid @NotNull - DateTimeParseException.class, // 날짜 문자열 파싱 에러 - MethodArgumentTypeMismatchException.class // 파라미터 타입 변환 실패 - }) - protected ResponseEntity handleValidationExceptions(Exception ex) { - log.error(LOG_FORMAT, "ValidationException", ex.getMessage(), ex); - - List validationErrors; - - if (ex instanceof ConstraintViolationException cve) { - validationErrors = cve.getConstraintViolations() - .stream() - .map(violation -> ErrorResponse.ValidationError.of( - extractFieldName(violation.getPropertyPath().toString()), - violation.getMessage(), - violation.getInvalidValue() - )) - .collect(Collectors.toList()); - } else if (ex instanceof MethodArgumentTypeMismatchException matme) { - String field = matme.getName(); - String message = matme.getRequiredType() != null - && LocalDate.class.isAssignableFrom(matme.getRequiredType()) - ? "날짜 형식은 'yyyy-MM-dd'이어야 합니다" - : "잘못된 형식입니다"; - - validationErrors = List.of( - ErrorResponse.ValidationError.of(field, message, matme.getValue()) - ); - } else if (ex instanceof DateTimeParseException dtpe) { - validationErrors = List.of( - ErrorResponse.ValidationError.of( - "date", - "날짜 형식은 'yyyy-MM-dd'이어야 합니다", - dtpe.getParsedString() - ) - ); - } else { - validationErrors = List.of( - ErrorResponse.ValidationError.of( - "unknown", - "잘못된 입력값입니다", - null - ) - ); - } - - return (ResponseEntity) createErrorResponse( - CustomErrorCode.INVALID_INPUT_VALUE, - ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrors) + CustomErrorCode.MISSING_REQUIRED_PARAMETER, + ErrorResponse.of(CustomErrorCode.MISSING_REQUIRED_PARAMETER, validationErrors) ); } /** - * @Valid, @Validated 어노테이션 검증 실패 처리 + * @Valid 검증 예외 처리 */ @Override protected ResponseEntity handleMethodArgumentNotValid( @@ -138,12 +108,16 @@ protected ResponseEntity handleMethodArgumentNotValid( List validationErrors = ex.getBindingResult() .getFieldErrors() .stream() - .map(ErrorResponse.ValidationError::of) + .map(error -> ErrorResponse.ValidationError.of( + error.getField(), + error.getDefaultMessage(), + error.getRejectedValue() + )) .collect(Collectors.toList()); return createErrorResponse( - CustomErrorCode.INVALID_INPUT_VALUE, - ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrors) + CustomErrorCode.INVALID_REQUEST_BODY, + ErrorResponse.of(CustomErrorCode.INVALID_REQUEST_BODY, validationErrors) ); } @@ -153,7 +127,7 @@ protected ResponseEntity handleMethodArgumentNotValid( @ExceptionHandler(Exception.class) public ResponseEntity handleAllException(Exception ex) { log.error(LOG_FORMAT, "UnexpectedException", ex.getMessage(), ex); - return (ResponseEntity) createErrorResponse( + return createErrorResponse( CustomErrorCode.INTERNAL_SERVER_ERROR, ErrorResponse.of(CustomErrorCode.INTERNAL_SERVER_ERROR) ); @@ -164,9 +138,4 @@ private ResponseEntity createErrorResponse(ErrorCode errorCode, T body) { .status(errorCode.getStatus()) .body(body); } - - private String extractFieldName(String propertyPath) { - String[] parts = propertyPath.split("\\."); - return parts[parts.length - 1]; - } } \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java new file mode 100644 index 0000000..9c5f20c --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java @@ -0,0 +1,40 @@ +package org.ktb.dev.assignment.core.handler.validation; + +import lombok.extern.slf4j.Slf4j; +import org.ktb.dev.assignment.core.exception.CustomErrorCode; +import org.ktb.dev.assignment.core.handler.validation.strategy.ConstraintViolationStrategy; +import org.ktb.dev.assignment.core.handler.validation.strategy.DateTimeParseStrategy; +import org.ktb.dev.assignment.core.handler.validation.strategy.DefaultExceptionStrategy; +import org.ktb.dev.assignment.core.handler.validation.strategy.ExceptionStrategy; +import org.ktb.dev.assignment.core.handler.validation.strategy.TypeMismatchStrategy; +import org.ktb.dev.assignment.core.response.ErrorResponse; +import org.springframework.stereotype.Component; +import org.springframework.web.bind.MethodArgumentNotValidException; + +import jakarta.validation.ConstraintViolationException; +import java.time.format.DateTimeParseException; +import java.util.HashMap; +import java.util.List; +import java.util.Map; +import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; + +@Component +@Slf4j +public class ValidationExceptionHandler { + + private final Map, ExceptionStrategy> strategyMap; + + public ValidationExceptionHandler() { + strategyMap = new HashMap<>(); + strategyMap.put(ConstraintViolationException.class, new ConstraintViolationStrategy()); + strategyMap.put(MethodArgumentTypeMismatchException.class, new TypeMismatchStrategy()); + strategyMap.put(DateTimeParseException.class, new DateTimeParseStrategy()); + } + + // ErrorResponse 대신 List 반환하도록 수정 + public List handleException(Exception ex) { + return strategyMap + .getOrDefault(ex.getClass(), new DefaultExceptionStrategy()) + .handle(ex); + } +} \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/ConstraintViolationStrategy.java b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/ConstraintViolationStrategy.java new file mode 100644 index 0000000..a6b3724 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/ConstraintViolationStrategy.java @@ -0,0 +1,30 @@ +package org.ktb.dev.assignment.core.handler.validation.strategy; + + +import lombok.extern.slf4j.Slf4j; +import org.ktb.dev.assignment.core.response.ErrorResponse; +import jakarta.validation.ConstraintViolationException; +import java.util.List; + +import java.util.stream.Collectors; + +@Slf4j +public class ConstraintViolationStrategy implements ExceptionStrategy { + @Override + public List handle(Exception ex) { + ConstraintViolationException cve = (ConstraintViolationException) ex; + return cve.getConstraintViolations() + .stream() + .map(violation -> ErrorResponse.ValidationError.of( + extractFieldName(violation.getPropertyPath().toString()), + violation.getMessage(), + violation.getInvalidValue() + )) + .collect(Collectors.toList()); + } + + private String extractFieldName(String propertyPath) { + String[] parts = propertyPath.split("\\."); + return parts[parts.length - 1]; + } +} \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/DateTimeParseStrategy.java b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/DateTimeParseStrategy.java new file mode 100644 index 0000000..dd77a81 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/DateTimeParseStrategy.java @@ -0,0 +1,21 @@ +package org.ktb.dev.assignment.core.handler.validation.strategy; + +import lombok.extern.slf4j.Slf4j; +import org.ktb.dev.assignment.core.exception.CustomErrorCode; +import org.ktb.dev.assignment.core.response.ErrorResponse; +import java.time.format.DateTimeParseException; +import java.util.List; +@Slf4j +public class DateTimeParseStrategy implements ExceptionStrategy { + @Override + public List handle(Exception ex) { + DateTimeParseException dtpe = (DateTimeParseException) ex; + return List.of( + ErrorResponse.ValidationError.of( + "date", + CustomErrorCode.INVALID_DATE_FORMAT.getMessage(), + dtpe.getParsedString() + ) + ); + } +} \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/DefaultExceptionStrategy.java b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/DefaultExceptionStrategy.java new file mode 100644 index 0000000..dc32717 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/DefaultExceptionStrategy.java @@ -0,0 +1,21 @@ +package org.ktb.dev.assignment.core.handler.validation.strategy; + +import lombok.extern.slf4j.Slf4j; +import org.ktb.dev.assignment.core.exception.CustomErrorCode; +import org.ktb.dev.assignment.core.response.ErrorResponse; + +import java.util.List; + +@Slf4j +public class DefaultExceptionStrategy implements ExceptionStrategy { + @Override + public List handle(Exception ex) { + return List.of( + ErrorResponse.ValidationError.of( + "unknown", + CustomErrorCode.INVALID_INPUT_VALUE.getMessage(), + null + ) + ); + } +} \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/ExceptionStrategy.java b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/ExceptionStrategy.java new file mode 100644 index 0000000..044d635 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/ExceptionStrategy.java @@ -0,0 +1,8 @@ +package org.ktb.dev.assignment.core.handler.validation.strategy; + +import org.ktb.dev.assignment.core.response.ErrorResponse; +import java.util.List; + +public interface ExceptionStrategy { + List handle(Exception ex); +} \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/TypeMismatchStrategy.java b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/TypeMismatchStrategy.java new file mode 100644 index 0000000..4b24029 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/handler/validation/strategy/TypeMismatchStrategy.java @@ -0,0 +1,30 @@ +package org.ktb.dev.assignment.core.handler.validation.strategy; + +import lombok.extern.slf4j.Slf4j; +import org.ktb.dev.assignment.core.exception.CustomErrorCode; +import org.ktb.dev.assignment.core.response.ErrorResponse; +import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; + +import java.time.LocalDate; +import java.util.List; + +@Slf4j +public class TypeMismatchStrategy implements ExceptionStrategy { + @Override + public List handle(Exception ex) { + MethodArgumentTypeMismatchException matme = (MethodArgumentTypeMismatchException) ex; + String field = matme.getName(); + CustomErrorCode errorCode = matme.getRequiredType() != null + && LocalDate.class.isAssignableFrom(matme.getRequiredType()) + ? CustomErrorCode.INVALID_DATE_FORMAT + : CustomErrorCode.INVALID_PARAMETER_VALUE; + + return List.of( + ErrorResponse.ValidationError.of( + field, + errorCode.getMessage(), + matme.getValue() + ) + ); + } +} \ No newline at end of file From c0f47c5fd57a49f1719d0aa6c5de97f81c1d3940 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 16:52:41 +0900 Subject: [PATCH 30/37] =?UTF-8?q?fix:=20=EC=82=AC=EC=9A=A9=ED=95=98?= =?UTF-8?q?=EC=A7=80=20=EC=95=8A=EB=8A=94=20import=20=EB=B0=8F=20=EC=9D=98?= =?UTF-8?q?=EB=AF=B8=EC=97=86=EB=8A=94=20=EC=A3=BC=EC=84=9D=20=EC=A0=9C?= =?UTF-8?q?=EA=B1=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../dev/assignment/core/exception/CustomErrorCode.java | 10 ---------- .../core/handler/GlobalExceptionHandler.java | 5 ----- .../handler/validation/ValidationExceptionHandler.java | 3 --- 3 files changed, 18 deletions(-) diff --git a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java index eea72a0..e38bfca 100644 --- a/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java @@ -6,16 +6,6 @@ @RequiredArgsConstructor public enum CustomErrorCode implements ErrorCode { - /* - **요구사항에 적힌 커스텀 에러 목록!** - * 초과 시 429 Too Many Requests 등의 상태 코드를 반환하고 에러 메시지에 제한 정보(몇 초 내 N건)를 담아주면 좋습니다. - * 필수 파라미터 누락, 유효성 검사, API 키 누락 등 다양한 케이스를 테스트해주세요. - * 유효성 검사를 통해 고객에게 어떻게 호출해야 하는지 직간접적으로 안내할 수 있도록 합니다. - * 만약 요청에 키가 없다고 판단 될 경우 400, 값이 아래 API Key가 아닌 경우, 403 에러를 반환해주시기 바랍니다. - * 마찬가지로 Endopoint에서 필수 파라미터로 정의하신 파라미터가 오지 않을 경우 400 에러를 반환해주시면 되며, - * 존재하지 않는 API를 호출 할 경우, 404 에러를 반환해주시기 바랍니다. - */ - // 400 Bad Request MISSING_REQUIRED_PARAMETER(400, "E001", CustomErrorMessage.MISSING_PARAMETER), INVALID_PARAMETER_VALUE(400, "E002", CustomErrorMessage.INVALID_PARAMETER), diff --git a/src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java index 7e2f023..c31cb74 100644 --- a/src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java +++ b/src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java @@ -53,11 +53,6 @@ public ResponseEntity handleBusinessException(BusinessException e protected ResponseEntity handleValidationExceptions(Exception ex) { log.error(LOG_FORMAT, "ValidationException", ex.getMessage(), ex); - /* - Required type: List - Provided: ErrorResponse - - */ List validationErrors = validationExceptionHandler.handleException(ex); diff --git a/src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java index 9c5f20c..e89bdfc 100644 --- a/src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java +++ b/src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java @@ -1,7 +1,6 @@ package org.ktb.dev.assignment.core.handler.validation; import lombok.extern.slf4j.Slf4j; -import org.ktb.dev.assignment.core.exception.CustomErrorCode; import org.ktb.dev.assignment.core.handler.validation.strategy.ConstraintViolationStrategy; import org.ktb.dev.assignment.core.handler.validation.strategy.DateTimeParseStrategy; import org.ktb.dev.assignment.core.handler.validation.strategy.DefaultExceptionStrategy; @@ -9,7 +8,6 @@ import org.ktb.dev.assignment.core.handler.validation.strategy.TypeMismatchStrategy; import org.ktb.dev.assignment.core.response.ErrorResponse; import org.springframework.stereotype.Component; -import org.springframework.web.bind.MethodArgumentNotValidException; import jakarta.validation.ConstraintViolationException; import java.time.format.DateTimeParseException; @@ -31,7 +29,6 @@ public ValidationExceptionHandler() { strategyMap.put(DateTimeParseException.class, new DateTimeParseStrategy()); } - // ErrorResponse 대신 List 반환하도록 수정 public List handleException(Exception ex) { return strategyMap .getOrDefault(ex.getClass(), new DefaultExceptionStrategy()) From 6628e2d60b2afb2fedc118d696ccb5d9eb7c1722 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 17:17:58 +0900 Subject: [PATCH 31/37] =?UTF-8?q?feat:=20google=20guava=20(API=20Throttlin?= =?UTF-8?q?g=20=EB=9D=BC=EC=9D=B4=EB=B8=8C=EB=9F=AC=EB=A6=AC)=20=EC=9D=98?= =?UTF-8?q?=EC=A1=B4=EC=84=B1=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/build.gradle b/build.gradle index 3b87c48..2e1cf16 100644 --- a/build.gradle +++ b/build.gradle @@ -27,11 +27,10 @@ dependencies { compileOnly 'org.projectlombok:lombok:1.18.36' //lombok annotationProcessor 'org.projectlombok:lombok' // lombok 어노테이션 프로세서 - implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' // springdoc - implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.4.2' // jpa implementation 'com.mysql:mysql-connector-j' // MySQL Driver + implementation 'com.google.guava:guava:33.3.1-jre' // API Throttling 라이브러리 } From cf7f57732af4ac77d423f393f342c45f0b5900ed Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 17:32:46 +0900 Subject: [PATCH 32/37] =?UTF-8?q?feat:=20API=20Throttling(10=EA=B1=B4/10?= =?UTF-8?q?=EC=B4=88)=20=EA=B5=AC=ED=98=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../assignment/common/config/WebConfig.java | 39 +++++++++++++------ .../core/ratelimit/ApiKeyRateLimiter.java | 25 ++++++++++++ .../core/ratelimit/RateLimitConfig.java | 12 ++++++ 3 files changed, 64 insertions(+), 12 deletions(-) create mode 100644 src/main/java/org/ktb/dev/assignment/core/ratelimit/ApiKeyRateLimiter.java create mode 100644 src/main/java/org/ktb/dev/assignment/core/ratelimit/RateLimitConfig.java diff --git a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java index ca686e6..3e385cf 100644 --- a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java +++ b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java @@ -3,9 +3,11 @@ import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import jakarta.validation.Valid; +import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.ktb.dev.assignment.core.exception.BusinessException; import org.ktb.dev.assignment.core.exception.CustomErrorCode; +import org.ktb.dev.assignment.core.ratelimit.ApiKeyRateLimiter; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.HandlerInterceptor; @@ -21,10 +23,11 @@ */ @Slf4j @Configuration +@RequiredArgsConstructor public class WebConfig implements WebMvcConfigurer { - private static final String HEADER_API_KEY = "x-api-key"; private static final String PARAM_API_KEY = "apikey"; + private final ApiKeyRateLimiter rateLimiter; @Value("${api.key.secret}") private String API_KEY; @@ -43,30 +46,42 @@ public void addInterceptors(InterceptorRegistry registry) { registry.addInterceptor(new HandlerInterceptor() { @Override public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) { - // 헤더에서 API 키 확인 String headerApiKey = request.getHeader(HEADER_API_KEY); - // 파라미터에서 API 키 확인 String paramApiKey = request.getParameter(PARAM_API_KEY); - // 둘 다 없는 경우 if (headerApiKey == null && paramApiKey == null) { response.setStatus(HttpServletResponse.SC_BAD_REQUEST); throw new BusinessException(CustomErrorCode.MISSING_API_KEY); } - // 키 검증 - if (headerApiKey != null && headerApiKey.equals(API_KEY)) { - return true; - } - - if (paramApiKey != null && paramApiKey.equals(API_KEY)) { + // API 키를 request attribute로 저장 (Rate Limiting에서 사용하는 값!) + String validApiKey = headerApiKey != null ? headerApiKey : paramApiKey; + if (validApiKey.equals(API_KEY)) { + request.setAttribute("VALID_API_KEY", validApiKey); return true; } - // 여기까지 왔다면 키가 불일치 response.setStatus(HttpServletResponse.SC_FORBIDDEN); throw new BusinessException(CustomErrorCode.INVALID_API_KEY); } - }).addPathPatterns("/api/**"); + }).addPathPatterns("/api/**").order(1); // 1. API 키 검증 인터셉터 (order: 1) + + registry.addInterceptor(new HandlerInterceptor() { + @Override + public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) { + String apiKey = (String) request.getAttribute("VALID_API_KEY"); + + // API 키가 이미 검증되었으므로, null 체크는 불필요! + if (!rateLimiter.tryAcquire(apiKey)) { + throw new BusinessException( + CustomErrorCode.RATE_LIMIT_EXCEEDED, + ApiKeyRateLimiter.MAX_REQUESTS, + ApiKeyRateLimiter.WINDOW_SECONDS + ); + } + + return true; + } + }).addPathPatterns("/api/**").order(2); // 2. Rate Limiting 인터셉터 (order: 2) } } \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/ratelimit/ApiKeyRateLimiter.java b/src/main/java/org/ktb/dev/assignment/core/ratelimit/ApiKeyRateLimiter.java new file mode 100644 index 0000000..817ee7f --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/ratelimit/ApiKeyRateLimiter.java @@ -0,0 +1,25 @@ +package org.ktb.dev.assignment.core.ratelimit; + +import com.google.common.util.concurrent.RateLimiter; +import org.springframework.stereotype.Component; + +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +@Component +public class ApiKeyRateLimiter { + private final Map limiters = new ConcurrentHashMap<>(); + + // Rate Limit 상수 정의 + public static final int MAX_REQUESTS = 10; + public static final int WINDOW_SECONDS = 10; + private static final double RATE = (double) MAX_REQUESTS / WINDOW_SECONDS; + + public RateLimiter getLimiter(String apiKey) { + return limiters.computeIfAbsent(apiKey, k -> RateLimiter.create(RATE)); + } + + public boolean tryAcquire(String apiKey) { + return getLimiter(apiKey).tryAcquire(); + } +} diff --git a/src/main/java/org/ktb/dev/assignment/core/ratelimit/RateLimitConfig.java b/src/main/java/org/ktb/dev/assignment/core/ratelimit/RateLimitConfig.java new file mode 100644 index 0000000..4ee692a --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/ratelimit/RateLimitConfig.java @@ -0,0 +1,12 @@ +package org.ktb.dev.assignment.core.ratelimit; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +@Configuration +public class RateLimitConfig { + @Bean + public ApiKeyRateLimiter apiKeyRateLimiter() { + return new ApiKeyRateLimiter(); + } +} \ No newline at end of file From f1a59d4bcb2a59eebabe713d43b877a24b8e7870 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 18:16:17 +0900 Subject: [PATCH 33/37] =?UTF-8?q?feat:=20logback-spring=20=EC=84=A4?= =?UTF-8?q?=EC=A0=95=20=EC=B6=94=EA=B0=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/resources/application.yml | 5 -- src/main/resources/logback-spring.xml | 109 ++++++++++++++++++++++++++ 2 files changed, 109 insertions(+), 5 deletions(-) create mode 100644 src/main/resources/logback-spring.xml diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index ee6843b..e19ee9f 100644 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -26,8 +26,3 @@ spring: api: key: secret: ${API_SECRET_KEY} - -logging: - level: - org.hibernate.SQL: debug - org.hibernate.type: trace diff --git a/src/main/resources/logback-spring.xml b/src/main/resources/logback-spring.xml new file mode 100644 index 0000000..40dcacb --- /dev/null +++ b/src/main/resources/logback-spring.xml @@ -0,0 +1,109 @@ + + + + + + + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + + /logs/application.log + + + + + %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n + + + + + + /home/ubuntu/logs/application.%d{yyyy-MM-dd}.%i.log.gz + + 50MB + + 30 + + 5GB + + + + + + + /home/ubuntu/logs/error.log + + + + %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n + + + + + ERROR + + + + + /home/ubuntu/logs/error.%d{yyyy-MM-dd}.%i.log.gz + + 20MB + 60 + 1GB + + + + + + + + + + + + + + + + \ No newline at end of file From cb3401fd6ea0eef448911474fba16a45444151d9 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 18:48:20 +0900 Subject: [PATCH 34/37] =?UTF-8?q?feat:=20=EC=9D=91=EB=8B=B5=20=ED=98=95?= =?UTF-8?q?=EC=8B=9D(json,=20xml)=20=EC=84=A0=ED=83=9D=EC=9D=84=20?= =?UTF-8?q?=EA=B5=AC=ED=98=84=ED=95=98=EA=B8=B0=20=EC=9C=84=ED=95=9C=20dat?= =?UTF-8?q?aformat=20=EB=9D=BC=EC=9D=B4=EB=B8=8C=EB=9F=AC=EB=A6=AC=20?= =?UTF-8?q?=EC=9D=98=EC=A1=B4=EC=84=B1=20=EC=B6=94=EA=B0=80=20=EB=B0=8F=20?= =?UTF-8?q?build.gradle=20implementation=20=EC=A0=95=EB=A6=AC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build.gradle | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/build.gradle b/build.gradle index 2e1cf16..b4760d0 100644 --- a/build.gradle +++ b/build.gradle @@ -23,14 +23,19 @@ dependencies { testImplementation 'org.springframework.boot:spring-boot-starter-test' testRuntimeOnly 'org.junit.platform:junit-platform-launcher' - implementation 'org.springframework.boot:spring-boot-starter-validation:3.4.2' + // lombok compileOnly 'org.projectlombok:lombok:1.18.36' //lombok annotationProcessor 'org.projectlombok:lombok' // lombok 어노테이션 프로세서 - implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' // springdoc + + // DB implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.4.2' // jpa implementation 'com.mysql:mysql-connector-j' // MySQL Driver - implementation 'com.google.guava:guava:33.3.1-jre' // API Throttling 라이브러리 + + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4' // springdoc + implementation 'org.springframework.boot:spring-boot-starter-validation:3.4.2' // 유효성 검증을 위한 validation 라이브러리 + implementation 'com.google.guava:guava:33.3.1-jre' // API Throttling 구현을 위한 라이브러리 + implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml' // 응답 형식(json, xml) 선택을 구현하기 위한 dataformat 라이브러리 } From 1a05513f3f9a124c3fb15c7461980b97b501f068 Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 19:10:16 +0900 Subject: [PATCH 35/37] =?UTF-8?q?fix:=20log=20=EA=B8=B0=EB=B3=B8=20?= =?UTF-8?q?=EB=94=94=EB=A0=89=ED=86=A0=EB=A6=AC=20=EC=84=A4=EC=A0=95=20?= =?UTF-8?q?=EB=B3=80=EA=B2=BD=20=EC=A0=88=EB=8C=80=EA=B2=BD=EB=A1=9C=20->?= =?UTF-8?q?=20=EC=83=81=EB=8C=80=EA=B2=BD=EB=A1=9C(./logs)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- src/main/resources/logback-spring.xml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/src/main/resources/logback-spring.xml b/src/main/resources/logback-spring.xml index 40dcacb..aa2e43c 100644 --- a/src/main/resources/logback-spring.xml +++ b/src/main/resources/logback-spring.xml @@ -1,6 +1,8 @@ + + - /logs/application.log + ${LOG_PATH}/application.log @@ -43,12 +45,12 @@ - /home/ubuntu/logs/application.%d{yyyy-MM-dd}.%i.log.gz + /logs/application.%d{yyyy-MM-dd}.%i.log.gz 50MB @@ -61,7 +63,7 @@ - /home/ubuntu/logs/error.log + ${LOG_PATH}/error.log @@ -75,7 +77,7 @@ - /home/ubuntu/logs/error.%d{yyyy-MM-dd}.%i.log.gz + /logs/error.%d{yyyy-MM-dd}.%i.log.gz 20MB 60 From 32f8e62eefe5aea9bdf0ed074106e4286d5e0add Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 19:10:37 +0900 Subject: [PATCH 36/37] =?UTF-8?q?feat:=20=EC=9D=91=EB=8B=B5=20=ED=98=95?= =?UTF-8?q?=EC=8B=9D=20(xml/json)=20=EC=84=A0=ED=83=9D=20=EA=B8=B0?= =?UTF-8?q?=EB=8A=A5=20=EA=B5=AC=ED=98=84?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../assignment/common/config/WebConfig.java | 38 +++++++++++++++++++ .../core/response/ErrorResponse.java | 2 + .../core/response/SuccessResponse.java | 11 +++++- .../v1/controller/StockPriceApi.java | 17 ++++++++- .../v1/dto/GetStockByCompanyCodeResponse.java | 5 +++ 5 files changed, 69 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java index 3e385cf..f5d94a8 100644 --- a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java +++ b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java @@ -1,5 +1,8 @@ package org.ktb.dev.assignment.common.config; +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.databind.ObjectMapper; +import com.fasterxml.jackson.dataformat.xml.XmlMapper; import jakarta.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletResponse; import jakarta.validation.Valid; @@ -10,12 +13,18 @@ import org.ktb.dev.assignment.core.ratelimit.ApiKeyRateLimiter; import org.springframework.beans.factory.annotation.Value; import org.springframework.context.annotation.Configuration; +import org.springframework.http.MediaType; +import org.springframework.http.converter.HttpMessageConverter; +import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter; +import org.springframework.http.converter.xml.MappingJackson2XmlHttpMessageConverter; import org.springframework.web.servlet.HandlerInterceptor; +import org.springframework.web.servlet.config.annotation.ContentNegotiationConfigurer; import org.springframework.web.servlet.config.annotation.CorsRegistry; import org.springframework.web.servlet.config.annotation.InterceptorRegistry; import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; import java.util.Arrays; +import java.util.List; /* * !!할일 : 프로트엔드 포트에 맞게 CORS 설정 수정 필요 ! @@ -84,4 +93,33 @@ public boolean preHandle(HttpServletRequest request, HttpServletResponse respons } }).addPathPatterns("/api/**").order(2); // 2. Rate Limiting 인터셉터 (order: 2) } + + @Override + public void configureContentNegotiation(ContentNegotiationConfigurer configurer) { + // Content Negotiation 설정 + configurer + .defaultContentType(MediaType.APPLICATION_JSON) // 기본 응답 타입은 JSON + .favorParameter(false) // URL 파라미터 비활성화 + .ignoreAcceptHeader(false) // Accept 헤더 활성화 + .mediaType("json", MediaType.APPLICATION_JSON) + .mediaType("xml", MediaType.APPLICATION_XML); + } + + @Override + public void configureMessageConverters(List> converters) { + // JSON 컨버터 설정 + MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter(); + ObjectMapper jsonMapper = new ObjectMapper(); + jsonMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); + jsonConverter.setObjectMapper(jsonMapper); + + // XML 컨버터 설정 + MappingJackson2XmlHttpMessageConverter xmlConverter = new MappingJackson2XmlHttpMessageConverter(); + XmlMapper xmlMapper = new XmlMapper(); + xmlMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL); + xmlConverter.setObjectMapper(xmlMapper); + + converters.add(0, jsonConverter); + converters.add(1, xmlConverter); + } } \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java index 96a0fd0..e08e79d 100644 --- a/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java +++ b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java @@ -1,6 +1,7 @@ package org.ktb.dev.assignment.core.response; import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonRootName; import io.swagger.v3.oas.annotations.media.Schema; import lombok.AccessLevel; import lombok.Getter; @@ -11,6 +12,7 @@ import java.util.List; @Getter +@JsonRootName("error") @Schema(description = "실패 Response") @RequiredArgsConstructor(access = AccessLevel.PRIVATE) public class ErrorResponse { diff --git a/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java b/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java index 40f70c1..b32f530 100644 --- a/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java +++ b/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java @@ -1,14 +1,17 @@ package org.ktb.dev.assignment.core.response; import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonRootName; import io.swagger.v3.oas.annotations.media.Schema; import lombok.AccessLevel; import lombok.Getter; import lombok.NoArgsConstructor; import org.springframework.http.HttpStatus; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; @Getter +@JsonRootName("response") @Schema(description = "성공 Response") @NoArgsConstructor(access = AccessLevel.PRIVATE) public class SuccessResponse { @@ -21,9 +24,7 @@ public class SuccessResponse { public static SuccessResponse of(T data) { SuccessResponse successResponse = new SuccessResponse<>(); - successResponse.data = data; - return successResponse; } @@ -34,4 +35,10 @@ public static SuccessResponse ofNoData() { public ResponseEntity> asHttp(HttpStatus httpStatus) { return ResponseEntity.status(httpStatus).body(this); } + + public ResponseEntity> asHttp(HttpStatus httpStatus, MediaType mediaType) { + return ResponseEntity.status(httpStatus) + .contentType(mediaType) + .body(this); + } } \ No newline at end of file diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java index c9d3df5..03c140e 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java @@ -1,6 +1,7 @@ package org.ktb.dev.assignment.presentation.v1.controller; import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.responses.ApiResponses; import io.swagger.v3.oas.annotations.tags.Tag; @@ -8,6 +9,7 @@ import org.ktb.dev.assignment.core.response.SuccessResponse; import org.ktb.dev.assignment.presentation.v1.dto.GetStockByCompanyCodeResponse; import org.springframework.format.annotation.DateTimeFormat; +import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.validation.annotation.Validated; import org.springframework.web.bind.annotation.GetMapping; @@ -24,9 +26,20 @@ public interface StockPriceApi { @Operation(summary = "기업의 주가 조회 API", description = "기간 내 특정 기업의 주가 정보를 조회") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "성공적으로 기업 주가 조회가 완료되었습니다.") + @ApiResponse(responseCode = "200", description = "성공적으로 기업 주가 조회가 완료되었습니다.", + content = { + @Content(mediaType = MediaType.APPLICATION_JSON_VALUE), + @Content(mediaType = MediaType.APPLICATION_XML_VALUE) + }) + }) - @GetMapping("/api/v1/stocks/{companyCode}/prices") + @GetMapping( + value="/api/v1/stocks/{companyCode}/prices", + produces = { + MediaType.APPLICATION_JSON_VALUE, + MediaType.APPLICATION_XML_VALUE + } + ) ResponseEntity> getStockByCompany( @Parameter(description = "기업 코드 (최대 10자리)") @PathVariable("companyCode") diff --git a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java index a1d5b56..b88bcf6 100644 --- a/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java @@ -1,17 +1,22 @@ package org.ktb.dev.assignment.presentation.v1.dto; +import com.fasterxml.jackson.annotation.JsonRootName; +import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper; import io.swagger.v3.oas.annotations.media.Schema; import java.util.List; +@JsonRootName("stockData") @Schema(name="GetStockByCompanyCodeResponse", description ="기업 별 기간 내 주식 정보 조회 결과") public record GetStockByCompanyCodeResponse( @Schema(description = "기업명", requiredMode = Schema.RequiredMode.REQUIRED) String companyName, + @JacksonXmlElementWrapper(localName = "stockPrices") @Schema(description = "주가 정보 목록", requiredMode = Schema.RequiredMode.REQUIRED) List stockPrices ) { + @JsonRootName("stockPrice") public record StockPriceInfo( @Schema(description = "거래일", requiredMode = Schema.RequiredMode.REQUIRED) String tradeDate, From 1b75cc578a1de9a04944faa0fd59737df31698ce Mon Sep 17 00:00:00 2001 From: sanghyuk Kim Date: Sun, 16 Feb 2025 19:17:39 +0900 Subject: [PATCH 37/37] =?UTF-8?q?fix:=20CORS=20=EC=84=A4=EC=A0=95=20?= =?UTF-8?q?=EB=B3=80=EA=B2=BD=20-=20Origin=20=EB=AA=A8=EB=91=90=20?= =?UTF-8?q?=ED=97=88=EC=9A=A9=20(OPEN=20API=20=EA=B3=A0=EB=A0=A4)=20-=20Me?= =?UTF-8?q?thod=20GET=EB=A7=8C=20=ED=97=88=EC=9A=A9=20-=20Header=20x-api-k?= =?UTF-8?q?ey,=20Accept=EB=A7=8C=20=ED=97=88=EC=9A=A9=20-=20Credentials=20?= =?UTF-8?q?false=20=EC=84=A4=EC=A0=95?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../ktb/dev/assignment/common/config/WebConfig.java | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java index f5d94a8..068be97 100644 --- a/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java +++ b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java @@ -44,10 +44,12 @@ public class WebConfig implements WebMvcConfigurer { @Override public void addCorsMappings(CorsRegistry registry) { registry.addMapping("/api/**") - .allowedOrigins("http://localhost:3000") - .allowedMethods("GET", "POST", "PUT", "DELETE") - .allowedHeaders("*") - .allowCredentials(true); + .allowedOrigins("*") + .allowedMethods("GET") + .allowedHeaders("x-api-key", "Accept") + .exposedHeaders("Content-Type") + .allowCredentials(false) + .maxAge(3600); } @Override