[A팀] 백엔드 파트 코드리뷰용 PR

.github/ISSUE_TEMPLATE/issue_template.md

@@ -0,0 +1,20 @@
+---
+name: "\bIssue 생성 템플릿"
+about: 해당 Issue 생성 템플릿을 통하여 Issue를 생성해주세요.
+title: 'ex) 깃모지 [feat] : Issue 제목'
+labels: ''
+assignees: ''
+
+---
+
+### 📝 Description
+
+- 구현할 내용 1
+- 구현할 내용 2
+
+---
+
+### 📝 Todo
+
+- [ ] 구현할 내용 1
+- [ ] 구현할 내용 2

.github/pull_request_template.md

@@ -0,0 +1,35 @@
+## ✅ PR 유형
+어떤 변경 사항이 있었나요?
+
+- [ ] 새로운 기능 추가
+- [ ] 버그 수정
+- [ ] 코드에 영향을 주지 않는 변경사항(오타 수정, 탭 사이즈 변경, 변수명 변경)
+- [ ] 코드 리팩토링
+- [ ] 주석 추가 및 수정
+- [ ] 문서 수정
+- [ ] 빌드 부분 혹은 패키지 매니저 수정
+- [ ] 파일 혹은 폴더명 수정
+- [ ] 파일 혹은 폴더 삭제
+
+---
+
+## 📝 작업 내용
+이번 PR에서 작업한 내용을 간략히 설명해주세요(이미지 첨부 가능)
+
+- 작업한 내용 1
+- 작업한 내용 2
+
+---
+
+## ✏️ 관련 이슈
+본인이 작업한 내용이 어떤 Issue Number와 관련이 있는지만 작성해주세요
+
+ex)
+- Fixes : #00 (수정중인 이슈)
+- Resolves : #100 (무슨 이슈를 해결했는지)
+- Ref : #00 #01 (참고할 이슈)
+- Related to : #00 #01 (해당 커밋과 관려)
+
+---
+
+## 🎸 기타 사항 or 추가 코멘트

.github/workflows/cicd.yaml

@@ -0,0 +1,55 @@
+name: Hitzone CI/CD with Gradle
+
+on:
+  push:
+    branches: [ "main", "develop" ]
+  pull_request:
+    branches: [ "main", "develop" ]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: ⏱️Set up JDK 17
+        uses: actions/setup-java@v3
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+
+      - name: ⏱️Gradle Caching - 빌드 시간 향상
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.gradle/caches
+            ~/.gradle/wrapper
+          key: ${{ runner.os }}-gradle-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }}
+          restore-keys: |
+            ${{ runner.os }}-gradle-
+
+      - name: ⏱️gradle build를 위한 권한을 부여합니다.
+        run: chmod +x gradlew
+
+      - name: ⏱️gradle build 중입니다.
+        run: ./gradlew clean build openapi3 asciidoctor
+
+      - name: ⏱️NCP Container Registry에 로그인 후, docker image build 후 NCP Container Registry에 push합니다.
+        run: |
+          docker login -u ${{ secrets.NCP_API_ACCESS_KEY }} -p ${{ secrets.NCP_API_SECRET_KEY }} ${{secrets.NCP_CONTAINER_REGISTRY_PUBLIC_ENDPOINT}}
+          docker build -f Dockerfile -t ${{ secrets.NCP_CONTAINER_REGISTRY_PUBLIC_ENDPOINT }}/${{ secrets.NCP_CONTAINER_REGISTRY_IMAGE }} .
+          docker push ${{ secrets.NCP_CONTAINER_REGISTRY_PUBLIC_ENDPOINT }}/${{ secrets.NCP_CONTAINER_REGISTRY_IMAGE }}
+
+      - name: ⏱️NCP Container Registry에서 pull 후 deploy합니다.
+        uses: appleboy/ssh-action@master
+        with:
+          username: ${{ secrets.NCP_SERVER_USERNAME }}
+          password: ${{ secrets.NCP_SERVER_PASSWORD }}
+          host: ${{ secrets.NCP_SERVER_HOST }}
+          script: |
+            chmod 777 ./deploy.sh
+            ./deploy.sh
+            docker image prune -f

.gitignore

@@ -35,3 +35,7 @@ out/
 
 ### VS Code ###
 .vscode/
+
+.DS_Store
+
+src/main/resources/static/docs/

Dockerfile

@@ -0,0 +1,16 @@
+# 최종 이미지 단계
+FROM openjdk:17-jdk-alpine as final
+
+WORKDIR /app
+
+# 빌드된 JAR 파일과 정적 문서 파일을 복사
+COPY ./build/libs/backend-0.0.1-SNAPSHOT.jar app.jar
+COPY ./build/resources/main/static/docs /app/static/docs
+
+# HEALTHCHECK 추가
+HEALTHCHECK --interval=5s --timeout=3s --start-period=30s --retries=3 \
+  CMD curl --fail http://localhost:8080 || exit 1
+
+ENTRYPOINT ["java", "-jar", "app.jar"]
+
+EXPOSE 8080

build.gradle

@@ -2,6 +2,11 @@ plugins {
     id 'java'
     id 'org.springframework.boot' version '3.3.4'
     id 'io.spring.dependency-management' version '1.1.6'
+
+    // REST Docs
+    id "org.asciidoctor.jvm.convert" version "3.3.2"
+    id 'com.epages.restdocs-api-spec' version '0.19.2'
+    id 'org.hidetake.swagger.generator' version '2.18.2'
 }
 
 group = 'kusitms'
@@ -13,31 +18,122 @@ java {
     }
 }
 
-configurations {
-    compileOnly {
-        extendsFrom annotationProcessor
-    }
-}
-
 repositories {
     mavenCentral()
 }
 
 dependencies {
-    // Web
+    // WEB
     implementation 'org.springframework.boot:spring-boot-starter-web'
+    implementation 'org.springframework.boot:spring-boot-starter-validation'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
-    // DB
+
+    // JPA
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
     runtimeOnly 'com.mysql:mysql-connector-j'
+
+    // OAuth 2.0
+    implementation 'org.springframework.boot:spring-boot-starter-oauth2-client'
+
     // Security
     implementation 'org.springframework.boot:spring-boot-starter-security'
     testImplementation 'org.springframework.security:spring-security-test'
+
     // Lombok
     compileOnly 'org.projectlombok:lombok'
     annotationProcessor 'org.projectlombok:lombok'
+
+    // Redis
+    implementation 'org.springframework.boot:spring-boot-starter-data-redis'
+
+    // Twilio SDK
+    implementation 'com.twilio.sdk:twilio:8.24.0'
+
+    // REST Docs & Swagger 의존성 추가
+    testImplementation 'com.epages:restdocs-api-spec-mockmvc:0.19.2'
+    testImplementation 'org.springframework.restdocs:spring-restdocs-mockmvc:3.0.0'
+    testImplementation 'com.squareup.okhttp3:mockwebserver'
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.1.0'
+
+    // WebClient
+    implementation 'org.springframework.boot:spring-boot-starter-webflux'
+
+    // MacOS Silicon 라이브러리 누락 문제
+    runtimeOnly 'io.netty:netty-resolver-dns-native-macos:4.1.104.Final:osx-aarch_64'
+
+
+    // Querydsl 추가
+    implementation 'com.querydsl:querydsl-jpa:5.0.0:jakarta'
+    annotationProcessor "com.querydsl:querydsl-apt:5.0.0:jakarta"
+    annotationProcessor "jakarta.annotation:jakarta.annotation-api"
+    annotationProcessor "jakarta.persistence:jakarta.persistence-api"
+
+    // S3
+    implementation 'org.springframework.cloud:spring-cloud-starter-aws:2.2.6.RELEASE'
+
+}
+
+def querydslDir = "src/main/generated"
+
+ext {
+    snippetsDir = file('build/generated-snippets')
 }
 
 tasks.named('test') {
     useJUnitPlatform()
-}
+    outputs.dir snippetsDir
+}
+
+sourceSets {
+    test {
+        java {
+            srcDirs = ['src/test/java']
+        }
+    }
+}
+
+def serverUrl = "https://git.hitzone.store"
+
+openapi3 {
+    server = serverUrl
+    title = "히트존 API 문서"
+    description = "Spring REST Docs with Swagger UI."
+    version = "0.0.1"
+    outputFileNamePrefix = 'open-api-3.0.1'
+    format = 'json'
+    outputDirectory = 'build/resources/main/static/docs'
+}
+
+tasks.withType(GenerateSwaggerUI).configureEach {
+    dependsOn 'openapi3'
+
+    delete file('src/main/resources/static/docs/')
+    copy {
+        from "build/resources/main/static/docs"
+        into "src/main/resources/static/docs/"
+    }
+}
+
+// Asciidoctor 설정
+tasks.named('asciidoctor') {
+    inputs.dir snippetsDir
+    dependsOn test
+}
+
+tasks.named("bootJar") {
+    dependsOn asciidoctor
+    from("${asciidoctor.outputDir}") {
+        into 'static/docs'
+    }
+    dependsOn ':openapi3'
+}
+
+tasks.register('copyDocument', Copy) {
+    dependsOn asciidoctor
+    from file(project.layout.buildDirectory.dir("docs/asciidoc").get().asFile.path)
+    into file("src/main/resources/static/docs")
+}
+
+tasks.named("build") {
+    dependsOn copyDocument
+}

settings.gradle

@@ -1 +1 @@
-rootProject.name = 'bakend'
+rootProject.name = 'backend'

src/main/java/kusitms/bakend/BakendApplication.java → src/main/java/kusitms/backend/BackendApplication.java

@@ -1,13 +1,13 @@
-package kusitms.bakend;
+package kusitms.backend;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 @SpringBootApplication
-public class BakendApplication {
+public class BackendApplication {
 
     public static void main(String[] args) {
-        SpringApplication.run(BakendApplication.class, args);
+        SpringApplication.run(BackendApplication.class, args);
     }
 
 }

src/main/java/kusitms/backend/auth/application/AuthService.java

@@ -0,0 +1,51 @@
+package kusitms.backend.auth.application;
+
+import jakarta.servlet.http.HttpServletResponse;
+import kusitms.backend.auth.jwt.JWTUtil;
+import kusitms.backend.auth.status.AuthErrorStatus;
+import kusitms.backend.global.exception.CustomException;
+import kusitms.backend.global.redis.RedisManager;
+import kusitms.backend.global.util.CookieUtil;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Slf4j
+@Service
+@RequiredArgsConstructor
+public class AuthService {
+
+    @Value("${spring.jwt.access-token.expiration-time}")
+    private long ACCESS_TOKEN_EXPIRATION_TIME;
+
+    @Value("${spring.jwt.refresh-token.expiration-time}")
+    private long REFRESH_TOKEN_EXPIRATION_TIME;
+
+    private final JWTUtil jwtUtil;
+    private final RedisManager redisManager;
+
+    @Transactional
+    public void reIssueToken(String refreshToken, HttpServletResponse response) {
+        if (refreshToken == null) {
+            throw new CustomException(AuthErrorStatus._EXPIRED_REFRESH_TOKEN);
+        }
+        Long userId = jwtUtil.getUserIdFromToken(refreshToken);
+        String storedRefreshToken = redisManager.getRefreshToken(userId.toString());
+        if (!storedRefreshToken.equals(refreshToken)){
+            throw new CustomException(AuthErrorStatus._TOKEN_USER_MISMATCH);
+        }
+
+        jwtUtil.validateRefreshToken(storedRefreshToken);
+        String newAccessToken = jwtUtil.generateToken(userId, ACCESS_TOKEN_EXPIRATION_TIME);  // 1시간 유효기간
+        String newRefreshToken = jwtUtil.generateToken(userId, REFRESH_TOKEN_EXPIRATION_TIME);  // 14일 유효기간
+        redisManager.saveRefreshToken(userId.toString(), newRefreshToken);
+
+        CookieUtil.setCookie(response, "accessToken", newAccessToken, (int) (ACCESS_TOKEN_EXPIRATION_TIME * 1.5) / 1000);
+        CookieUtil.setCookie(response, "refreshToken", newRefreshToken, (int) REFRESH_TOKEN_EXPIRATION_TIME / 1000);
+        CookieUtil.setNotHttpOnlyCookie(response, "expirationTime", String.valueOf((int) ACCESS_TOKEN_EXPIRATION_TIME / 1000), (int) (ACCESS_TOKEN_EXPIRATION_TIME * 1.5) / 1000);
+    }
+
+
+}

src/main/java/kusitms/backend/auth/dto/response/GoogleUserInfo.java

@@ -0,0 +1,31 @@
+package kusitms.backend.auth.dto.response;
+
+import lombok.AllArgsConstructor;
+
+import java.util.Map;
+
+@AllArgsConstructor
+public class GoogleUserInfo implements OAuth2UserInfo {
+
+    private final Map<String, Object> attribute;
+
+    @Override
+    public String getProvider() {
+        return "google";
+    }
+
+    @Override
+    public String getProviderId() {
+        return attribute.get("sub").toString();
+    }
+
+    @Override
+    public String getEmail() {
+        return attribute.get("email").toString();
+    }
+
+    @Override
+    public String getName() {
+        return attribute.get("name").toString();
+    }
+}