diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..9ef9dc1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,27 @@ +--- +name: Bug Report +about: Report a bug to improve the project +title: '[Bug] ' +labels: Bug +assignees: '' + +--- + +## 어떤 버그인가요? + +> 어떤 버그인지 간결하게 설명해주세요 + +## 어떤 상황에서 발생한 버그인가요? + +> (가능하면) Given-When-Then 형식으로 서술해주세요 + +## 예상 결과 + +> 예상했던 정상적인 결과가 어떤 것이었는지 설명해주세요 + +## 참고할만한 자료(선택) + + +## Must do +- [ ] checked assignees +- [ ] checked labels \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/etc-issue-template.md b/.github/ISSUE_TEMPLATE/etc-issue-template.md new file mode 100644 index 0000000..7da4c5a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/etc-issue-template.md @@ -0,0 +1,22 @@ +--- +name: Other Issue +about: Feat, Bug 외 이슈 +title: '[Other] ' +labels: +assignees: '' + +--- + +## 어떤 이슈인가요? +> 어떤 아슈인지 간결하게 설명해주세요 + + +## 작업 상세 내용 +- [ ] TODO +- [ ] TODO +- [ ] TODO + + +## Must do +- [ ] checked assignees +- [ ] checked labels \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..d8cf240 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,25 @@ +--- +name: Feature Request +about: Suggest a new feature for the project +title: '[Feat] ' +labels: Feat +assignees: '' + +--- + +## 어떤 기능인가요? +> 추가하려는 기능에 대해 간결하게 설명해주세요 + + +## 작업 상세 내용 +- [ ] TODO +- [ ] TODO +- [ ] TODO + + +## 참고할만한 자료(선택) + + +## Must do +- [ ] checked assignees +- [ ] checked labels \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..fc6df7a --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,25 @@ +## PR 타입 +> 하나 이상의 PR 타입을 선택해주세요. +- [ ] 기능 추가 +- [ ] 기능 삭제 +- [ ] 버그 수정 +- [ ] 의존성, 환경 변수, 빌드 관련 코드 업데이트 +- [ ] 문서 관련 +- [ ] 기타 + + +## ⭐Related Issues +- closes # + + +## 변경 사항 +> ex) 로그인 시, 구글 소셜 로그인 기능을 추가했습니다. + + +## 테스트 결과 +> 병합되기 위한 코드는 모두 정상적으로 동작해야 합니다. 결과물에 대한 스크린 샷, GIF, 혹은 라이브 데모가 가능하도록 샘플 API를 추가할 수 있습니다. + + +## Must do +- [ ] checked assignees +- [ ] checked labels \ No newline at end of file diff --git a/.github/hooks/pre-commit b/.github/hooks/pre-commit new file mode 100644 index 0000000..3ef3f9f --- /dev/null +++ b/.github/hooks/pre-commit @@ -0,0 +1,16 @@ +#!/bin/bash + +echo "Spotless를 사용하여 코드를 자동 포맷팅합니다" + +# Spotless 적용 +if ./gradlew spotlessApply; then + + # Spotless 적용 후 변경된 파일들을 다시 스테이징 + git diff --staged --name-only | while read -r file; do + [ -f "$file" ] && git add "$file" + done + +else + echo "Spotless 자동 포맷팅에 실패했습니다." >&2 + exit 1 +fi diff --git a/.github/workflows/build-test.yml b/.github/workflows/build-test.yml new file mode 100644 index 0000000..913376b --- /dev/null +++ b/.github/workflows/build-test.yml @@ -0,0 +1,29 @@ +name: Spring boot build test + +on: + pull_request: + branches: + - Develop + +jobs: + build: + runs-on: ubuntu-latest + + steps: + - name: ✔️ 리포지토리 가져오기 + uses: actions/checkout@v4 + + - name: ✔️ JDK 17 설치 + uses: actions/setup-java@v4 + with: + java-version: '17' + distribution: 'temurin' + + - name: ✔️ Gradle 명령 실행 권한 설정 + run: chmod +x gradlew + + - name: ✔️ Gradle build + run: ./gradlew build -x installLocalGitHook -x spotlessInternalRegisterDependencies -x spotlessJava -x spotlessJavaApply -x spotlessApply -x spotlessJavaCheck -x spotlessCheck -x test + + - name: ✔️ Gradle test + run: ./gradlew --info test -Dspring.profiles.active=test \ No newline at end of file diff --git a/.github/workflows/docker-deploy.yml b/.github/workflows/docker-deploy.yml new file mode 100644 index 0000000..3ca259b --- /dev/null +++ b/.github/workflows/docker-deploy.yml @@ -0,0 +1,59 @@ +name: Build and Push Docker Image to ECR and Deploy on EC2 + +on: + pull_request: + branches: + - main + +jobs: + build-and-push: + runs-on: ubuntu-latest + + steps: + - name: ✔️ 리포지토리 가져오기 + uses: actions/checkout@v4 + + - name: ✔️ JDK 17 설치 + uses: actions/setup-java@v3 + with: + java-version: '17' + distribution: 'temurin' + + - name: ✔️ Gradle 명령 실행 권한 설정 + run: chmod +x gradlew + + - name: ✔️ Configure AWS credentials + uses: aws-actions/configure-aws-credentials@v2 + with: + aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }} + aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }} + aws-region: ${{ secrets.AWS_DEFAULT_REGION }} + + - name: ✔️ Amazon ECR에 로그인 + id: login-ecr + uses: aws-actions/amazon-ecr-login@v1 + + - name: ✔️ Docker Image 빌드 및 ECR에 push + env: + ECR_REGISTRY: ${{ steps.login-ecr.outputs.registry }} + ECR_REPOSITORY: ${{ secrets.ECR_REPOSITORY_NAME }} + IMAGE_TAG: ${{ github.sha }} + run: | + ./gradlew jib \ + -Djib.to.image=$ECR_REGISTRY/$ECR_REPOSITORY:$IMAGE_TAG + + run-images-on-ec2: + needs: build-and-push + runs-on: ubuntu-latest + + steps: + - name: ✔️ EC2 접속 및 배포 스크립트 실행 + uses: appleboy/ssh-action@v0.1.6 + with: + host: ${{ secrets.SSH_HOST_NAME }} + username: ${{ secrets.SSH_USER_NAME }} + key: ${{ secrets.SSH_PRIVATE_KEY }} + port: ${{ secrets.SSH_PORT }} + script: | + cd deploy-script + sh ./deploy.sh \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4b6f09b --- /dev/null +++ b/.gitignore @@ -0,0 +1,43 @@ +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/ + +### macOS ### +# General +.DS_Store +.AppleDouble +.LSOverride \ No newline at end of file diff --git a/HELP.md b/HELP.md new file mode 100644 index 0000000..82bc2a4 --- /dev/null +++ b/HELP.md @@ -0,0 +1,24 @@ +# Getting Started + +### Reference Documentation +For further reference, please consider the following sections: + +* [Official Gradle documentation](https://docs.gradle.org) +* [Spring Boot Gradle Plugin Reference Guide](https://docs.spring.io/spring-boot/3.3.7/gradle-plugin) +* [Create an OCI image](https://docs.spring.io/spring-boot/3.3.7/gradle-plugin/packaging-oci-image.html) +* [Spring Web](https://docs.spring.io/spring-boot/3.3.7/reference/web/servlet.html) +* [Spring Data JPA](https://docs.spring.io/spring-boot/3.3.7/reference/data/sql.html#data.sql.jpa-and-spring-data) + +### Guides +The following guides illustrate how to use some features concretely: + +* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/) +* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/) +* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/) +* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/) +* [Accessing data with MySQL](https://spring.io/guides/gs/accessing-data-mysql/) + +### Additional Links +These additional references should also help you: + +* [Gradle Build Scans – insights for your project's build](https://scans.gradle.com#gradle) diff --git a/README.md b/README.md index 833c362..9e9b9e2 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ # CodePlay-BE -CodePlay Spring Boot + +## CodePlay Spring Boot 파트 팀원 + +- 강슬미(@2020147542), 김민형(@johnjal), 서지민(@SeoJimin1234), 이찬우(@chan0831) + +## ⚡️변경사항 확인 바람⚡️ + +- [배포 과정 설명](https://github.com/UMC-CodePlay/CodePlay-BE/discussions/52) +- [Docker를 이용한 DB 세팅 방법 확인하기](https://github.com/UMC-CodePlay/CodePlay-BE/discussions/28) +- [자동 스타일 포맷터 사용법 바로가기](https://github.com/UMC-CodePlay/CodePlay-BE/discussions/3#discussioncomment-11796830) diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..5f5c061 --- /dev/null +++ b/build.gradle @@ -0,0 +1,121 @@ +plugins { + id 'java' + id 'org.springframework.boot' version '3.3.7' + id 'io.spring.dependency-management' version '1.1.7' + id 'com.diffplug.spotless' version '6.23.3' + id 'com.google.cloud.tools.jib' version '3.4.3' +} + +group = 'umc' +version = '0.0.1-SNAPSHOT' + +java { + toolchain { + languageVersion = JavaLanguageVersion.of(17) + } +} + +configurations { + compileOnly { + extendsFrom annotationProcessor + } +} + +repositories { + mavenCentral() +} + +dependencies { + + implementation 'org.springframework.boot:spring-boot-starter-web' + compileOnly 'org.projectlombok:lombok' + annotationProcessor 'org.projectlombok:lombok' + + // mysql 사용시 주석 해제 + implementation 'org.springframework.boot:spring-boot-starter-data-jpa' + runtimeOnly 'com.mysql:mysql-connector-j' + + // .env 사용 + implementation 'io.github.cdimascio:java-dotenv:5.2.2' + + // 테스트 + testImplementation 'org.springframework.boot:spring-boot-starter-test' + testRuntimeOnly 'org.junit.platform:junit-platform-launcher' + testImplementation 'io.rest-assured:rest-assured:5.3.1' + testRuntimeOnly 'com.h2database:h2' + + // 스웨거 + implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0' + + // 스프링 시큐리티 + implementation 'org.springframework.boot:spring-boot-starter-security' + testImplementation 'org.springframework.security:spring-security-test' + + // jwt + implementation 'io.jsonwebtoken:jjwt-api:0.11.5' + runtimeOnly 'io.jsonwebtoken:jjwt-impl:0.11.5' + runtimeOnly 'io.jsonwebtoken:jjwt-jackson:0.11.5' + + // validation + implementation 'org.springframework.boot:spring-boot-starter-validation' +} + +tasks.named('test') { + useJUnitPlatform() +} + +tasks.register('installLocalGitHook', Copy) { + from("${rootProject.rootDir}/.github/hooks") + into("${rootProject.rootDir}/.git/hooks") + + eachFile { + mode = 0755 + } + + onlyIf { + !file("${rootProject.rootDir}/.git/hooks/pre-commit").exists() + } + + doLast { + println 'pre-commit 훅이 성공적으로 설치되었습니다.' + } +} + +spotless { + java { + googleJavaFormat().aosp() // Google Java 포맷 적용 + importOrder( + 'java|javax|jakarta', + 'org.springframework', + 'lombok', + '', + 'org.junit|org.mockito', + '\\#', + '\\#org.junit' + ) // 이 순서로 import문 정렬 + removeUnusedImports() // 사용하지 않는 import문 제거 + trimTrailingWhitespace() // 각 라인 끝의 공백 제거 + endWithNewline() // 파일 끝에 항상 새로운 줄 추가 + formatAnnotations() // 어노테이션 정렬 + } +} + +tasks.named('compileJava') { + dependsOn 'installLocalGitHook' + dependsOn 'spotlessApply' +} + +jib { + from { + image = 'openjdk:17-alpine' + } + to { + image = 'code-play-image' + tags = ['latest'] + } + container { + jvmFlags = ['-Xms512m'] + format = 'OCI' + creationTime = 'USE_CURRENT_TIMESTAMP' + } +} diff --git a/docker/deploy/deploy.sh b/docker/deploy/deploy.sh new file mode 100644 index 0000000..32e0e1c --- /dev/null +++ b/docker/deploy/deploy.sh @@ -0,0 +1,23 @@ +# ECR에서 최신 이미지 pull +echo "ECR에 있는 이미지 불러오기" +if ! docker pull 120569606420.dkr.ecr.ap-northeast-2.amazonaws.com/umc/code-play:latest; then + echo "이미지 불러오기에 실패했습니다." + exit 1 +fi + +# Docker compose down으로 기존 컨테이너 중지 및 삭제 +echo "Docker compose down 실행" +docker compose down + +# Docker compose up 실행 +echo "Docker compose up 실행" +if ! docker compose up -d; then + echo "컨테이너 실행에 실패했습니다" + exit 1 +fi + +# dangling 이미지 삭제 +echo "dangling 이미지 삭제" +docker image prune -f + +echo "모든 작업이 완료되었습니다." \ No newline at end of file diff --git a/docker/deploy/docker-compose.yml b/docker/deploy/docker-compose.yml new file mode 100644 index 0000000..bac4dc5 --- /dev/null +++ b/docker/deploy/docker-compose.yml @@ -0,0 +1,41 @@ +name: CodePlay + +services: + database: + container_name: codeplay-db + image: mysql:latest + env_file: prod-db.env + volumes: + - /home/ubuntu/deploy-db:/var/lib/mysql + ports: + - "3306:3306" + networks: + - umc_code_play + command: [ "--character-set-server=utf8mb4","--collation-server=utf8mb4_unicode_ci" ] # MySQL 서버가 실행될 때 사용할 문자셋 및 정렬 규칙 지정 + restart: always + healthcheck: + test: [ "CMD", "mysqladmin", "ping", "-h", "localhost" ] + interval: 10s + timeout: 5s + retries: 5 + + application: + container_name: codeplay-app + image: 120569606420.dkr.ecr.ap-northeast-2.amazonaws.com/umc/code-play:latest + env_file: prod-spring.env + ports: + - "8080:8080" + networks: + - umc_code_play + restart: always + depends_on: + - database + healthcheck: + test: [ "CMD", "curl", "-f", "http://localhost:8080/health" ] + interval: 20s + timeout: 10s + retries: 5 + +networks: + umc_code_play: + driver: bridge # "브리지 네트워크"를 자동 생성하고 컨테이너 간 통신이 가능하도록 설정 \ No newline at end of file diff --git a/docker/local/docker-compose.yml b/docker/local/docker-compose.yml new file mode 100644 index 0000000..4bb63ad --- /dev/null +++ b/docker/local/docker-compose.yml @@ -0,0 +1,15 @@ +name: CodePlayDB + +services: + mysql: + container_name: mysql + image: mysql:latest + ports: + - 3306:3306 + volumes: + - data:/var/lib/mysql # Docker 볼륨 사용 + env_file: ../../env/local-db.env + restart: always + +volumes: + data: \ No newline at end of file diff --git a/env/local-db.env b/env/local-db.env new file mode 100644 index 0000000..d578ea8 --- /dev/null +++ b/env/local-db.env @@ -0,0 +1,5 @@ +MYSQL_DATABASE=codeplay_local +MYSQL_USER=codeplay +MYSQL_PASSWORD=QWER1234QWER1234XCVBNMASDFGH +MYSQL_ROOT_PASSWORD=QWER1234QWER1234XCVBNMASDFGH +TZ=Asia/Seoul diff --git a/env/local-spring.env b/env/local-spring.env new file mode 100644 index 0000000..d071728 --- /dev/null +++ b/env/local-spring.env @@ -0,0 +1,13 @@ +# MySQL 설정 +DB_URL=jdbc:mysql://localhost:3306/codeplay_local +MYSQL_USERNAME=codeplay +MYSQL_PASSWORD=QWER1234QWER1234XCVBNMASDFGH + +# Spring Boot 설정 +JWT_SECRET=qwertyuiopokjhSDFGHJKIUYTREDCVBNMKIJKJHGFHYTRFCVBGFDSXCVBHH + +# AWS S3 settings + +# Kakao settings + +# Google settings \ No newline at end of file diff --git a/env/prod-db.env b/env/prod-db.env new file mode 100644 index 0000000..5bc2231 --- /dev/null +++ b/env/prod-db.env @@ -0,0 +1,5 @@ +MYSQL_DATABASE=codeplay_prod +MYSQL_USER=codeplay +MYSQL_PASSWORD=QWER1234QWER1234XCVBNMASDFGH +MYSQL_ROOT_PASSWORD=QWER1234QWER1234XCVBNMASDFGH +TZ=Asia/Seoul \ No newline at end of file diff --git a/env/prod-spring.env b/env/prod-spring.env new file mode 100644 index 0000000..b335105 --- /dev/null +++ b/env/prod-spring.env @@ -0,0 +1,14 @@ +# MySQL 설정 +DB_URL=jdbc:mysql://codeplay-db:3306/codeplay_prod?useSSL=false&allowPublicKeyRetrieval=true +MYSQL_USERNAME=codeplay +MYSQL_PASSWORD=QWER1234QWER1234XCVBNMASDFGH + +# Spring Boot 설정 +SPRING_PROFILES_ACTIVE=prod +JWT_SECRET=qwertyuiopokjhSDFGHJKIUYTREDCVBNMKIJKJHGFHYTRFCVBGFDSXCVBHH + +# AWS S3 settings + +# Kakao settings + +# Google settings \ 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..a4b76b9 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..e2847c8 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,7 @@ +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip +networkTimeout=10000 +validateDistributionUrl=true +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..f5feea6 --- /dev/null +++ b/gradlew @@ -0,0 +1,252 @@ +#!/bin/sh + +# +# Copyright © 2015-2021 the original authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +# SPDX-License-Identifier: Apache-2.0 +# + +############################################################################## +# +# Gradle start up script for POSIX generated by Gradle. +# +# Important for running: +# +# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is +# noncompliant, but you have some other compliant shell such as ksh or +# bash, then to run this script, type that shell name before the whole +# command line, like: +# +# ksh Gradle +# +# Busybox and similar reduced shells will NOT work, because this script +# requires all of these POSIX shell features: +# * functions; +# * expansions «$var», «${var}», «${var:-default}», «${var+SET}», +# «${var#prefix}», «${var%suffix}», and «$( cmd )»; +# * compound commands having a testable exit status, especially «case»; +# * various built-in commands including «command», «set», and «ulimit». +# +# Important for patching: +# +# (2) This script targets any POSIX shell, so it avoids extensions provided +# by Bash, Ksh, etc; in particular arrays are avoided. +# +# The "traditional" practice of packing multiple parameters into a +# space-separated string is a well documented source of bugs and security +# problems, so this is (mostly) avoided, by progressively accumulating +# options in "$@", and eventually passing that to Java. +# +# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, +# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; +# see the in-line comments for details. +# +# There are tweaks for specific operating systems such as AIX, CygWin, +# Darwin, MinGW, and NonStop. +# +# (3) This script is generated from the Groovy template +# https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt +# within the Gradle project. +# +# You can find Gradle at https://github.com/gradle/gradle/. +# +############################################################################## + +# Attempt to set APP_HOME + +# Resolve links: $0 may be a link +app_path=$0 + +# Need this for daisy-chained symlinks. +while + APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path + [ -h "$app_path" ] +do + ls=$( ls -ld "$app_path" ) + link=${ls#*' -> '} + case $link in #( + /*) app_path=$link ;; #( + *) app_path=$APP_HOME$link ;; + esac +done + +# This is normally unused +# shellcheck disable=SC2034 +APP_BASE_NAME=${0##*/} +# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036) +APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s +' "$PWD" ) || exit + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD=maximum + +warn () { + echo "$*" +} >&2 + +die () { + echo + echo "$*" + echo + exit 1 +} >&2 + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "$( uname )" in #( + CYGWIN* ) cygwin=true ;; #( + Darwin* ) darwin=true ;; #( + MSYS* | MINGW* ) msys=true ;; #( + NONSTOP* ) nonstop=true ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD=$JAVA_HOME/jre/sh/java + else + JAVACMD=$JAVA_HOME/bin/java + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD=java + if ! command -v java >/dev/null 2>&1 + then + die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +fi + +# Increase the maximum file descriptors if we can. +if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then + case $MAX_FD in #( + max*) + # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + MAX_FD=$( ulimit -H -n ) || + warn "Could not query maximum file descriptor limit" + esac + case $MAX_FD in #( + '' | soft) :;; #( + *) + # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked. + # shellcheck disable=SC2039,SC3045 + ulimit -n "$MAX_FD" || + warn "Could not set maximum file descriptor limit to $MAX_FD" + esac +fi + +# Collect all arguments for the java command, stacking in reverse order: +# * args from the command line +# * the main class name +# * -classpath +# * -D...appname settings +# * --module-path (only if needed) +# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. + +# For Cygwin or MSYS, switch paths to Windows format before running java +if "$cygwin" || "$msys" ; then + APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) + CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) + + JAVACMD=$( cygpath --unix "$JAVACMD" ) + + # Now convert the arguments - kludge to limit ourselves to /bin/sh + for arg do + if + case $arg in #( + -*) false ;; # don't mess with options #( + /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath + [ -e "$t" ] ;; #( + *) false ;; + esac + then + arg=$( cygpath --path --ignore --mixed "$arg" ) + fi + # Roll the args list around exactly as many times as the number of + # args, so each arg winds up back in the position where it started, but + # possibly modified. + # + # NB: a `for` loop captures its iteration list before it begins, so + # changing the positional parameters here affects neither the number of + # iterations, nor the values presented in `arg`. + shift # remove old arg + set -- "$@" "$arg" # push replacement arg + done +fi + + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Collect all arguments for the java command: +# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments, +# and any embedded shellness will be escaped. +# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be +# treated as '${Hostname}' itself on the command line. + +set -- \ + "-Dorg.gradle.appname=$APP_BASE_NAME" \ + -classpath "$CLASSPATH" \ + org.gradle.wrapper.GradleWrapperMain \ + "$@" + +# Stop when "xargs" is not available. +if ! command -v xargs >/dev/null 2>&1 +then + die "xargs is not available" +fi + +# Use "xargs" to parse quoted args. +# +# With -n1 it outputs one arg per line, with the quotes and backslashes removed. +# +# In Bash we could simply go: +# +# readarray ARGS < <( xargs -n1 <<<"$var" ) && +# set -- "${ARGS[@]}" "$@" +# +# but POSIX shell has neither arrays nor command substitution, so instead we +# post-process each arg (as a line of input to sed) to backslash-escape any +# character that might be a shell metacharacter, then use eval to reverse +# that process (while maintaining the separation between arguments), and wrap +# the whole thing up as a single "set" statement. +# +# This will of course break if any of these variables contains a newline or +# an unmatched quote. +# + +eval "set -- $( + printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | + xargs -n1 | + sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | + tr '\n' ' ' + )" '"$@"' + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..9b42019 --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,94 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem +@rem SPDX-License-Identifier: Apache-2.0 +@rem + +@if "%DEBUG%"=="" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%"=="" set DIRNAME=. +@rem This is normally unused +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if %ERRORLEVEL% equ 0 goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. 1>&2 +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2 +echo. 1>&2 +echo Please set the JAVA_HOME variable in your environment to match the 1>&2 +echo location of your Java installation. 1>&2 + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if %ERRORLEVEL% equ 0 goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +set EXIT_CODE=%ERRORLEVEL% +if %EXIT_CODE% equ 0 set EXIT_CODE=1 +if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% +exit /b %EXIT_CODE% + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..9e287d4 --- /dev/null +++ b/settings.gradle @@ -0,0 +1 @@ +rootProject.name = 'codeplay' diff --git a/src/main/java/umc/codeplay/CodeplayApplication.java b/src/main/java/umc/codeplay/CodeplayApplication.java new file mode 100644 index 0000000..ebe4f4d --- /dev/null +++ b/src/main/java/umc/codeplay/CodeplayApplication.java @@ -0,0 +1,12 @@ +package umc.codeplay; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class CodeplayApplication { + + public static void main(String[] args) { + SpringApplication.run(CodeplayApplication.class, args); + } +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/ApiResponse.java b/src/main/java/umc/codeplay/apiPayLoad/ApiResponse.java new file mode 100644 index 0000000..eb02ee1 --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/ApiResponse.java @@ -0,0 +1,44 @@ +package umc.codeplay.apiPayLoad; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +import com.fasterxml.jackson.annotation.JsonInclude; +import com.fasterxml.jackson.annotation.JsonProperty; +import com.fasterxml.jackson.annotation.JsonPropertyOrder; +import umc.codeplay.apiPayLoad.code.BaseCode; +import umc.codeplay.apiPayLoad.code.status.SuccessStatus; + +@Getter +@AllArgsConstructor +@JsonPropertyOrder({"isSuccess", "code", "message", "result"}) +public class ApiResponse { + + @JsonProperty("isSuccess") + private final Boolean isSuccess; + + private final String code; + private final String message; + + @JsonInclude(JsonInclude.Include.NON_NULL) + private T result; + + // 성공한 경우 응답 생성 + public static ApiResponse onSuccess(T result) { + return new ApiResponse<>( + true, SuccessStatus._OK.getCode(), SuccessStatus._OK.getMessage(), result); + } + + public static ApiResponse of(BaseCode code, T result) { + return new ApiResponse<>( + true, + code.getReasonHttpStatus().getCode(), + code.getReasonHttpStatus().getMessage(), + result); + } + + // 실패한 경우 응답 생성 + public static ApiResponse onFailure(String code, String message, T data) { + return new ApiResponse<>(false, code, message, data); + } +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/code/BaseCode.java b/src/main/java/umc/codeplay/apiPayLoad/code/BaseCode.java new file mode 100644 index 0000000..6e96d65 --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/code/BaseCode.java @@ -0,0 +1,8 @@ +package umc.codeplay.apiPayLoad.code; + +public interface BaseCode { + + ReasonDTO getReason(); + + ReasonDTO getReasonHttpStatus(); +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/code/BaseErrorCode.java b/src/main/java/umc/codeplay/apiPayLoad/code/BaseErrorCode.java new file mode 100644 index 0000000..eaa5fc7 --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/code/BaseErrorCode.java @@ -0,0 +1,8 @@ +package umc.codeplay.apiPayLoad.code; + +public interface BaseErrorCode { + + ErrorReasonDTO getReason(); + + ErrorReasonDTO getReasonHttpStatus(); +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/code/ErrorReasonDTO.java b/src/main/java/umc/codeplay/apiPayLoad/code/ErrorReasonDTO.java new file mode 100644 index 0000000..83b0bcc --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/code/ErrorReasonDTO.java @@ -0,0 +1,21 @@ +package umc.codeplay.apiPayLoad.code; + +import org.springframework.http.HttpStatus; + +import lombok.Builder; +import lombok.Getter; + +@Getter +@Builder +public class ErrorReasonDTO { + + private HttpStatus httpStatus; + + private final boolean isSuccess; + private final String code; + private final String message; + + public boolean getIsSuccess() { + return isSuccess; + } +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/code/ReasonDTO.java b/src/main/java/umc/codeplay/apiPayLoad/code/ReasonDTO.java new file mode 100644 index 0000000..ae41f19 --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/code/ReasonDTO.java @@ -0,0 +1,21 @@ +package umc.codeplay.apiPayLoad.code; + +import org.springframework.http.HttpStatus; + +import lombok.Builder; +import lombok.Getter; + +@Getter +@Builder +public class ReasonDTO { + + private HttpStatus httpStatus; + + private final boolean isSuccess; + private final String code; + private final String message; + + public boolean getIsSuccess() { + return isSuccess; + } +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/code/status/ErrorStatus.java b/src/main/java/umc/codeplay/apiPayLoad/code/status/ErrorStatus.java new file mode 100644 index 0000000..df8f9a0 --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/code/status/ErrorStatus.java @@ -0,0 +1,46 @@ +package umc.codeplay.apiPayLoad.code.status; + +import org.springframework.http.HttpStatus; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +import umc.codeplay.apiPayLoad.code.BaseErrorCode; +import umc.codeplay.apiPayLoad.code.ErrorReasonDTO; + +@Getter +@AllArgsConstructor +public enum ErrorStatus implements BaseErrorCode { + + // 가장 일반적인 응답 + _INTERNAL_SERVER_ERROR(HttpStatus.INTERNAL_SERVER_ERROR, "COMMON500", "서버 에러, 관리자에게 문의 바랍니다."), + _BAD_REQUEST(HttpStatus.BAD_REQUEST, "COMMON400", "잘못된 요청입니다."), + _UNAUTHORIZED(HttpStatus.UNAUTHORIZED, "COMMON401", "인증이 필요합니다."), + _FORBIDDEN(HttpStatus.FORBIDDEN, "COMMON403", "금지된 요청입니다."), + + MEMBER_NOT_FOUND(HttpStatus.BAD_REQUEST, "MEMBER400", "유저를 찾을 수 없습니다."), + MEMBER_ALREADY_EXISTS(HttpStatus.BAD_REQUEST, "MEMBER401", "유저가 이미 존재합니다."), + + NOT_AUTHORIZED(HttpStatus.BAD_REQUEST, "AUTH400", "인증되지 않은 요청입니다."), + ID_OR_PASSWORD_WRONG(HttpStatus.BAD_REQUEST, "AUTH401", "아이디 혹은 비밀번호가 잘못되었습니다."), + INVALID_REFRESH_TOKEN(HttpStatus.BAD_REQUEST, "AUTH402", "유효하지 않은 리프레시 토큰입니다."); + + private final HttpStatus httpStatus; + private final String code; + private final String message; + + @Override + public ErrorReasonDTO getReason() { + return ErrorReasonDTO.builder().message(message).code(code).isSuccess(false).build(); + } + + @Override + public ErrorReasonDTO getReasonHttpStatus() { + return ErrorReasonDTO.builder() + .message(message) + .code(code) + .isSuccess(false) + .httpStatus(httpStatus) + .build(); + } +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/code/status/SuccessStatus.java b/src/main/java/umc/codeplay/apiPayLoad/code/status/SuccessStatus.java new file mode 100644 index 0000000..3d98f57 --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/code/status/SuccessStatus.java @@ -0,0 +1,36 @@ +package umc.codeplay.apiPayLoad.code.status; + +import org.springframework.http.HttpStatus; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +import umc.codeplay.apiPayLoad.code.BaseCode; +import umc.codeplay.apiPayLoad.code.ReasonDTO; + +@Getter +@AllArgsConstructor +public enum SuccessStatus implements BaseCode { + + // 일반적인 응답 + _OK(HttpStatus.OK, "COMMON200", "성공입니다."); + + private final HttpStatus httpStatus; + private final String code; + private final String message; + + @Override + public ReasonDTO getReason() { + return ReasonDTO.builder().message(message).code(code).isSuccess(true).build(); + } + + @Override + public ReasonDTO getReasonHttpStatus() { + return ReasonDTO.builder() + .message(message) + .code(code) + .isSuccess(true) + .httpStatus(httpStatus) + .build(); + } +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/exception/ExceptionAdvice.java b/src/main/java/umc/codeplay/apiPayLoad/exception/ExceptionAdvice.java new file mode 100644 index 0000000..d21a77f --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/exception/ExceptionAdvice.java @@ -0,0 +1,138 @@ +package umc.codeplay.apiPayLoad.exception; + +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.Optional; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.validation.ConstraintViolationException; + +import org.springframework.http.HttpHeaders; +import org.springframework.http.HttpStatus; +import org.springframework.http.HttpStatusCode; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.MethodArgumentNotValidException; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.RestController; +import org.springframework.web.bind.annotation.RestControllerAdvice; +import org.springframework.web.context.request.ServletWebRequest; +import org.springframework.web.context.request.WebRequest; +import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler; + +import lombok.extern.slf4j.Slf4j; + +import umc.codeplay.apiPayLoad.ApiResponse; +import umc.codeplay.apiPayLoad.code.ErrorReasonDTO; +import umc.codeplay.apiPayLoad.code.status.ErrorStatus; + +@Slf4j +@RestControllerAdvice(annotations = {RestController.class}) +public class ExceptionAdvice extends ResponseEntityExceptionHandler { + + @ExceptionHandler + public ResponseEntity validation(ConstraintViolationException e, WebRequest request) { + String errorMessage = + e.getConstraintViolations().stream() + .map(constraintViolation -> constraintViolation.getMessage()) + .findFirst() + .orElseThrow( + () -> + new RuntimeException( + "ConstraintViolationException 추출 도중 에러 발생")); + + return handleExceptionInternalConstraint( + e, ErrorStatus.valueOf(errorMessage), HttpHeaders.EMPTY, request); + } + + @Override + public ResponseEntity handleMethodArgumentNotValid( + MethodArgumentNotValidException e, + HttpHeaders headers, + HttpStatusCode status, + WebRequest request) { + + Map errors = new LinkedHashMap<>(); + + e.getBindingResult().getFieldErrors().stream() + .forEach( + fieldError -> { + String fieldName = fieldError.getField(); + String errorMessage = + Optional.ofNullable(fieldError.getDefaultMessage()).orElse(""); + errors.merge( + fieldName, + errorMessage, + (existingErrorMessage, newErrorMessage) -> + existingErrorMessage + ", " + newErrorMessage); + }); + + return handleExceptionInternalArgs( + e, HttpHeaders.EMPTY, ErrorStatus.valueOf("_BAD_REQUEST"), request, errors); + } + + @ExceptionHandler + public ResponseEntity exception(Exception e, WebRequest request) { + e.printStackTrace(); + + return handleExceptionInternalFalse( + e, + ErrorStatus._INTERNAL_SERVER_ERROR, + HttpHeaders.EMPTY, + ErrorStatus._INTERNAL_SERVER_ERROR.getHttpStatus(), + request, + e.getMessage()); + } + + @ExceptionHandler(value = umc.codeplay.apiPayLoad.exception.GeneralException.class) + public ResponseEntity onThrowException( + umc.codeplay.apiPayLoad.exception.GeneralException generalException, + HttpServletRequest request) { + ErrorReasonDTO errorReasonHttpStatus = generalException.getErrorReasonHttpStatus(); + return handleExceptionInternal(generalException, errorReasonHttpStatus, null, request); + } + + private ResponseEntity handleExceptionInternal( + Exception e, ErrorReasonDTO reason, HttpHeaders headers, HttpServletRequest request) { + + ApiResponse body = + ApiResponse.onFailure(reason.getCode(), reason.getMessage(), null); + e.printStackTrace(); + + WebRequest webRequest = new ServletWebRequest(request); + return super.handleExceptionInternal(e, body, headers, reason.getHttpStatus(), webRequest); + } + + private ResponseEntity handleExceptionInternalFalse( + Exception e, + ErrorStatus errorCommonStatus, + HttpHeaders headers, + HttpStatus status, + WebRequest request, + String errorPoint) { + ApiResponse body = + ApiResponse.onFailure( + errorCommonStatus.getCode(), errorCommonStatus.getMessage(), errorPoint); + return super.handleExceptionInternal(e, body, headers, status, request); + } + + private ResponseEntity handleExceptionInternalArgs( + Exception e, + HttpHeaders headers, + ErrorStatus errorCommonStatus, + WebRequest request, + Map errorArgs) { + ApiResponse body = + ApiResponse.onFailure( + errorCommonStatus.getCode(), errorCommonStatus.getMessage(), errorArgs); + return super.handleExceptionInternal( + e, body, headers, errorCommonStatus.getHttpStatus(), request); + } + + private ResponseEntity handleExceptionInternalConstraint( + Exception e, ErrorStatus errorCommonStatus, HttpHeaders headers, WebRequest request) { + ApiResponse body = + ApiResponse.onFailure( + errorCommonStatus.getCode(), errorCommonStatus.getMessage(), null); + return super.handleExceptionInternal( + e, body, headers, errorCommonStatus.getHttpStatus(), request); + } +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/exception/GeneralException.java b/src/main/java/umc/codeplay/apiPayLoad/exception/GeneralException.java new file mode 100644 index 0000000..d87f144 --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/exception/GeneralException.java @@ -0,0 +1,22 @@ +package umc.codeplay.apiPayLoad.exception; + +import lombok.AllArgsConstructor; +import lombok.Getter; + +import umc.codeplay.apiPayLoad.code.BaseErrorCode; +import umc.codeplay.apiPayLoad.code.ErrorReasonDTO; + +@Getter +@AllArgsConstructor +public class GeneralException extends RuntimeException { + + private BaseErrorCode code; + + public ErrorReasonDTO getErrorReason() { + return this.code.getReason(); + } + + public ErrorReasonDTO getErrorReasonHttpStatus() { + return this.code.getReasonHttpStatus(); + } +} diff --git a/src/main/java/umc/codeplay/apiPayLoad/exception/handler/GeneralHandler.java b/src/main/java/umc/codeplay/apiPayLoad/exception/handler/GeneralHandler.java new file mode 100644 index 0000000..fa7e9c9 --- /dev/null +++ b/src/main/java/umc/codeplay/apiPayLoad/exception/handler/GeneralHandler.java @@ -0,0 +1,11 @@ +package umc.codeplay.apiPayLoad.exception.handler; + +import umc.codeplay.apiPayLoad.code.BaseErrorCode; +import umc.codeplay.apiPayLoad.exception.GeneralException; + +public class GeneralHandler extends GeneralException { + + public GeneralHandler(BaseErrorCode errorCode) { + super(errorCode); + } +} diff --git a/src/main/java/umc/codeplay/config/SecurityConfig.java b/src/main/java/umc/codeplay/config/SecurityConfig.java new file mode 100644 index 0000000..fca2218 --- /dev/null +++ b/src/main/java/umc/codeplay/config/SecurityConfig.java @@ -0,0 +1,131 @@ +package umc.codeplay.config; + +import java.io.IOException; +import jakarta.servlet.ServletException; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import org.springframework.http.MediaType; +import org.springframework.security.authentication.AuthenticationManager; +import org.springframework.security.config.Customizer; +import org.springframework.security.config.annotation.authentication.configuration.AuthenticationConfiguration; +import org.springframework.security.config.annotation.web.builders.HttpSecurity; +import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity; +import org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer; +import org.springframework.security.config.http.SessionCreationPolicy; +import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder; +import org.springframework.security.crypto.password.PasswordEncoder; +import org.springframework.security.web.AuthenticationEntryPoint; +import org.springframework.security.web.SecurityFilterChain; + +import com.fasterxml.jackson.databind.ObjectMapper; +import umc.codeplay.apiPayLoad.ApiResponse; +import umc.codeplay.apiPayLoad.code.status.ErrorStatus; +import umc.codeplay.jwt.JwtAuthenticationFilter; +import umc.codeplay.jwt.JwtUtil; + +@EnableWebSecurity +@Configuration +public class SecurityConfig { + + private final JwtUtil jwtUtil; + + private final ObjectMapper objectMapper; + + public SecurityConfig(JwtUtil jwtUtil, ObjectMapper objectMapper) { + this.jwtUtil = jwtUtil; + this.objectMapper = objectMapper; + } + + // AuthenticationManager 를 빈으로 등록 (스프링 시큐리티 6.x 이상) + @Bean + public AuthenticationManager authenticationManager(AuthenticationConfiguration configuration) + throws Exception { + return configuration.getAuthenticationManager(); + } + + @Bean + public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { + AuthenticationEntryPoint entryPoint = new CustomAuthenticationEntryPoint(objectMapper); + http + // 세션을 사용하지 않도록 설정 + .sessionManagement( + session -> session.sessionCreationPolicy(SessionCreationPolicy.STATELESS)) + .csrf(AbstractHttpConfigurer::disable) // JWT 사용 시 일반적으로 CSRF 는 disable + .exceptionHandling(exception -> exception.authenticationEntryPoint(entryPoint)) + .authorizeHttpRequests( + auth -> + auth + // 로그인, 회원가입 등 토큰 없이 접근해야 하는 API 허용 + .requestMatchers( + "/health", + "/auth/refresh", + "/auth/signup", + "/auth/login", + "/v2/api-docs", + "/v3/api-docs", + "/v3/api-docs/**", + "/swagger-resources", + "/swagger-resources/**", + "/configuration/ui", + "/configuration/security", + "/swagger-ui/**", + "/webjars/**", + "/swagger-ui.html") + .permitAll() + // 그 외 나머지는 인증 필요 + .anyRequest() + .authenticated()) + // 폼 로그인 등 기본 기능 비활성화 (JWT 만 쓰려면) + .formLogin(Customizer.withDefaults()) + // .formLogin(form -> form.disable()) // 더 엄격하게 + // 폼 로그인 완전히 비활성화할 수도 있음 + .logout(AbstractHttpConfigurer::disable); + + // 커스텀 JWT 필터 추가 + // UsernamePasswordAuthenticationFilter 이전에 동작하도록 설정 + http.addFilterBefore( + new JwtAuthenticationFilter(jwtUtil), + org.springframework.security.web.authentication.UsernamePasswordAuthenticationFilter + .class); + + return http.build(); + } + + @Bean + public PasswordEncoder passwordEncoder() { + return new BCryptPasswordEncoder(); + } + + public static class CustomAuthenticationEntryPoint implements AuthenticationEntryPoint { + + private final ObjectMapper objectMapper; + + public CustomAuthenticationEntryPoint(ObjectMapper objectMapper) { + this.objectMapper = objectMapper; + } + + @Override + public void commence( + HttpServletRequest request, + HttpServletResponse response, + org.springframework.security.core.AuthenticationException authException) + throws IOException, ServletException { + + ApiResponse apiResponse = + ApiResponse.onFailure( + ErrorStatus.NOT_AUTHORIZED.getCode(), + ErrorStatus.NOT_AUTHORIZED.getMessage(), + null); + + response.setStatus(HttpServletResponse.SC_UNAUTHORIZED); + response.setContentType(MediaType.APPLICATION_JSON_VALUE + ";charset=UTF-8"); + response.setCharacterEncoding("UTF-8"); + + String jsonResponse = objectMapper.writeValueAsString(apiResponse); + response.getWriter().write(jsonResponse); + } + } +} diff --git a/src/main/java/umc/codeplay/config/SwaggerConfig.java b/src/main/java/umc/codeplay/config/SwaggerConfig.java new file mode 100644 index 0000000..2c856de --- /dev/null +++ b/src/main/java/umc/codeplay/config/SwaggerConfig.java @@ -0,0 +1,46 @@ +package umc.codeplay.config; + +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; + +import io.swagger.v3.oas.models.Components; +import io.swagger.v3.oas.models.OpenAPI; +import io.swagger.v3.oas.models.info.Info; +import io.swagger.v3.oas.models.security.SecurityRequirement; +import io.swagger.v3.oas.models.security.SecurityScheme; +import io.swagger.v3.oas.models.servers.Server; + +@Configuration +public class SwaggerConfig { + + @Bean + public OpenAPI CodePlayAPI() { + + Info info = + new Info() + .title("CodePlay Server API") + .description("UMC 7th Code Play Server API 문서") + .version("1.0"); + + String securitySchemeName = "JWT TOKEN"; + + SecurityRequirement securityRequirement = + new SecurityRequirement().addList(securitySchemeName); + + Components components = + new Components() + .addSecuritySchemes( + securitySchemeName, + new SecurityScheme() + .name(securitySchemeName) + .type(SecurityScheme.Type.HTTP) + .scheme("bearer") + .bearerFormat("JWT")); + + return new OpenAPI() + .addServersItem(new Server().url("/")) + .info(info) + .addSecurityItem(securityRequirement) + .components(components); + } +} diff --git a/src/main/java/umc/codeplay/config/WebConfig.java b/src/main/java/umc/codeplay/config/WebConfig.java new file mode 100644 index 0000000..92b8e81 --- /dev/null +++ b/src/main/java/umc/codeplay/config/WebConfig.java @@ -0,0 +1,23 @@ +package umc.codeplay.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 { + + private static final String[] ALLOWED_METHOD_NAMES = { + "GET", "HEAD", "POST", "PUT", "DELETE", "TRACE", "OPTIONS", "PATCH" + }; + + @Override + public void addCorsMappings(CorsRegistry registry) { + registry.addMapping("/**") // 모든 경로에 대해서 cors 허용 + .allowedOrigins("*") // 모든 출처로 부터 요청 허용 - TODO: 변경해야 함 + .allowedMethods(ALLOWED_METHOD_NAMES) + .allowedHeaders("Content-Type", "Authorization") + .maxAge(3600); // 캐싱 시간 설정 + // .exposedHeaders("Authorization") // 클라이언트가 접근할 수 있는 헤더 + } +} diff --git a/src/main/java/umc/codeplay/config/security/CustomUserDetailsService.java b/src/main/java/umc/codeplay/config/security/CustomUserDetailsService.java new file mode 100644 index 0000000..5cc649c --- /dev/null +++ b/src/main/java/umc/codeplay/config/security/CustomUserDetailsService.java @@ -0,0 +1,33 @@ +package umc.codeplay.config.security; + +import org.springframework.security.core.userdetails.UserDetails; +import org.springframework.security.core.userdetails.UserDetailsService; +import org.springframework.security.core.userdetails.UsernameNotFoundException; +import org.springframework.stereotype.Service; + +import lombok.RequiredArgsConstructor; + +import umc.codeplay.apiPayLoad.code.status.ErrorStatus; +import umc.codeplay.apiPayLoad.exception.handler.GeneralHandler; +import umc.codeplay.domain.Member; +import umc.codeplay.repository.MemberRepository; + +@Service +@RequiredArgsConstructor +public class CustomUserDetailsService implements UserDetailsService { + + private final MemberRepository memberRepository; + + @Override + public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException { + Member member = + memberRepository + .findByEmail(username) + .orElseThrow(() -> new GeneralHandler(ErrorStatus.MEMBER_NOT_FOUND)); + + return org.springframework.security.core.userdetails.User.withUsername(member.getEmail()) + .password(member.getPassword()) + .roles(member.getRole().name()) + .build(); + } +} diff --git a/src/main/java/umc/codeplay/controller/AuthController.java b/src/main/java/umc/codeplay/controller/AuthController.java new file mode 100644 index 0000000..a082dae --- /dev/null +++ b/src/main/java/umc/codeplay/controller/AuthController.java @@ -0,0 +1,107 @@ +package umc.codeplay.controller; + +import java.util.Collection; +import java.util.stream.Collectors; + +import org.springframework.security.authentication.AuthenticationManager; +import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; +import org.springframework.security.core.Authentication; +import org.springframework.security.core.GrantedAuthority; +import org.springframework.security.core.authority.SimpleGrantedAuthority; +import org.springframework.validation.annotation.Validated; +import org.springframework.web.bind.annotation.*; + +import lombok.RequiredArgsConstructor; + +import io.swagger.v3.oas.annotations.security.SecurityRequirement; +import umc.codeplay.apiPayLoad.ApiResponse; +import umc.codeplay.apiPayLoad.code.status.ErrorStatus; +import umc.codeplay.apiPayLoad.exception.handler.GeneralHandler; +import umc.codeplay.converter.MemberConverter; +import umc.codeplay.domain.Member; +import umc.codeplay.dto.MemberRequestDTO; +import umc.codeplay.dto.MemberResponseDTO; +import umc.codeplay.jwt.JwtUtil; +import umc.codeplay.service.MemberService; + +@RestController +@RequestMapping("/auth") +@RequiredArgsConstructor +@Validated +public class AuthController { + + private final AuthenticationManager authenticationManager; + private final JwtUtil jwtUtil; + private final MemberService memberService; + + @PostMapping("/login") + public ApiResponse login( + @RequestBody MemberRequestDTO.LoginDto request) { + // 아이디/비밀번호를 사용해 AuthenticationToken 생성 + UsernamePasswordAuthenticationToken authToken = + new UsernamePasswordAuthenticationToken(request.getEmail(), request.getPassword()); + + // 실제 인증 수행 + try { + Authentication authentication = authenticationManager.authenticate(authToken); + + // Role 정보 가져오기 + Collection authorities = authentication.getAuthorities(); + + // 인증에 성공했다면, JWT 토큰 생성 후 반환 + String token = jwtUtil.generateToken(authentication.getName(), authorities); + String refreshToken = + jwtUtil.generateRefreshToken(authentication.getName(), authorities); + return ApiResponse.onSuccess( + MemberConverter.toLoginResultDTO( + request.getEmail(), token, refreshToken)); // 예시로 토큰만 문자열로 반환 + } catch (Exception e) { + throw new GeneralHandler(ErrorStatus.ID_OR_PASSWORD_WRONG); + } + } + + @PostMapping("/signup") + public ApiResponse join( + @RequestBody MemberRequestDTO.JoinDto request) { + Member member = memberService.joinMember(request); + MemberResponseDTO.JoinResultDTO newJoinResult = MemberConverter.toJoinResultDTO(member); + + return ApiResponse.onSuccess(newJoinResult); + } + + @PostMapping("/refresh") + public ApiResponse refresh( + @RequestHeader("Refresh-Token") String refreshToken, + @RequestParam("email") String email) { + // 리프레시 토큰 유효성 검사 + if (jwtUtil.validateToken(refreshToken) + && (jwtUtil.getTypeFromToken(refreshToken).equals("refresh"))) { + // 리프레시 토큰에서 사용자명 추출 + String usernameFromToken = jwtUtil.getUsernameFromToken(refreshToken); + + if (!email.equals(usernameFromToken)) { + throw new GeneralHandler(ErrorStatus.INVALID_REFRESH_TOKEN); + } + + // 사용자 권한 정보 가져오기 + Collection authorities = + jwtUtil.getRolesFromToken(refreshToken).stream() + .map(SimpleGrantedAuthority::new) + .collect(Collectors.toList()); + + // 새로운 액세스 토큰 생성 + String newAccessToken = jwtUtil.generateToken(usernameFromToken, authorities); + + return ApiResponse.onSuccess( + MemberConverter.toLoginResultDTO(usernameFromToken, newAccessToken, null)); + } else { + throw new GeneralHandler(ErrorStatus.INVALID_REFRESH_TOKEN); + } + } + + @SecurityRequirement(name = "JWT TOKEN") + @GetMapping("/test") + public ApiResponse test() { + return ApiResponse.onSuccess("test"); + } +} diff --git a/src/main/java/umc/codeplay/controller/HealthCheck.java b/src/main/java/umc/codeplay/controller/HealthCheck.java new file mode 100644 index 0000000..c8f7bcc --- /dev/null +++ b/src/main/java/umc/codeplay/controller/HealthCheck.java @@ -0,0 +1,14 @@ +package umc.codeplay.controller; + +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +public class HealthCheck { + + @GetMapping("/health") + public ResponseEntity healthCheck() { + return ResponseEntity.ok("UMC 7th CodePlay Well Connected!"); + } +} diff --git a/src/main/java/umc/codeplay/converter/MemberConverter.java b/src/main/java/umc/codeplay/converter/MemberConverter.java new file mode 100644 index 0000000..7c5c0b8 --- /dev/null +++ b/src/main/java/umc/codeplay/converter/MemberConverter.java @@ -0,0 +1,32 @@ +package umc.codeplay.converter; + +import umc.codeplay.domain.Member; +import umc.codeplay.dto.MemberRequestDTO; +import umc.codeplay.dto.MemberResponseDTO; + +public class MemberConverter { + + public static Member toMember(MemberRequestDTO.JoinDto request) { + + return Member.builder() + .name(request.getName()) + .email(request.getEmail()) + .password(request.getPassword()) + .role(request.getRole()) + .build(); + } + + public static MemberResponseDTO.JoinResultDTO toJoinResultDTO(Member member) { + return MemberResponseDTO.JoinResultDTO.builder().id(member.getId()).build(); + } + + public static MemberResponseDTO.LoginResultDTO toLoginResultDTO( + String email, String token, String refreshToken) { + + return MemberResponseDTO.LoginResultDTO.builder() + .email(email) + .token(token) + .refreshToken(refreshToken) + .build(); + } +} diff --git a/src/main/java/umc/codeplay/domain/Member.java b/src/main/java/umc/codeplay/domain/Member.java new file mode 100644 index 0000000..8d7d6ed --- /dev/null +++ b/src/main/java/umc/codeplay/domain/Member.java @@ -0,0 +1,38 @@ +package umc.codeplay.domain; + +import jakarta.persistence.Entity; +import jakarta.persistence.GeneratedValue; +import jakarta.persistence.GenerationType; +import jakarta.persistence.Id; + +import lombok.AccessLevel; +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +import umc.codeplay.domain.enums.Role; + +@Entity +@Getter +@Builder +@NoArgsConstructor(access = AccessLevel.PROTECTED) +@AllArgsConstructor +public class Member { + + @Id + @GeneratedValue(strategy = GenerationType.IDENTITY) + private Long id; + + private String name; + + private String password; + + private String email; + + private Role role; + + public void encodePassword(String password) { + this.password = password; + } +} diff --git a/src/main/java/umc/codeplay/domain/enums/Role.java b/src/main/java/umc/codeplay/domain/enums/Role.java new file mode 100644 index 0000000..8645757 --- /dev/null +++ b/src/main/java/umc/codeplay/domain/enums/Role.java @@ -0,0 +1,6 @@ +package umc.codeplay.domain.enums; + +public enum Role { + ADMIN, + USER +} diff --git a/src/main/java/umc/codeplay/dto/MemberRequestDTO.java b/src/main/java/umc/codeplay/dto/MemberRequestDTO.java new file mode 100644 index 0000000..b2b28eb --- /dev/null +++ b/src/main/java/umc/codeplay/dto/MemberRequestDTO.java @@ -0,0 +1,22 @@ +package umc.codeplay.dto; + +import lombok.Getter; + +import umc.codeplay.domain.enums.Role; + +public class MemberRequestDTO { + + @Getter + public static class JoinDto { + String name; + String email; + String password; + Role role; + } + + @Getter + public static class LoginDto { + String email; + String password; + } +} diff --git a/src/main/java/umc/codeplay/dto/MemberResponseDTO.java b/src/main/java/umc/codeplay/dto/MemberResponseDTO.java new file mode 100644 index 0000000..dd2a4b2 --- /dev/null +++ b/src/main/java/umc/codeplay/dto/MemberResponseDTO.java @@ -0,0 +1,27 @@ +package umc.codeplay.dto; + +import lombok.AllArgsConstructor; +import lombok.Builder; +import lombok.Getter; +import lombok.NoArgsConstructor; + +public class MemberResponseDTO { + + @Builder + @Getter + @NoArgsConstructor + @AllArgsConstructor + public static class JoinResultDTO { + Long id; + } + + @Builder + @Getter + @NoArgsConstructor + @AllArgsConstructor + public static class LoginResultDTO { + String email; + String token; + String refreshToken; + } +} diff --git a/src/main/java/umc/codeplay/jwt/JwtAuthenticationFilter.java b/src/main/java/umc/codeplay/jwt/JwtAuthenticationFilter.java new file mode 100644 index 0000000..9251fb2 --- /dev/null +++ b/src/main/java/umc/codeplay/jwt/JwtAuthenticationFilter.java @@ -0,0 +1,57 @@ +package umc.codeplay.jwt; + +import java.io.IOException; +import java.util.List; +import java.util.stream.Collectors; +import jakarta.servlet.FilterChain; +import jakarta.servlet.http.HttpServletRequest; +import jakarta.servlet.http.HttpServletResponse; + +import org.springframework.security.authentication.UsernamePasswordAuthenticationToken; +import org.springframework.security.core.GrantedAuthority; +import org.springframework.security.core.authority.SimpleGrantedAuthority; +import org.springframework.security.core.context.SecurityContextHolder; +import org.springframework.web.filter.OncePerRequestFilter; + +public class JwtAuthenticationFilter extends OncePerRequestFilter { + + private final JwtUtil jwtUtil; + + public JwtAuthenticationFilter(JwtUtil jwtUtil) { + this.jwtUtil = jwtUtil; + } + + @Override + protected void doFilterInternal( + HttpServletRequest request, HttpServletResponse response, FilterChain filterChain) + throws IOException, jakarta.servlet.ServletException { + + // 1. Authorization 헤더 파싱 + String authHeader = request.getHeader("Authorization"); + if (authHeader != null && authHeader.startsWith("Bearer ")) { + String token = authHeader.substring(7); + + // 2. 토큰 유효성 검사 + if (jwtUtil.validateToken(token) + && (jwtUtil.getTypeFromToken(token).equals("access"))) { + // 3. 토큰에서 사용자명 추출 + String username = jwtUtil.getUsernameFromToken(token); + + List roles = jwtUtil.getRolesFromToken(token); + + List authorities = + roles.stream() + .map(SimpleGrantedAuthority::new) + .collect(Collectors.toList()); + + UsernamePasswordAuthenticationToken authentication = + new UsernamePasswordAuthenticationToken(username, null, authorities); + + SecurityContextHolder.getContext().setAuthentication(authentication); + } + } + + // 필터 체인 계속 진행 + filterChain.doFilter(request, response); + } +} diff --git a/src/main/java/umc/codeplay/jwt/JwtUtil.java b/src/main/java/umc/codeplay/jwt/JwtUtil.java new file mode 100644 index 0000000..466e4fb --- /dev/null +++ b/src/main/java/umc/codeplay/jwt/JwtUtil.java @@ -0,0 +1,125 @@ +package umc.codeplay.jwt; + +import java.security.Key; +import java.util.Collection; +import java.util.Date; +import java.util.List; + +import org.springframework.beans.factory.annotation.Value; +import org.springframework.security.core.GrantedAuthority; +import org.springframework.stereotype.Component; + +import io.jsonwebtoken.Claims; +import io.jsonwebtoken.JwtException; +import io.jsonwebtoken.Jwts; +import io.jsonwebtoken.SignatureAlgorithm; +import io.jsonwebtoken.security.Keys; + +@Component +public class JwtUtil { + + private final String SECRET_KEY; + + public JwtUtil(@Value("${JWT_SECRET}") String secretKey) { + this.SECRET_KEY = secretKey; + } + + private Key getSigningKey() { + return Keys.hmacShaKeyFor(SECRET_KEY.getBytes()); + } + + // JWT 토큰 생성 + public String generateToken( + String username, Collection authorities) { + Date now = new Date(); + + List roleNames = + authorities.stream() + .map(GrantedAuthority::getAuthority) // "ROLE_ADMIN" 등 + .toList(); + + // 30분 만료 + long EXPIRATION_TIME = 1000 * 60 * 30L; + return Jwts.builder() + .setSubject(username) // 사용자 식별 정보 + .setIssuedAt(now) + .claim("type", "access") + .claim("roles", roleNames) // 발급 시간 + .setExpiration(new Date(now.getTime() + EXPIRATION_TIME)) // 만료 시간 + .signWith(getSigningKey(), SignatureAlgorithm.HS256) // 서명 (HS256 알고리즘) + .compact(); + } + + // JWT 토큰에서 username 추출 + public String getUsernameFromToken(String token) { + return Jwts.parserBuilder() + .setSigningKey(getSigningKey()) + .build() + .parseClaimsJws(token) + .getBody() + .getSubject(); + } + + // 토큰 유효성 검사 + public boolean validateToken(String token) { + try { + Jwts.parserBuilder().setSigningKey(getSigningKey()).build().parseClaimsJws(token); + return true; + } catch (JwtException | IllegalArgumentException e) { + // 만료되었거나 서명 검증 실패 등 + return false; + } + } + + // 토큰 클레임 요청 + private Claims getAllClaimsFromToken(String token) { + return Jwts.parserBuilder() + .setSigningKey(getSigningKey()) // 서명 검증을 위한 키 설정 + .build() + .parseClaimsJws(token) + .getBody(); + } + + // 토큰에서 + public List getRolesFromToken(String token) { + Claims claims = getAllClaimsFromToken(token); + + // "roles"라는 이름의 클레임에서 리스트를 꺼냄 + // 저장할 때 List으로 넣었다면, get("roles", List.class) 로 받는 것이 간단함 + List roles = claims.get("roles", List.class); + + // roles 가 null 일 수도 있으므로 안전 처리 + if (roles == null) { + return List.of(); // 빈 리스트 반환 + } + return roles; + } + + // JWT 리프레시 토큰 생성 + public String generateRefreshToken( + String username, Collection authorities) { + Date now = new Date(); + + List roleNames = + authorities.stream() + .map(GrantedAuthority::getAuthority) // "ROLE_ADMIN" 등 + .toList(); + + // 1일 만료 + long EXPIRATION_TIME = 1000 * 60 * 60 * 24L; + return Jwts.builder() + .setSubject(username) // 사용자 식별 정보 + .setIssuedAt(now) + .claim("type", "refresh") + .claim("roles", roleNames) // 역할 정보 추가 + .setExpiration(new Date(now.getTime() + EXPIRATION_TIME)) // 만료 시간 + .signWith(getSigningKey(), SignatureAlgorithm.HS256) // 서명 (HS256 알고리즘) + .compact(); + } + + // 토큰에서 type 추출 + public String getTypeFromToken(String token) { + Claims claims = getAllClaimsFromToken(token); + return claims.get("type", String.class); + } +} diff --git a/src/main/java/umc/codeplay/repository/MemberRepository.java b/src/main/java/umc/codeplay/repository/MemberRepository.java new file mode 100644 index 0000000..611ff78 --- /dev/null +++ b/src/main/java/umc/codeplay/repository/MemberRepository.java @@ -0,0 +1,11 @@ +package umc.codeplay.repository; + +import java.util.Optional; + +import org.springframework.data.jpa.repository.JpaRepository; + +import umc.codeplay.domain.Member; + +public interface MemberRepository extends JpaRepository { + Optional findByEmail(String email); +} diff --git a/src/main/java/umc/codeplay/service/MemberService.java b/src/main/java/umc/codeplay/service/MemberService.java new file mode 100644 index 0000000..48d1bc4 --- /dev/null +++ b/src/main/java/umc/codeplay/service/MemberService.java @@ -0,0 +1,32 @@ +package umc.codeplay.service; + +import org.springframework.security.crypto.password.PasswordEncoder; +import org.springframework.stereotype.Service; + +import lombok.RequiredArgsConstructor; + +import umc.codeplay.apiPayLoad.code.status.ErrorStatus; +import umc.codeplay.apiPayLoad.exception.handler.GeneralHandler; +import umc.codeplay.converter.MemberConverter; +import umc.codeplay.domain.Member; +import umc.codeplay.dto.MemberRequestDTO; +import umc.codeplay.repository.MemberRepository; + +@Service +@RequiredArgsConstructor +public class MemberService { + + private final MemberRepository memberRepository; + private final PasswordEncoder passwordEncoder; + + public Member joinMember(MemberRequestDTO.JoinDto request) { + + if (memberRepository.findByEmail(request.getEmail()).isPresent()) { + throw new GeneralHandler(ErrorStatus.MEMBER_ALREADY_EXISTS); + } + + Member newMember = MemberConverter.toMember(request); + newMember.encodePassword(passwordEncoder.encode(request.getPassword())); + return memberRepository.save(newMember); + } +} diff --git a/src/main/resources/application-prod.yml b/src/main/resources/application-prod.yml new file mode 100644 index 0000000..e1c85a5 --- /dev/null +++ b/src/main/resources/application-prod.yml @@ -0,0 +1,29 @@ +spring: + application: + name: codeplay + + config: + import: + - optional:file:env/prod-spring.env[.properties] + + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + url: ${DB_URL} + username: ${MYSQL_USERNAME} + password: ${MYSQL_PASSWORD} + + sql: + init: + mode: never # 데이터베이스 초기화 비활성화 + + jpa: + hibernate: + ddl-auto: update # Hibernate 엔티티 스키마 자동 업데이트 + properties: + jakarta.persistence.sharedCache.mode: ALL + hibernate: + dialect: org.hibernate.dialect.MySQLDialect + show_sql: true + format_sql: true + use_sql_comments: true + default_batch_fetch_size: 1000 # 배치 크기 설정 (성능 최적화) \ No newline at end of file diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 0000000..30d35b5 --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,29 @@ +spring: + application: + name: codeplay + + config: + import: + - optional:file:env/local-spring.env[.properties] + + datasource: + driver-class-name: com.mysql.cj.jdbc.Driver + url: ${DB_URL} + username: ${MYSQL_USERNAME} + password: ${MYSQL_PASSWORD} + + sql: + init: + mode: never # 데이터베이스 초기화 비활성화 + + jpa: + hibernate: + ddl-auto: update # Hibernate 엔티티 스키마 자동 업데이트 + properties: + jakarta.persistence.sharedCache.mode: ALL + hibernate: + dialect: org.hibernate.dialect.MySQLDialect + show_sql: true + format_sql: true + use_sql_comments: true + default_batch_fetch_size: 1000 # 배치 크기 설정 (성능 최적화) \ No newline at end of file diff --git a/src/test/java/umc/codeplay/CodeplayApplicationTests.java b/src/test/java/umc/codeplay/CodeplayApplicationTests.java new file mode 100644 index 0000000..63f4f28 --- /dev/null +++ b/src/test/java/umc/codeplay/CodeplayApplicationTests.java @@ -0,0 +1,16 @@ +package umc.codeplay; + +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.test.context.ActiveProfiles; + +import org.junit.jupiter.api.Test; + +@ActiveProfiles("test") +@SpringBootTest +@ComponentScan(basePackages = "umc.codeplay") +class CodeplayApplicationTests { + + @Test + void contextLoads() {} +} diff --git a/src/test/resources/application-test.yml b/src/test/resources/application-test.yml new file mode 100644 index 0000000..ae60a01 --- /dev/null +++ b/src/test/resources/application-test.yml @@ -0,0 +1,15 @@ +spring: + h2: + console: + enabled: true + datasource: + url: jdbc:h2:mem:testdb;MODE=MYSQL + driver-class-name: org.h2.Driver + username: sa + password: + jpa: + show-sql: true + properties: + hibernate: + dialect: org.hibernate.dialect.H2Dialect + ddl-auto: create-drop \ No newline at end of file