diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..44fcb81 --- /dev/null +++ b/.gitignore @@ -0,0 +1,44 @@ +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 + +### Config ### +application-secret.properties +application.yaml \ No newline at end of file diff --git a/README.md b/README.md index 1a08dcc..01eadb0 100644 --- a/README.md +++ b/README.md @@ -1 +1 @@ -# SANHAK_Server \ No newline at end of file +# SANHAK_Server diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..027092f --- /dev/null +++ b/build.gradle @@ -0,0 +1,77 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.1.10' + id 'io.spring.dependency-management' version '1.1.4' +} + +group = 'org.kau' +version = '0.0.1-SNAPSHOT' + +java { + sourceCompatibility = '17' +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + // Spring Web + implementation 'org.springframework.boot:spring-boot-starter-web' + + // Test & Validation + testImplementation 'org.springframework.boot:spring-boot-starter-test' + implementation 'org.springframework.boot:spring-boot-starter-validation' + + //Lombok + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + + // Spring Data JPA + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + // MySQL + runtimeOnly 'com.mysql:mysql-connector-j' + + // AWS SDK + implementation("software.amazon.awssdk:bom:2.21.0") + implementation("software.amazon.awssdk:s3:2.21.0") + + // AWS Secrets + implementation 'org.springframework.cloud:spring-cloud-starter-bootstrap:3.1.3' + implementation 'org.springframework.cloud:spring-cloud-starter-aws-secrets-manager-config:2.2.6.RELEASE' + + // Health Check + implementation 'org.springframework.boot:spring-boot-starter-actuator' + + // JWT + implementation group: 'io.jsonwebtoken', name: 'jjwt-api', version: '0.11.5' + runtimeOnly group: 'io.jsonwebtoken', name: 'jjwt-impl', version: '0.11.5' + runtimeOnly group: 'io.jsonwebtoken', name: 'jjwt-jackson', version: '0.11.5' + + // Spring Security + implementation 'org.springframework.boot:spring-boot-starter-security' + implementation 'org.springframework.security:spring-security-test' + + // Redis + implementation 'org.springframework.boot:spring-boot-starter-data-redis' + + // Open Feign + implementation 'org.springframework.cloud:spring-cloud-starter-openfeign:4.0.4' + + // JSON + implementation 'com.googlecode.json-simple:json-simple:1.1.1' +} + +tasks.named('bootBuildImage') { + builder = 'paketobuildpacks/builder-jammy-base:latest' +} + +tasks.named('test') { + useJUnitPlatform() +} diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..d64cd49 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..97f9ad6 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,23 @@ +# +# Copyright 2012-2024 the original author or 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. +# + +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.6-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100644 index 0000000..1aa94a4 --- /dev/null +++ b/gradlew @@ -0,0 +1,249 @@ +#!/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/HEAD/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 + +# 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 "${APP_HOME:-./}" > /dev/null && pwd -P ) || 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..93e3f59 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,92 @@ +@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=. +@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. +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% 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..b06e6ae --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'kkoolbeeServer' diff --git a/src/main/java/org/kau/kkoolbeeServer/KkoolbeeServerApplication.java b/src/main/java/org/kau/kkoolbeeServer/KkoolbeeServerApplication.java new file mode 100644 index 0000000..023b644 --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/KkoolbeeServerApplication.java @@ -0,0 +1,13 @@ +package org.kau.kkoolbeeServer; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class KkoolbeeServerApplication { + + public static void main(String[] args) { + SpringApplication.run(KkoolbeeServerApplication.class, args); + } + +} diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/config/AWSConfig.java b/src/main/java/org/kau/kkoolbeeServer/global/common/config/AWSConfig.java new file mode 100644 index 0000000..8499a83 --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/config/AWSConfig.java @@ -0,0 +1,48 @@ +package org.kau.kkoolbeeServer.global.common.config; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import software.amazon.awssdk.auth.credentials.SystemPropertyCredentialsProvider; +import software.amazon.awssdk.regions.Region; +import software.amazon.awssdk.services.s3.S3Client; + +@Configuration +public class AWSConfig { + + private static final String AWS_ACCESS_KEY_ID = "aws.accessKeyId"; + private static final String AWS_SECRET_ACCESS_KEY = "aws.secretAccessKey"; + + private final String accessKey; + private final String secretKey; + private final String regionString; + + public AWSConfig(@Value("${aws-property.access-key}") final String accessKey, + @Value("${aws-property.secret-key}") final String secretKey, + @Value("${aws-property.aws-region}") final String regionString) { + this.accessKey = accessKey; + this.secretKey = secretKey; + this.regionString = regionString; + } + + + @Bean + public SystemPropertyCredentialsProvider systemPropertyCredentialsProvider() { + System.setProperty(AWS_ACCESS_KEY_ID, accessKey); + System.setProperty(AWS_SECRET_ACCESS_KEY, secretKey); + return SystemPropertyCredentialsProvider.create(); + } + + @Bean + public Region getRegion() { + return Region.of(regionString); + } + + @Bean + public S3Client getS3Client() { + return S3Client.builder() + .region(getRegion()) + .credentialsProvider(systemPropertyCredentialsProvider()) + .build(); + } +} \ No newline at end of file diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/config/JpaAuditingConfig.java b/src/main/java/org/kau/kkoolbeeServer/global/common/config/JpaAuditingConfig.java new file mode 100644 index 0000000..a072121 --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/config/JpaAuditingConfig.java @@ -0,0 +1,9 @@ +package org.kau.kkoolbeeServer.global.common.config; + +import org.springframework.context.annotation.Configuration; +import org.springframework.data.jpa.repository.config.EnableJpaAuditing; + +@Configuration +@EnableJpaAuditing +public class JpaAuditingConfig { +} diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/config/WebConfig.java b/src/main/java/org/kau/kkoolbeeServer/global/common/config/WebConfig.java new file mode 100644 index 0000000..aa2dca5 --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/config/WebConfig.java @@ -0,0 +1,18 @@ +package org.kau.kkoolbeeServer.global.common.config; + +import org.springframework.context.annotation.Configuration; +import org.springframework.web.servlet.config.annotation.CorsRegistry; +import org.springframework.web.servlet.config.annotation.WebMvcConfigurer; + +@Configuration +public class WebConfig implements WebMvcConfigurer { + + @Override + public void addCorsMappings(CorsRegistry registry) { + registry.addMapping("/**") + .allowedOrigins("http://localhost:8080", "http://localhost:8081", "http://localhost:5173") + .allowedMethods("GET", "POST", "PUT", "PATCH", "DELETE") + .allowCredentials(true) + .maxAge(3000); + } +} diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/domain/BaseTimeEntity.java b/src/main/java/org/kau/kkoolbeeServer/global/common/domain/BaseTimeEntity.java new file mode 100644 index 0000000..15f25cd --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/domain/BaseTimeEntity.java @@ -0,0 +1,21 @@ +package org.kau.kkoolbeeServer.global.common.domain; + +import jakarta.persistence.EntityListeners; +import jakarta.persistence.MappedSuperclass; +import org.springframework.data.annotation.CreatedDate; +import org.springframework.data.annotation.LastModifiedDate; +import org.springframework.data.jpa.domain.support.AuditingEntityListener; + +import java.time.LocalDateTime; + +@MappedSuperclass +@EntityListeners(AuditingEntityListener.class) +public abstract class BaseTimeEntity { + + @CreatedDate + private LocalDateTime createdAt; + + @LastModifiedDate + private LocalDateTime updatedAt; + +} diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/dto/ApiResponse.java b/src/main/java/org/kau/kkoolbeeServer/global/common/dto/ApiResponse.java new file mode 100644 index 0000000..cd1822c --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/dto/ApiResponse.java @@ -0,0 +1,51 @@ +package org.kau.kkoolbeeServer.global.common.dto; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import lombok.RequiredArgsConstructor; +import org.kau.kkoolbeeServer.global.common.enums.ErrorType; +import org.kau.kkoolbeeServer.global.common.enums.SuccessType; + +@Getter +@JsonPropertyOrder({"code", "message", "data"}) +@RequiredArgsConstructor(access = AccessLevel.PRIVATE) +@AllArgsConstructor(access = AccessLevel.PRIVATE) +public class ApiResponse { + + private final int code; // 상태 코드 + private final String message; // 회원 조회가 정상 처리되었습니다! + + @JsonInclude(JsonInclude.Include.NON_NULL) + private T data; // 객체가 실제로 들어감 + + public static ApiResponse success(SuccessType successType) { + return new ApiResponse<>(successType.getHttpStatusCode(), successType.getMessage()); + } + + public static ApiResponse success(SuccessType successType, T data) { + return new ApiResponse(successType.getHttpStatusCode(), successType.getMessage(), data); + } + + public static ApiResponse error(ErrorType errorType) { + return new ApiResponse<>(errorType.getHttpStatusCode(), errorType.getMessage()); + } + + public static ApiResponse error(ErrorType errorType, String message) { + return new ApiResponse<>(errorType.getHttpStatusCode(), message); + } + + public static ApiResponse error(ErrorType errorType, String message, T data) { + return new ApiResponse<>(errorType.getHttpStatusCode(), message, data); + } + + public static ApiResponse error(ErrorType errorType, Exception e) { + return new ApiResponse<>(errorType.getHttpStatusCode(), errorType.getMessage(), e); + } + + public static ApiResponse error(ErrorType errorType, T data) { + return new ApiResponse<>(errorType.getHttpStatusCode(), errorType.getMessage(), data); + } +} diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/enums/ErrorType.java b/src/main/java/org/kau/kkoolbeeServer/global/common/enums/ErrorType.java new file mode 100644 index 0000000..44b7fb8 --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/enums/ErrorType.java @@ -0,0 +1,29 @@ +package org.kau.kkoolbeeServer.global.common.enums; + +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +@AllArgsConstructor(access = AccessLevel.PRIVATE) +public enum ErrorType { + + /** + * 400 BAD REQUEST + */ + REQUEST_VALIDATION_EXCEPTION(HttpStatus.BAD_REQUEST, "잘못된 요청입니다"), + + /** + * 500 INTERNAL SERVER ERROR + */ + INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "알 수 없는 서버 에러가 발생했습니다."), + ; + + private final HttpStatus httpStatus; + private final String message; + + public int getHttpStatusCode() { + return httpStatus.value(); + } +} diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/enums/SuccessType.java b/src/main/java/org/kau/kkoolbeeServer/global/common/enums/SuccessType.java new file mode 100644 index 0000000..7640e4b --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/enums/SuccessType.java @@ -0,0 +1,24 @@ +package org.kau.kkoolbeeServer.global.common.enums; + +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Getter; +import org.springframework.http.HttpStatus; + +@Getter +@AllArgsConstructor(access = AccessLevel.PRIVATE) +public enum SuccessType { + + /** + * 200 OK + */ + PROCESS_SUCCESS(HttpStatus.OK, "OK"), + ; + + private final HttpStatus httpStatus; + private final String message; + + public int getHttpStatusCode() { + return httpStatus.value(); + } +} diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/exception/GlobalExceptionHandler.java b/src/main/java/org/kau/kkoolbeeServer/global/common/exception/GlobalExceptionHandler.java new file mode 100644 index 0000000..d04d832 --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/exception/GlobalExceptionHandler.java @@ -0,0 +1,73 @@ +package org.kau.kkoolbeeServer.global.common.exception; + +import jakarta.servlet.http.HttpServletRequest; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; +import org.kau.kkoolbeeServer.global.common.dto.ApiResponse; +import org.kau.kkoolbeeServer.global.common.model.CustomException; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Component; +import org.springframework.validation.Errors; +import org.springframework.validation.FieldError; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.ResponseStatus; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +import java.io.IOException; +import java.util.HashMap; +import java.util.Map; + +import static org.kau.kkoolbeeServer.global.common.enums.ErrorType.INTERNAL_SERVER_ERROR; +import static org.kau.kkoolbeeServer.global.common.enums.ErrorType.REQUEST_VALIDATION_EXCEPTION; + +@Slf4j // 로그 출력 +@RestControllerAdvice +@Component +@RequiredArgsConstructor +public class GlobalExceptionHandler { +// 오류를 ApiResponse에 담아서 처리해주는 친구 (감시하고 있음) + +// @Size(min = 2, max = 8, message = "닉네임은 2글자 이상 8글자 이하여야합니다.") +// private String nickname; +// + Controller 계층에 @Valid 어노테이션 + /** + * VALIDATION_ERROR + */ + @ResponseStatus(HttpStatus.BAD_REQUEST) + @ExceptionHandler(MethodArgumentNotValidException.class) + protected ApiResponse handleMethodArgumentNotValidException(final MethodArgumentNotValidException e) { + + Errors errors = e.getBindingResult(); + Map validateDetails = new HashMap<>(); + + for (FieldError error : errors.getFieldErrors()) { + String validKeyName = String.format("valid_%s", error.getField()); + validateDetails.put(validKeyName, error.getDefaultMessage()); + } + return ApiResponse.error(REQUEST_VALIDATION_EXCEPTION, validateDetails); + } + + /** + * CUSTOM_ERROR + */ + @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) + @ExceptionHandler(CustomException.class) + protected ResponseEntity> handleBusinessException(CustomException e) { + + log.error("[EXCEPTION] CustomException Occured: {}", e.getMessage(), e); + + return ResponseEntity.status(e.getHttpStatus()) + .body(ApiResponse.error(e.getErrorType(), e.getMessage())); + } + + /** + * 500 INTERNEL_SERVER + */ + @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) + @ExceptionHandler(Exception.class) + protected ApiResponse handleException(final Exception e, final HttpServletRequest request) throws IOException { + return ApiResponse.error(INTERNAL_SERVER_ERROR, e); + } +} diff --git a/src/main/java/org/kau/kkoolbeeServer/global/common/model/CustomException.java b/src/main/java/org/kau/kkoolbeeServer/global/common/model/CustomException.java new file mode 100644 index 0000000..4cd39e3 --- /dev/null +++ b/src/main/java/org/kau/kkoolbeeServer/global/common/model/CustomException.java @@ -0,0 +1,22 @@ +package org.kau.kkoolbeeServer.global.common.model; + +import lombok.Getter; +import org.kau.kkoolbeeServer.global.common.enums.ErrorType; + +//[호출 관계] Controller(요청 처리) -> Service(순서) -> Repository -> DB +//throw new CustomException(ERROR_TYPE); +//RuntimeException은 "특별한 애 (언체크 예외)" +@Getter +public class CustomException extends RuntimeException { + + private final ErrorType errorType; + + public CustomException(ErrorType errorType) { + super(errorType.getMessage()); + this.errorType = errorType; + } + + public int getHttpStatus() { + return errorType.getHttpStatusCode(); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..8e4c066 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,22 @@ +#spring: +# datasource: +# driver-class-name: com.mysql.cj.jdbc.Driver +# url: jdbc:mysql://${DATABASE_ENDPOINT_URL}:3306/${DATABASE_NAME}?serverTimezone=UTC&characterEncoding=UTF-8 +# username: ${DATABASE_USER} +# password: ${DATABASE_PASSWORD} +# +# jpa: +# hibernate: +# ddl-auto: update +# properties: +# hibernate: +# auto_quote_keyword: true +# +# config: +# import: optional:application-secret.properties +# +#aws-property: +# access-key: ${ACCESS_KEY} +# secret-key: ${SECRET_KEY} +# aws-region: ap-northeast-2 +# s3-bucket-name: ${BUCKET_NAME} \ No newline at end of file diff --git a/src/test/java/org/kau/kkoolbeeServer/KkoolbeeServerApplicationTests.java b/src/test/java/org/kau/kkoolbeeServer/KkoolbeeServerApplicationTests.java new file mode 100644 index 0000000..d3071ed --- /dev/null +++ b/src/test/java/org/kau/kkoolbeeServer/KkoolbeeServerApplicationTests.java @@ -0,0 +1,13 @@ +package org.kau.kkoolbeeServer; + +import org.junit.jupiter.api.Test; +import org.springframework.boot.test.context.SpringBootTest; + +@SpringBootTest +class KkoolbeeServerApplicationTests { + + @Test + void contextLoads() { + } + +}