diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..edd6118 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,3 @@ +gradlew text eol=lf +*.sh text eol=lf +*.bat text eol=crlf diff --git "a/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\265\254\355\230\204-\354\235\264\354\212\210-\355\205\234\355\224\214\353\246\277.md" "b/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\265\254\355\230\204-\354\235\264\354\212\210-\355\205\234\355\224\214\353\246\277.md" new file mode 100644 index 0000000..d9956ef --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\352\270\260\353\212\245-\352\265\254\355\230\204-\354\235\264\354\212\210-\355\205\234\355\224\214\353\246\277.md" @@ -0,0 +1,18 @@ +--- +name: 기능 구현 이슈 템플릿 +about: 기능 구현 관련 이슈 템플릿입니다. +title: '' +labels: '' +assignees: '' + +--- + +## 어떤 기능인가요? + +> 추가하려는 기능에 대해 간결하게 설명해주세요 + +## 작업 상세 내용 + +- [ ] + +## 참고할만한 자료(선택) diff --git "a/.github/ISSUE_TEMPLATE/\354\210\230\354\240\225---\353\246\254\355\214\251\355\206\240\353\247\201-\352\264\200\353\240\250-\354\235\264\354\212\210-\355\205\234\355\224\214\353\246\277.md" "b/.github/ISSUE_TEMPLATE/\354\210\230\354\240\225---\353\246\254\355\214\251\355\206\240\353\247\201-\352\264\200\353\240\250-\354\235\264\354\212\210-\355\205\234\355\224\214\353\246\277.md" new file mode 100644 index 0000000..d9e5114 --- /dev/null +++ "b/.github/ISSUE_TEMPLATE/\354\210\230\354\240\225---\353\246\254\355\214\251\355\206\240\353\247\201-\352\264\200\353\240\250-\354\235\264\354\212\210-\355\205\234\355\224\214\353\246\277.md" @@ -0,0 +1,20 @@ +--- +name: 수정 & 리팩토링 관련 이슈 템플릿 +about: 수정 & 리팩토링 관련 이슈 템플릿입니다. +title: '' +labels: '' +assignees: '' + +--- + +## 어떤 기능인가요? + +> 수정/리팩토링하려는 기능에 대해 간결하게 설명해주세요 + +## 작업 상세 내용 + +- [ ] TODO +- [ ] TODO +- [ ] TODO + +## 참고할만한 자료(선택) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..27c8e0d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ +## 🎋 이슈 및 작업중인 브랜치 + +- + +## 🔑 주요 내용 + +- + + +## Check List + +- [ ] **Assignees** 등록을 하였나요? +- [ ] **라벨(Label)** 등록을 하였나요? +- [ ] PR 머지하기 전 반드시 **CI가 정상적으로 작동하는지 확인**해주세요! \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..15ce21b --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,19 @@ +name: CI + +on: + push: + branches: [main] + pull_request: + +jobs: + test: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-java@v4 + with: + java-version: '21' + distribution: 'temurin' + cache: 'gradle' + - name: Test + run: ./gradlew test --no-daemon diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..99b80d3 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +.gradle/ +build/ +!gradle/wrapper/gradle-wrapper.jar +.idea/ +*.iml +.kotlin/ +.env +data/ + +src/test/ diff --git a/build.gradle.kts b/build.gradle.kts new file mode 100644 index 0000000..1a4dc49 --- /dev/null +++ b/build.gradle.kts @@ -0,0 +1,69 @@ +plugins { + id("org.springframework.boot") version "3.5.9" + id("io.spring.dependency-management") version "1.1.7" + kotlin("jvm") version "1.9.25" + kotlin("plugin.spring") version "1.9.25" + kotlin("plugin.jpa") version "1.9.25" +} + +group = "com.option" +version = "0.0.1-SNAPSHOT" + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(21) + } +} + +repositories { + mavenCentral() +} + +dependencies { + // 기본 + implementation("org.springframework.boot:spring-boot-starter-web") + implementation("org.springframework.boot:spring-boot-starter-data-jpa") + implementation("org.springframework.boot:spring-boot-starter-validation") + + // kotlin + implementation("com.fasterxml.jackson.module:jackson-module-kotlin") + implementation("org.jetbrains.kotlin:kotlin-reflect") + + // swagger + implementation("org.springdoc:springdoc-openapi-starter-webmvc-ui:2.8.4") + + // security + implementation("org.springframework.boot:spring-boot-starter-security") + implementation("io.jsonwebtoken:jjwt-api:0.12.6") + runtimeOnly("io.jsonwebtoken:jjwt-impl:0.12.6") + runtimeOnly("io.jsonwebtoken:jjwt-jackson:0.12.6") // JSON 파싱용 + + // db + runtimeOnly("org.postgresql:postgresql") + + // 엑셀 파싱 + implementation("org.apache.poi:poi-ooxml:5.4.1") + + // grafana + implementation("org.springframework.boot:spring-boot-starter-actuator") + implementation("io.micrometer:micrometer-registry-prometheus") + + // test + testImplementation("org.springframework.boot:spring-boot-starter-test") + testImplementation("org.springframework.security:spring-security-test") + testImplementation("org.mockito.kotlin:mockito-kotlin:5.4.0") + testImplementation("org.testcontainers:postgresql") + testImplementation("org.testcontainers:junit-jupiter") + testImplementation("com.tngtech.archunit:archunit-junit5:1.3.0") + testRuntimeOnly("org.junit.platform:junit-platform-launcher") +} + +kotlin { + compilerOptions { + freeCompilerArgs.addAll("-Xjsr305=strict") + } +} + +tasks.withType { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..b1b8ef5 Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..fec70bd --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,9 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip +networkTimeout=10000 +retries=0 +retryBackOffMs=500 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..b9bb139 --- /dev/null +++ b/gradlew @@ -0,0 +1,248 @@ +#!/bin/sh + +# +# Copyright © 2015 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/3d91ce3b8caaf77ad09f381f43615b715b53f72c/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\n' "$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 + + + +# 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" ) + + 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, 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" \ + -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \ + "$@" + +# 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..24c62d5 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,82 @@ +@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, and ensure extensions are enabled +setlocal EnableExtensions + +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 + +"%COMSPEC%" /c exit 1 + +: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 + +"%COMSPEC%" /c exit 1 + +:execute +@rem Setup the command line + + + +@rem Execute Gradle +@rem endlocal doesn't take effect until after the line is parsed and variables are expanded +@rem which allows us to clear the local environment before executing the java command +endlocal & "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %* & call :exitWithErrorLevel + +:exitWithErrorLevel +@rem Use "%COMSPEC%" /c exit to allow operators to work properly in scripts +"%COMSPEC%" /c exit %ERRORLEVEL% diff --git a/settings.gradle.kts b/settings.gradle.kts new file mode 100644 index 0000000..30a9eb6 --- /dev/null +++ b/settings.gradle.kts @@ -0,0 +1 @@ +rootProject.name = "option" diff --git a/src/main/kotlin/com/option/OptionApplication.kt b/src/main/kotlin/com/option/OptionApplication.kt new file mode 100644 index 0000000..6d3eaca --- /dev/null +++ b/src/main/kotlin/com/option/OptionApplication.kt @@ -0,0 +1,15 @@ +package com.option + +import org.springframework.boot.autoconfigure.SpringBootApplication +import org.springframework.boot.context.properties.ConfigurationPropertiesScan +import org.springframework.boot.runApplication +import org.springframework.scheduling.annotation.EnableScheduling + +@EnableScheduling +@ConfigurationPropertiesScan +@SpringBootApplication +class OptionApplication + +fun main(args: Array) { + runApplication(*args) +} diff --git a/src/main/kotlin/com/option/global/apiPayLoad/error/AuthErrorCode.kt b/src/main/kotlin/com/option/global/apiPayLoad/error/AuthErrorCode.kt new file mode 100644 index 0000000..f31f34f --- /dev/null +++ b/src/main/kotlin/com/option/global/apiPayLoad/error/AuthErrorCode.kt @@ -0,0 +1,16 @@ +package com.option.global.apiPayLoad.error + +import org.springframework.http.HttpStatus + +enum class AuthErrorCode( + override val httpStatus: HttpStatus, + override val code: String, + override val message: String, +) : ErrorCode { + UNAUTHORIZED(HttpStatus.UNAUTHORIZED, "A001", "로그인이 필요합니다."), + LOGIN_FAILED(HttpStatus.UNAUTHORIZED, "A002", "이메일 또는 비밀번호가 올바르지 않습니다."), + EMAIL_ALREADY_EXISTS(HttpStatus.CONFLICT, "A003", "이미 가입한 이메일입니다."), + INVALID_TOKEN(HttpStatus.UNAUTHORIZED, "A004", "토큰이 올바르지 않습니다."), + EXPIRED_TOKEN(HttpStatus.UNAUTHORIZED, "A005", "토큰이 만료되었습니다."), + USER_NOT_FOUND(HttpStatus.UNAUTHORIZED, "A006", "계정을 찾을 수 없습니다."), +} diff --git a/src/main/kotlin/com/option/global/apiPayLoad/error/CommonErrorCode.kt b/src/main/kotlin/com/option/global/apiPayLoad/error/CommonErrorCode.kt new file mode 100644 index 0000000..96477a2 --- /dev/null +++ b/src/main/kotlin/com/option/global/apiPayLoad/error/CommonErrorCode.kt @@ -0,0 +1,14 @@ +package com.option.global.apiPayLoad.error + +import org.springframework.http.HttpStatus + +enum class CommonErrorCode( + override val httpStatus: HttpStatus, + override val code: String, + override val message: String, +) : ErrorCode { + INVALID_REQUEST(HttpStatus.BAD_REQUEST, "C001", "잘못된 요청입니다."), + INTERNAL_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "C002", "서버 오류가 발생했습니다."), + NOT_FOUND(HttpStatus.NOT_FOUND, "C003", "요청한 주소를 찾을 수 없습니다."), + METHOD_NOT_ALLOWED(HttpStatus.METHOD_NOT_ALLOWED, "C004", "지원하지 않는 메서드입니다."), +} diff --git a/src/main/kotlin/com/option/global/apiPayLoad/error/ErrorCode.kt b/src/main/kotlin/com/option/global/apiPayLoad/error/ErrorCode.kt new file mode 100644 index 0000000..30c165d --- /dev/null +++ b/src/main/kotlin/com/option/global/apiPayLoad/error/ErrorCode.kt @@ -0,0 +1,10 @@ +package com.option.global.apiPayLoad.error + +import org.springframework.http.HttpStatus + +// 기본 에러코드 +interface ErrorCode { + val httpStatus: HttpStatus + val code: String + val message: String +} diff --git a/src/main/kotlin/com/option/global/apiPayLoad/exception/BusinessException.kt b/src/main/kotlin/com/option/global/apiPayLoad/exception/BusinessException.kt new file mode 100644 index 0000000..1090c3e --- /dev/null +++ b/src/main/kotlin/com/option/global/apiPayLoad/exception/BusinessException.kt @@ -0,0 +1,8 @@ +package com.option.global.apiPayLoad.exception + +import com.option.global.apiPayLoad.error.ErrorCode + +class BusinessException( + val errorCode: ErrorCode, + val detail: Map? = null, +) : RuntimeException(errorCode.message) diff --git a/src/main/kotlin/com/option/global/apiPayLoad/exception/GlobalExceptionHandler.kt b/src/main/kotlin/com/option/global/apiPayLoad/exception/GlobalExceptionHandler.kt new file mode 100644 index 0000000..f5fa222 --- /dev/null +++ b/src/main/kotlin/com/option/global/apiPayLoad/exception/GlobalExceptionHandler.kt @@ -0,0 +1,59 @@ +package com.option.global.apiPayLoad.exception + +import com.option.global.apiPayLoad.error.CommonErrorCode +import com.option.global.apiPayLoad.response.ApiResponse +import org.slf4j.LoggerFactory +import org.springframework.http.ResponseEntity +import org.springframework.http.converter.HttpMessageNotReadableException +import org.springframework.web.ErrorResponse +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.method.annotation.MethodArgumentTypeMismatchException + +@RestControllerAdvice +class GlobalExceptionHandler { + + private val logger = LoggerFactory.getLogger(GlobalExceptionHandler::class.java) + + // 서비스가 던진 BusinessException, 에러코드에 적힌 상태와 메시지로 응답 + @ExceptionHandler(BusinessException::class) + fun handleBusinessException(e: BusinessException): ResponseEntity> { + logger.warn("Business exception: [{}] {}", e.errorCode.code, e.message) + return ResponseEntity.status(e.errorCode.httpStatus).body(ApiResponse.error(e.errorCode, e.detail)) + } + + // @Valid 검증 실패 + @ExceptionHandler(MethodArgumentNotValidException::class) + fun handleValidation(e: MethodArgumentNotValidException): ResponseEntity> { + val detail = e.bindingResult.fieldErrors.associate { it.field to it.defaultMessage } + return ResponseEntity.badRequest().body(ApiResponse.error(CommonErrorCode.INVALID_REQUEST, detail)) + } + + // 요청 자체가 잘못된 경우 + @ExceptionHandler( + HttpMessageNotReadableException::class, + MissingServletRequestParameterException::class, + MethodArgumentTypeMismatchException::class, + ) + fun handleBadRequest(e: Exception): ResponseEntity> { + logger.warn("Bad request: {}", e.message) + return ResponseEntity.badRequest().body(ApiResponse.error(CommonErrorCode.INVALID_REQUEST)) + } + + @ExceptionHandler(Exception::class) + fun handleUnexpected(e: Exception): ResponseEntity> { + if (e is ErrorResponse && e.statusCode.is4xxClientError) { + logger.warn("Client error: {} {}", e.statusCode.value(), e.message) + val errorCode = when (e.statusCode.value()) { + 404 -> CommonErrorCode.NOT_FOUND + 405 -> CommonErrorCode.METHOD_NOT_ALLOWED + else -> CommonErrorCode.INVALID_REQUEST + } + return ResponseEntity.status(e.statusCode).body(ApiResponse.error(errorCode)) + } + logger.error("Unexpected error", e) + return ResponseEntity.internalServerError().body(ApiResponse.error(CommonErrorCode.INTERNAL_ERROR)) + } +} diff --git a/src/main/kotlin/com/option/global/apiPayLoad/response/ApiResponse.kt b/src/main/kotlin/com/option/global/apiPayLoad/response/ApiResponse.kt new file mode 100644 index 0000000..a876037 --- /dev/null +++ b/src/main/kotlin/com/option/global/apiPayLoad/response/ApiResponse.kt @@ -0,0 +1,27 @@ +package com.option.global.apiPayLoad.response + +import com.fasterxml.jackson.annotation.JsonInclude +import com.option.global.apiPayLoad.error.ErrorCode + +// 공통응답 +@JsonInclude(JsonInclude.Include.NON_NULL) +data class ApiResponse( + val data: T? = null, + val error: ErrorResponse? = null, +) { + companion object { + fun ok(data: T): ApiResponse = ApiResponse(data = data) + + fun ok(): ApiResponse = ApiResponse(data = Unit) + + fun error(errorCode: ErrorCode, detail: Map? = null): ApiResponse = + ApiResponse(error = ErrorResponse(errorCode.code, errorCode.message, detail)) + } +} + +@JsonInclude(JsonInclude.Include.NON_NULL) +data class ErrorResponse( + val code: String, + val message: String, + val detail: Map? = null, +) diff --git a/src/main/kotlin/com/option/global/config/ClockConfig.kt b/src/main/kotlin/com/option/global/config/ClockConfig.kt new file mode 100644 index 0000000..15a3d85 --- /dev/null +++ b/src/main/kotlin/com/option/global/config/ClockConfig.kt @@ -0,0 +1,13 @@ +package com.option.global.config + +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration +import java.time.Clock + +@Configuration +class ClockConfig { + + // 테스트에서 시간을 바꿀 수 있게 시간을 빈으로 + @Bean + fun clock(): Clock = Clock.systemUTC() +} diff --git a/src/main/kotlin/com/option/global/config/SwaggerConfig.kt b/src/main/kotlin/com/option/global/config/SwaggerConfig.kt new file mode 100644 index 0000000..04bbc65 --- /dev/null +++ b/src/main/kotlin/com/option/global/config/SwaggerConfig.kt @@ -0,0 +1,13 @@ +package com.option.global.config + +import io.swagger.v3.oas.models.OpenAPI +import io.swagger.v3.oas.models.info.Info +import org.springframework.context.annotation.Bean +import org.springframework.context.annotation.Configuration + +@Configuration +class SwaggerConfig { + + @Bean + fun openApi(): OpenAPI = OpenAPI().info(Info().title("Option API").version("v1")) +} diff --git a/src/main/kotlin/com/option/global/properties/AlpacaProperties.kt b/src/main/kotlin/com/option/global/properties/AlpacaProperties.kt new file mode 100644 index 0000000..712732b --- /dev/null +++ b/src/main/kotlin/com/option/global/properties/AlpacaProperties.kt @@ -0,0 +1,13 @@ +package com.option.global.properties + +import org.springframework.boot.context.properties.ConfigurationProperties +import java.time.Duration + +@ConfigurationProperties("alpaca") +class AlpacaProperties( + val keyId: String, + val secretKey: String, + val minCallInterval: Duration, + val dataUrl: String = "https://data.alpaca.markets", + val tradingUrl: String = "https://paper-api.alpaca.markets", +) diff --git a/src/main/kotlin/com/option/global/properties/FinnhubProperties.kt b/src/main/kotlin/com/option/global/properties/FinnhubProperties.kt new file mode 100644 index 0000000..2499f5c --- /dev/null +++ b/src/main/kotlin/com/option/global/properties/FinnhubProperties.kt @@ -0,0 +1,9 @@ +package com.option.global.properties + +import org.springframework.boot.context.properties.ConfigurationProperties + +@ConfigurationProperties("finnhub") +class FinnhubProperties( + val apiKey: String, + val baseUrl: String = "https://finnhub.io/api/v1", +) diff --git a/src/main/kotlin/com/option/global/properties/FredProperties.kt b/src/main/kotlin/com/option/global/properties/FredProperties.kt new file mode 100644 index 0000000..1889bfc --- /dev/null +++ b/src/main/kotlin/com/option/global/properties/FredProperties.kt @@ -0,0 +1,9 @@ +package com.option.global.properties + +import org.springframework.boot.context.properties.ConfigurationProperties + +@ConfigurationProperties("fred") +class FredProperties( + val apiKey: String, + val baseUrl: String = "https://api.stlouisfed.org/fred", +) diff --git a/src/main/kotlin/com/option/global/properties/JobProperties.kt b/src/main/kotlin/com/option/global/properties/JobProperties.kt new file mode 100644 index 0000000..57a6b5a --- /dev/null +++ b/src/main/kotlin/com/option/global/properties/JobProperties.kt @@ -0,0 +1,13 @@ +package com.option.global.properties + +import org.springframework.boot.context.properties.ConfigurationProperties +import java.time.Duration +import java.time.LocalDate + +@ConfigurationProperties("job") +data class JobProperties( + val lease: Duration, + val tradeTimeBudget: Duration, + val backfillStart: LocalDate, + val backfillExpirationStart: LocalDate, +) diff --git a/src/main/kotlin/com/option/global/properties/PublicSourceProperties.kt b/src/main/kotlin/com/option/global/properties/PublicSourceProperties.kt new file mode 100644 index 0000000..2ff0be3 --- /dev/null +++ b/src/main/kotlin/com/option/global/properties/PublicSourceProperties.kt @@ -0,0 +1,10 @@ +package com.option.global.properties + +import org.springframework.boot.context.properties.ConfigurationProperties + +@ConfigurationProperties("public-source") +data class PublicSourceProperties( + val spdrHoldingsUrl: String = "https://www.ssga.com/us/en/intermediary/library-content/products/fund-data/etfs/us/holdings-daily-us-en-spy.xlsx", + val cboeDailyUrl: String = "https://cdn.cboe.com/data/us/options/market_statistics/daily", + val fedCalendarUrl: String = "https://www.federalreserve.gov/json/calendar.json", +) diff --git a/src/main/kotlin/com/option/global/properties/StorageProperties.kt b/src/main/kotlin/com/option/global/properties/StorageProperties.kt new file mode 100644 index 0000000..104b038 --- /dev/null +++ b/src/main/kotlin/com/option/global/properties/StorageProperties.kt @@ -0,0 +1,12 @@ +package com.option.global.properties + +import org.springframework.boot.context.properties.ConfigurationProperties + +@ConfigurationProperties("storage") +data class StorageProperties( + val rawDir: String, + val tradesDir: String, + val stopBackgroundFreeRatio: Double, + val stopCollectionFreeRatio: Double, + val minFreeBytes: Long, +) diff --git a/src/main/kotlin/com/option/global/properties/UniverseProperties.kt b/src/main/kotlin/com/option/global/properties/UniverseProperties.kt new file mode 100644 index 0000000..2ff7e14 --- /dev/null +++ b/src/main/kotlin/com/option/global/properties/UniverseProperties.kt @@ -0,0 +1,14 @@ +package com.option.global.properties + +import org.springframework.boot.context.properties.ConfigurationProperties + +@ConfigurationProperties("universe") +data class UniverseProperties( + val tradeSymbols: List, + val backfillSymbols: List, + // 이거 빼면 S&P 500과 아래 ETF 전부 수집 + val only: List = emptyList(), + val indexEtfs: List = listOf("SPY", "QQQ", "IWM", "DIA"), + val sectorEtfs: List = listOf("XLB", "XLC", "XLE", "XLF", "XLI", "XLK", "XLP", "XLRE", "XLU", "XLV", "XLY"), + val otherEtfs: List = listOf("VXX", "UVXY", "SVXY", "GLD", "TLT", "HYG"), +) diff --git a/src/main/resources/application-dev.yml b/src/main/resources/application-dev.yml new file mode 100644 index 0000000..da9f805 --- /dev/null +++ b/src/main/resources/application-dev.yml @@ -0,0 +1,5 @@ +spring: + datasource: + url: ${LOCAL_DB_URL} + username: ${LOCAL_DB_USERNAME} + password: ${LOCAL_DB_PASSWORD} diff --git a/src/main/resources/application-prod.yml b/src/main/resources/application-prod.yml new file mode 100644 index 0000000..c5dfea3 --- /dev/null +++ b/src/main/resources/application-prod.yml @@ -0,0 +1,5 @@ +spring: + datasource: + url: ${PROD_DB_URL} + username: ${PROD_DB_USERNAME} + password: ${PROD_DB_PASSWORD} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..63ab13a --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,79 @@ +spring: + profiles: + active: dev + + application: + name: option + + jpa: + open-in-view: false + hibernate: + ddl-auto: update + properties: + hibernate: + jdbc: + time_zone: UTC + +# 타임아웃 설정 + http: + client: + factory: simple + connect-timeout: 10s + read-timeout: 60s + + task: + scheduling: + pool: + size: 2 + +management: + server: + # 메트릭용 포트 + port: 8081 + endpoints: + web: + exposure: + include: health, info, prometheus, metrics + metrics: + distribution: + percentiles-histogram: + http.server.requests: true + +scheduling: + enabled: ${OPTION_SCHEDULING_ENABLED:true} + +jwt: + secret: ${JWT_SECRET:} + access-token-validity: 30m + refresh-token-validity: 14d + +alpaca: + key-id: ${APCA_API_KEY_ID:} + secret-key: ${APCA_API_SECRET_KEY:} + # 분당 200한도 + min-call-interval: 300ms + +fred: + api-key: ${FRED_API_KEY:} + +finnhub: + api-key: ${FINNHUB_API_KEY:} + +storage: + raw-dir: ${OPTION_RAW_DIR:./data/raw} + trades-dir: ${OPTION_TRADES_DIR:./data/trades} + # 디스크 용량 확보용 + stop-background-free-ratio: 0.20 + stop-collection-free-ratio: 0.10 + min-free-bytes: 2147483648 + +job: + lease: 10m + trade-time-budget: 6h + backfill-start: 2024-01-01 + backfill-expiration-start: 2024-02-01 + +universe: + only: ${OPTION_UNIVERSE_ONLY:} + trade-symbols: SPY, QQQ + backfill-symbols: SPY, QQQ