Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Seminar2 #10

Open
wants to merge 10 commits into
base: main
Choose a base branch
from
4 changes: 3 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,4 +40,6 @@ bin/
.vscode/

### Mac OS ###
.DS_Store
.DS_Store

application.yml
23 changes: 23 additions & 0 deletions build.gradle
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
plugins {
id 'java'
id 'org.springframework.boot' version '3.3.4'
id 'io.spring.dependency-management' version '1.1.6'
}

group = 'org.sopt'
Expand All @@ -9,9 +11,30 @@ repositories {
mavenCentral()
}

java {
toolchain {
languageVersion=JavaLanguageVersion.of(17)
}
}

dependencies {
implementation 'org.springframework.boot:spring-boot-starter'
implementation 'org.springframework.boot:spring-boot-starter-web'
testImplementation 'org.springframework.boot:spring-boot-starter-test'
testRuntimeOnly 'org.junit.platform:junit-platform-launcher'

implementation 'org.springframework.boot:spring-boot-starter-data-jpa'
runtimeOnly 'com.h2database:h2'

testImplementation platform('org.junit:junit-bom:5.9.1')
testImplementation 'org.junit.jupiter:junit-jupiter'

//Lombok
compileOnly 'org.projectlombok:lombok'
annotationProcessor 'org.projectlombok:lombok'

// Validation
implementation 'org.springframework.boot:spring-boot-starter-validation'
}

test {
Expand Down
11 changes: 11 additions & 0 deletions src/main/java/org/sopt/diary/DiaryApplication.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package org.sopt.diary;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DiaryApplication {
public static void main(String[] args) {
SpringApplication.run(DiaryApplication.class, args);
}
}
10 changes: 10 additions & 0 deletions src/main/java/org/sopt/diary/Repository/DiaryRepository.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package org.sopt.diary.Repository;


import org.sopt.diary.domain.Diary;
import org.springframework.data.jpa.repository.JpaRepository;
import java.util.List;

public interface DiaryRepository extends JpaRepository<Diary, Long> {
List<Diary> findTop10ByOrderByCreatedAtDesc();
}
39 changes: 39 additions & 0 deletions src/main/java/org/sopt/diary/advice/GlobalExceptionHandler.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
package org.sopt.diary.advice;

import org.sopt.diary.dto.common.ResponseDto;
import org.sopt.diary.exception.NotFoundException;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.FieldError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import java.util.HashMap;
import java.util.Map;

@RestControllerAdvice
public class GlobalExceptionHandler {

@ExceptionHandler(NotFoundException.class)
public ResponseEntity<ResponseDto<String>> handleNotFoundException(NotFoundException e) {
return ResponseEntity
.status(e.getErrorCode().getHttpStatus())
.body(ResponseDto.fail(e.getErrorCode().getCode(),e.getErrorCode().getMessage()));
}

@ExceptionHandler(MethodArgumentNotValidException.class)
public ResponseEntity<ResponseDto<Map<String, String>>> handleValidationExceptions(MethodArgumentNotValidException e) {
Map<String, String> errors = new HashMap<>();

e.getBindingResult().getFieldErrors().forEach((FieldError error) -> {
String fieldName = error.getField();
String errorMessage = error.getDefaultMessage();
errors.put(fieldName, errorMessage);
});

return ResponseEntity
.status(HttpStatus.BAD_REQUEST)
.body(ResponseDto.failValidate(errors));
}
}
65 changes: 65 additions & 0 deletions src/main/java/org/sopt/diary/controller/DiaryController.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
package org.sopt.diary.controller;

import jakarta.validation.Valid;
import lombok.RequiredArgsConstructor;
import org.sopt.diary.dto.request.DiaryDetailsDto;
import org.sopt.diary.dto.request.DiaryCreateDto;
import org.sopt.diary.dto.request.DiaryUpdateDto;
import org.sopt.diary.dto.response.DiaryListResponse;
import org.sopt.diary.service.DiaryService;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.net.URI;

@RestController
@RequiredArgsConstructor
@RequestMapping("/api")
public class DiaryController {

private final DiaryService diaryService;

// 일기 작성
@PostMapping("/diary")
public ResponseEntity<Void> createDiary(
@RequestBody @Valid final DiaryCreateDto diaryCreateDto
) {
return ResponseEntity.created(URI.create(
diaryService.createDiary(diaryCreateDto).getId().toString()
)).build();
}

// 일기 상세 조회
@GetMapping("/diary/{diaryId}")
public ResponseEntity<DiaryDetailsDto> getDiary(
@PathVariable final Long diaryId
){
return ResponseEntity.ok(diaryService.getDiaryDetails(diaryId));
}

// 일기 목록 조회
@GetMapping("/diary")
public ResponseEntity<DiaryListResponse> getDiaryList(
){
return ResponseEntity.ok(diaryService.getDiaryList());
}

// 일기 수정
@PatchMapping("/diary/{diaryId}")
public ResponseEntity<Void> updateDiary(
@PathVariable final Long diaryId,
@RequestBody @Valid final DiaryUpdateDto diaryUpdateDto
){
diaryService.updateDiary(diaryId, diaryUpdateDto);
return ResponseEntity.noContent().build();
}

// 일기 제거
@DeleteMapping("/diary/{diaryId}")
public ResponseEntity<Void> deleteDiary(
@PathVariable final Long diaryId
) {
diaryService.removeDiary(diaryId);
return ResponseEntity.noContent().build();
}
}
35 changes: 35 additions & 0 deletions src/main/java/org/sopt/diary/domain/Diary.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
package org.sopt.diary.domain;

import jakarta.persistence.*;
import lombok.AccessLevel;
import lombok.Builder;
import lombok.Getter;
import lombok.NoArgsConstructor;
import java.time.LocalDateTime;

@Entity
@Getter
@NoArgsConstructor(access = AccessLevel.PROTECTED)
public class Diary {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
public Long id;

public String title;

public LocalDateTime createdAt;

public String content;

@Builder
private Diary(Long id, String title, String content, LocalDateTime createdAt){
this.id = id;
this.title = title;
this.content = content;
this.createdAt = LocalDateTime.now();
}

public void updateDiary(String content){
this.content = content;
}
}
22 changes: 22 additions & 0 deletions src/main/java/org/sopt/diary/dto/common/ResponseDto.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
package org.sopt.diary.dto.common;

public record ResponseDto<T> (
String code,
T data,
String message
) {
public static <T> ResponseDto<T> fail(String code, String message) {
return new ResponseDto<>(code, null, message);
}

// Validation 실패 시 응답 형식
public static <T> ResponseDto<T> failValidate(final T data) {
return new ResponseDto<>("fail", data, null);
}

// 후에 아래처럼 success 에 대해서도 공통된 응답 형식을 반환할 수 있도록 하면 좋은 코드가 될 것 같다.
public static <T> ResponseDto<T> success(final T data) {
return new ResponseDto<>("success", data, null);
}

}
19 changes: 19 additions & 0 deletions src/main/java/org/sopt/diary/dto/request/DiaryCreateDto.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
package org.sopt.diary.dto.request;

import jakarta.validation.constraints.NotNull;
import jakarta.validation.constraints.Size;

import java.time.LocalDateTime;

public record DiaryCreateDto(
Long id,

@NotNull(message = "제목을 입력해주세요.")
@Size(max = 10, message = "일기의 제목은 10자 이내여야 합니다.")
String title,

@Size(max = 30, message = "일기의 내용은 30자 이내여야 합니다.")
String content,
LocalDateTime createdAt
) {
}
14 changes: 14 additions & 0 deletions src/main/java/org/sopt/diary/dto/request/DiaryDetailsDto.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
package org.sopt.diary.dto.request;

import lombok.Builder;

import java.time.LocalDateTime;

@Builder
public record DiaryDetailsDto(
Long id,
String title,
String content,
LocalDateTime createdAt
) {
}
11 changes: 11 additions & 0 deletions src/main/java/org/sopt/diary/dto/request/DiaryUpdateDto.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
package org.sopt.diary.dto.request;

import jakarta.validation.constraints.Size;
import lombok.Builder;

@Builder
public record DiaryUpdateDto(
@Size(max = 30, message = "일기의 내용은 30자 이내여야 합니다.")
String content
) {
}
18 changes: 18 additions & 0 deletions src/main/java/org/sopt/diary/dto/response/DiaryListResponse.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package org.sopt.diary.dto.response;

import lombok.Builder;

import java.util.List;

@Builder
public record DiaryListResponse(
List<DiaryDto> diaryLists
) {

@Builder
public record DiaryDto(
Long id,
String title
){
}
}
18 changes: 18 additions & 0 deletions src/main/java/org/sopt/diary/exception/ErrorCode.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
package org.sopt.diary.exception;

import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.AllArgsConstructor;
import lombok.Getter;
import org.springframework.http.HttpStatus;

@Getter
@AllArgsConstructor
public enum ErrorCode{
NOT_FOUND_DIARY(HttpStatus.NOT_FOUND,"error","존재하지 않는 Diary 입니다."),
;

@JsonIgnore
private final HttpStatus httpStatus;
private final String code;
private final String message;
}
10 changes: 10 additions & 0 deletions src/main/java/org/sopt/diary/exception/NotFoundException.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
package org.sopt.diary.exception;

import lombok.Getter;
import lombok.RequiredArgsConstructor;

@Getter
@RequiredArgsConstructor
public class NotFoundException extends RuntimeException {
private final ErrorCode errorCode;
}
Loading