[MERGE/#4] 프로젝트 추가 세팅

.github/ISSUE_TEMPLATE/issue_template.md

@@ -0,0 +1,25 @@
+---
+name: ISSUE_TEMPLATE
+about: "\b이슈 생성 템플릿"
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## 💡 Issue
+<!-- 이슈에 대해 간략하게 설명해 주세요 -->
+- 
+
+## 📝 To-do
+<!-- 진행할 작업에 대해 적어주세요 -->
+<!--
+- [ ] 도메인 모델(Entity) 정의
+- [ ] DTO(Record) 정의
+- [ ] Repository 인터페이스 생성
+- [ ] Service 클래스 작성
+- [ ] Controller 클래스 작성
+- [ ] 공통 응답 처리 및 예외 처리
+- [ ] Swagger 테스트
+-->
+- [ ]

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,21 @@
+# 💡 Issue
+- resolved: #이슈번호
+
+# 📸 Screenshot
+<!-- 필요 시 사진, 동영상 등을 첨부해 주세요
+ex) 포스트맨, 스웨거, 로그 등 -->
+
+
+# 📄 Description
+<!-- 작업한 내용에 대해 상세하게 설명해 주세요,
+코드를 첨부할 경우 permalink를 사용해 주세요 -->
+- 
+
+# 💬 To Reviewers
+<!-- 리뷰어들에게 남기고 싶은 말을 적어주세요
+ex) 코드 리뷰 간 참고사항, 질문 등 -->
+	- 
+
+# 🔗 Reference
+<!-- 이슈를 해결하며 도움이 되었거나, 참고했던 아티클들의 링크를 첨부해 주세요 -->
+- 

.gitignore

@@ -41,4 +41,5 @@ out/
 
 ### Config ###
 application-secret.properties
-application.yaml
+application.yaml
+application.yml

build.gradle

@@ -24,17 +24,20 @@ repositories {
 }
 
 dependencies {
-    //JPA
+    // JPA
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
 
-    //Spring WEB
+    // PostgreSql
+    implementation group: 'org.postgresql', name:'postgresql', version:'42.7.3'
+
+    // Spring WEB
     implementation 'org.springframework.boot:spring-boot-starter-web'
 
-    //Lombok
+    // Lombok
     compileOnly 'org.projectlombok:lombok'
     annotationProcessor 'org.projectlombok:lombok'
 
-    //Test
+    // Test
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
 }

gradlew.bat

@@ -1,92 +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. 1>&2
-echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
-echo. 1>&2
-echo Please set the JAVA_HOME variable in your environment to match the 1>&2
-echo location of your Java installation. 1>&2
-
-goto fail
-
-:findJavaFromJavaHome
-set JAVA_HOME=%JAVA_HOME:"=%
-set JAVA_EXE=%JAVA_HOME%/bin/java.exe
-
-if exist "%JAVA_EXE%" goto execute
-
-echo. 1>&2
-echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
-echo. 1>&2
-echo Please set the JAVA_HOME variable in your environment to match the 1>&2
-echo location of your Java installation. 1>&2
-
-goto fail
-
-:execute
-@rem Setup the command line
-
-set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
-
-
-@rem Execute Gradle
-"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
-
-:end
-@rem End local scope for the variables with windows NT shell
-if %ERRORLEVEL% equ 0 goto mainEnd
-
-:fail
-rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
-rem the _cmd.exe /c_ return code!
-set EXIT_CODE=%ERRORLEVEL%
-if %EXIT_CODE% equ 0 set EXIT_CODE=1
-if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
-exit /b %EXIT_CODE%
-
-:mainEnd
-if "%OS%"=="Windows_NT" endlocal
-
-:omega
+@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. 1>&2
+echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:findJavaFromJavaHome
+set JAVA_HOME=%JAVA_HOME:"=%
+set JAVA_EXE=%JAVA_HOME%/bin/java.exe
+
+if exist "%JAVA_EXE%" goto execute
+
+echo. 1>&2
+echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
+echo. 1>&2
+echo Please set the JAVA_HOME variable in your environment to match the 1>&2
+echo location of your Java installation. 1>&2
+
+goto fail
+
+:execute
+@rem Setup the command line
+
+set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
+
+
+@rem Execute Gradle
+"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
+
+:end
+@rem End local scope for the variables with windows NT shell
+if %ERRORLEVEL% equ 0 goto mainEnd
+
+:fail
+rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
+rem the _cmd.exe /c_ return code!
+set EXIT_CODE=%ERRORLEVEL%
+if %EXIT_CODE% equ 0 set EXIT_CODE=1
+if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
+exit /b %EXIT_CODE%
+
+:mainEnd
+if "%OS%"=="Windows_NT" endlocal
+
+:omega

src/main/java/org/sopt/seonyakServer/SeonyakServerApplication.java

@@ -4,10 +4,9 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 @SpringBootApplication
-public class SeonYakApplication {
+public class SeonyakServerApplication {
 
     public static void main(String[] args) {
-        SpringApplication.run(SeonYakApplication.class, args);
+        SpringApplication.run(SeonyakServerApplication.class, args);
     }
-
 }

src/main/java/org/sopt/seonyakServer/global/common/dto/ResponseDto.java

@@ -0,0 +1,19 @@
+package org.sopt.seonyakServer.global.common.dto;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import org.sopt.seonyakServer.global.exception.enums.ErrorType;
+
+@JsonInclude(JsonInclude.Include.NON_NULL)
+public record ResponseDto<T>(
+        String code,
+        T data,
+        String message
+) {
+    public static <T> ResponseDto<T> success(final T data) {
+        return new ResponseDto<>("success", data, null);
+    }
+
+    public static <T> ResponseDto<T> fail(ErrorType errorType) {
+        return new ResponseDto<>(errorType.getCode(), null, errorType.getMessage());
+    }
+}

src/main/java/org/sopt/seonyakServer/global/exception/GlobalExceptionHandler.java

@@ -1,4 +1,21 @@
 package org.sopt.seonyakServer.global.exception;
 
+import lombok.extern.slf4j.Slf4j;
+import org.sopt.seonyakServer.global.exception.enums.ErrorType;
+import org.sopt.seonyakServer.global.exception.model.CustomException;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+@Slf4j
+@RestControllerAdvice
 public class GlobalExceptionHandler {
+    // 비즈니스 로직에서 발생한 예외 (언체크)
+    @ExceptionHandler(CustomException.class)
+    public ResponseEntity<ErrorType> handleBusinessException(CustomException e) {
+        log.error("GlobalExceptionHandler catch CustomException : {}", e.getErrorType().getMessage());
+        return ResponseEntity
+                .status(e.getErrorType().getHttpStatus())
+                .body(e.getErrorType());
+    }
 }

src/main/java/org/sopt/seonyakServer/global/exception/ResponseDtoAdvice.java

@@ -0,0 +1,37 @@
+package org.sopt.seonyakServer.global.exception;
+
+import org.sopt.seonyakServer.global.common.dto.ResponseDto;
+import org.sopt.seonyakServer.global.exception.enums.ErrorType;
+import org.springframework.core.MethodParameter;
+import org.springframework.http.MediaType;
+import org.springframework.http.converter.json.MappingJackson2HttpMessageConverter;
+import org.springframework.http.server.ServerHttpRequest;
+import org.springframework.http.server.ServerHttpResponse;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;
+
+@RestControllerAdvice(
+        basePackages = "org.sopt.seonyakServer"
+)
+public class ResponseDtoAdvice implements ResponseBodyAdvice<Object> {
+
+    @Override
+    public boolean supports(MethodParameter returnType, Class converterType) {
+        return !(returnType.getParameterType() == ResponseDto.class)
+                && MappingJackson2HttpMessageConverter.class.isAssignableFrom(converterType);
+    }
+
+    @Override
+    public Object beforeBodyWrite(
+            Object body,
+            MethodParameter returnType,
+            MediaType selectedContentType,
+            Class selectedConverterType,
+            ServerHttpRequest request,
+            ServerHttpResponse response
+    ) {
+        if (body instanceof ErrorType)
+            return ResponseDto.fail((ErrorType) body);
+        return ResponseDto.success(body);
+    }
+}