Briefing 2.0.0 서버 추가 요구사항

.github/workflows/dev_deploy.yml

@@ -54,12 +54,12 @@ jobs:
       - name: Beanstalk Deploy
         uses: einaregilsson/beanstalk-deploy@v20
         with:
-          aws_access_key: ${{ secrets.AWS_ACTION_ACCESS_KEY_ID }}
-          aws_secret_key: ${{ secrets.AWS_ACTION_SECRET_ACCESS_KEY }}
-          application_name: breifing-dev
-          environment_name: Breifing-dev-env
+          aws_access_key: ${{ secrets.AWS_DEV_ACTION_ACCESS_KEY_ID }}
+          aws_secret_key: ${{ secrets.AWS_DEV_ACTION_SECRET_ACCESS_KEY }}
+          application_name: briefing-dev
+          environment_name: Briefing-dev-env
           version_label: github-action-${{ steps.current-time.outputs.formattedTime }}
-          region: ap-northeast-1
+          region: ap-northeast-2
           deployment_package: deploy/deploy.zip
           wait_for_deployment: false
 

README.md

@@ -57,13 +57,14 @@
 </div>
 <div>
   <img src="https://img.shields.io/badge/MySQL-4479A1.svg?style=square&logo=MySQL&logoColor=white">
-  <img src="https://img.shields.io/badge/Redis-DC382D?style=flat-square&logo=Redis&logoColor=white">
+  <img src="https://img.shields.io/badge/Redis-DC382D?style=square&logo=Redis&logoColor=white">
   <img src="https://img.shields.io/badge/Amazon AWS-232F3E?style=square&logo=Amazon AWS&logoColor=white">
 </div>
 <br/>
 
 <b>Spring Cloud</b>
-- write
+- Node.js 크롤러 서버가 하나의 Base Url만을 이용하여 개발 서버와 릴리즈 서버 모두에게 요청을 보낼 수 있도록 해서 편의성을 늘렸습니다.
+- 개발 편의성을 위해 Feign 클라이언트를 사용해 외부 API를 호출 했습니다.
 
 <b>QueryDSL</b>
 - 컴파일 시점 문법 검사와 개발 편의성을 위해 QueryDSL을 사용했습니다.
@@ -77,8 +78,10 @@
 <br/>
 
 ## 📚 개발 과정
-- [[Briefing] API 버전 관리 & 전략 패턴](https://velog.io/@cekim/briefing-api-versioning)
-
+- [[Briefing] API 버전 관리 & 전략 패턴](https://poisson-it.tistory.com/75)
+- [[Briefing] Spotless로 코드 포맷 유지하기](https://poisson-it.tistory.com/77)
+- [[Briefing] Spring Security - Swagger 로그인 적용하기](https://ddol-dev-blog.tistory.com/3)
+- [[Briefing] API 응답 캐싱을 통한 조회 속도 개선](https://poisson-it.tistory.com/78)
 
 <br/>
 

build.gradle

@@ -2,7 +2,7 @@ plugins {
     id 'java'
     id 'org.springframework.boot' version '3.1.2'
     id 'io.spring.dependency-management' version '1.1.2'
-//    id 'com.ewerk.gradle.plugins.querydsl' version '1.0.10'
+    id 'com.diffplug.spotless' version '6.23.3' // Spotless 플러그인
 }
 
 group = 'briefing.info'
@@ -72,6 +72,35 @@ tasks.named('test') {
     useJUnitPlatform()
 }
 
+
+/*
+    compileJava 태스크가 실행되기 전에 spotlessApply 태스크가 먼저 실행되도록 구성
+    개발자가 별도로 코드 포맷팅을 신경 쓸 필요 없이, 코드가 항상 일관된 스타일을 유지하도록 설정
+ */
+tasks.named('compileJava') {
+    dependsOn 'spotlessApply'
+}
+
 jar {
     enabled = false
+}
+
+spotless {
+    java {
+        // Google Java 포맷 적용
+        /*
+            googleJavaFormat() : 탭은 2개의 공백
+            googleJavaFormat().aosp() : 탭은 4개의 공백
+            [참고] https://github.com/google/google-java-format/issues/525
+         */
+        googleJavaFormat().aosp()
+        // 아래 순서로 import문 정렬
+        importOrder('java', 'javax', 'jakarta', 'org', 'com')
+        // 사용하지 않는 import 제거
+        removeUnusedImports()
+        // 각 라인 끝에 있는 공백을 제거
+        trimTrailingWhitespace()
+        // 파일 끝에 새로운 라인 추가
+        endWithNewline()
+    }
 }

src/main/java/briefing/BriefingApplication.java

@@ -3,18 +3,28 @@
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.ImportAutoConfiguration;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.cache.annotation.EnableCaching;
 import org.springframework.cloud.openfeign.EnableFeignClients;
 import org.springframework.cloud.openfeign.FeignAutoConfiguration;
 import org.springframework.data.redis.repository.configuration.EnableRedisRepositories;
 
+import io.swagger.v3.oas.annotations.OpenAPIDefinition;
+import io.swagger.v3.oas.annotations.servers.Server;
+
+@OpenAPIDefinition(
+        servers = {
+            @Server(url = "http://localhost:8080", description = "local server"),
+            @Server(url = "https://dev.briefing.store", description = "dev server"),
+            @Server(url = "https://api.newsbreifing.store", description = "release server")
+        })
 @SpringBootApplication
+@EnableCaching
 @EnableFeignClients
 @EnableRedisRepositories
 @ImportAutoConfiguration({FeignAutoConfiguration.class})
 public class BriefingApplication {
 
-  public static void main(final String[] args) {
-    SpringApplication.run(BriefingApplication.class, args);
-  }
-
+    public static void main(final String[] args) {
+        SpringApplication.run(BriefingApplication.class, args);
+    }
 }

src/main/java/briefing/GlobalControllerAdvice.java

@@ -1,27 +1,27 @@
 package briefing;
 
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+
 import briefing.base.BaseException;
 import briefing.base.BaseExceptionType;
 import lombok.extern.slf4j.Slf4j;
-import org.springframework.http.ResponseEntity;
-import org.springframework.web.bind.annotation.ExceptionHandler;
-import org.springframework.web.bind.annotation.RestControllerAdvice;
 
 @Slf4j
-//@RestControllerAdvice
+// @RestControllerAdvice
 public class GlobalControllerAdvice {
 
-  @ExceptionHandler(BaseException.class)
-  public ResponseEntity<ExceptionResponse> handleException(final BaseException e) {
-    final BaseExceptionType type = e.exceptionType();
-    log.warn("[WARN] MESSAGE: {}", type.message());
-    return new ResponseEntity<>(ExceptionResponse.from(e), e.exceptionType().status());
-  }
+    @ExceptionHandler(BaseException.class)
+    public ResponseEntity<ExceptionResponse> handleException(final BaseException e) {
+        final BaseExceptionType type = e.exceptionType();
+        log.warn("[WARN] MESSAGE: {}", type.message());
+        return new ResponseEntity<>(ExceptionResponse.from(e), e.exceptionType().status());
+    }
 
-  private record ExceptionResponse(String message) {
+    private record ExceptionResponse(String message) {
 
-    private static ExceptionResponse from(final BaseException e) {
-      return new ExceptionResponse(e.exceptionType().message());
+        private static ExceptionResponse from(final BaseException e) {
+            return new ExceptionResponse(e.exceptionType().message());
+        }
     }
-  }
 }

src/main/java/briefing/base/BaseDateTimeEntity.java

@@ -1,22 +1,25 @@
 package briefing.base;
 
+import java.time.LocalDateTime;
+
 import jakarta.persistence.Column;
 import jakarta.persistence.EntityListeners;
 import jakarta.persistence.MappedSuperclass;
-import java.time.LocalDateTime;
-import lombok.Getter;
+
 import org.springframework.data.annotation.CreatedDate;
 import org.springframework.data.annotation.LastModifiedDate;
 import org.springframework.data.jpa.domain.support.AuditingEntityListener;
 
+import lombok.Getter;
+
 @EntityListeners(AuditingEntityListener.class)
 @MappedSuperclass
 @Getter
 public abstract class BaseDateTimeEntity {
 
-  @Column(updatable = false)
-  @CreatedDate
-  private LocalDateTime createdAt;
-  @LastModifiedDate
-  private LocalDateTime updatedAt;
+    @Column(updatable = false)
+    @CreatedDate
+    private LocalDateTime createdAt;
+
+    @LastModifiedDate private LocalDateTime updatedAt;
 }

src/main/java/briefing/base/BaseException.java

@@ -2,9 +2,9 @@
 
 public abstract class BaseException extends RuntimeException {
 
-  protected BaseException(final String message) {
-    super(message);
-  }
+    protected BaseException(final String message) {
+        super(message);
+    }
 
-  public abstract BaseExceptionType exceptionType();
+    public abstract BaseExceptionType exceptionType();
 }

src/main/java/briefing/base/BaseExceptionType.java

@@ -4,7 +4,7 @@
 
 public interface BaseExceptionType {
 
-  HttpStatus status();
+    HttpStatus status();
 
-  String message();
+    String message();
 }