[4기 김민희,박세영] Spring Boot JPA로 게시판 구현 미션 제출합니다. #261

KimMinheee · 2023-08-08T07:26:49Z

📌 과제 설명

요구 사항

SpringDataJPA 를 설정한다.

datasource : h2 or mysql

엔티티를 구성한다

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

API를 구현한다.

Post

게시글 조회
- 페이징 조회 (GET "/posts")
- 단건 조회 (GET "/posts/{postId}")
- 작성자 페이징 조회 (GET "/posts/user/{userId}")
게시글 작성 (POST "/posts/{userId}")
게시글 수정 (POST "/posts/{postId}/user/{userId}")
게시글 삭제 (DELETE "/posts/{postId}/user/{userId}")

User

유저 조회
- 페이징 조회 (GET "/posts")
- 단건 조회 (GET "/users/{userId}")
게시글 작성 (POST "/users/{userId}")
게시글 삭제 (DELETE "/users/{userId}")

REST-DOCS를 이용해서 문서화한다.

SpringRestDocs를 활용하여 index.html, post.html, user.html 페이지를 각각 구현하였습니다.

- PermissionDeniedException - PostNotFoundException

- Controller & Service

wonu606 · 2023-08-08T08:48:35Z

src/test/java/com/blackdog/springbootBoardJpa/user/controller/UserControllerTest.java

+                                fieldWithPath("userResponses").type(JsonFieldType.OBJECT).description("유저 응답"),
+                                fieldWithPath("userResponses.content[]").type(JsonFieldType.ARRAY).description("유저 정보 배열"),
+                                fieldWithPath("userResponses.content[].id").type(JsonFieldType.NUMBER).description("유저 아이디"),
+                                fieldWithPath("userResponses.content[].name").type(JsonFieldType.STRING).description("유저 이름"),
+                                fieldWithPath("userResponses.content[].age").type(JsonFieldType.NUMBER).description("유저 나이"),
+                                fieldWithPath("userResponses.content[].hobby").type(JsonFieldType.STRING).description("유저 취미"),
+                                fieldWithPath("userResponses.content[].createdAt").type(JsonFieldType.STRING).description("유저 생성일"),
+                                fieldWithPath("userResponses.content[].updatedAt").type(JsonFieldType.STRING).description("유저 갱신일"),
+                                fieldWithPath("userResponses.pageable").type(JsonFieldType.OBJECT).description("pageable").ignored(),
+                                fieldWithPath("userResponses.last").type(JsonFieldType.BOOLEAN).description("last").ignored(),
+                                fieldWithPath("userResponses.totalElements").type(JsonFieldType.NUMBER).description("totalElements"),
+                                fieldWithPath("userResponses.totalPages").type(JsonFieldType.NUMBER).description("totalPages"),
+                                fieldWithPath("userResponses.size").type(JsonFieldType.NUMBER).description("size").ignored(),
+                                fieldWithPath("userResponses.number").type(JsonFieldType.NUMBER).description("number").ignored(),
+                                fieldWithPath("userResponses.sort.empty").type(JsonFieldType.BOOLEAN).description("sort.empty").ignored(),
+                                fieldWithPath("userResponses.sort.sorted").type(JsonFieldType.BOOLEAN).description("sort.sorted").ignored(),
+                                fieldWithPath("userResponses.sort.unsorted").type(JsonFieldType.BOOLEAN).description("sort.unsorted").ignored(),
+                                fieldWithPath("userResponses.first").type(JsonFieldType.BOOLEAN).description("first").ignored(),
+                                fieldWithPath("userResponses.numberOfElements").type(JsonFieldType.NUMBER).description("numberOfElements").ignored(),
+                                fieldWithPath("userResponses.empty").type(JsonFieldType.BOOLEAN).description("empty").ignored()


아직 서비스 배포를 해본 경험이 없어, 이 정보들이 클라이언트에서 필요한지 모르겠습니다.
필요한 정보들인가용?🤔

저희는 JPA pageable을 사용하기 때문에 asciidocs에서 모든 pageable 속성을 명시해줘야 했습니다.
필요한 정보만 노출하는 방법은 필요한 Page 속성을 가진 새로운 DTO를 도입하는 것입니다.
하지만, 저희는 Page 를 감싸고 있는 DTO를 정의해 사용하고 있기 때문에 모든 필드를 명시하는 방향으로 작성했습니다.

JaeyoungAhn

민희님, 세영님 과제하신다고 고생 많으셨습니다!

전체적으로 코드가 깔끔하고 테스트와 에러 처리도 꼼꼼히 하신 것을 보아 얼마나 열심히 하셨을지가 보입니다 ㅎㅎ

오히려 제가 배워서 프로젝트에 적용해봐야 할 것들도 많이 보였던 것 같습니다. 다시 한번 수고하셨습니다!

JaeyoungAhn · 2023-08-08T09:07:57Z

src/main/resources/application.yml

설정 파일 내 민감 정보를 노출 시키지 않기 위해 관리 툴이나 환경변수와 같은 것들을 사용할 수 있을 것 같습니다!

Jasypt 모듈을 사용해서 yaml 파일 보안했습니다.

JaeyoungAhn · 2023-08-08T09:24:06Z

src/test/java/com/blackdog/springbootBoardJpa/user/controller/UserControllerTest.java

+    @ParameterizedTest
+    @DisplayName("유저를 전체 조회한다.")
+    @MethodSource("userCreateRequest_Data")
+    void getAllUsers_Pageable_ReturnResponses(List<UserCreateRequest> requests) throws Exception {


파라미터 requests가 코드 내에서 사용되고 있지 않은 것 같습니다!

JaeyoungAhn · 2023-08-08T10:59:33Z

src/main/java/com/blackdog/springbootBoardJpa/global/response/ErrorCode.java

이렇게 깔끔하게 정리되어있으면 에러 응답을 해줄 때 편하겠다는 생각이 듭니다!

에러 코드를 정말 깔끔하게 관리하셨군요!!

심지어 사용하는 도메인별로 나누어 놓으셔서 더 보기 좋은 것 같습니다!!

young970 · 2023-08-09T09:52:27Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/service/PostService.java

+                .findById(postId)
+                .orElseThrow(() -> new PostNotFoundException(NOT_FOUND_POST));
+
+        if (!Objects.equals(targetPost.getUser().getId(), userId)) {


이런 조건 특히 !가 들어간 조건문은 다른 개발자가 코드를 해석할때 가독성을 저하시킬 수 있을것 같아요...

isNotOwner 이런 느낌의 메서드명으로 분리하는건 어떻게 생각하시나요??ㅎㅎ

boolean isNotOwner = !Objects.equals(targetPost.getUser().getId(), userId)

targetPost.isOwner(userId)

young970 · 2023-08-09T13:34:56Z

src/test/resources/application-test.yml

+        hibernate:
+          type:
+            descriptor:
+              sql: trace


현재 테스트 코드내에서 test 프로파일 설정된 곳이 없어 이 yml파일이 필요 없을것 같습니다!!

young970 · 2023-08-10T08:48:16Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/model/Post.java

+        this.content = content;
+    }
+
+    public void changePost(PostUpdateRequest post) {


엔티티가 서비스 레이어에 있는 dto에 의존하는것이 저는 좀 어색한 것 같아요ㅎㅎ

이렇게 되면 단방향을 지키기 위해 controller와 service레이어의 dto를 따로 나누었는데

정작 entity와 service간에 양방향이 생기고 있다고 저는 생각듭니다!!

민희님과 세영님은 어떻게 생각하시나요??

사실 이정도면 그냥 title, content로 쪼개도 괜찮다고 생각합니다 ㅎㅎ 굳이 request 객체 넘기지 않고요.

방향에 대한 고려로 크게 두 가지 해결법을 생각해봤습니다.

DTO 사용말고 분해해서 파라미터로 넘기는 방법

Entity가 있는 model 패키지 안에서 별도로 Converter와 DTO를 따로 생성해서 사용

저희는 컨벤션으로 5개 미만의 필드인 경우에는 따로 DTO를 만들지 않고 1번 방법처럼 분해해서 사용하는 것이 좋다고 생각합니다.

young970

민희님 세영님 깔끔하고 좋은 코드 잘 봤습니다!!ㅎㅎ

덕분에 에러 코드 관리, 깔끔한 테스트 코드 작성 이 밖에 언급하지 않은 기타 등등
많이 배웠습니다ㅎㅎ

과제하시느라 고생 많으셨습니다!! 👍

WooSungHwan

코드가 전반적으로 깔끔하네요 ㅎㅎ 리뷰내용 많이 달아놓긴 했지만 계속 인지시켜줘야하는 부분이라서 request change 까지는 필요 없을 것 같습니다. 하지만 반드시 리뷰내용은 검토하고 지나갔으면 좋겠습니다. 수고하셨습니다!

WooSungHwan · 2023-08-10T10:46:37Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/controller/PostController.java

+        this.controllerConverter = controllerConverter;
+    }
+
+    @PostMapping(value = "/{userId}", consumes = MediaType.APPLICATION_JSON_VALUE)


consumes 보다는 produces가 모아두기 좋겠네요. body가 없는데 굳이 consumes를 둘 필요가 없어서요.

WooSungHwan · 2023-08-10T10:48:09Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/controller/PostController.java

+                .body(postService.savePost(userId, controllerConverter.toCreateRequest(createDto)));
+    }
+
+    @PatchMapping(value = "/{postId}/user/{userId}", consumes = MediaType.APPLICATION_JSON_VALUE)


path 로 쓰는것 같은데 여기는 흘리셨네요 ㅎㅎ

WooSungHwan · 2023-08-10T10:49:15Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/controller/PostController.java

+                .status(HttpStatus.OK)
+                .body(postService.findPostsByUserId(userId, pageable));
+    }
+


getAllPosts 와 getPostsByUserId 두 API는 통합할 수 있을 것 같은데요?

검색 조건에 userId를 넣는다는 생각으로 통합할 수 있을 것 같아요 🐣

requestParam을 사용하여 getAllPosts와 getPostsByUserId 두 API 통합하는 방식으로 수정했습니다!

WooSungHwan · 2023-08-10T10:49:52Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/controller/PostController.java

+                .body(postService.findPostById(postId));
+    }
+
+    @GetMapping(value = "/user/{userId}", produces = MediaType.APPLICATION_JSON_VALUE)


?userId=xxx 로 request parameter 사용 권장.
불필요한 path 인것 같아요. 여기는 post 도메인이니

WooSungHwan · 2023-08-10T10:50:22Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/controller/dto/PostCreateDto.java

+        @NotBlank
+        String title,
+
+        @NotNull
+        @Size(max = 255)
+        String content


메시지를 명시해주는게 좋을 것 같습니다.

WooSungHwan · 2023-08-10T11:02:12Z

src/main/java/com/blackdog/springbootBoardJpa/domain/user/model/vo/Name.java

+@Embeddable
+public class Name {
+
+    @NotBlank


not blank도 생성자에서 해주는게 더 좋겠네요.

참고로 생성자 파라미터에 갖다 붙이라는게 아니라 StringUtils.isNotBlank(name) 혹은 require(StringUtils.isNotBlank(name)) 이런 내용이 코드에 있어야 한다는 이야기입니다.

StringUtils.isNotBlank가 딱 원하는 메소드라 생성자에 넣어두었습니다.

WooSungHwan · 2023-08-10T11:03:49Z

src/main/java/com/blackdog/springbootBoardJpa/domain/user/service/UserService.java

+
+    @Transactional
+    public UserResponse saveUser(@Valid UserCreateRequest dto) {
+        return converter.toResponse(repository.save(converter.toEntity(dto)));


WooSungHwan · 2023-08-10T11:06:19Z

src/main/java/com/blackdog/springbootBoardJpa/global/exception/GlobalExceptionHandler.java

+        log.warn("{}", errorResponse);
+        log.warn("{}", e.getCause());
+        return ResponseEntity
+                .status(HttpStatus.NON_AUTHORITATIVE_INFORMATION)


상태 정의가 틀린것 같은데요.

403으로 변경했습니다

WooSungHwan · 2023-08-10T11:10:03Z

src/test/java/com/blackdog/springbootBoardJpa/post/service/PostServiceTest.java

+
+    @ParameterizedTest
+    @DisplayName("존재하는 유저로 게시글을 생성하면 성공한다.")
+    @MethodSource("providePostCreateRequest")


providePostCreateRequest 텍스트 오타가 발생하는 경우에 type safe하게 호출하긴 어려울 것 같아요.
ArgumentsSource 를 한번 알아봅세다.

ArgumentSource를 이용하여 데이터를 주입받는 방식으로 변경했습니다!
(inner static 클래스 이용)

WooSungHwan · 2023-08-10T11:14:33Z

src/test/java/com/blackdog/springbootBoardJpa/post/service/PostServiceTest.java

+
+@SpringBootTest
+@Transactional
+class PostServiceTest {


전체 테스트 코드중에 service 테스트위주로 진행되었는데. web 계층에 선언해놓은 validation 코드는 어떻게 테스트가 되고 있는지도 돌아보면 좋을 것 같습니다.

byeolhaha · 2023-08-14T16:27:06Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/controller/PostController.java

+                .status(HttpStatus.OK)
+                .body(postService.findPostsByUserId(userId, pageable));
+    }
+


검색 조건에 userId를 넣는다는 생각으로 통합할 수 있을 것 같아요 🐣

byeolhaha · 2023-08-14T16:29:45Z

src/main/java/com/blackdog/springbootBoardJpa/domain/post/model/Post.java

+    private Long id;
+
+    @Column(nullable = false)
+    private String title;


내부적으로 new 연산자를 통해서 title이 빈 값이 들어온다면, 테스트 코드의 경우 null 상태의 title을 만들 수 있는데 어떻게 방어할 수 있을까요? 🐣

byeolhaha · 2023-08-14T16:32:51Z

src/main/java/com/blackdog/springbootBoardJpa/domain/user/model/vo/Age.java

+
+    @Column(nullable = false)
+    @Positive
+    private int ageValue;


만약 사용자가 2000살이라고 잘못 입력하면 어떻게 될까요? 🐣

- final 키워드 추가 - PermissionDeniedHandler http 코드 수정

- 작성자 여부 확인하는 boolean 변수 추출 - 개행

KimMinheee added 26 commits August 2, 2023 21:27

[Feat] : 프로젝트 세팅

88ba28d

[Feat] : 의존성 세팅

4f57ecf

[Feat] : yml 파일 세팅

1cd3687

[Feat] : BaseEntity 구현

4a0852f

[Feat] : 클래스 다이어그램 작성

386cc4b

[Feat] : User 엔티티 추가

cea7c3f

[Feat] : User 컨트롤러 구현

21e4803

[Feat] : User Controller Dto 및 Converter 구현

5810a42

[Feat] : User Service 구현

08da48d

[Feat] : User Service Dto 및 Converter 구현

5a59911

[Feat] : UserNotFoundException 구현

2698eb3

[Feat] : ErrorCode 및 GlobalExceptionHandler 구현

0235e6d

[Feat] : ErrorResponse 구현

952e6ac

[Feat] : SuccessCode 구현

3494d20

[Feat] : Post 엔티티 구현

798c2a4

[Feat] : Post Controller 구현

43329b2

[Feat] : Post Controller Dto 및 Converter 구현

8e435e5

[Feat] : Post Service 구현

0a0843e

[Feat] : Post Service Dto 및 Converter 구현

4b77c1e

[Feat] : Custom Exception 구현

46db2d2

- PermissionDeniedException - PostNotFoundException

[Feat] : PostRepository 구현

7d99660

[Feat] : UserRepository 구현

9c5c72a

[Test] : User 테스트 코드 작성

4380410

- Controller & Service

[Test] : Post 테스트 코드 작성

d088b35

- Controller & Service

[Test] : RestDocs 문서 작성

33e57f3

[Style] : RestDocs html 문서 생성

cbd4c79

KimMinheee added 🔥 매운맛 Team-Blackdog labels Aug 8, 2023

KimMinheee requested review from JaeyoungAhn and WooSungHwan August 8, 2023 07:26

wonu606 approved these changes Aug 8, 2023

View reviewed changes

JaeyoungAhn approved these changes Aug 8, 2023

View reviewed changes

young970 reviewed Aug 9, 2023

View reviewed changes

young970 reviewed Aug 10, 2023

View reviewed changes

young970 approved these changes Aug 10, 2023

View reviewed changes

WooSungHwan approved these changes Aug 10, 2023

View reviewed changes

byeolhaha reviewed Sep 5, 2023

View reviewed changes

KimMinheee added 21 commits September 29, 2023 19:26

[Refactor] : Dto 내 message 추가

189ba50

[Refactor] : PostController @RequestMapping 수정 및 api 주석 추가

4fef777

[Refactor] : Post entity 클래스 내 @getter 및 생성자 내부 검증 코드 추ㄱ

d7caca4

[Refactor] : Response Dto 클래스 내 @Valid 검증 어노테이션 삭제

66fa377

[Feat] : SuccessResponse 클래스 생성 및 삭제시 사용 코드 추가

9826104

[Refactor] : GlobalExceptionHandler 내 코드 일부 수정

5a7bf8a

- final 키워드 추가 - PermissionDeniedHandler http 코드 수정

[Refactor] : ErrorResponse 내 get메소드 추가 & 개행

b0b633b

[Refactor] : PostService 코드 수정

aa1eb85

- 작성자 여부 확인하는 boolean 변수 추출 - 개행

[Feat] : JasyptTest 관련 코드 추가

281491a

[Test] : PostControllerTest 코드 수정

054756d

[Test] : PostServiceTest 코드 수정

dc1636e

[Test] : UserControllerTest 코드 수정

7ba24e2

[Feat] : application-test.yml 파일 추가

92e3699

[Feat] : jascypt 의존성 추가

4ab0ba7

[Feat] : gitignore에 jasycpt 관련 파일 추가

9f5c9a5

[Test] : UserControllerTest 코드 수정

c20d65b

[Feat] : jascypt 적용을 위한 application.yml 파일 수정

7aa2c20

[Refactor] : PostService 코드 수정

d06196c

[Style] : 코드 개행

ded9b9e

[Refactor] : UserController 수정

46e48ef

[Refactor] : (Age, Name) vo 내 유효성 검사 코드 추가

1d35fc3

[4기 김민희,박세영] Spring Boot JPA로 게시판 구현 미션 제출합니다. #261

Are you sure you want to change the base?

[4기 김민희,박세영] Spring Boot JPA로 게시판 구현 미션 제출합니다. #261

Conversation

KimMinheee commented Aug 8, 2023

📌 과제 설명

요구 사항

SpringDataJPA 를 설정한다.

엔티티를 구성한다

API를 구현한다.

Post

User

REST-DOCS를 이용해서 문서화한다.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JaeyoungAhn 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

young970 Aug 9, 2023 • edited

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

young970 Aug 10, 2023 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

young970 left a comment

Choose a reason for hiding this comment

WooSungHwan 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

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

young970 Aug 9, 2023 •

edited

young970 Aug 10, 2023 •

edited