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..b4760d0 --- /dev/null +++ b/build.gradle @@ -0,0 +1,44 @@ +plugins { + id 'java' + 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() +} + +// 호환되는 버전 확인 : 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' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + + + // lombok + compileOnly 'org.projectlombok:lombok:1.18.36' //lombok + annotationProcessor 'org.projectlombok:lombok' // lombok 어노테이션 프로세서 + + // DB + implementation 'org.springframework.boot:spring-boot-starter-data-jpa:3.4.2' // jpa + implementation 'com.mysql:mysql-connector-j' // MySQL Driver + + 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 라이브러리 + +} + +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..f8a8f87 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'ktb-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/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..0894033 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/common/config/SwaggerConfig.java @@ -0,0 +1,47 @@ +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/v1/**") + .packagesToScan("org.ktb.dev.assignment.presentation.v1") + .build(); + } +} 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..068be97 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/common/config/WebConfig.java @@ -0,0 +1,127 @@ +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; +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.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 설정 수정 필요 ! + * author : hyuk.kim (김상혁) + */ +@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; + + @Override + public void addCorsMappings(CorsRegistry registry) { + registry.addMapping("/api/**") + .allowedOrigins("*") + .allowedMethods("GET") + .allowedHeaders("x-api-key", "Accept") + .exposedHeaders("Content-Type") + .allowCredentials(false) + .maxAge(3600); + } + + @Override + public void addInterceptors(InterceptorRegistry registry) { + registry.addInterceptor(new HandlerInterceptor() { + @Override + public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) { + String headerApiKey = request.getHeader(HEADER_API_KEY); + 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); + } + + // 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/**").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) + } + + @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/exception/BusinessException.java b/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java new file mode 100644 index 0000000..237343b --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/exception/BusinessException.java @@ -0,0 +1,35 @@ +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; + } + + // 에러 코드 + 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 new file mode 100644 index 0000000..e38bfca --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/exception/CustomErrorCode.java @@ -0,0 +1,57 @@ +package org.ktb.dev.assignment.core.exception; + +import lombok.RequiredArgsConstructor; + +import java.text.MessageFormat; + +@RequiredArgsConstructor +public enum CustomErrorCode implements ErrorCode { + // 400 Bad Request + 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", CustomErrorMessage.INVALID_API_KEY), + + // 404 Not Found + 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", CustomErrorMessage.RATE_LIMIT_EXCEEDED), + + // 500 Internal Server Error + INTERNAL_SERVER_ERROR(500, "E901", CustomErrorMessage.INTERNAL_SERVER_ERROR); + + private final int status; + private final String code; + private final CustomErrorMessage messageTemplate; + + @Override + public int getStatus() { + return status; + } + + @Override + public String getCode() { + return code; + } + + @Override + public String getMessage() { + 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 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/handler/GlobalExceptionHandler.java b/src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java new file mode 100644 index 0000000..c31cb74 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/handler/GlobalExceptionHandler.java @@ -0,0 +1,136 @@ +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; +import org.springframework.http.ResponseEntity; +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; +import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException; +import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; + +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; + + /** + * 비즈니스 예외 처리 + */ + @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); + + List validationErrors = + validationExceptionHandler.handleException(ex); + + return createErrorResponse( + CustomErrorCode.INVALID_INPUT_VALUE, + ErrorResponse.of(CustomErrorCode.INVALID_INPUT_VALUE, validationErrors) + ); + } + + /** + * 필수값 누락 예외 처리 + */ + @Override + 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(), + CustomErrorCode.MISSING_REQUIRED_PARAMETER.formatMessage(ex.getParameterName()), + null + ) + ); + + return createErrorResponse( + CustomErrorCode.MISSING_REQUIRED_PARAMETER, + ErrorResponse.of(CustomErrorCode.MISSING_REQUIRED_PARAMETER, validationErrors) + ); + } + + /** + * @Valid 검증 예외 처리 + */ + @Override + protected ResponseEntity handleMethodArgumentNotValid( + MethodArgumentNotValidException ex, + @NonNull HttpHeaders headers, + @NonNull HttpStatusCode status, + @NonNull WebRequest request) { + + log.error(LOG_FORMAT, "MethodArgumentNotValidException", ex.getMessage(), ex); + + List validationErrors = ex.getBindingResult() + .getFieldErrors() + .stream() + .map(error -> ErrorResponse.ValidationError.of( + error.getField(), + error.getDefaultMessage(), + error.getRejectedValue() + )) + .collect(Collectors.toList()); + + return createErrorResponse( + CustomErrorCode.INVALID_REQUEST_BODY, + ErrorResponse.of(CustomErrorCode.INVALID_REQUEST_BODY, validationErrors) + ); + } + + /** + * 예상치 못한 예외 처리 + */ + @ExceptionHandler(Exception.class) + public ResponseEntity handleAllException(Exception ex) { + log.error(LOG_FORMAT, "UnexpectedException", ex.getMessage(), ex); + return createErrorResponse( + CustomErrorCode.INTERNAL_SERVER_ERROR, + ErrorResponse.of(CustomErrorCode.INTERNAL_SERVER_ERROR) + ); + } + + private ResponseEntity createErrorResponse(ErrorCode errorCode, T body) { + return ResponseEntity + .status(errorCode.getStatus()) + .body(body); + } +} \ 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..e89bdfc --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/handler/validation/ValidationExceptionHandler.java @@ -0,0 +1,37 @@ +package org.ktb.dev.assignment.core.handler.validation; + +import lombok.extern.slf4j.Slf4j; +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 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()); + } + + 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 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 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..e08e79d --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/response/ErrorResponse.java @@ -0,0 +1,59 @@ +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.RequiredArgsConstructor; +import org.ktb.dev.assignment.core.exception.ErrorCode; +import org.springframework.validation.FieldError; + +import java.util.List; + +@Getter +@JsonRootName("error") +@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 message) { + return new ErrorResponse(new ErrorInfo(errorCode.getCode(), message, null)); + } + + 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(), + fieldError.getRejectedValue() + ); + } + public static ValidationError of(String field, String message, Object rejectedValue) { + return new ValidationError(field, message, rejectedValue); + } + } + + 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 new file mode 100644 index 0000000..b32f530 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/core/response/SuccessResponse.java @@ -0,0 +1,44 @@ +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 { + + @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); + } + + 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/domain/Company.java b/src/main/java/org/ktb/dev/assignment/domain/Company.java new file mode 100644 index 0000000..16a2b09 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/domain/Company.java @@ -0,0 +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 new file mode 100644 index 0000000..d226d47 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/domain/StocksHistory.java @@ -0,0 +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/StockPriceApi.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java new file mode 100644 index 0000000..03c140e --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceApi.java @@ -0,0 +1,65 @@ +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; +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.MediaType; +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; +import io.swagger.v3.oas.annotations.Parameter; +import io.swagger.v3.oas.annotations.media.Schema; + +import java.time.LocalDate; + +@Tag(name = "주가 조회 API", description = "주가 정보를 조회") +@Validated +public interface StockPriceApi { + + @Operation(summary = "기업의 주가 조회 API", description = "기간 내 특정 기업의 주가 정보를 조회") + @ApiResponses(value = { + @ApiResponse(responseCode = "200", description = "성공적으로 기업 주가 조회가 완료되었습니다.", + content = { + @Content(mediaType = MediaType.APPLICATION_JSON_VALUE), + @Content(mediaType = MediaType.APPLICATION_XML_VALUE) + }) + + }) + @GetMapping( + value="/api/v1/stocks/{companyCode}/prices", + produces = { + MediaType.APPLICATION_JSON_VALUE, + MediaType.APPLICATION_XML_VALUE + } + ) + 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 + ); + +} 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..6d54422 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/controller/StockPriceController.java @@ -0,0 +1,33 @@ +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.validation.annotation.Validated; +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/GetStockByCompanyCodeResponse.java b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java new file mode 100644 index 0000000..b88bcf6 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/presentation/v1/dto/GetStockByCompanyCodeResponse.java @@ -0,0 +1,27 @@ +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, + + @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 new file mode 100644 index 0000000..05e6ca8 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/repository/CompanyRepository.java @@ -0,0 +1,15 @@ +package org.ktb.dev.assignment.repository; + +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 new file mode 100644 index 0000000..680f018 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/repository/StocksHistoryRepository.java @@ -0,0 +1,26 @@ +package org.ktb.dev.assignment.repository; + +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 new file mode 100644 index 0000000..34804e7 --- /dev/null +++ b/src/main/java/org/ktb/dev/assignment/service/StockPriceService.java @@ -0,0 +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.COMPANY_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); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..e19ee9f --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,28 @@ +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 + +api: + key: + secret: ${API_SECRET_KEY} diff --git a/src/main/resources/logback-spring.xml b/src/main/resources/logback-spring.xml new file mode 100644 index 0000000..aa2e43c --- /dev/null +++ b/src/main/resources/logback-spring.xml @@ -0,0 +1,111 @@ + + + + + + + + + + + + + %d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n + + + + + + + + ${LOG_PATH}/application.log + + + + + %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n + + + + + + /logs/application.%d{yyyy-MM-dd}.%i.log.gz + + 50MB + + 30 + + 5GB + + + + + + + ${LOG_PATH}/error.log + + + + %d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n + + + + + ERROR + + + + + /logs/error.%d{yyyy-MM-dd}.%i.log.gz + + 20MB + 60 + 1GB + + + + + + + + + + + + + + + + \ No newline at end of file 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() { + } + +}