[4기 고예성] Spring Boot JPA로 게시판 구현 미션 제출합니다. #254

Dev-Yesung · 2023-08-05T14:21:48Z

📌 과제 설명

JPA로 게시판을 구현하고 API를 문서화를 했습니다.

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

SpringDataJPA 를 설정한다
datasource : h2
엔티티를 구성한다
- 회원(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를 구현한다.
- 게시글 조회
- 페이징 조회 (GET "/posts")
- 단건 조회 (GET "/posts/{id}")
- 게시글 작성 (POST "/posts")
- 게시글 수정 (POST "/posts/{id}")
REST-DOCS를 이용해서 문서화한다

✅ PR 포인트 & 궁금한 점

springboot-board-jpa setup

User, Post Entity 구현완료

gitignore 수정

JPA게시판 기능구현을 모두 완료했습니다.

게시판 테스트 코드 구현 완료 및 asciidoctor 적용

kimihiqq

예성님 이번과제도 수고많으셨습니다~! 😁😁
예성님 코드 보면서 제가 미쳐 생각하지 못한 부분들이 많아 보면서 많이 배웠습니다!👍
잘 작성해주셔서 리뷰드릴부분이 많이 없었지만 몇가지 남겨 보았습니다!!
(혹시 리뷰 중 잘못된 부분이 있다면 지적해주시면 감사하겠습니다!)

kimihiqq · 2023-08-07T04:41:19Z

src/main/java/prgrms/board/config/JpaConfig.java

+@Configuration
+@EnableJpaAuditing
+public class JpaConfig {
+}


저 같은 경우엔 @EnableJpaAuditing을 메인 클래스에 직접 적용하였는데, 이렇게 별도의 설정 클래스를 사용하면 구조상의 구분이나 가독성을 높일 수 있겠군요!!

kimihiqq · 2023-08-07T05:14:14Z

src/main/java/prgrms/board/post/application/PostService.java

+import java.util.Optional;
+
+@Service
+@Transactional(readOnly = true)


읽기 전용 트랜잭션을 기본으로 하시고 쓰기 작업이 필요한 메서드에 대해서만 @transactional을 재적용하셨군요! (저도 참고하겠습니다!)

제가 readOnly 관련해서 공부할 때 찾았던 글입니다~
https://hungseong.tistory.com/74
특히 JPA를 사용할 때 얻을 수 있는 이점이 많은 것 같습니다!

kimihiqq · 2023-08-07T05:51:40Z

src/main/java/prgrms/board/post/presentation/PostController.java

+    @PostMapping("/{id}")
+    public ResponseEntity<PostUpdateResponse> updatePost(


리소스를 수정하는 경우 PUT 메서드가 더 적합할 것 같습니다! (혹시 PostMapping을 사용하신 다른 이유가 있으실까요??)

앗 요구사항에 POST "/posts/{id}"로 구현하라고 나와있어서 이렇게 구현했습니다.
하지만 저도 구현하면서 PUT이 더 적절하다고 생각했는데~ 바로 고치겠습니다.
감사합니다☺️

kimihiqq · 2023-08-07T06:10:52Z

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

+    @Column(nullable = false)
+    private Integer age;


저는 null을 가질 수 없는 int를 사용하는 것이 db의 not null 제약 조건과 더욱 분명한 일치가 이루어지지 않을까 생각했습니다! 혹시 age필드에 Integer를 사용하신 이유가 있으실까요?

아아 맞습니다. 사실 객체로 만든게 습관적으로 예전에 원시값을 포장해서 써야한다는 글을 읽은 적 있었는데,
은연중에 큰 이유없이 코딩했었네요...! 성현님이 주신 리뷰를 읽고 생각해본 다음 아래의 글과 함께 학습했습니다!
예리한 지적 감사합니다~🫠 반영하겠습니다

https://warpgate3.tistory.com/m/entry/JPA-ENTITY-%EC%97%90%EC%84%9C-%EC%9B%90%EC%8B%9C%ED%83%80%EC%9E%85%EA%B3%BC-Wrapper-%ED%81%B4%EB%9E%98%EC%8A%A4%EC%A4%91-%EB%AD%98-%EC%82%AC%EC%9A%A9%ED%95%B4%EC%95%BC-%EB%90%98%EB%82%98

null값이 필요없는 필드이기 때문에 원시타입을 사용하는 것이 더 적절해서입니다.

좀 더 캡슐화가 되는 방향으로 DTO의 메서드를 변경했습니다. BREAKING CHANGE: 서

lleellee0 · 2023-08-09T11:22:23Z

src/main/java/prgrms/board/post/exception/IllegalPostDataException.java

+@Getter
+public class IllegalPostDataException extends RuntimeException {
+
+    private final ErrorCode errorCode;
+    private final String className;
+
+    public IllegalPostDataException(ErrorCode errorCode, String className) {
+        this.errorCode = errorCode;
+        this.className = className;
+    }
+}


@Getter public class PostNotFoundException extends RuntimeException { private final ErrorCode errorCode; private final String className; public PostNotFoundException(ErrorCode errorCode, String className) { this.errorCode = errorCode; this.className = className; } }

private final ErrorCode errorCode; private final String className;

이 두 필드가 동일하게 계속 들어갈 것 같은데, 이렇게할거면 부모 예외를 만들고 상속 관계를 활용하는게 더 적절할 것 같습니다. :)

앗... ㅎㅎ 맞습니다 리팩토링하도록 하겠습니다!

lleellee0 · 2023-08-09T11:38:41Z

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

+    private void validateTitle(String title) {
+        if (!StringUtils.hasText(title) ||
+                title.length() > MAXIMUM_LENGTH) {
+            throw new IllegalPostDataException(ErrorCode.EMPTY_POST_TITLE, className);
+        }
+    }
+
+    private void validateContent(String content) {
+        if (!StringUtils.hasText(content)) {
+            throw new IllegalPostDataException(ErrorCode.EMPTY_POST_CONTENT, className);
+        }
+    }
+
+    private void updateCreatedBy(String createdBy) {
+        if (!StringUtils.hasText(createdBy) ||
+                createdBy.length() > MAXIMUM_LENGTH) {
+            throw new IllegalPostDataException(ErrorCode.INVALID_CREATED_BY_VALUE, className);
+        }
+        this.createdBy = createdBy;
+    }


예외를 던질 때 className를 같이 넘겨주는게 큰 의미가 있나용?!
로그를 찍기 위한 의도라던지..

로그찍을 용도로 만든거였는데, 생각해보니 로그에 클래스이름이 들어갈 필요는 없네요🧐
좀 더 의미있는 데이터로 바꿔보겠습니다...!

lleellee0 · 2023-08-09T11:41:52Z

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

+    public void updateUser(User user) {
+        if (Objects.nonNull(this.user)) {
+            this.user.getPosts().remove(this);
+        }
+
+        this.user = user;
+        user.getPosts().add(this);
+        String name = user.getName();
+        updateCreatedBy(name);
+    }


일반적으로 게시글(Post)의 유저를 다른 user로 바꾸는게 적절한건가요?

@Transactional public PostSaveResponse savePost(PostSaveRequest request) { Post newPost = request.toEntity(); Long userId = request.userId(); User user = userRepository.findById(userId) .orElseThrow(() -> new UserNotFoundException( ErrorCode.USER_NOT_FOUND, this.getClass().getName() )); newPost.updateUser(user); postRepository.save(newPost); return PostSaveResponse.of(newPost); }

물론 여기서 Post를 생성할 때 사용하고 있긴한데, updateUser를 따로 호출해서 넣어줘야하는건지...
지금 이 코드는 마치 User를 새로 업데이트 해줄 수 있는것처럼 보입니다.
그리고

@Column(nullable = false, length = 50) private String createdBy; @ManyToOne @JoinColumn(name = "user_id") private User user;

이렇게 게시글을 작성한 유저의 Name과 User에 대한 연관 관계를 둘다 가지고 있어서 더 혼란스러운 것 같아요.

아아 이해했습니다. update라는 메서드 자체도 유저를 변경해준다는 의미가 강하고
애초에 updateUser란 메서드도 Post에 있어 어색하네요...!
애초에 그 글을 작성하는 사람이 바뀔 이유가 없고요~
User를 Post를 생성할 때 주입하는 것으로 바꾸겠습니다.

createdBy는 요구사항에 있어서 그냥 집어넣은거 같은데 확실히 어색하네요!
연관관계만 집어넣고 삭제하는 걸로 하겠습니다~

+궁금한 점 : 원래는 updateUser가 아니라 setUser로 메서드를 변경하려고 했는데,
혹시 User를 Post메서드에 setUser(user)와 같은 방식으로 설정하는 것도
그렇게 바람직한 방식은 아닌건가요?!

lleellee0 · 2023-08-09T11:50:47Z

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

+    private void validateAge(Integer age) {
+        if (age < MIN_AGE || age > MAX_AGE) {
+            throw new IllegalUserDataException(ErrorCode.INVALID_USER_AGE);
+        }
+    }
+
+    private void validateName(String name) {
+        if (!StringUtils.hasText(name) ||
+                name.length() > MAXIMUM_LENGTH ||
+                !Pattern.matches(NAME_REGEX_PATTERN, name)
+        ) {
+            throw new IllegalUserDataException(ErrorCode.INVALID_USER_AGE);
+        }
+    }


Post와는 다르게 User는 또 클래스 이름을 안넘겨주네요? ㅎㅎ

함께 리팩토링 하도록 하겠습니다!

lleellee0 · 2023-08-09T11:52:28Z

src/main/java/prgrms/board/post/application/PostService.java

+        String postTitle = request.title();
+        String postContent = request.content();
+        post.updateTitle(postTitle);
+        post.updateContent(postContent);


title과 content를 함께 수정하는 메서드를 만드는게 더 낫지 않을까요 ㅎㅎ
이 둘이 따로따로 사용될 상황이 없다면..

앗 맞습니다...! 게시판 글을 수정하면 보통 둘 다 수정할 수 있도록 만드는데~
함께 수정하도록 하는게, 효율적이겠네요! 감사합니다

lleellee0 · 2023-08-09T11:53:11Z

src/test/java/prgrms/board/post/application/PostServiceTest.java

+    @Test
+    @DisplayName("새 Post 생성 실패 테스트")
+    void savePostFailTest() {
+        // given
+        var request = new PostSaveRequest(
+                500L,
+                "이거 저장안됨ㅎ",
+                "제곧내 저장 안됨~"
+        );
+
+        // when, then
+        assertThatThrownBy(() -> postService.savePost(request))
+                .isInstanceOf(UserNotFoundException.class);
+    }


유저가 늘어나서 500번 유저가 생기면 어쩌죠?!

앗 맞습니다 아예 적절하지 않은 값을 넣어야하네요! 감사합니다~

maenguin · 2023-08-10T15:22:55Z

src/main/java/prgrms/board/post/domain/PostRepository.java

+import org.springframework.data.jpa.repository.JpaRepository;
+
+public interface PostRepository extends JpaRepository<Post, Long> {
+    Page<Post> findAll(Pageable pageable);


이거 원래 정의되어 있지 않나요?

맞습니다! JPA에 익숙하지 않아서 몰랐는데, 원래 있더군요. 바로 삭제했습니다~

maenguin · 2023-08-10T15:27:19Z

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

+    @OneToMany(
+            mappedBy = "user",
+            cascade = CascadeType.ALL,
+            orphanRemoval = true
+    )
+    List<Post> posts = new ArrayList<>();


포스트가 유저에 전적으로 의존적이라면 해당 코드가 유의미할 수 있는데 아니라면 조금 위험해보이네요
유저가 삭제되면 유저가 작성한 모든 포스트도 같이 삭제될것 같은데.. 상황에 따라 조금 고민이 필요해보이지만.. 지금은 괜찮을것 같네요

넵 맹희님이 피드백 해주신 것을 토대로 한 번 생각해보았습니다.
서비스가 확장되면 문제가 생길거 같아 삭제하는게 낫다는 생각이 들었습니다.
또 굳이 양방향 연관관계로 조회를 할 필요도 없을거 같아 삭제했습니다!

maenguin · 2023-08-10T15:28:01Z

src/main/java/prgrms/board/user/presentation/UserController.java

+@RestController
+@RequestMapping("api/v1")


여기도 뒤에 users를 붙여주시면 좋을것 같네요

maenguin · 2023-08-10T15:28:42Z

src/test/java/prgrms/board/post/application/PostServiceTest.java

+@SpringBootTest
+@Transactional
+class PostServiceTest {


슬라이스 테스트로 한번 바꿔보세요
Auditing 때문에 조금 시행착오는 있을거에요 ㅋㅋ

시도해보겠습니다! 감사합니다 :)

maenguin · 2023-08-10T15:29:33Z

src/test/java/prgrms/board/post/presentation/PostControllerTest.java

+@SpringBootTest
+@AutoConfigureMockMvc
+@AutoConfigureRestDocs
+@Transactional
+class PostControllerTest {


현재 레스트 도큐먼트 구성 목적으로만 테스트 코드가 존재해서
@AutoConfigureRestDocs
@WebMvcTest(PostController.class)
위 코드만으로 될것 같아요(아마도?)

추가로, 실제 응답을 검증하는 테스트는 없는것 같은데요 이번에 한번 작성해보시면 좋을것 같네요

테스트 작성을 슬라이스 테스트로 작성하지 않아서 전체적으로 코드를 바꿔봐야겠네요!
실제 응답 검증 테스트도 진행해보겠습니다~ 감사합니다!

Dev-Yesung added 8 commits August 1, 2023 11:01

feat: springboot-board-jpa setup

97a0fae

springboot-board-jpa setup

feat: springboot-board-jpa setup

b8e7806

springboot-board-jpa setup

feat: User, Post Entity 구현완료

4703247

User, Post Entity 구현완료

chore: gitignore 수정

23f96c8

gitignore 수정

feat: 게시판 기능 구현 모두 완료

55e3af6

JPA게시판 기능구현을 모두 완료했습니다.

feat: 게시판 테스트 코드 구현 완료 및 asciidoctor 적용

890833c

게시판 테스트 코드 구현 완료 및 asciidoctor 적용

chore: asciidoc 파일명 변경 -> asciidoc.adoc

365c9c5

필요없는 파일 삭제

ad5b5ea

Dev-Yesung changed the title ~~[4기 공] Spring Boot JPA로 게시판 구현 미션 제출합니다.~~ [4기 고예성] Spring Boot JPA로 게시판 구현 미션 제출합니다. Aug 5, 2023

Dev-Yesung marked this pull request as draft August 5, 2023 14:23

Dev-Yesung requested review from maenguin and lleellee0 August 5, 2023 14:24

Dev-Yesung self-assigned this Aug 5, 2023

Dev-Yesung added 🔥 매운맛 Team-F labels Aug 5, 2023

Dev-Yesung marked this pull request as ready for review August 5, 2023 14:27

Dev-Yesung requested a review from kimihiqq August 5, 2023 14:30

kimihiqq approved these changes Aug 7, 2023

View reviewed changes

Dev-Yesung added 3 commits August 7, 2023 22:19

refactor: 게시물 수정 엔드포인트인 api/v1/posts/{id}의 HTTP메서드를 POST에서 PUT으로 변경했습니다.

f0b36eb

refactor: 도메인에 원시타입 래퍼 클래스를 원시타입으로 변경했습니다.

9b25d3f

null값이 필요없는 필드이기 때문에 원시타입을 사용하는 것이 더 적절해서입니다.

refactor: DTO수정을 통한 캡슐화 증가

cf72e15

좀 더 캡슐화가 되는 방향으로 DTO의 메서드를 변경했습니다. BREAKING CHANGE: 서

lleellee0 reviewed Aug 9, 2023

View reviewed changes

lleellee0 approved these changes Aug 9, 2023

View reviewed changes

maenguin approved these changes Aug 10, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[4기 고예성] Spring Boot JPA로 게시판 구현 미션 제출합니다. #254

[4기 고예성] Spring Boot JPA로 게시판 구현 미션 제출합니다. #254

Dev-Yesung commented Aug 5, 2023 •

edited

kimihiqq left a comment

kimihiqq Aug 7, 2023

kimihiqq Aug 7, 2023

Dev-Yesung Aug 7, 2023

kimihiqq Aug 7, 2023

Dev-Yesung Aug 7, 2023

kimihiqq Aug 7, 2023

Dev-Yesung Aug 7, 2023

lleellee0 Aug 9, 2023

Dev-Yesung Aug 11, 2023

lleellee0 Aug 9, 2023

Dev-Yesung Aug 11, 2023

lleellee0 Aug 9, 2023

Dev-Yesung Aug 11, 2023 •

edited

lleellee0 Aug 9, 2023

Dev-Yesung Aug 11, 2023

lleellee0 Aug 9, 2023

Dev-Yesung Aug 11, 2023

lleellee0 Aug 9, 2023

Dev-Yesung Aug 11, 2023

maenguin Aug 10, 2023

Dev-Yesung Aug 11, 2023

maenguin Aug 10, 2023 •

edited

Dev-Yesung Aug 11, 2023

maenguin Aug 10, 2023

maenguin Aug 10, 2023

Dev-Yesung Aug 11, 2023

maenguin Aug 10, 2023

Dev-Yesung Aug 11, 2023

		@PostMapping("/{id}")
		public ResponseEntity<PostUpdateResponse> updatePost(

		@RestController
		@RequestMapping("api/v1")

[4기 고예성] Spring Boot JPA로 게시판 구현 미션 제출합니다. #254

Are you sure you want to change the base?

[4기 고예성] Spring Boot JPA로 게시판 구현 미션 제출합니다. #254

Conversation

Dev-Yesung commented Aug 5, 2023 • edited

📌 과제 설명

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

✅ PR 포인트 & 궁금한 점

kimihiqq 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

Dev-Yesung Aug 11, 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

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

maenguin 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

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

Dev-Yesung commented Aug 5, 2023 •

edited

Dev-Yesung Aug 11, 2023 •

edited

maenguin Aug 10, 2023 •

edited