commit a2a9402270d7692ab350f2c58f863a093a689856 Author: kric_jspark Date: Wed Nov 12 15:53:31 2025 +0900 first commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1fac4d5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +.gradle +build/ +!gradle/wrapper/gradle-wrapper.jar +!**/src/main/**/build/ +!**/src/test/**/build/ +.kotlin + +### IntelliJ IDEA ### +.idea/modules.xml +.idea/jarRepositories.xml +.idea/compiler.xml +.idea/libraries/ +*.iws +*.iml +*.ipr +out/ +!**/src/main/**/out/ +!**/src/test/**/out/ + +### Eclipse ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache +bin/ +!**/src/main/**/bin/ +!**/src/test/**/bin/ + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ + +### VS Code ### +.vscode/ + +### Mac OS ### +.DS_Store \ No newline at end of file diff --git a/.idea/.gitignore b/.idea/.gitignore new file mode 100644 index 0000000..c3f502a --- /dev/null +++ b/.idea/.gitignore @@ -0,0 +1,8 @@ +# 디폴트 무시된 파일 +/shelf/ +/workspace.xml +# 에디터 기반 HTTP 클라이언트 요청 +/httpRequests/ +# Datasource local storage ignored files +/dataSources/ +/dataSources.local.xml diff --git a/.idea/gradle.xml b/.idea/gradle.xml new file mode 100644 index 0000000..715ee12 --- /dev/null +++ b/.idea/gradle.xml @@ -0,0 +1,18 @@ + + + + + + + \ No newline at end of file diff --git a/.idea/material_theme_project_new.xml b/.idea/material_theme_project_new.xml new file mode 100644 index 0000000..609166c --- /dev/null +++ b/.idea/material_theme_project_new.xml @@ -0,0 +1,12 @@ + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..f6589e3 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,10 @@ + + + + + + + + + + \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..637e752 --- /dev/null +++ b/build.gradle @@ -0,0 +1,39 @@ +plugins { + id 'java-library' + id 'maven-publish' +} + +group = 'com.kri.common' +version = '1.0.0' + +java { + toolchain { languageVersion = JavaLanguageVersion.of(17) } +} + +repositories { + mavenCentral() +} + +dependencies { + // Spring BOM (버전 정합성) + api platform('org.springframework.boot:spring-boot-dependencies:3.5.7') + + // ★ 자동구성/웹/검증/AOP는 컴파일만 (전이 방지) + compileOnly 'org.springframework.boot:spring-boot-autoconfigure' + compileOnly 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.springframework.boot:spring-boot-starter-validation' + compileOnly 'org.springframework.boot:spring-boot-starter-aop' + + // ★ Redis 자동구성용 (원하면 끌 수 있게) — 런타임은 소비 앱이 책임 + compileOnly 'org.springframework.boot:spring-boot-starter-data-redis' +} + +publishing { + publications { + release(MavenPublication) { + from components.java + artifactId = 'starter' // 소비 앱에서 com.kri.common:starter:1.0.0 로 의존 + } + } + // repositories { maven { url = uri('https://your-internal-registry') } } +} \ No newline at end of file diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..249e583 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..d9a79a7 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Tue Nov 11 15:01:17 KST 2025 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.14-bin.zip +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1b6c787 --- /dev/null +++ b/gradlew @@ -0,0 +1,234 @@ +#!/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. +# + +############################################################################## +# +# 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/master/subprojects/plugins/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 + +APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit + +APP_NAME="Gradle" +APP_BASE_NAME=${0##*/} + +# 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"' + +# 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 + which java >/dev/null 2>&1 || 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 + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + 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 + +# Collect all arguments for the java command; +# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of +# shell script including quotes and variable substitutions, so put them in +# double quotes to make sure that they get re-expanded; and +# * put everything else in single quotes, so that it's not re-expanded. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# 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..107acd3 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@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 + +@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=. +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%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +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%"=="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! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..9a91348 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'KriCommon' \ No newline at end of file diff --git a/src/main/java/com/kri/common/redis/CommonRedisAutoConfiguration.java b/src/main/java/com/kri/common/redis/CommonRedisAutoConfiguration.java new file mode 100644 index 0000000..fb05ee3 --- /dev/null +++ b/src/main/java/com/kri/common/redis/CommonRedisAutoConfiguration.java @@ -0,0 +1,22 @@ +package com.kri.common.redis; + +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.*; +import org.springframework.context.annotation.Bean; +import org.springframework.data.redis.connection.RedisConnectionFactory; +import org.springframework.data.redis.core.*; + +@AutoConfiguration +@ConditionalOnClass(RedisTemplate.class) +@ConditionalOnProperty(prefix = "common.redis", name = "enabled", havingValue = "true", matchIfMissing = false) +@ConditionalOnBean(RedisConnectionFactory.class) +public class CommonRedisAutoConfiguration { + + @Bean @ConditionalOnMissingBean + public StringRedisTemplate stringRedisTemplate(org.springframework.data.redis.connection.RedisConnectionFactory cf) { + return new StringRedisTemplate(cf); + } + + @Bean @ConditionalOnMissingBean + public RedisQueueHelper redisQueueHelper(StringRedisTemplate rt) { return new RedisQueueHelper(rt); } +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/redis/RedisQueueHelper.java b/src/main/java/com/kri/common/redis/RedisQueueHelper.java new file mode 100644 index 0000000..3494892 --- /dev/null +++ b/src/main/java/com/kri/common/redis/RedisQueueHelper.java @@ -0,0 +1,11 @@ +package com.kri.common.redis; + +import org.springframework.data.redis.core.StringRedisTemplate; +import java.time.Duration; + +public class RedisQueueHelper { + private final StringRedisTemplate rt; + public RedisQueueHelper(StringRedisTemplate rt){ this.rt = rt; } + public void enqueue(String key, String value){ rt.opsForList().rightPush(key, value); } + public String blockingDequeue(String key, Duration timeout){ return rt.opsForList().leftPop(key, timeout); } +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/scheduling/CommonSchedulingAutoConfiguration.java b/src/main/java/com/kri/common/scheduling/CommonSchedulingAutoConfiguration.java new file mode 100644 index 0000000..5f701fe --- /dev/null +++ b/src/main/java/com/kri/common/scheduling/CommonSchedulingAutoConfiguration.java @@ -0,0 +1,10 @@ +package com.kri.common.scheduling; + +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.scheduling.annotation.EnableScheduling; + +@AutoConfiguration +@EnableScheduling +@ConditionalOnProperty(prefix = "common.scheduling", name = "enabled", havingValue = "true", matchIfMissing = false) +public class CommonSchedulingAutoConfiguration { } \ No newline at end of file diff --git a/src/main/java/com/kri/common/web/BusinessException.java b/src/main/java/com/kri/common/web/BusinessException.java new file mode 100644 index 0000000..abb528b --- /dev/null +++ b/src/main/java/com/kri/common/web/BusinessException.java @@ -0,0 +1,51 @@ +package com.kri.common.web; + +import org.springframework.http.HttpStatus; +import java.util.Collections; +import java.util.HashMap; +import java.util.Map; + +public class BusinessException extends RuntimeException { + private final HttpStatus status; + private final String code; + private final Map extras; + + private static String defaultCode(HttpStatus status) { return status.name(); } // 예: NOT_FOUND, CONFLICT … + + private BusinessException(HttpStatus status, String code, String message, + Map extras, Throwable cause) { + super(message != null && !message.isBlank() ? message : status.getReasonPhrase(), cause); + this.status = status; + this.code = (code != null && !code.isBlank()) ? code : defaultCode(status); // 코드가 없으면 상태명으로 대체 + this.extras = extras == null ? Collections.emptyMap() + : Collections.unmodifiableMap(new HashMap<>(extras)); + } + + public static BusinessException of(HttpStatus status, String code, String message) { + return new BusinessException(status, code, message, null, null); + } + public static BusinessException of(HttpStatus status, String code, String message, Map extras) { + return new BusinessException(status, code, message, extras, null); + } + // 편의 생성자들 + public static BusinessException notFound(String code, String message) { + return of(HttpStatus.NOT_FOUND, code, message); + } + public static BusinessException conflict(String code, String message) { + return of(HttpStatus.CONFLICT, code, message); + } + public static BusinessException forbidden(String code, String message) { + return of(HttpStatus.FORBIDDEN, code, message); + } + + public HttpStatus getStatus(){ return status; } + public String getCode(){ return code; } + public Map getExtras(){ return extras; } + + /** 편의: 체이닝으로 extras 추가 */ + public BusinessException with(String key, Object value) { + var map = new HashMap<>(this.extras); + map.put(key, value); + return new BusinessException(this.status, this.code, this.getMessage(), map, this.getCause()); + } +} \ No newline at end of file diff --git a/src/main/java/com/kri/common/web/CommonWebAutoConfiguration.java b/src/main/java/com/kri/common/web/CommonWebAutoConfiguration.java new file mode 100644 index 0000000..4ca1333 --- /dev/null +++ b/src/main/java/com/kri/common/web/CommonWebAutoConfiguration.java @@ -0,0 +1,18 @@ +package com.kri.common.web; + +import org.springframework.boot.autoconfigure.AutoConfiguration; +import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; +import org.springframework.context.annotation.Bean; +import org.springframework.boot.web.servlet.FilterRegistrationBean; +import org.springframework.core.Ordered; + +@AutoConfiguration +@ConditionalOnProperty(name = "common.web.enabled", matchIfMissing = true) +public class CommonWebAutoConfiguration { + @Bean public ErrorAdvice errorAdvice() { return new ErrorAdvice(); } + @Bean public FilterRegistrationBean traceFilter() { + var reg = new FilterRegistrationBean<>(new TraceFilter()); + reg.setOrder(Ordered.HIGHEST_PRECEDENCE); + return reg; + } +} diff --git a/src/main/java/com/kri/common/web/ErrorAdvice.java b/src/main/java/com/kri/common/web/ErrorAdvice.java new file mode 100644 index 0000000..7f9a40d --- /dev/null +++ b/src/main/java/com/kri/common/web/ErrorAdvice.java @@ -0,0 +1,200 @@ +package com.kri.common.web; + +import jakarta.servlet.http.HttpServletRequest; +import jakarta.validation.ConstraintViolationException; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.slf4j.MDC; +import org.springframework.beans.factory.annotation.Value; +import org.springframework.http.HttpMethod; +import org.springframework.http.HttpStatus; +import org.springframework.http.ProblemDetail; +import org.springframework.http.converter.HttpMessageNotReadableException; +import org.springframework.web.ErrorResponseException; +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; +import org.springframework.web.server.ResponseStatusException; +import org.springframework.web.servlet.NoHandlerFoundException; +import org.springframework.web.HttpMediaTypeNotSupportedException; +import org.springframework.web.HttpRequestMethodNotSupportedException; + +import java.time.Instant; +import java.util.*; +import java.util.stream.Collectors; + +@RestControllerAdvice +public class ErrorAdvice { + private static final Logger log = LoggerFactory.getLogger(ErrorAdvice.class); + + // 기본값은 모두 false → 외부 응답엔 노출 안 함 + @Value("${common.error.expose.handler:false}") + private boolean exposeHandler; + @Value("${common.error.expose.service:false}") + private boolean exposeService; + + /* ---------- 공통 ProblemDetail 빌더 ---------- */ + protected ProblemDetail pd(HttpStatus status, String code, String message, + HttpServletRequest req, Map extras) { + ProblemDetail p = ProblemDetail.forStatusAndDetail(status, message); + p.setTitle(status.getReasonPhrase()); + p.setProperty("code", code); + p.setProperty("timestamp", Instant.now().toString()); + p.setProperty("path", req.getRequestURI()); + + String traceId = MDC.get("traceId"); + if (traceId != null) p.setProperty("traceId", traceId); // traceId는 외부에 주는 게 일반적 + + // ↓↓↓ 외부로 숨기고 싶으면 기본 false + if (exposeHandler) { + String handler = MDC.get("handler"); // Controller#method + if (handler != null) p.setProperty("handler", handler); + } + if (exposeService) { + String service = MDC.get("service"); // Service#method (최초 진입) + if (service != null) p.setProperty("service", service); + } + + if (extras != null) extras.forEach(p::setProperty); + return p; + } + + /* ---------- Custom Exception ---------- */ + @ExceptionHandler(BusinessException.class) + public ProblemDetail handleBusiness(BusinessException e, HttpServletRequest req) { + logBusiness(e, req); // ← 로그 먼저 + return pd( + e.getStatus(), + e.getCode(), // 문자열 코드(없으면 상태명으로 이미 대체됨) + e.getMessage(), + req, + e.getExtras().isEmpty() ? null : e.getExtras() + ); + } + + /* 상황별 로그 레벨/스택트레이스 정책 */ + private void logBusiness(BusinessException e, HttpServletRequest req) { + int sc = e.getStatus().value(); + String traceId = MDC.get("traceId"); + String path = req.getRequestURI(); + String code = e.getCode(); + var extras = e.getExtras(); + + if (sc >= 500) { + // 5xx: 운영 이슈 → ERROR + 스택트레이스 + log.error("BusinessException status={} code={} path={} traceId={} extras={}", + sc, code, path, traceId, extras, e); + } else if (sc == 409 || sc == 404 || sc == 400 || sc == 403 || sc == 422) { + // 사용자/도메인 입력 문제 → WARN, 스택트레이스 제외 + log.warn("BusinessException status={} code={} path={} traceId={} extras={}", + sc, code, path, traceId, extras); + } else { + // 기타 → WARN 기본 + log.warn("BusinessException status={} code={} path={} traceId={} extras={}", + sc, code, path, traceId, extras); + } + } + + /* ---------- 400: Bean Validation(@Valid) 바디/폼 바인딩 ---------- */ + @ExceptionHandler(MethodArgumentNotValidException.class) + public ProblemDetail handleMethodArgumentNotValid(MethodArgumentNotValidException e, HttpServletRequest req) { + var fieldErrors = e.getBindingResult().getFieldErrors().stream() + .map(fe -> Map.of( + "field", fe.getField(), + "message", Optional.ofNullable(fe.getDefaultMessage()).orElse("invalid"), + "rejectedValue", String.valueOf(fe.getRejectedValue()) + )) + .collect(Collectors.toList()); + return pd(HttpStatus.BAD_REQUEST, "VALIDATION_ERROR", "요청 데이터가 올바르지 않습니다.", req, + Map.of("errors", fieldErrors)); + } + + /* ---------- 400: 파라미터/타입 문제 ---------- */ + @ExceptionHandler({ + MissingServletRequestParameterException.class, + HttpMessageNotReadableException.class + }) + public ProblemDetail handleBadRequest(RuntimeException e, HttpServletRequest req) { + String msg = (e instanceof HttpMessageNotReadableException) + ? "요청 바디를 읽을 수 없습니다(형식 오류/잘못된 JSON)." + : e.getMessage(); + return pd(HttpStatus.BAD_REQUEST, "BAD_REQUEST", msg, req, null); + } + + @ExceptionHandler(MethodArgumentTypeMismatchException.class) + public ProblemDetail handleTypeMismatch(MethodArgumentTypeMismatchException e, HttpServletRequest req) { + String need = (e.getRequiredType() != null) ? e.getRequiredType().getSimpleName() : "required type"; + String msg = "파라미터 '" + e.getName() + "' 형식이 올바르지 않습니다. 필요 타입: " + need; + return pd(HttpStatus.BAD_REQUEST, "TYPE_MISMATCH", msg, req, null); + } + + /* ---------- 400: 메서드 파라미터(@Validated) 제약 위반 ---------- */ + @ExceptionHandler(ConstraintViolationException.class) + public ProblemDetail handleConstraintViolation(ConstraintViolationException e, HttpServletRequest req) { + var errors = e.getConstraintViolations().stream() + .map(v -> Map.of("property", v.getPropertyPath().toString(), "message", v.getMessage())) + .collect(Collectors.toList()); + return pd(HttpStatus.BAD_REQUEST, "CONSTRAINT_VIOLATION", "요청 파라미터가 제약을 위반했습니다.", req, + Map.of("errors", errors)); + } + + /* ---------- 404/405/415 등 표준 스프링 예외 ---------- */ + @ExceptionHandler(NoHandlerFoundException.class) + public ProblemDetail handleNotFound(NoHandlerFoundException e, HttpServletRequest req) { + return pd(HttpStatus.NOT_FOUND, "NOT_FOUND", "요청한 리소스를 찾을 수 없습니다.", req, null); + } + + @ExceptionHandler(HttpRequestMethodNotSupportedException.class) + public ProblemDetail handleMethodNotSupported(HttpRequestMethodNotSupportedException e, HttpServletRequest req) { + String supported = resolveSupportedMethods(e); + String msg = "허용되지 않은 HTTP 메서드입니다. 지원: " + supported; + // 필요하면 extras로 supported를 내려도 됩니다: Map.of("supported", supported) + return pd(HttpStatus.METHOD_NOT_ALLOWED, "METHOD_NOT_ALLOWED", msg, req, null); + } + + @ExceptionHandler(HttpMediaTypeNotSupportedException.class) + public ProblemDetail handleMediaType(HttpMediaTypeNotSupportedException e, HttpServletRequest req) { + String supported = e.getSupportedMediaTypes().stream().map(Object::toString).collect(Collectors.joining(",")); + String msg = "지원하지 않는 Content-Type입니다. 지원: " + supported; + return pd(HttpStatus.UNSUPPORTED_MEDIA_TYPE, "UNSUPPORTED_MEDIA_TYPE", msg, req, null); + } + + /* ---------- 4xx/5xx를 명시하는 스프링 예외 ---------- */ + @ExceptionHandler({ ResponseStatusException.class, ErrorResponseException.class }) + public ProblemDetail handleResponseStatus(Exception e, HttpServletRequest req) { + HttpStatus status; + String reason; + if (e instanceof ResponseStatusException rse) { + status = HttpStatus.valueOf(rse.getStatusCode().value()); + reason = Optional.ofNullable(rse.getReason()).orElse(status.getReasonPhrase()); + } else { // ErrorResponseException (Spring 6+) + var ere = (ErrorResponseException) e; + status = HttpStatus.valueOf(ere.getStatusCode().value()); + reason = Optional.ofNullable(ere.getBody()).map(ProblemDetail::getDetail).orElse(status.getReasonPhrase()); + } + return pd(status, "ERROR", reason, req, null); + } + + /* ---------- 마지막: 예상 못한 예외는 500 ---------- */ + @ExceptionHandler(Exception.class) + public ProblemDetail handleAny(Exception e, HttpServletRequest req) { + return pd(HttpStatus.INTERNAL_SERVER_ERROR, "INTERNAL_ERROR", "서버 내부 오류가 발생했습니다.", req, null); + } + + private static String resolveSupportedMethods(HttpRequestMethodNotSupportedException e) { + Set httpMethods = e.getSupportedHttpMethods(); + if (httpMethods != null && !httpMethods.isEmpty()) { + // ✅ 핵심 수정: Enum::name 대신 HttpMethod::name + return httpMethods.stream() + .map(HttpMethod::name) + .collect(Collectors.joining(", ")); + } + String[] methods = e.getSupportedMethods(); // 구버전 호환용 + if (methods != null && methods.length > 0) { + return String.join(", ", methods); + } + return "N/A"; + } +} diff --git a/src/main/java/com/kri/common/web/MdcHandlerConfig.java b/src/main/java/com/kri/common/web/MdcHandlerConfig.java new file mode 100644 index 0000000..b29328e --- /dev/null +++ b/src/main/java/com/kri/common/web/MdcHandlerConfig.java @@ -0,0 +1,33 @@ +package com.kri.common.web; + +import jakarta.servlet.http.*; +import org.slf4j.MDC; +import org.springframework.context.annotation.Bean; +import org.springframework.web.method.HandlerMethod; +import org.springframework.web.servlet.config.annotation.*; + +public class MdcHandlerConfig { + @Bean + public WebMvcConfigurer mdcWebMvcConfigurer() { + return new WebMvcConfigurer() { + @Override + public void addInterceptors(InterceptorRegistry registry) { + registry.addInterceptor(new org.springframework.web.servlet.HandlerInterceptor() { + @Override + public boolean preHandle(HttpServletRequest req, HttpServletResponse res, Object handler) { + if (handler instanceof HandlerMethod hm) { + String ctrl = hm.getBeanType().getSimpleName(); // ex) ContactController + String method = hm.getMethod().getName(); // ex) create + MDC.put("handler", ctrl + "#" + method); // ex) ContactController#create + } + return true; + } + @Override + public void afterCompletion(HttpServletRequest req, HttpServletResponse res, Object handler, Exception ex) { + MDC.remove("handler"); + } + }); + } + }; + } +} diff --git a/src/main/java/com/kri/common/web/ServiceMdcAspect.java b/src/main/java/com/kri/common/web/ServiceMdcAspect.java new file mode 100644 index 0000000..705e21c --- /dev/null +++ b/src/main/java/com/kri/common/web/ServiceMdcAspect.java @@ -0,0 +1,25 @@ +package com.kri.common.web; + +import org.aspectj.lang.ProceedingJoinPoint; +import org.aspectj.lang.annotation.*; +import org.slf4j.MDC; +import org.springframework.stereotype.Component; + +@Aspect +@Component +public class ServiceMdcAspect { + @Around("within(@org.springframework.stereotype.Service *)") + public Object aroundService(ProceedingJoinPoint pjp) throws Throwable { + boolean first = (MDC.get("service") == null); + if (first) { + String cls = pjp.getSignature().getDeclaringType().getSimpleName(); // ex) ExportService + String mtd = pjp.getSignature().getName(); // ex) enqueue + MDC.put("service", cls + "#" + mtd); // ex) ExportService#enqueue + } + try { + return pjp.proceed(); + } finally { + if (first) MDC.remove("service"); + } + } +} diff --git a/src/main/java/com/kri/common/web/TraceFilter.java b/src/main/java/com/kri/common/web/TraceFilter.java new file mode 100644 index 0000000..fed0139 --- /dev/null +++ b/src/main/java/com/kri/common/web/TraceFilter.java @@ -0,0 +1,28 @@ +package com.kri.common.web; + +import jakarta.servlet.*; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; +import org.slf4j.MDC; +import java.io.IOException; +import java.util.UUID; + +public class TraceFilter implements Filter { + private static final String REQ_HEADER = "X-Request-Id"; + private static final String MDC_KEY = "traceId"; + + @Override + public void doFilter(ServletRequest req, ServletResponse res, FilterChain chain) + throws IOException, ServletException { + var httpReq = (HttpServletRequest) req; + var httpRes = (HttpServletResponse) res; + + String id = httpReq.getHeader(REQ_HEADER); + if (id == null || id.isBlank()) id = UUID.randomUUID().toString(); + + try (MDC.MDCCloseable ignored = MDC.putCloseable(MDC_KEY, id)) { + httpRes.setHeader(REQ_HEADER, id); // 응답에도 echo + chain.doFilter(req, res); + } + } +} \ No newline at end of file diff --git a/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports b/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports new file mode 100644 index 0000000..05f3b22 --- /dev/null +++ b/src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports @@ -0,0 +1,3 @@ +com.kri.common.web.CommonWebAutoConfiguration +com.kri.common.redis.CommonRedisAutoConfiguration +com.kri.common.scheduling.CommonSchedulingAutoConfiguration \ No newline at end of file diff --git a/src/main/resources/logback-spring.xml b/src/main/resources/logback-spring.xml new file mode 100644 index 0000000..e5bb0e0 --- /dev/null +++ b/src/main/resources/logback-spring.xml @@ -0,0 +1,50 @@ + + + + + + + + + + + + + + + ${LOG_PATTERN} + + + + + + ${LOG_DIR}/${APP_NAME}.log + + ${LOG_PATTERN} + + + ${LOG_DIR}/${APP_NAME}-%d{yyyy-MM-dd}.log.gz + 14 + + + + + + 8192 + 0 + true + + + + + + + + + + + \ No newline at end of file