[5기 엄예림, 정의진] Spring Boot JPA 게시판 구현 미션 제출합니다. #265

yenzip · 2023-11-21T14:00:13Z

📌 과제 설명

Sprint Data JPA를 사용한 간단한 게시판

👩‍💻 요구 사항과 구현 내용

SpringDataJPA 를 설정한다.

datasource : mysql

엔티티를 구성한다

회원(User)
- id (PK) (auto increment)
- name
- age
- hobby
- created_at
- created_by
게시글(Post)
- id (PK) (auto increment)
- title
- content
- created_at
- created_by
회원과 게시글에 대한 연관관계를 설정한다.
- 회원과 게시글은 1:N 관계이다.
게시글 Repository를 구현한다. (PostRepository)

API를 구현한다.

회원 생성
게시글 작성 (POST "/posts")
게시글 조회
- 페이징 조회 (GET "/posts")
- 단건 조회 (GET "/posts/{id}")
게시글 수정 (POST "/posts/{id}")
REST-DOCS를 이용해서 문서화한다.

✅ 실행 방법

docker 폴더로 이동해 아래 명령어를 입력하면 MySQL을 실행시킬 수 있습니다.

docker-compose -p board up -d

✅ PR 포인트 & 궁금한 점

도메인에서는 이미 Spring Validation을 통해 유효성을 검사했지만, 생성자 내에서 추가적인 Validation 메서드를 포함시켜야 하는지, 또는 현재의 검사만으로 충분한지에 대한 고민이 있습니다.
엔티티와 DTO 간의 상호 변환 로직은 Converter 클래스에서 수행하고 있습니다. 현재 Service에서 이 Converter를 호출하여 사용 중이지만, 이 변환 로직을 Controller에서 처리하는 것이 더 나은 방법일지에 대한 고민이 있습니다.
게시물 다건 조회 API의 문서 작성 시, 응답 객체에 포함된 Pageable 관련 속성이 너무 많다고 생각하여 필요한 속성만 추출하여 응답 객체로 반환하였습니다. 현업에서는 페이징과 관련된 응답 객체를 어떻게 처리하는지에 대한 실무적인 접근 방식이 궁금합니다.
일반적으로 실무에서는 단방향 매핑을 많이 사용하고, 양방향 매핑은 복잡하기에 한정적으로 사용한다고 알고 있습니다. 그렇다면, 만약 양방향 매핑을 사용한다면 어떤 상황에서 사용되는지에 대한 실무적인 사례가 궁금합니다.

…ption)

errors.properties 추가

Sehee-Lee-01

전체적으로 코드 컨벤션이랑 스타일이랑 너무 깔끔해서 보기 편했습니다! 여러가지 배워간 것도 많은 것 같군요!!🥰

Sehee-Lee-01 · 2023-11-23T07:51:47Z

http/post-request.http

오 요 api 문서 형식은 강의에서 보았던 방식은 아닌 것 같은데 어떤 것을 사용하신 건가요?

api 호출을 파일로 관리하는 점이 참 좋네요 👍

@Sehee-Lee-01 문서 형식을 따로 참고한 것은 아니고, 저희가 임의로 만들었습니다!
아직도 postman 쓰세요? Intellij http를 통해 api를 테스트해보자! 이 링크에 Intellij http로 api 문서화 하는 방법이 꽤 잘 설명 되어 있어서 참고해도 좋을 것 같아요!

아아아!!! 그 강의에 나왔던 내용이군요ㅠㅠ🥲
이미 설치한 포스트맨만 쓰다보니 잊고 있었네요ㅠㅠㅠ 확실히 이렇게 저장하면 따로 포스트맨 기록을 관리하지 않아도 되고 편리한 것 같군용!! 다시 상기 시켜주셔서 감사해요ㅠㅠㅠ

Sehee-Lee-01 · 2023-11-23T07:55:48Z

src/docs/asciidoc/index.html

이 html 파일 저희가 실습할 땐 build 디렉토리에 들어가던데ㅠㅠ 현재 경로(src/docs/asciidoc)로 들어가도록 어떻게 설정하셨나요? 👍

사실 저희는 build 폴더에 있는 http 파일을 복사해서 넣어 놨습니다!😅

Sehee-Lee-01 · 2023-11-23T08:00:29Z

src/main/java/org/prgms/springbootboardjpayu/controller/PostController.java

+    }
+
+    @GetMapping
+    public ResponseEntity<ListResponse> getPosts(Pageable pageable) {


ListResponse로 정보를 잘 감싸주었군요! 👍덕분에 코드도 깔끔해보이네용!

Sehee-Lee-01 · 2023-11-23T11:26:34Z

src/main/java/org/prgms/springbootboardjpayu/controller/PostController.java

+    private final PostService postService;
+
+    @PostMapping
+    public ResponseEntity<PostResponse> createPost(@Valid @RequestBody CreatePostRequest request) {


DTO(PostResponse) 네이밍이 직관적이라서 좋은 것 같습니다!

Sehee-Lee-01 · 2023-11-23T16:01:38Z

src/main/java/org/prgms/springbootboardjpayu/domain/BaseEntity.java

+    private String createdBy;
+
+    @Column(name = "created_at", columnDefinition = "TIMESTAMP", updatable = false)
+    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd'T'HH:mm:ss.SSS'Z'")


format까지 설정하신 부분이 너무 좋은 것 같습니다! 하나 배워갑니당!! 👍

Sehee-Lee-01 · 2023-11-23T16:33:41Z

src/main/resources/errors.properties

+NotNull={0}은(는) 필수 입력 항목입니다.
+NotBlank={0}은(는) 필수 입력 항목이며 공백을 제외한 문자를 하나 이상 포함해야 합니다.
+Range={0}의 범위는 {2}에서 {1}사이여야 합니다.
+Length={0}의 길이는 {2}에서 {1}사이여야 합니다.


저 { } 안에는 BindingResult Error와 관련된 argument가 들어가는 것일까요?

처음 봐요! 지식이 늘었습니다 👍

Sehee-Lee-01 · 2023-11-23T16:39:07Z

src/test/java/org/prgms/springbootboardjpayu/controller/PostControllerTest.java

+    private ObjectMapper objectMapper;
+
+    @MockBean
+    private PostService postService;


여기 프로젝트에서는 각 레이어별 유효성 검사를 하기 때문에 컨트롤러만 유효성 검사가 잘 되는지 mocking 이용해서 테스트 하셨군요! 프로젝트 특성에 맞게, 필요한 부분에만 테스트를 작성한 것 같아서 좋은 것 같습니다! 👍

Sehee-Lee-01 · 2023-11-23T16:40:21Z

src/test/java/org/prgms/springbootboardjpayu/controller/PostControllerTest.java

+    @DisplayName("제목이 1 ~ 30자 범위를 초과해 게시글 생성에 실패한다.")
+    @ParameterizedTest(name = "{index}. {0} 제목의 글자 수 범위를 초과한다.")
+    @EmptySource
+    @MethodSource("provideLongTitle")


메소드 설정해서 소스를 만들 수 있군요! 하나 배워갑니다용👍

Sehee-Lee-01 · 2023-11-23T16:43:32Z

src/test/java/org/prgms/springbootboardjpayu/controller/docs/PostControllerDocsTest.java

+                .andExpect(status().isCreated())
+                .andDo(document("post-create",
+                        preprocessRequest(prettyPrint()),
+                        preprocessResponse(prettyPrint()),


👍prettyPrint() 배워갑니당!

Sehee-Lee-01 · 2023-11-23T16:46:54Z

src/test/java/org/prgms/springbootboardjpayu/controller/docs/RestDocsSupport.java

+
+    protected abstract Object initController();
+
+}


상속을 이용한 부분 좋은 것 같아요! 코드 가독성이 엄청 좋은데용!

ASak1104

코드 리뷰를 하면서 많이 배운 것 같아요!
저의 개인적인 의견이 다소 많아서 반영을 위해 무리하시기 보단 이렇게도 생각할 수 있겠군..처럼 가볍게 생각해주시면 좋을 것 같아요!
그리고 저도 모르는게 정말 많아서 반박 및 질문 부탁드립니다! 🤗

ASak1104 · 2023-11-25T16:58:52Z

docker/docker-compose.yml

+    container_name: board
+    environment:
+      MYSQL_DATABASE: board_system
+      MYSQL_ROOT_HOST: '%'
+      MYSQL_ROOT_PASSWORD: 1234
+      TZ: 'Asia/Seoul'
+    ports:
+      - "23306:3306"


docker compose 파일로 db 관리에 편의성을 가져가는 부분이 좋네요 👍

보통 docker compose는 서비스에서 다수의 컨테이너를 사용하고 관리할 때 사용하다 보니 단일 컨테이너를 사용하는 지금은 dockerFile을 고려하는 것도 좋을 것 같아요

만약 docker compose에서 test에서 사용하는 DB를 관리한다면 지금처럼 compose 파일에서 관리하는 것도 좋을 것 같네요

컨테이너 이름이나 서버 port, db에 대한 설정 값은 변경이 잦은 경우가 많은 것 같아서 직접적으로 버전 관리가 되도록 하는 것 보다는 runtime에 사용자가 입력하도록 하는 걸 고려하면 좋을 것 같아요

ASak1104 · 2023-11-25T17:03:46Z

http/post-request.http

api 호출을 파일로 관리하는 점이 참 좋네요 👍

ASak1104 · 2023-11-25T17:06:09Z

src/docs/asciidoc/index.adoc

+==== HTTP request
+
+include::{snippets}/post-update/http-request.adoc[]
+include::{snippets}/post-update/path-parameters.adoc[]


path 파라미터도 스니펫으로 존재하는 줄 몰랐네요!
배워 갑니다~

ASak1104 · 2023-11-25T17:17:09Z

src/main/java/org/prgms/springbootboardjpayu/controller/PostController.java

+    }
+
+    @PatchMapping("/{id}")
+    public ResponseEntity<PostResponse> updatePost(@PathVariable Long id, @Valid @RequestBody UpdatePostRequest request) {


이 라인은 120자를 넘어가는 것 같네요
아래와 같이 수정하면 좋을 것 같아요

public ResponseEntity<PostResponse> updatePost(@PathVariable Long id, @Valid @RequestBody UpdatePostRequest request) {

ASak1104 · 2023-11-25T17:21:49Z

src/main/java/org/prgms/springbootboardjpayu/controller/PostController.java

+    @PatchMapping("/{id}")
+    public ResponseEntity<PostResponse> updatePost(@PathVariable Long id, @Valid @RequestBody UpdatePostRequest request) {


title이나 content가 모두 바뀌는 것이 아니어서 해당 메서드를 PATCH로 하신 것 같아요

제 생각으로는 front-end가 게시글의 title과 content를 모두 알고 있어야 요청을 보낼 수 있고 ~~현재 애플리케이션이 게시글이 존재하지 않을 때와 존재할 때에 대한~~ 요청 시 포스트 제목과 내용이 각각 멱등성이 보장되지 않기 때문에 PUT 메서드를 사용하시면 좋을 것 같아요!

작성자나 생성시간 등이 변경 되지 않기 때문에 PATCH로 결정을 했었습니다 그리고 사용자가 수정할 수 있는 것은 제목과 내용 뿐이라고 생각을 했었는데요!
그런데 혹시 _"현재 애플리케이션이 게시글이 존재하지 않을 때와 존재할 때에 대한 요청 시 포스트 제목과 내용이 각각 이 보장되지 않기 때문에"_라는 말씀이 어떤 의미인지 알 수 있을까요?
저희도 front-end가 게시글의 title과 content를 모두 알고 있어야 요청을 보낼 수 있고, 만약 제목만 변경하고 싶더라도 { "title": "수정된 title", "content": "기존 content"} 이런식으로 요청을 보낸다고 생각을 했었습니다! 이 경우에는 title과 content를 기존값에 관계 없이 항상 요청된 상태로 설정하기 때문에, 멱등성이 지켜지지 않을까요..? 혹시 제가 이해한 바가 맞는지 궁금합니다..!
그런데 생각해보니 { "title": "수정된 title" } 이런식으로 요청이 오는 경우가 아예 없다고 보장할 수 없으니 null 처리에 대한 방어를 해둬야 겠다는 생각이 드네요..! PATCH를 유지하되 null 처리를 해주는 방법은 혹시 어떨까요?

참고 링크
HTTP PUT vs HTTP PATCH in a REST API

ASak1104 · 2023-11-25T19:25:25Z

src/test/java/org/prgms/springbootboardjpayu/controller/PostControllerTest.java

+
+    @DisplayName("수정된 제목이 1 ~ 30자 범위를 초과로 게시글 수정에 실패한다.")
+    @ParameterizedTest
+    @EmptySource


@NullAndEmptySource를 활용하는 것도 좋을 것 같아요!

ASak1104 · 2023-11-25T19:26:22Z

src/main/java/org/prgms/springbootboardjpayu/exception/GlobalExceptionHandler.java

+
+@RestControllerAdvice
+@RequiredArgsConstructor
+public class GlobalExceptionHandler {


커버 되지 않는 부분의 테스트를 추가하면 더 좋을 것 같아요 💯

ASak1104 · 2023-11-25T19:29:33Z

src/test/java/org/prgms/springbootboardjpayu/controller/docs/PostControllerDocsTest.java

+                        responseFields(
+                                fieldWithPath("id").type(NUMBER).description("Post Id"),
+                                fieldWithPath("title").type(STRING).description("Title"),
+                                fieldWithPath("content").type(STRING).description("Content"),


파라미터 커버리지가 넓어지면 해당 테스트가 통과되지 않을 것 같아서 nullable 한 필드에 대해선 optional을 붙여주는게 좋을 것 같아요!

fieldWithPath("content").type(STRING).description("Content").optional(),

ASak1104 · 2023-11-25T19:34:03Z

src/test/java/org/prgms/springbootboardjpayu/controller/docs/PostControllerDocsTest.java

+                                parameterWithName("page").description("페이지"),
+                                parameterWithName("size").description("페이지 크기")


api 문서의 파라미터와 필드 설명 중 이 부분만 한글이라 통일하면 좋을 것 같아요!

ASak1104 · 2023-11-25T19:43:19Z

src/test/java/org/prgms/springbootboardjpayu/service/PostServiceTest.java

+        assertThatThrownBy(() -> postService.createPost(request))
+                .isInstanceOf(ConstraintViolationException.class);


반환하는 메시지인 널이어서는 안됩니다를 검증하면 더 좋을 것 같아요!

twotwobread · 2023-11-30T11:02:21Z

src/main/java/org/prgms/springbootboardjpayu/service/PostService.java

+        Post post = postRepository.findById(id)
+                .orElseThrow(() -> new EntityNotFoundException("존재하지 않는 게시글입니다."));
+
+        post.editPostTitleContent(request.title(), request.content());


요기 update할 때 기존에 content에 데이터가 존재하는 경우에 {"title": "title"} 이런 식으로 받으면 content도 null로 수정되는 거 아닌가요??

twotwobread · 2023-11-30T11:12:52Z

src/main/java/org/prgms/springbootboardjpayu/service/converter/UserConverter.java

+import org.prgms.springbootboardjpayu.dto.response.UserResponse;
+
+public final class UserConverter {
+


어떤 클래스에는 상위에 개행이 있고 어떤 클래스에는 개행이 없는데 이런 스타일 맞춰줄 수 있는 formatter가 있는지 찾아보면 좋을 것 같습니다!

twotwobread · 2023-11-30T11:27:00Z

src/main/java/org/prgms/springbootboardjpayu/domain/User.java

+
+    @Column(name = "age")
+    @Range(min = 0, max = 200)
+    private Integer age;


primitive 타입을 사용해서 null이 들어가지 않게 해도 괜찮을 것 같습니다.

게시판에서 age가 필수값이 아니라고 생각해서 데이터베이스의 default 값인 nullable=true로 설정했습니다!

twotwobread · 2023-11-30T11:44:01Z

src/main/java/org/prgms/springbootboardjpayu/exception/GlobalExceptionHandler.java

+        for (String code : codes) {
+            try {
+                return messageSource.getMessage(code, error.getArguments(), Locale.KOREA);
+            } catch (NoSuchMessageException ignored) {


아니면 메서드를 분리해서 NoSuchMessageException이 발생했을 때 ""나 Optional.empty 반환해서 filter하고 findFirst로 찾아서 반환하고 orElse로 못찾은 경우 default message 반환하게 구성해도 좋을 것 같습니다.

twotwobread · 2023-11-30T12:05:20Z

src/test/java/org/prgms/springbootboardjpayu/domain/PostTest.java

+class PostTest {
+    @DisplayName("게시글을 생성할 수 있다.")
+    @Test
+    void createPost() {


validation 관련 예외 테스트도 짜보면 좋을 것 같습니다!

twotwobread · 2023-11-30T12:10:56Z

src/test/java/org/prgms/springbootboardjpayu/service/PostServiceTest.java

+        // then
+        assertThat(savedPost.id()).isNotNull();
+        assertThat(savedPost.createdAt()).isNotNull();
+        assertThat(savedPost).extracting("title", "content")


개인적으로 property를 스트링으로 써서 테스트를 할 때 PostResponse 내부 필드가 바뀌었을 때 ide에 에러로 잡히지 않을 꺼 같아서 잡힐 수 있게 따로 검증하는 방법도 생각해보면 좋을 것 같습니다.

twotwobread · 2023-11-30T12:12:38Z

src/test/java/org/prgms/springbootboardjpayu/service/UserServiceTest.java

+
+    }
+
+    private static List<String> provideLongName() {


👍 UserServiceTest에도 duplicate function이 존재하는 것 같아서 이런 부분을 테스트 내부 유틸로 빼서 다른 함수들에서 같이 사용하면 더 좋을 것 같습니다.

twotwobread · 2023-11-30T12:15:03Z

src/test/java/org/prgms/springbootboardjpayu/controller/PostControllerTest.java

+        CreatePostRequest request = new CreatePostRequest("제목", "내용", 1L);
+
+        // when then
+        mockMvc.perform(


MockMvc를 이용하여 컨트롤러 단에서의 모킹 테스트가 RestDocs에서 수행한 테스트와 다른점이 있나요?? 서블릿을 띄우는 E2E 테스트가 더 의미있을 것 같습니다. TestRestTemplate 같은 것을 찾아보면 좋을 것 같아요!

yenzip and others added 30 commits November 16, 2023 16:16

chore: 프로젝트 생성

254b961

docs: gitignore 파일(폴더) 추가

87e8ce9

feat: docker-compose 생성 및 MySQL 설정 정보 추가

1f5e697

docs: build.gradle 파일 설명 추가

d6bb666

feat: User, Post 엔티티 생성

c58a916

fix: 테이블이 생성되지 않는 오류 해결

6bb6abf

docs: build.gradle validation 의존성 추가

e8f6b86

feat: User, Post validation 추가

58287d3

test: 변수명 변경 (created -> savedXXX)

ca16187

feat: User 생성 요청, 응답 dto 생성

b81f1a7

feat: User, Post repository 생성

03af911

feat: User service 생성 및 유저 저장 메서드 추가

5c3c12d

test: User service 유저 저장 테스트 수행

21f8ac1

test: 테스트 포맷을 BDD에 맞게 수정

b667e3b

feat: 유저 생성 controller 추가

32874c0

feat: Post validation 추가

9b77607

feat: 게시글 작성 기능 추가

b8e25d4

test: 게시글 생성 테스트 수행

2a036f1

docs: rest api 문서 생성

7a81961

refactor: 구체적인 에러로 변경 (IllegalArgumentException -> EntityNotFoundExce…

86c1a43

…ption)

feat: 전역 에러 핸들러 생성

711432d

test: 게시글 생성 실패 테스트 수행

fbd98c3

feat: 게시글 수정 기능 추가

9b0ef42

test: 게시글 수정 테스트 수행

4ddf132

docs: post-request.http 게시글 수정 요청 추가

5f988c9

feat: 게시글 단건 조회 기능 추가

b62011a

test: 게시글 단건 조회 테스트 수행

ca8feb3

docs: post-request.http 게시글 단건 조회 요청 추가

d098b3c

feat: 게시글 다건 조회 기능 추가

3471380

docs: post-request.http 게시글 다전 조회 요청 추가

70b8862

yenzip and others added 16 commits November 21, 2023 20:19

feat: 게시글 다건 조회 및 페이지 관련 응답 dto 생성

188942d

refactor: 게시글 다건 조회 반환형 변경 (PostResponse -> ListResponse)

4118271

test: 게시글 다건 조회 반환형 변경 (PostResponse -> ListResponse)

0e749c7

docs: post-request.http 다건 조회 요청 수정

2482671

test: 게시글 다건 조회 API 문서 작성

1037d7f

test: 게시글 수정, 단건 조회 API 문서 작성

6ffce2f

docs: 게시글 수정, 단건 조회, 다건 조회 추가

7bac8d5

docs: index.html 추가

cc8f3b0

refactor: response 리팩토링

02d3b52

docs: Message Source로 에러 메시지 관리

a5030f0

errors.properties 추가

refactor: 에러 메시지 리팩토링

68b06f7

feat: Post, User, CreateUserRequest 유효성 검사 추가

da180dd

refactor: @transaction(readOnly = true)를 클래스단에 설정

664f5b6

test: 테스트 리팩토링

e6dae44

refactor: 전체적인 코드 리팩토링

17e286c

docs: index.html 수정

7d72a2f

yenzip added 🔥 매운맛 Team-Marco labels Nov 21, 2023

yenzip requested review from ASak1104 and Sehee-Lee-01 November 21, 2023 14:00

yenzip assigned uijin-j and yenzip Nov 21, 2023

yenzip changed the base branch from main to YU November 21, 2023 14:01

fix: response dto 생성자 추가로 오류 해결

eb15530

Sehee-Lee-01 reviewed Nov 23, 2023

View reviewed changes

yenzip requested review from ksy90101 and twotwobread November 25, 2023 16:38

ASak1104 reviewed Nov 25, 2023

View reviewed changes

twotwobread reviewed Nov 30, 2023

View reviewed changes

		@PatchMapping("/{id}")
		public ResponseEntity<PostResponse> updatePost(@PathVariable Long id, @Valid @RequestBody UpdatePostRequest request) {

		parameterWithName("page").description("페이지"),
		parameterWithName("size").description("페이지 크기")

		assertThatThrownBy(() -> postService.createPost(request))
		.isInstanceOf(ConstraintViolationException.class);

		import org.prgms.springbootboardjpayu.dto.response.UserResponse;

		public final class UserConverter {

[5기 엄예림, 정의진] Spring Boot JPA 게시판 구현 미션 제출합니다. #265

Are you sure you want to change the base?

[5기 엄예림, 정의진] Spring Boot JPA 게시판 구현 미션 제출합니다. #265

Conversation

yenzip commented Nov 21, 2023 • edited by voidmelody Loading

📌 과제 설명

👩‍💻 요구 사항과 구현 내용

API를 구현한다.

✅ 실행 방법

✅ PR 포인트 & 궁금한 점

Sehee-Lee-01 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sehee-Lee-01 Nov 23, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ASak1104 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ASak1104 Nov 25, 2023 • edited Loading

Choose a reason for hiding this comment

uijin-j Dec 1, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yenzip commented Nov 21, 2023 •

edited by voidmelody

Loading

Sehee-Lee-01 Nov 23, 2023 •

edited

Loading

ASak1104 Nov 25, 2023 •

edited

Loading

uijin-j Dec 1, 2023 •

edited

Loading