🚀 Deploy: Ver1.0.0 배포

.github/workflows/dev-deploy.yml

@@ -0,0 +1,44 @@
+name: Deploy
+
+on:
+  push:
+    branches:
+      - dev
+    paths-ignore:
+      - '.github/workflows/**'
+
+jobs:
+  deploy:
+    runs-on: self-hosted
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Set up Java
+      uses: actions/setup-java@v3
+      with:
+        distribution: 'temurin'
+        java-version: '21'
+
+    - name: Make gradlew executable
+      run: chmod +x ./gradlew
+
+    - name: Build Spring Boot (JAR)
+      run: ./gradlew bootJar -Penv=test
+
+    - name: Copy JAR to shared volume
+      run: cp build/libs/*.jar /deploy/app.jar
+
+    - name: Restart Docker with New JAR
+      run: |
+        cd /deploy
+        docker-compose down
+        docker-compose up -d --build
+
+    - name: Wait for test server to be healthy
+      run: |
+        echo "🔍 Checking https://yakplus-test.techlog.dev/actuator/health ..."
+        curl --silent --fail \
+             --retry 5 --retry-connrefused --retry-delay 5 \
+             https://yakplus-test.techlog.dev/actuator/health

.gitignore

@@ -19,7 +19,7 @@ build/
 *.iml
 *.iws
 *.ipr
-out/
+/out/
 .idea/**/
 .idea_modules/
 .idea/httpRequests

build.gradle

@@ -39,10 +39,31 @@ dependencies {
     // RDB
     runtimeOnly 'com.mysql:mysql-connector-j'
     implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
+    implementation 'com.fasterxml.jackson.dataformat:jackson-dataformat-xml'
+    implementation 'org.springframework.boot:spring-boot-starter-jdbc'
 
     // Elastic search
     implementation 'org.springframework.boot:spring-boot-starter-data-elasticsearch'
     implementation 'org.elasticsearch.client:elasticsearch-rest-high-level-client:7.17.10'
+
+    //ai
+    implementation 'org.springframework.ai:spring-ai-openai-spring-boot-starter:1.0.0-M5'
+
+    // Swagger 설치
+    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.7.0'
+
+    // build.gradle
+    if (project.hasProperty('env') && project.env == 'test') {
+        dependencies {
+            implementation 'org.springframework.boot:spring-boot-starter-actuator'
+        }
+    }
+}
+
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.ai:spring-ai-bom:1.0.0-M5"
+    }
 }
 
 tasks.named('test') {

src/main/java/com/likelion/backendplus4/yakplus/YakplusApplication.java

@@ -5,8 +5,7 @@
 
 @SpringBootApplication
 public class YakplusApplication {
-    public static void main(String[] args) {
-        SpringApplication.run(YakplusApplication.class, args);
-
-    }
+	public static void main(String[] args) {
+		SpringApplication.run(YakplusApplication.class, args);
+	}
 }

src/main/java/com/likelion/backendplus4/yakplus/common/configuration/LogbackConfig.java

@@ -0,0 +1,188 @@
+package com.likelion.backendplus4.yakplus.common.configuration;
+
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Configuration;
+
+import ch.qos.logback.classic.Level;
+import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.classic.encoder.PatternLayoutEncoder;
+import ch.qos.logback.classic.spi.ILoggingEvent;
+import ch.qos.logback.core.ConsoleAppender;
+import ch.qos.logback.core.FileAppender;
+import ch.qos.logback.core.rolling.TimeBasedRollingPolicy;
+import ch.qos.logback.core.util.FileSize;
+import jakarta.annotation.PostConstruct;
+
+/**
+ * 로깅 설정을 위한 설정 클래스
+ *
+ * @modified 2025-04-18
+ * @since 2025-04-16
+ */
+@Configuration
+public class LogbackConfig {
+	@Value("${log.rolling.directory}")
+	private String LOG_DIRECTORY;
+	@Value("${log.rolling.file-name}")
+	private String LOG_FILE_NAME;
+	@Value("${log.rolling.pattern}")
+	private String LOG_PATTERN;
+	@Value("${log.rolling.max-history}")
+	private int MAX_HISTORY;
+	@Value("${log.rolling.total-size-cap}")
+	private String TOTAL_SIZE_CAP;
+
+	/**
+	 * 로깅 설정을 초기화하는 메서드
+	 *
+	 * @author 정안식
+	 * @modified 2025-04-18
+	 * @since 2025-04-16
+	 */
+	@PostConstruct
+	public void configure() {
+		LoggerContext context = initializeLoggerContext();
+		createLogDirectory();
+
+		ConsoleAppender<ILoggingEvent> consoleAppender = createConsoleAppender(context);
+		FileAppender<ILoggingEvent> fileAppender = createFileAppender(context);
+
+		configureRootLogger(context, consoleAppender, fileAppender);
+	}
+
+	/**
+	 * LoggerContext를 초기화하는 메서드
+	 *
+	 * @return LoggerContext 초기화된 로거 컨텍스트
+	 * @author 정안식
+	 * @modified 2025-04-18
+	 * @since 2025-04-16
+	 */
+	private LoggerContext initializeLoggerContext() {
+		LoggerContext context = (LoggerContext)LoggerFactory.getILoggerFactory();
+		context.reset();
+		return context;
+	}
+
+	/**
+	 * 로그 디렉토리를 생성하는 메서드
+	 *
+	 * @author 정안식
+	 * @modified 2025-04-18
+	 * @since 2025-04-16
+	 */
+	private void createLogDirectory() {
+		Path logPath = Paths.get(LOG_DIRECTORY);
+		try {
+			if (!Files.exists(logPath)) {
+				Files.createDirectories(logPath);
+			}
+		} catch (Exception e) {
+			throw new RuntimeException("로그 디렉토리 생성 실패", e);
+		}
+	}
+
+	/**
+	 * 콘솔 어펜더를 생성하는 메서드
+	 *
+	 * @param context LoggerContext 로거 컨텍스트
+	 * @return ConsoleAppender 생성된 콘솔 어펜더
+	 * @author 정안식
+	 * @modified 2025-04-18
+	 * @since 2025-04-16
+	 */
+	private ConsoleAppender<ILoggingEvent> createConsoleAppender(LoggerContext context) {
+		ConsoleAppender<ILoggingEvent> appender = new ConsoleAppender<>();
+		appender.setContext(context);
+		appender.setEncoder(createEncoder(context));
+		appender.start();
+		return appender;
+	}
+
+	/**
+	 * 파일 어펜더를 생성하는 메서드
+	 *
+	 * @param context LoggerContext 로거 컨텍스트
+	 * @return FileAppender 생성된 파일 어펜더
+	 * @author 정안식
+	 * @modified 2025-04-18
+	 * @since 2025-04-16
+	 */
+	private FileAppender<ILoggingEvent> createFileAppender(LoggerContext context) {
+		FileAppender<ILoggingEvent> appender = new FileAppender<>();
+		appender.setContext(context);
+		appender.setFile(LOG_DIRECTORY + "/" + LOG_FILE_NAME);
+		appender.setAppend(true);
+		appender.setEncoder(createEncoder(context));
+
+		TimeBasedRollingPolicy<ILoggingEvent> rollingPolicy = createRollingPolicy(context, appender);
+		rollingPolicy.start();
+
+		appender.start();
+		return appender;
+	}
+
+	/**
+	 * 패턴 레이아웃 인코더를 생성하는 메서드
+	 *
+	 * @param context LoggerContext 로거 컨텍스트
+	 * @return PatternLayoutEncoder 생성된 패턴 레이아웃 인코더
+	 * @author 정안식
+	 * @modified 2025-04-18
+	 * @since 2025-04-16
+	 */
+	private PatternLayoutEncoder createEncoder(LoggerContext context) {
+		PatternLayoutEncoder encoder = new PatternLayoutEncoder();
+		encoder.setContext(context);
+		encoder.setPattern(LOG_PATTERN);
+		encoder.start();
+		return encoder;
+	}
+
+	/**
+	 * 롤링 정책을 생성하는 메서드
+	 *
+	 * @param context LoggerContext 로거 컨텍스트
+	 * @param parent FileAppender 부모 파일 어펜더
+	 * @return TimeBasedRollingPolicy 생성된 롤링 정책
+	 * @author 정안식
+	 * @modified 2025-04-18
+	 * @since 2025-04-16
+	 */
+	private TimeBasedRollingPolicy<ILoggingEvent> createRollingPolicy(LoggerContext context,
+		FileAppender<ILoggingEvent> parent) {
+		TimeBasedRollingPolicy<ILoggingEvent> policy = new TimeBasedRollingPolicy<>();
+		policy.setContext(context);
+		policy.setParent(parent);
+		policy.setFileNamePattern(LOG_DIRECTORY + "/" + LOG_FILE_NAME.replace(".log", ".%d{yyyy-MM-dd}.log"));
+		policy.setMaxHistory(MAX_HISTORY);
+		policy.setTotalSizeCap(FileSize.valueOf(TOTAL_SIZE_CAP));
+		return policy;
+	}
+
+	/**
+	 * 루트 로거를 설정하는 메서드
+	 *
+	 * @param context LoggerContext 로거 컨텍스트
+	 * @param consoleAppender ConsoleAppender 콘솔 어펜더
+	 * @param fileAppender FileAppender 파일 어펜더
+	 * @author 정안식
+	 * @since 2025-04-16
+	 */
+	private void configureRootLogger(LoggerContext context, ConsoleAppender<ILoggingEvent> consoleAppender,
+		FileAppender<ILoggingEvent> fileAppender) {
+		Logger logger = LoggerFactory.getLogger(Logger.ROOT_LOGGER_NAME);
+		if (logger instanceof ch.qos.logback.classic.Logger) {
+			ch.qos.logback.classic.Logger rootLogger = (ch.qos.logback.classic.Logger)logger;
+			rootLogger.setLevel(Level.INFO);
+			rootLogger.addAppender(consoleAppender);
+			rootLogger.addAppender(fileAppender);
+		}
+	}
+}

src/main/java/com/likelion/backendplus4/yakplus/common/configuration/SwaggerConfig.java

@@ -0,0 +1,21 @@
+package com.likelion.backendplus4.yakplus.common.configuration;
+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+
+import io.swagger.v3.oas.models.OpenAPI;
+import io.swagger.v3.oas.models.info.Info;
+
+@Configuration
+public class SwaggerConfig {
+
+	@Bean
+	public OpenAPI openAPI() {
+		return new OpenAPI()
+			.info(new Info()
+				.title("YakPlus API")
+				.description("YakPlus 프로젝트의 API 문서입니다.")
+				.version("1.0.0"));
+	}
+}

src/main/java/com/likelion/backendplus4/yakplus/common/configuration/WebConfig.java

@@ -0,0 +1,38 @@
+package com.likelion.backendplus4.yakplus.common.configuration;
+
+import com.likelion.backendplus4.yakplus.common.interceptor.LogInterceptor;
+import lombok.RequiredArgsConstructor;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
+import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
+
+/**
+ * 웹 설정을 위한 설정 클래스
+ * 
+ * @modified 2025-04-18
+ * @since 2025-04-16
+ */
+@Configuration
+@RequiredArgsConstructor
+public class WebConfig implements WebMvcConfigurer {
+
+    private static final String ALL_PATTERN = "/**";
+
+    private final LogInterceptor logInterceptor;
+
+    /**
+     * 인터셉터를 등록하는 메서드
+     *
+     * @param registry InterceptorRegistry 인터셉터 레지스트리
+     * @author 정안식
+     * @modified 2025-04-18
+     * @since 2025-04-16
+     */
+    @Override
+    public void addInterceptors(InterceptorRegistry registry) {
+        // 모든 요청에 대해 LogInterceptor를 적용
+        registry.addInterceptor(logInterceptor)
+                .addPathPatterns(ALL_PATTERN);  // 모든 URL 패턴에 적용
+    }
+}

src/main/java/com/likelion/backendplus4/yakplus/common/exception/CustomException.java

@@ -0,0 +1,35 @@
+package com.likelion.backendplus4.yakplus.common.exception;
+
+
+import com.likelion.backendplus4.yakplus.common.exception.error.ErrorCode;
+
+/**
+ * 사용자 정의 예외의 추상 클래스 애플리케이션 전역에서 사용하는 공통 예외 상위 타입이다.
+ *
+ * @modified 2025-04-18
+ * @since 2025-04-16
+ */
+public abstract class CustomException extends RuntimeException {
+
+    /**
+     * 생성자 - ErrorCode의 메시지를 기반으로 예외 메시지를 설정한다.
+     *
+     * @param errorCode ErrorCode 객체
+     * @author 박찬병
+     * @modified 2025-04-18 박찬병
+     * @since 2025-04-16
+     */
+    public CustomException(ErrorCode errorCode) {
+        super(errorCode.message());
+    }
+
+    /**
+     * ErrorCode 반환
+     *
+     * @return ErrorCode 객체
+     * @author 박찬병
+     * @modified 2025-04-18 박찬병
+     * @since 2025-04-16
+     */
+    public abstract ErrorCode getErrorCode();
+}