프로젝트 패키지 디렉토리 구조 설계

src/main/java/kr/co/fastcampus/Yanabada/YanabadaApplication.java → src/main/java/kr/co/fastcampus/yanabada/YanabadaApplication.java

@@ -1,9 +1,11 @@
-package kr.co.fastcampus.Yanabada;
+package kr.co.fastcampus.yanabada;
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
 
 @SpringBootApplication
+@EnableJpaAuditing
 public class YanabadaApplication {
 
 	public static void main(String[] args) {

src/main/java/kr/co/fastcampus/yanabada/common/baseentity/BaseEntity.java

@@ -0,0 +1,22 @@
+package kr.co.fastcampus.yanabada.common.baseentity;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.EntityListeners;
+import jakarta.persistence.MappedSuperclass;
+import java.time.LocalDateTime;
+import org.springframework.data.annotation.CreatedDate;
+import org.springframework.data.annotation.LastModifiedDate;
+import org.springframework.data.jpa.domain.support.AuditingEntityListener;
+
+@MappedSuperclass
+@EntityListeners(AuditingEntityListener.class)
+public abstract class BaseEntity {
+
+    @CreatedDate
+    @Column(updatable = false)
+    private LocalDateTime createdDate;
+
+    @LastModifiedDate
+    private LocalDateTime updatedDate;
+
+}

src/main/java/kr/co/fastcampus/yanabada/common/config/AppConfig.java

@@ -0,0 +1,20 @@
+package kr.co.fastcampus.yanabada.common.config;
+
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+@Configuration
+public class AppConfig {
+    @Bean
+    public ObjectMapper objectMapper() {
+        ObjectMapper objectMapper = new ObjectMapper();
+        objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+        objectMapper.registerModule(new JavaTimeModule());
+        objectMapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
+        return objectMapper;
+    }
+}

src/main/java/kr/co/fastcampus/yanabada/common/exception/BaseException.java

@@ -0,0 +1,19 @@
+package kr.co.fastcampus.yanabada.common.exception;
+
+import lombok.Getter;
+
+@Getter
+public abstract class BaseException extends RuntimeException {
+
+    public BaseException() {
+        super();
+    }
+
+    public BaseException(String message) {
+        super(message);
+    }
+
+    public BaseException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

src/main/java/kr/co/fastcampus/yanabada/common/exception/CommonEntityNotFoundException.java

@@ -0,0 +1,9 @@
+package kr.co.fastcampus.yanabada.common.exception;
+
+import kr.co.fastcampus.yanabada.common.response.ErrorCode;
+
+public class CommonEntityNotFoundException extends BaseException {
+    public CommonEntityNotFoundException() {
+        super(ErrorCode.COMMON_ENTITY_NOT_FOUND.getErrorMsg());
+    }
+}

src/main/java/kr/co/fastcampus/yanabada/common/exception/handler/GlobalExceptionHandler.java

@@ -0,0 +1,97 @@
+package kr.co.fastcampus.yanabada.common.exception.handler;
+
+import java.lang.reflect.Field;
+import java.util.Arrays;
+import java.util.Comparator;
+import java.util.List;
+import java.util.Objects;
+import java.util.stream.Collectors;
+import kr.co.fastcampus.yanabada.common.exception.BaseException;
+import kr.co.fastcampus.yanabada.common.response.ResponseBody;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.core.NestedExceptionUtils;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.converter.HttpMessageNotReadableException;
+import org.springframework.validation.BindingResult;
+import org.springframework.validation.FieldError;
+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.ResponseStatus;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
+
+@Slf4j
+@RestControllerAdvice
+public class GlobalExceptionHandler {
+
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    @ExceptionHandler(value = BaseException.class)
+    public ResponseBody<Void> handleBaseException(BaseException e) {
+        log.warn("[BaseException] Message = {}", e.getMessage());
+        return ResponseBody.fail(e.getMessage());
+    }
+
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    @ExceptionHandler(value = MethodArgumentNotValidException.class)
+    public ResponseBody<Void> handleValidException(MethodArgumentNotValidException e) {
+        log.warn("[MethodArgumentNotValidException] Message = {}",
+            NestedExceptionUtils.getMostSpecificCause(e).getMessage());
+
+        BindingResult bindingResult = e.getBindingResult();
+        List<FieldError> fieldErrors = getSortedFieldErrors(bindingResult);
+
+        String response = "[Request error] "
+            + fieldErrors.stream()
+            .map(fieldError -> String.format("%s",
+                    fieldError.getDefaultMessage()
+                )
+            ).collect(Collectors.joining());
+        return ResponseBody.fail(response);
+    }
+
+    private List<FieldError> getSortedFieldErrors(BindingResult bindingResult) {
+        List<String> declaredFields = Arrays.stream(
+                Objects.requireNonNull(bindingResult.getTarget()).getClass().getDeclaredFields())
+            .map(Field::getName)
+            .toList();
+
+        return bindingResult.getFieldErrors().stream()
+            .filter(fieldError -> declaredFields.contains(fieldError.getField()))
+            .sorted(Comparator.comparingInt(fe -> declaredFields.indexOf(fe.getField())))
+            .collect(Collectors.toList());
+    }
+
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    @ExceptionHandler(value = IllegalArgumentException.class)
+    public ResponseBody<Void> illegalArgumentException(IllegalArgumentException e) {
+        log.error("[IllegalArgumentException] Message = {}", e.getMessage());
+        return ResponseBody.fail(e.getMessage());
+    }
+
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    @ExceptionHandler(value = HttpMessageNotReadableException.class)
+    public ResponseBody<Void> httpMessageNotReadableException(HttpMessageNotReadableException e) {
+        log.error("[HttpMessageNotReadableException] Message = {}", e.getMessage());
+        return ResponseBody.fail(e.getMessage());
+    }
+
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    @ExceptionHandler(value = MethodArgumentTypeMismatchException.class)
+    public ResponseBody<Void> methodArgumentTypeMismatchException(
+        MethodArgumentTypeMismatchException e
+    ) {
+        log.error("[MethodArgumentTypeMismatchException] Message = {}", e.getMessage());
+        return ResponseBody.fail(e.getMessage());
+    }
+
+    @ExceptionHandler(MissingServletRequestParameterException.class)
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    public ResponseBody<Void> missingServletRequestParameterException(
+        MissingServletRequestParameterException e
+    ) {
+        log.error("[MissingServletRequestParameterException] Message = {}", e.getMessage());
+        return ResponseBody.fail(e.getParameterName()
+            + " 파라미터가 빈 값이거나 잘못된 유형입니다.");
+    }
+}

src/main/java/kr/co/fastcampus/yanabada/common/response/ErrorCode.java

@@ -0,0 +1,17 @@
+package kr.co.fastcampus.yanabada.common.response;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+public enum ErrorCode {
+    COMMON_ENTITY_NOT_FOUND("존재하지 않는 엔티티입니다."),
+    ;
+
+    private final String errorMsg;
+
+    public String getErrorMsg(Object... arg) {
+        return String.format(errorMsg, arg);
+    }
+}

src/main/java/kr/co/fastcampus/yanabada/common/response/ResponseBody.java

@@ -0,0 +1,37 @@
+package kr.co.fastcampus.yanabada.common.response;
+
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+public class ResponseBody<T> {
+
+    private final Status status;
+    private final String errorMessage;
+    private final T data;
+
+    public static ResponseBody<Void> ok() {
+        return new ResponseBody<>(Status.SUCCESS, null, null);
+    }
+
+    public static <T> ResponseBody<T> ok(T data) {
+        return new ResponseBody<>(Status.SUCCESS, null, data);
+    }
+
+    public static ResponseBody<Void> fail(String errorMessage) {
+        return new ResponseBody<>(Status.FAIL, errorMessage, null);
+    }
+
+    public static <T> ResponseBody<T> fail(String errorMessage, T data) {
+        return new ResponseBody<>(Status.FAIL, errorMessage, data);
+    }
+
+    public static ResponseBody<Void> error(String errorMessage) {
+        return new ResponseBody<>(Status.ERROR, errorMessage, null);
+    }
+
+    public static <T> ResponseBody<T> error(String errorMessage, T data) {
+        return new ResponseBody<>(Status.ERROR, errorMessage, data);
+    }
+}

src/main/java/kr/co/fastcampus/yanabada/common/response/Status.java

@@ -0,0 +1,5 @@
+package kr.co.fastcampus.yanabada.common.response;
+
+public enum Status {
+    SUCCESS, FAIL, ERROR
+}

src/main/java/kr/co/fastcampus/yanabada/domain/test/controller/TestController.java

@@ -0,0 +1,32 @@
+package kr.co.fastcampus.yanabada.domain.test.controller;
+
+import kr.co.fastcampus.yanabada.common.response.ResponseBody;
+import kr.co.fastcampus.yanabada.domain.test.dto.TestInfoResponse;
+import kr.co.fastcampus.yanabada.domain.test.dto.TestSaveRequest;
+import kr.co.fastcampus.yanabada.domain.test.service.TestService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.RequestBody;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequestMapping("/api/tests")
+@RequiredArgsConstructor
+public class TestController {
+
+    private final TestService testService;
+
+    @GetMapping("/{testId}")
+    public ResponseBody<TestInfoResponse> getTest(@PathVariable Long testId) {
+        return ResponseBody.ok(testService.findById(testId));
+    }
+
+    @PostMapping
+    public ResponseBody<TestInfoResponse> addTest(@RequestBody TestSaveRequest request) {
+        return ResponseBody.ok(testService.save(request));
+    }
+
+}

src/main/java/kr/co/fastcampus/yanabada/domain/test/dto/TestInfoResponse.java

@@ -0,0 +1,20 @@
+package kr.co.fastcampus.yanabada.domain.test.dto;
+
+import kr.co.fastcampus.yanabada.domain.test.entity.TestEntity;
+import lombok.Builder;
+
+@Builder
+public record TestInfoResponse(
+    Long id,
+    String name,
+    String email
+) {
+
+    public static TestInfoResponse from(TestEntity testEntity) {
+        return TestInfoResponse.builder()
+            .id(testEntity.getId())
+            .name(testEntity.getName())
+            .email(testEntity.getEmail())
+            .build();
+    }
+}

src/main/java/kr/co/fastcampus/yanabada/domain/test/dto/TestSaveRequest.java

@@ -0,0 +1,13 @@
+package kr.co.fastcampus.yanabada.domain.test.dto;
+
+import kr.co.fastcampus.yanabada.domain.test.entity.TestEntity;
+
+public record TestSaveRequest(
+    String name,
+    String email
+) {
+
+    public TestEntity toEntity() {
+        return TestEntity.create(name, email);
+    }
+}

src/main/java/kr/co/fastcampus/yanabada/domain/test/entity/TestEntity.java

@@ -0,0 +1,37 @@
+package kr.co.fastcampus.yanabada.domain.test.entity;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
+import kr.co.fastcampus.yanabada.common.baseentity.BaseEntity;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+@Entity
+@NoArgsConstructor(access = AccessLevel.PROTECTED)
+@Getter
+public class TestEntity extends BaseEntity {
+
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
+    private Long id;
+
+    @Column(nullable = false, length = 100)
+    private String name;
+
+    @Column(nullable = false, length = 100)
+    private String email;
+
+    private TestEntity(String name, String email) {
+        this.name = name;
+        this.email = email;
+    }
+
+    public static TestEntity create(String name, String email) {
+        return new TestEntity(name, email);
+    }
+
+}

src/main/java/kr/co/fastcampus/yanabada/domain/test/repository/TestRepository.java

@@ -0,0 +1,8 @@
+package kr.co.fastcampus.yanabada.domain.test.repository;
+
+import kr.co.fastcampus.yanabada.domain.test.entity.TestEntity;
+import org.springframework.data.repository.CrudRepository;
+
+public interface TestRepository extends CrudRepository<TestEntity, Long> {
+
+}

src/main/java/kr/co/fastcampus/yanabada/domain/test/service/TestService.java

@@ -0,0 +1,29 @@
+package kr.co.fastcampus.yanabada.domain.test.service;
+
+import kr.co.fastcampus.yanabada.domain.test.dto.TestInfoResponse;
+import kr.co.fastcampus.yanabada.domain.test.dto.TestSaveRequest;
+import kr.co.fastcampus.yanabada.domain.test.entity.TestEntity;
+import kr.co.fastcampus.yanabada.domain.test.repository.TestRepository;
+import lombok.RequiredArgsConstructor;
+import org.springframework.stereotype.Service;
+import org.springframework.transaction.annotation.Transactional;
+
+@Service
+@RequiredArgsConstructor
+@Transactional(readOnly = true)
+public class TestService {
+
+    private final TestRepository testRepository;
+
+    public TestInfoResponse findById(Long testId) {
+        TestEntity testEntity = testRepository.findById(testId).orElseThrow();
+        return TestInfoResponse.from(testEntity);
+    }
+
+    @Transactional
+    public TestInfoResponse save(TestSaveRequest request) {
+        TestEntity testEntity = request.toEntity();
+        TestEntity result = testRepository.save(testEntity);
+        return TestInfoResponse.from(result);
+    }
+}

src/test/java/kr/co/fastcampus/Yanabada/YanabadaApplicationTests.java → src/test/java/kr/co/fastcampus/yanabada/YanabadaApplicationTests.java

@@ -1,4 +1,4 @@
-package kr.co.fastcampus.Yanabada;
+package kr.co.fastcampus.yanabada;
 
 import org.junit.jupiter.api.Test;
 import org.springframework.boot.test.context.SpringBootTest;