feat: ��implement core module (#9)

* style: simplify file path

* feat: add custom exception

* feat: add exception handler, response

* feat: add logback.yml

* feat: depend on core module

* feat: implement process of bootJar task

* chore: update by code review

* refactor: unify domain package path

.gitignore

@@ -36,3 +36,5 @@ out/
 ### VS Code ###
 .vscode/
 .DS_Store
+
+**/logs

api-server/build.gradle

@@ -0,0 +1,29 @@
+plugins {
+    id 'java'
+    id 'org.springframework.boot' version '3.2.1'
+    id 'io.spring.dependency-management' version '1.1.4'
+}
+
+dependencies {
+    implementation(project(":core"))
+
+    implementation 'org.springframework.boot:spring-boot-starter-web'
+    testImplementation 'org.springframework.boot:spring-boot-starter-test'
+}
+
+tasks.named('test') {
+    useJUnitPlatform()
+}
+
+String jarName = "api-server.jar";
+
+tasks.named("bootJar") {
+    bootJar.getArchiveFileName().set(jarName);
+
+    bootJar.doLast(task -> {
+        copy(copySpec -> {
+            copySpec.from("build/libs/" + jarName);
+            copySpec.into("../build/libs");
+        });
+    });
+};

dividend-api-server/src/main/java/nexters/dividendapiserver/DividendApiServerApplication.java → api-server/src/main/java/nexters/dividend/apiserver/DividendApiServerApplication.java

@@ -1,4 +1,4 @@
-package nexters.dividendapiserver;
+package nexters.dividend.apiserver;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

api-server/src/main/resources/application.properties

@@ -0,0 +1 @@
+spring.profiles.include=console-logging, file-logging

dividend-api-server/src/test/java/nexters/dividendapiserver/DividendApiServerApplicationTests.java → api-server/src/test/java/nexters/dividend/apiserver/DividendApiServerApplicationTests.java

@@ -1,4 +1,4 @@
-package nexters.dividendapiserver;
+package nexters.dividend.apiserver;
 
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;

dividend-batch/build.gradle → batch/build.gradle

@@ -4,14 +4,26 @@ plugins {
     id 'io.spring.dependency-management' version '1.1.4'
 }
 
-group = 'nexters'
-version = '0.0.1-SNAPSHOT'
-
 dependencies {
+    implementation(project(":core"))
+
     implementation 'org.springframework.boot:spring-boot-starter'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
 }
 
 tasks.named('test') {
     useJUnitPlatform()
 }
+
+String jarName = "batch.jar";
+
+tasks.named("bootJar") {
+    bootJar.getArchiveFileName().set(jarName);
+
+    bootJar.doLast(task -> {
+        copy(copySpec -> {
+            copySpec.from("build/libs/" + jarName);
+            copySpec.into("../build/libs");
+        });
+    });
+};

dividend-batch/src/main/java/nexters/dividendbatch/DividendBatchApplication.java → batch/src/main/java/nexters/dividend/batch/DividendBatchApplication.java

@@ -1,4 +1,4 @@
-package nexters.dividendbatch;
+package nexters.dividend.batch;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

dividend-batch/src/test/java/nexters/dividendbatch/DividendBatchApplicationTests.java → batch/src/test/java/nexters/dividend/batch/DividendBatchApplicationTests.java

@@ -1,4 +1,4 @@
-package nexters.dividendbatch;
+package nexters.dividend.batch;
 
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;

build.gradle

@@ -1,10 +1,14 @@
 allprojects {
-	apply plugin: 'java'
-	group = 'nexters'
+    apply plugin: 'java'
+    group = 'nexters'
 
-	sourceCompatibility = '17'
+    sourceCompatibility = '17'
 
-	repositories {
-		mavenCentral()
-	}
+    repositories {
+        mavenCentral()
+    }
+}
+
+jar {
+    enabled = false
 }

dividend-core/build.gradle → core/build.gradle

@@ -4,14 +4,11 @@ plugins {
     id 'io.spring.dependency-management' version '1.1.4'
 }
 
-group = 'nexters'
-version = '0.0.1-SNAPSHOT'
-
 bootJar.enabled = false
 jar.enabled = true
 
 dependencies {
-    implementation 'org.springframework.boot:spring-boot-starter'
+    implementation 'org.springframework.boot:spring-boot-starter-web'
     testImplementation 'org.springframework.boot:spring-boot-starter-test'
 }
 

dividend-core/src/main/java/nexters/dividendcore/DividendCoreApplication.java → core/src/main/java/nexters/dividend/core/DividendCoreApplication.java

@@ -1,4 +1,4 @@
-package nexters.dividendcore;
+package nexters.dividend.core;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

core/src/main/java/nexters/dividend/core/exception/ErrorResponse.java

@@ -0,0 +1,7 @@
+package nexters.dividend.core.exception;
+
+public record ErrorResponse(
+        int code,
+        String message
+) {
+}

core/src/main/java/nexters/dividend/core/exception/GlobalExceptionHandler.java

@@ -0,0 +1,90 @@
+package nexters.dividend.core.exception;
+
+import nexters.dividend.core.exception.error.AlreadyExistsException;
+import nexters.dividend.core.exception.error.BadRequestException;
+import nexters.dividend.core.exception.error.NotFoundException;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.HttpStatusCode;
+import org.springframework.http.ResponseEntity;
+import org.springframework.http.converter.HttpMessageNotReadableException;
+import org.springframework.web.bind.MethodArgumentNotValidException;
+import org.springframework.web.bind.MissingServletRequestParameterException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.context.request.WebRequest;
+import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
+
+import java.util.NoSuchElementException;
+
+@RestControllerAdvice
+public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {
+
+    @Override
+    protected ResponseEntity<Object> handleMethodArgumentNotValid(
+            final MethodArgumentNotValidException ex,
+            final HttpHeaders headers,
+            final HttpStatusCode status,
+            final WebRequest request) {
+        logger.error("message", ex);
+
+        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
+                .body(new ErrorResponse(HttpStatus.BAD_REQUEST.value(), ex.getMessage()));
+    }
+
+    @Override
+    protected ResponseEntity<Object> handleHttpMessageNotReadable(
+            final HttpMessageNotReadableException ex,
+            final HttpHeaders headers,
+            final HttpStatusCode status,
+            final WebRequest request) {
+        logger.error("message", ex);
+
+        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
+                .body(new ErrorResponse(HttpStatus.BAD_REQUEST.value(), ex.getMessage()));
+    }
+
+    @Override
+    protected ResponseEntity<Object> handleMissingServletRequestParameter(
+            final MissingServletRequestParameterException ex,
+            final HttpHeaders headers,
+            final HttpStatusCode status,
+            final WebRequest request) {
+        logger.error("message", ex);
+
+        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
+                .body(new ErrorResponse(HttpStatus.BAD_REQUEST.value(), ex.getMessage()));
+    }
+
+    @ExceptionHandler({IllegalArgumentException.class, BadRequestException.class})
+    public ResponseEntity<ErrorResponse> handleBadRequestException(final RuntimeException exception) {
+        logger.error("message", exception);
+
+        return ResponseEntity.status(HttpStatus.BAD_REQUEST)
+                .body(new ErrorResponse(HttpStatus.BAD_REQUEST.value(), exception.getMessage()));
+    }
+
+    @ExceptionHandler({NoSuchElementException.class, NotFoundException.class})
+    public ResponseEntity<ErrorResponse> handleNotFoundException(final RuntimeException exception) {
+        logger.error("message", exception);
+
+        return ResponseEntity.status(HttpStatus.NOT_FOUND)
+                .body(new ErrorResponse(HttpStatus.NOT_FOUND.value(), exception.getMessage()));
+    }
+
+    @ExceptionHandler(AlreadyExistsException.class)
+    public ResponseEntity<ErrorResponse> handleDuplicateException(final AlreadyExistsException exception) {
+        logger.error("message", exception);
+
+        return ResponseEntity.status(HttpStatus.CONFLICT)
+                .body(new ErrorResponse(HttpStatus.CONFLICT.value(), exception.getMessage()));
+    }
+
+    @ExceptionHandler(Exception.class)
+    public ResponseEntity<ErrorResponse> handleException(final Exception exception) {
+        logger.error("message", exception);
+
+        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
+                .body(new ErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR.value(), exception.getMessage()));
+    }
+}

core/src/main/java/nexters/dividend/core/exception/error/AlreadyExistsException.java

@@ -0,0 +1,7 @@
+package nexters.dividend.core.exception.error;
+
+public class AlreadyExistsException extends BaseException {
+    public AlreadyExistsException(final String message) {
+        super(message);
+    }
+}

core/src/main/java/nexters/dividend/core/exception/error/BadRequestException.java

@@ -0,0 +1,7 @@
+package nexters.dividend.core.exception.error;
+
+public class BadRequestException extends BaseException {
+    public BadRequestException(final String message) {
+        super(message);
+    }
+}

core/src/main/java/nexters/dividend/core/exception/error/BaseException.java

@@ -0,0 +1,14 @@
+package nexters.dividend.core.exception.error;
+
+public class BaseException extends RuntimeException {
+    private final String message;
+
+    public BaseException(final String message) {
+        this.message = message;
+    }
+
+    @Override
+    public String getMessage() {
+        return message;
+    }
+}

core/src/main/java/nexters/dividend/core/exception/error/NotFoundException.java

@@ -0,0 +1,7 @@
+package nexters.dividend.core.exception.error;
+
+public class NotFoundException extends BaseException {
+    public NotFoundException(final String message) {
+        super(message);
+    }
+}

core/src/main/resources/logback-spring.xml

@@ -0,0 +1,29 @@
+<configuration>
+    <springProfile name="console-logging">
+        <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
+        <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
+        <root level="INFO">
+            <appender-ref ref="CONSOLE"/>
+        </root>
+    </springProfile>
+
+    <springProfile name="file-logging">
+        <property name="LOG_PATH" value="./logs"/>
+        <property name="LOG_FILE_NAME" value="dividend"/>
+
+        <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
+            <file>${LOG_PATH}/${LOG_FILE_NAME}.log</file>
+            <rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
+                <fileNamePattern>${LOG_PATH}/%d{yyyy-MM-dd}-info-%i.log</fileNamePattern>
+                <maxFileSize>50MB</maxFileSize>
+                <maxHistory>30</maxHistory>
+            </rollingPolicy>
+            <encoder>
+                <pattern>%d{HH:mm:ss.SSS} [%level] [%thread] [%logger{36}] - %msg%n</pattern>
+            </encoder>
+        </appender>
+        <root level="INFO">
+            <appender-ref ref="FILE"/>
+        </root>
+    </springProfile>
+</configuration>

dividend-core/src/test/java/nexters/dividendcore/DividendCoreApplicationTests.java → core/src/test/java/nexters/dividend/core/DividendCoreApplicationTests.java

@@ -1,4 +1,4 @@
-package nexters.dividendcore;
+package nexters.dividend.core;
 
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;

domain/build.gradle

@@ -4,9 +4,6 @@ plugins {
     id 'io.spring.dependency-management' version '1.1.4'
 }
 
-group = 'nexters'
-version = '0.0.1-SNAPSHOT'
-
 repositories {
     mavenCentral()
 }

domain/src/main/java/nexters/domain/base/BaseEntity.java → domain/src/main/java/nexters/dividend/domain/BaseEntity.java

@@ -1,4 +1,4 @@
-package nexters.domain.base;
+package nexters.dividend.domain;
 
 import jakarta.persistence.*;
 import lombok.Getter;

domain/src/main/java/nexters/domain/DomainApplication.java → domain/src/main/java/nexters/dividend/domain/DomainApplication.java

@@ -1,4 +1,4 @@
-package nexters.domain;
+package nexters.dividend.domain;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;

domain/src/main/java/nexters/domain/dividend/Dividend.java → domain/src/main/java/nexters/dividend/domain/dividend/Dividend.java

@@ -1,11 +1,11 @@
-package nexters.domain.dividend;
+package nexters.dividend.domain.dividend;
 
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;
 import lombok.AccessLevel;
 import lombok.Getter;
 import lombok.NoArgsConstructor;
-import nexters.domain.base.BaseEntity;
+import nexters.dividend.domain.BaseEntity;
 
 import java.time.Instant;
 import java.util.UUID;

domain/src/main/java/nexters/domain/dividend/repository/DividendRepository.java → domain/src/main/java/nexters/dividend/domain/dividend/repository/DividendRepository.java

@@ -1,6 +1,6 @@
-package nexters.domain.dividend.repository;
+package nexters.dividend.domain.dividend.repository;
 
-import nexters.domain.dividend.Dividend;
+import nexters.dividend.domain.dividend.Dividend;
 import org.springframework.data.jpa.repository.JpaRepository;
 
 import java.util.UUID;

domain/src/main/java/nexters/domain/stock/Sector.java → domain/src/main/java/nexters/dividend/domain/stock/Sector.java

@@ -1,4 +1,4 @@
-package nexters.domain.stock;
+package nexters.dividend.domain.stock;
 
 public enum Sector {
     TECHNOLOGY("Technology"),