[1기-P] 김다희 - JPA 게시판 구현하기 #30

0923kdh · 2021-10-15T04:41:23Z

📌 과제 설명

SpringDataJPA를 설정한다. (h2 or MySQL)
엔티티를 구성한다.
API를 구현한다.
테스트코드를 작성한다.
REST-DOCS를 이용해 문서화 한다.

💻 개발 환경

IDE : IntelliJ
개발 언어 : Java 17
프레임워크 : SpringBoot 2.5.5
라이브러리 : JPA
빌드도구 : Maven 3.8.2
데이터베이스 : AWS RDS MySQL 8.0.26

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

📍 엔티티 구성

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

📍 API 구현

User API

유저 생성
* POST /users

유저 조회
* GET /users/{userId}

유저 수정
* PUT /users/{userId}

유저 삭제
* DELETE /users/{userId}

Post API

포스트 생성
* POST /posts

포스트 조회
* GET /posts/{postId}

특정 유저가 작성한 포스트 전체 조회
* GET /posts/list/{postId}

포스트 수정
* PUT /posts/{postId}

포스트 삭제
* DELETE /posts/{postId}

ERD

Directory

- 포스트 생성 - 포스트 조회 - 특정 유저가 작성한 포스트 전체 조회 - 포스트 수정 - 포스트 삭제

taehyunnn

테트리스 장인 다희님 코드 깔끔하네요 ㅎ
옥상에서 늦게까지 공부도 열심히 하시고
질문도 많이 하는 모습 멋집니다!!
따봉~ 👍

src/main/java/com/prgrms/board/controller/PostController.java

src/main/java/com/prgrms/board/domain/Post.java

src/main/java/com/prgrms/board/dto/post/PostCreateRequest.java

src/main/java/com/prgrms/board/error/ValidExceptionHandler.java

taehyunnn · 2021-10-15T10:02:31Z

src/test/java/com/prgrms/board/repository/PostRepositoryTest.java

+@Transactional
+@SpringBootTest
+class PostRepositoryTest {


@SpringBootTest 대신에 @DataJpaTest를 쓰는걸 추천드립니다~
SpringBootTest를 쓰면 JPA와 관련 없는 모든 빈들까지 다 등록이 되지만,
DataJpaTest는 JPA 관련 빈들만 등록합니다

이 부분은 적용해보았더니 오류가 .. 납니다!...

0923kdh · 2021-10-16T07:38:52Z

@sangmin7648 @eunseo2 리뷰 부탁 드립니다!

src/main/java/com/prgrms/board/BoardApplication.java

src/main/java/com/prgrms/board/domain/Post.java

sangmin7648 · 2021-10-16T12:06:12Z

src/main/java/com/prgrms/board/domain/Post.java

+        this.content = content;
+    }
+
+    public void changeInfo(String title, String content){


changeInfo라는 이름이 저는 조금 모호하게 느껴지는게 어떤가요?🤔

changePostInfo로 적용해보았는데.. 어떠신가요..?!

src/main/java/com/prgrms/board/domain/User.java

sangmin7648 · 2021-10-16T13:01:28Z

src/main/java/com/prgrms/board/dto/post/PostCreateRequest.java

+public record PostCreateRequest(
+        @Positive Long userId,
+        @NotBlank(message = "제목이 비어있습니다.") @Length(max = 250) String title,
+        String content) {
+}


Suggested change

public record PostCreateRequest(

@Positive Long userId,

@NotBlank(message = "제목이 비어있습니다.") @Length(max = 250) String title,

String content) {

}

public record PostCreateRequest(

@Positive

Long userId,

@NotBlank(message = "제목이 비어있습니다.") @Length(max = 250)

String title,

String content

) {

}

레코드 어떻게 쓰는지 잘모르지만, 일단 포메팅을 한번 바꿔봤습니다! 저렇게해도 돌아가는지 궁금하네요 ㅋㅋㅋ

바꾼 포메팅도 잘 돌아가네요!! ㅋㅋㅋㅋ

전 개인적으로 필드 어노테이션은 new line 이 좋은 것 같습니다.

src/main/java/com/prgrms/board/error/ValidErrorResponse.java

sangmin7648 · 2021-10-16T13:07:44Z

src/main/java/com/prgrms/board/error/ValidExceptionHandler.java

+import org.springframework.web.bind.annotation.RestControllerAdvice;
+
+@RestControllerAdvice
+public class ValidExceptionHandler {


Suggested change

public class ValidExceptionHandler {

public class InvalidExceptionHandler {

마찬가지로 또는 NotValidExceptionHandler가 어떤가요?

이 부분도 InValidExceptionHandler로 적용하였습니다~

src/main/java/com/prgrms/board/service/PostService.java

.gitignore

src/main/java/com/prgrms/board/controller/PostController.java

eunseo2 · 2021-10-16T15:10:23Z

src/main/java/com/prgrms/board/domain/Post.java

+    @Lob
+    private String content;


@ Lob을 쓰면 nullable = false를 할 수 없는 단점이 있더라구여!🙄
찾아본 결과 이렇게도 바꿀 수 있었습니다!

@Column(name = "content", nullable = false, columnDefinition = "TEXT") private String content;

src/main/java/com/prgrms/board/service/PostService.java

src/main/java/com/prgrms/board/controller/PostController.java

0923kdh · 2021-10-18T16:30:49Z

@neilsonT @sangmin7648 @eunseo2 리뷰주신 부분 반영하였습니다! 꼼꼼한 코드리뷰 감사합니다!

hanjo8813

지나가다 들렸읍니다. 정말 잘하셨네요
스윽 보고 갑니다~

hanjo8813 · 2021-10-19T01:27:43Z

src/main/java/com/prgrms/board/service/PostService.java

+@Transactional
+@Service
+public class PostService {


다희님 하이~ 지나가다 들렸는데요
클래스 전체에 @Transactional(readOnly = true)로 범위를 좁혀서 걸어놓고,
조회하는 메소드에는 어노테이션을 생략하구 테이블 변경시키는 어노테이션에만 @Transactional 달아줘도 될것 같아여
지금 어노테이션이 중복되서 쫌 들어가있는것 같아서용

오 ! 이 부분은 조금 더 공부해보고 재원님이 말씀해주신 방향으로 반영하도록 하겠습니다 ! 감사합니다~!

hanjo8813 · 2021-10-19T01:30:31Z

src/main/java/com/prgrms/board/domain/User.java

+    @Builder
+    private User(Long id, String name, int age, String hobby){
+        this.id = id;
+        this.name = name;
+        this.age = age;
+        this.hobby = hobby;
+    }
+
+    public void changeUserInfo(String name, int age, String hobby){
+        this.name = name;
+        this.age = age;
+        this.hobby = hobby;
+    }


다희님 언제부터 이렇게 객체지향적 사람으로 성장하셨나요
저도 객체지향맨이 되기 위해 분발하겠습니다

ㅋㅋㅋㅋ칭찬 감사합니다! 저도 재원님의 열쩡에 항상 동기부여 받고 갑니당

hanjo8813 · 2021-10-19T01:31:27Z

src/main/java/com/prgrms/board/controller/PostController.java

+    @PutMapping("/{id}")
+    public ResponseEntity<IdResponse> modifyPost(final @PathVariable Long id, final @Valid @RequestBody PostModifyRequest postModifyRequest){


요거 PATCH 메소드가 더 Restful 할것같아요~~

아! 저는 많은 부분을 수정할때는 put이 더 어울린다고 생각합니다! 주로 1개의 필드를 수정할 때 패치를 사용하는게 적절하다고 생각합니다! PUT 과 PATCH 에 대해서 재원님은 어떻게 생각하시나요?

PUT은 모든 컬럼을 업데이트 시켜줄때 사용한다고 해여
https://programmer93.tistory.com/39 이 블로그 참고해보세용

0923kdh · 2021-10-21T13:09:19Z

@hanjo8813 리뷰 감사합니다!🌱

…dler )

Jo-GyuHyeon · 2021-10-23T13:52:29Z

src/main/java/com/prgrms/board/controller/PostFilterController.java

+import org.springframework.web.bind.annotation.*;
+
+@RestController
+public class PostFilterController {


어떤 필터링을 하죠??? 네이밍을 보면 게시물 필터링 기능을 모아둔것 처럼 느껴집니다.
제가 잘 파악하였나요?

검색용 API만 모아두실 의도로 만드신것같은데.
이렇게 별도로 나누신 이유는 뭔가요??

Jo-GyuHyeon · 2021-10-23T13:55:12Z

src/main/java/com/prgrms/board/domain/BaseEntity.java

+public class BaseEntity {
+
+    @CreatedDate
+    private LocalDateTime createdAt;


기본값을 지정 해도 좋을 것 같습니다.

Jo-GyuHyeon · 2021-10-23T14:02:38Z

src/main/java/com/prgrms/board/domain/Post.java

+
+    public void changePostInfo(String title, String content){
+        this.title = title;
+        this.content = content;


this.updatedAt 필드도 함께 업데이트 해주는건 어떨까요? 단 이때는 파라미터로 입력 받지 않고 블럭 내에서 날짜를 대입 해주면 좋을 것 같습니다.

Jo-GyuHyeon · 2021-10-23T14:03:58Z

src/main/java/com/prgrms/board/domain/User.java

+import lombok.Getter;
+import lombok.NoArgsConstructor;
+
+import javax.persistence.*;


Static 하지 않다면 와일드 카드보다는 single import 를 할 수 있도록 ide 설정을 해보세요 :)

Jo-GyuHyeon · 2021-10-23T14:05:39Z

src/main/java/com/prgrms/board/dto/IdResponse.java

+import lombok.Getter;
+
+@Getter
+public class IdResponse {


id를 위해 DTO 가 필요할까요?

Jo-GyuHyeon · 2021-10-23T14:12:24Z

src/main/java/com/prgrms/board/dto/post/PostCreateRequest.java

+public record PostCreateRequest(
+        @Positive Long userId,
+        @NotBlank(message = "제목이 비어있습니다.") @Length(max = 250) String title,
+        String content) {
+}


전 개인적으로 필드 어노테이션은 new line 이 좋은 것 같습니다.

Jo-GyuHyeon · 2021-10-23T14:42:47Z

src/main/java/com/prgrms/board/service/PostService.java

+        return postRepository.findById(id).orElseThrow(() -> new NotFoundException("해당 게시글을 찾을 수 없습니다."));
+    }
+
+    private User getUser(final Long id) {


해당 메서드는 UserService 에서 작성하는 것이 좋을 것 같습니다.

Jo-GyuHyeon · 2021-10-23T14:47:36Z

src/main/java/com/prgrms/board/service/PostService.java

+    }
+
+    private User getUser(final Long id) {
+        return userRepository.findById(id).orElseThrow(() -> new NotFoundException("해당 사용자를 찾을 수 없습니다."));


message 에 id 값을 다시 넣어 주셔도 좋을 것 같습니다.
내부데이터가 아닌 사용자의 입력 값은 다시 반환 해도 상관없다고 생각합니다.

에러 메시지도 코드가 아닌 propertise 로 관리해봐도 좋을 것 같네요.

Jo-GyuHyeon · 2021-10-23T14:53:56Z

src/main/java/com/prgrms/board/service/UserService.java

+    @Transactional
+    public IdResponse modifyUser(final Long id, final UserCreateRequest userCreateRequest){
+        User user = getUser(id);
+        user.changeUserInfo(userCreateRequest.getName(), userCreateRequest.getAge(), userCreateRequest.getHobby());


UserCreateRequest 네이밍이 길어 지다 보니 인자 3개만 넣어도 길이가 길어지고 가독성이 높은가? 라는 의문도 있습니다.
이럴땐 예외적으로 변수명을 줄여도 좋을 것 같습니다.

Jo-GyuHyeon · 2021-10-23T14:55:21Z

src/main/resources/application.yml

+
+  datasource:
+    driver-class-name: com.mysql.cj.jdbc.Driver
+    url: ${DATABASE_URL}


Jo-GyuHyeon · 2021-10-23T15:26:44Z

src/main/java/com/prgrms/board/customValidation/NameValidator.java

+
+    @Override
+    public boolean isValid(String field, ConstraintValidatorContext cxt){
+        return field != null && field.matches("^[가-힣a-zA-Z]*$");


"^[가-힣a-zA-Z]*$" 는 static final String 으로 따로 빼도 좋을 것 같습니다.

DevRunner21

지나가다가 리뷰 남겨봅니다.

전체적으로 좋은 코드를 짜기 위해 엄청 고민하고 노력하셨다는게 보이는 코드였습니다!
저도 이렇게 열정적으로 해야하는데 ㅜㅜ 반성하고 갑니다.

DevRunner21 · 2021-10-24T09:11:51Z

src/main/java/com/prgrms/board/controller/PostController.java

+    }
+
+    @PostMapping
+    public ResponseEntity<IdResponse> createPost(@Valid @RequestBody PostCreateRequest postCreateRequest){


요기만 final이 빠져있습니다! ㅎㅎ

DevRunner21 · 2021-10-24T09:44:51Z

src/main/java/com/prgrms/board/dto/post/PostModifyRequest.java

+    @NotBlank(message = "제목이 비어있습니다.")
+    private String title;
+
+    private String content;


Entity에는 길이 제한 조건이 걸려있는데 , DTO에는 이에 대한 Validation Check 없군요.
DTO에도 이에 대한 Check를 해주면 좋을 것 같습니다! ㅎㅎ

DevRunner21 · 2021-10-24T10:00:46Z

src/main/java/com/prgrms/board/service/PostService.java

+
+    @Transactional(readOnly = true)
+    public Page<PostFindResponse> findAllPostByUserId(Pageable pageable, final Long userId){
+        User user = getUser(userId);


취향차이이긴 합니다만 "getUser()" 라는 네이밍이 뭔가 일반적인 Getter랑 네이밍 방식이 똑같다보니
개발하다가 햇갈릴 수도 있을 것 같습니다.
"get**"말고 "find**" 같은 네이밍은 어떨까요?

DevRunner21 · 2021-10-24T10:09:28Z

src/main/java/com/prgrms/board/dto/post/PostFindResponse.java

+@Getter
+public class PostFindResponse {
+
+    private Long id;
+
+    private String title;
+
+    private String content;
+
+    private LocalDateTime createdAt;
+
+    private LocalDateTime updatedAt;
+


작성자에 대한 정보도 같이 내려줘보는건 어떨까요?
하나의 Entity만 내려주기 보다는 연관된 2가지 Entity의 정보를 같이 내려줘보시면
거기서도 공부가 되시는 부분이 있을 것 같습니다! ( 페치조인이라던가, 배치사이즈 라던가.. ㅎㅎ )

DevRunner21 · 2021-10-24T12:26:32Z

src/main/java/com/prgrms/board/controller/PostFilterController.java

+import org.springframework.web.bind.annotation.*;
+
+@RestController
+public class PostFilterController {


검색용 API만 모아두실 의도로 만드신것같은데.
이렇게 별도로 나누신 이유는 뭔가요??

DevRunner21 · 2021-10-24T12:39:16Z

src/main/java/com/prgrms/board/error/InvalidErrorResponse.java

+public record InvalidErrorResponse(String field, String message) {
+
+    @Builder
+    public InvalidErrorResponse {
+    }
+
+}


GlobalErrorResponse과는 다르게 InvalidErrorResponse는 record를 사용하셨는데,
그냥 class가 아닌 record를 사용하신 이유는 뭔가요?

InvalidErrorResponsed와 GlobalErrorResponse 두개로 나눠서 사용하고 계시는군요.
혹시 이렇게 두가지로 나눠서 사용하시는 이유가 있나요?
저같은 경우 ErrorResponse를 하나로 사용하고 있다보니.. ㅎㅎ

제 생각에는 현재 발생한 예외가 뭔지 구분할 에러코드도 같이 내려준다면 더 좋지 않을까 합니다.

만약 클라이언트 개발자가 에러객체를 받았을 때,
나눠주신 두가지 에러객체를 어떻게 구분해서 그에 맞는 로직을 처리할지 생각해본다면
지금 생성해주신 구조로는 받은 에러객체를 개발자가 직접 까서 "field"라는 필드가 있는지 확인하거나
받은 message가 뭔지 직접 확인한 후에야 어떤 에러가 발생한건지 구분이 가능할꺼라 생각됩니다.

그리고 예외를 이렇게 코드로 구분한다면 에러객체 또한 하나로 통일해서 사용할 수 있을꺼라 생각합니다.
에러객체가 하나로 통일된다면 에러객체의 포맷이 하나로 정해진다는 말이고
클라이언트 개발자는 모든 통신에서 동일한 에러포맷을 보장받으니
에러처리 로직 또한 하나의 템플릿으로 만들어서 사용 할 수 있을꺼라 생각합니다.

0923kdh added 16 commits October 10, 2021 18:52

feat : project init

587e012

chore : application.yml gitignore 추가

53bce4b

feat : Post, User Entity 추가

fd76904

chore : Post, User Entity 수정

ff9ae39

feat : UserRepository 테스트 코드 작성

b24c616

feat : PostRepository 테스트 코드 작성

60f7da0

chore : Bean validation dependency 적용

c012671

feat : User CRUD API 개발

0e61d00

feat : Post CRUD API 개발

db7a7eb

- 포스트 생성 - 포스트 조회 - 특정 유저가 작성한 포스트 전체 조회 - 포스트 수정 - 포스트 삭제

chore : user 엔드포인트 수정

cdebe8e

feat : error 처리 적용

8eeabb4

chore : error message 잘못입력된 부분 수정

fedb95e

feat : Rest Docs 의존성 추가

8f32bd1

chore : UserController @RequestParam에서 @PathVariable로 수정

8117108

chore : PostController endPoint 수정

7549bf0

chore : README update

b83597f

0923kdh added Team-Kyu 과제 리뷰 요청 🔥 매운맛 labels Oct 15, 2021

0923kdh added 4 commits October 15, 2021 15:50

chore : README update

180df78

chore : return type Long 에서 IdResponse Dto 로 변경

f179bce

chore : UserController 메서드 이름 변경

06d39fa

chore : 불필요 import 코드 제거

30ed95e

taehyunnn reviewed Oct 15, 2021

View reviewed changes

feat : UserController Test Code 작성

0746de2

0923kdh requested a review from sangmin7648 October 16, 2021 07:38

0923kdh assigned Jo-GyuHyeon Oct 16, 2021

feat : PostController Test code 작성

aaabbd9

sangmin7648 suggested changes Oct 16, 2021

View reviewed changes

0923kdh requested review from Jo-GyuHyeon and eunseo2 and removed request for Jo-GyuHyeon October 16, 2021 14:14

eunseo2 reviewed Oct 16, 2021

View reviewed changes

src/main/java/com/prgrms/board/controller/PostController.java Outdated Show resolved Hide resolved

eunseo2 reviewed Oct 16, 2021

View reviewed changes

src/main/java/com/prgrms/board/service/PostService.java Outdated Show resolved Hide resolved

eunseo2 reviewed Oct 16, 2021

View reviewed changes

src/main/java/com/prgrms/board/controller/PostController.java Outdated Show resolved Hide resolved

0923kdh requested a review from Jo-GyuHyeon October 17, 2021 15:28

0923kdh unassigned Jo-GyuHyeon Oct 17, 2021

0923kdh added 3 commits October 18, 2021 18:24

feat : rest doc 문서화 추가

7ea6c91

feat : yml update

a755fc1

chore : 코드리뷰 적용

72607f6

hanjo8813 reviewed Oct 19, 2021

View reviewed changes

Jo-GyuHyeon assigned 0923kdh Oct 23, 2021

0923kdh added 3 commits October 23, 2021 23:28

chore : class name 변경( InvalidExceptionHandler -> InValidExceptionHan…

cbc7fe6

…dler )

chore : @PathVariable 검증 추가

2bfda6a

chore : @name Validation 적용

4c6252c

Jo-GyuHyeon requested changes Oct 23, 2021

View reviewed changes

DevRunner21 reviewed Oct 24, 2021

View reviewed changes

learn-programmers closed this Mar 16, 2022

	public class ValidExceptionHandler {
	public class InvalidExceptionHandler {

		@PutMapping("/{id}")
		public ResponseEntity<IdResponse> modifyPost(final @PathVariable Long id, final @Valid @RequestBody PostModifyRequest postModifyRequest){

[1기-P] 김다희 - JPA 게시판 구현하기 #30

[1기-P] 김다희 - JPA 게시판 구현하기 #30

Conversation

0923kdh commented Oct 15, 2021 • edited

📌 과제 설명

💻 개발 환경

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

📍 엔티티 구성

📍 API 구현

User API

Post API

ERD

Directory

taehyunnn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

0923kdh commented Oct 16, 2021

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

0923kdh commented Oct 18, 2021

hanjo8813 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

0923kdh commented Oct 21, 2021

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

DevRunner21 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

DevRunner21 Oct 24, 2021 • edited

Choose a reason for hiding this comment

0923kdh commented Oct 15, 2021 •

edited

DevRunner21 Oct 24, 2021 •

edited