[4기 강병곤, 최준혁] Spring Boot JPA 게시판 구현 미션 제출합니다. #223

Curry4182 · 2023-07-31T16:42:02Z

📌 과제 설명

강병곤, 최준혁 spring boot jpa 게시판 구현하여 제출 합니다.

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

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

✅ PR 포인트 & 궁금한 점

post 테스트에 getPosts 메서드에서 페이지네이션 응답 결과를 문서화하기 위해 slice 객체를 다음과 같이 작성하였는데 이런 식으로 하는게 맞는지 궁금합니다! (767a062)
-> 팀 미팅 때 답변 해주셔서 반영하고 있습니다!
user와 post 문서를 포함하는 index에서 같은 폴더에 있는 문서 결과를 표시해야 하는데 include 관련해서 오류가 나서 나중에 직접 여쭤 보겠습니다! (e0ffc36)

Curry4182 · 2023-07-31T17:00:03Z

Rest docs 작성 파일 입니다!

게시글 문서

사용자 문서

HandmadeCloud · 2023-08-04T14:14:31Z

hehe-board/src/test/java/com/programmers/heheboard/domain/post/PostTest.java

+		List<PostResponseDTO> postList = Arrays.asList(
+			PostResponseDTO.builder()
+				.title("title3")
+				.content("content3")
+				.createdAt(LocalDateTime.of(2000, 1, 1, 1, 1))
+				.modifiedAt(LocalDateTime.of(2000, 1, 1, 1, 1))
+				.build(),
+
+			PostResponseDTO.builder()
+				.title("title4")
+				.content("content4")
+				.createdAt(LocalDateTime.of(2000, 1, 1, 1, 1))
+				.modifiedAt(LocalDateTime.of(2000, 1, 1, 1, 1))
+				.build()
+		);


반복해서 사용하는 내용들이라면 beforeEach를 만들어서 넣고 사용해도 좋을 것 같아요~

PostResponseDTO를 공통적으로 생성해서 그 부분을 setUP메서드에 넣었습니다~! a9824bc

HandmadeCloud · 2023-08-04T14:17:48Z

hehe-board/src/test/java/com/programmers/heheboard/domain/post/PostTest.java

+		Long postId = 1L;
+
+		when(postService.findPost(postId)).thenReturn(responseDTO);


PostId 를 직접 지정해서 사용하는 것보다 anyLong을 사용해보는 건 어떤가요??

고민 해보았는데 입력한 postId를 컨트롤러에서 동일하게 찾는지 테스트 해보기 위해서 postId를 계속 사용할려고 합니다!

HandmadeCloud · 2023-08-04T14:19:49Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/CreatePostRequestDto.java

+import lombok.Getter;
+
+@Getter
+@AllArgsConstructor


저는 최근부터 AllargsConstructor를 지양하는 방향으로 생각해서 사용하고 있는데요, 그 이유에 대해서도 한번 생각해보면 좋을 것 같아요!

저도 AllargsConstructor가 일으키는 버그에 대해 검색해 보고 AllargsConstructor를 사용하지 않도록 전체적으로 수정 하였습니다! f74b8d9

HandmadeCloud · 2023-08-04T14:20:43Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/Post.java

+@NoArgsConstructor
+public class Post extends BaseEntity {
+	@Id
+	@GeneratedValue(strategy = GenerationType.AUTO)


(strategy = GenerationType.AUTO) default라 생략해도 될 것 같아요 의도하신거라면 패쓰

BeommoKoo-dev · 2023-08-04T15:33:00Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/CreatePostRequestDto.java

+	private String title;
+	private String content;
+	private Long userId;


개인적으로 생각했을때, 필드를 final로 선언하지 않으면 데이터의 조작가능성이 생길 수도 있어서, Dto객체는 final로 선언하는 것이 좋다고 생각합니다 ! 어떻게 생각하실까요 ?!

음 저도 다시 생각 해보니 그렇게 생각해서 Dto 객체를 record 클래스로 변경 하였습니다! f74b8d9

BeommoKoo-dev · 2023-08-04T15:33:38Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/Post.java

+	@Lob
+	private String content;


Lob 어노테이션은 처음 알아가네요 ! 배워갑니다 👍

p2;
@Lob는 내부에서 추가로 별도의 조회를 하여 느릴 수도 있다고 합니다. 컬럼 타입을 text 로 직접 명시해서 사용하는 것은 어떤가요~?

참고

BeommoKoo-dev · 2023-08-04T15:34:26Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/Post.java

+		this.content = content;
+	}
+
+	public void setUser(User user) {


p3
요즘 setter의 사용에 관심이 많은데요, 한 번에 메소드의 사용의도를 파악하기 힘든 setUser보다는,
협업에서도 사용 가능한 메소드이니 allocate / attach User같은 의미있는 메소드명은 어떠실까요 ?!

set 대신 의도를 쉽게 파악할 수 있도록 수정하였고 사용하지 않는 setter도 전체적으로 삭제하였습니다~! c7107c4

BeommoKoo-dev · 2023-08-04T15:35:08Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/Post.java

+		if (Objects.nonNull(this.user)) {
+			this.user.getPosts().remove(this);
+		}
+
+		this.user = user;
+		user.getPosts().add(this);


p1
만약 user가 갖고있는 post의 자료형이 list가 아닌 hashMap 등으로 변경되면 setUser 메소드도 수정이 추가되어야 할 것 같아요!

내부 자료형을 모르더라도 추가, 삭제할 수 있도록 수정하였습니다! aac52b4

BeommoKoo-dev · 2023-08-04T15:37:19Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/PostController.java

+	public ApiResponse<Slice<PostResponseDTO>> getAllPost(@RequestParam int page, @RequestParam int size) {
+		Slice<PostResponseDTO> posts = postService.getPosts(page, size);
+		return ApiResponse.ok(posts);


p3
slice를 그냥 반환하면 프론트에서 식별하기 힘든 정보들 (ex : Pageable type : "INSTANCE")같은 정보들도 반환되는 것으로 알고 있는데, 프론트단에서 좀 더 알아보기 쉬운 필드만 갖고 있는 Wrapper 클래스를 하나 만들어 주는 건 어떨까요 ?

slice를 그대로 반환하지 않고 클라이언트에 필요한 정보만 반환될 수 있도록 수정하고 restdocs도 수정하였습니다~! 0db39ee

BeommoKoo-dev · 2023-08-04T15:42:52Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/PostService.java

+		User user = userRepository.findById(createPostRequestDto.getUserId())
+			.orElseThrow(() -> new RuntimeException("User Not Found!"));
+
+		post.setUser(user);


p3
저는 Post객체에 User는 필수적인 존재라고 생각하여 Post생성자에 user를 넣어주었습니다.
만약 post.setUser(user)메소드를, post를 생성하는 다른 메소드에서 호출하는 것을 깜빡하는 것을 방지하기 위해 생성자 혹은 user세팅을 강제하는 다른 방법을 고안해 보는건 어떨까요 ?!

이 부분은 준혁님과 의논하고 반영하도록 하겠습니다!

Post의 생성자에 User를 넣어도 매핑 메서드를 실행하지 않으면 동일한 문제가 발생한다고 생각합니다.

BeommoKoo-dev · 2023-08-04T15:45:53Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/Post.java

+	@Builder
+	public Post(String title, String content) {
+		this.title = title;
+		this.content = content;
+	}


p1
Builder로 Post객체를 생성할 시에, nullable하지 않은 필드에 대한 검증(Notnull)이 이루어지지 않은 것 같습니다.
이는 DB에 영속화 시키기 이전까지 잡기 힘든 에러인것 같은데, 유효성 검증로직을 추가하는 것은 어떨까요 ?!

생성자에서 유효성 검사를 하도록 수정하였습니다! 3f95c3c

BeommoKoo-dev · 2023-08-04T15:47:31Z

hehe-board/src/main/java/com/programmers/heheboard/global/JpaAuditingConfiguration.java

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


저는 main 어플리케이션 클래스에 EnableJpaAuditing 어노테이션을 붙여주었는데, Config클래스에 붙이는게 좀 더 맞다는 생각이 드네요 ! 배워갑니다 👍

BeommoKoo-dev · 2023-08-04T15:48:02Z

hehe-board/src/main/java/com/programmers/heheboard/global/ApiResponse.java

성공, 실패에 대한 메소드를 따로 만든 점 좋은 것 같습니다 ! 배워갑니다 👍

Yiseull

병곤님, 준혁님 과제 하느라 수고 많으셨습니다!! 👏👏

Yiseull · 2023-08-05T08:24:39Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/Post.java

+	@Lob
+	private String content;


p2;
@Lob는 내부에서 추가로 별도의 조회를 하여 느릴 수도 있다고 합니다. 컬럼 타입을 text 로 직접 명시해서 사용하는 것은 어떤가요~?

참고

Yiseull · 2023-08-05T08:27:36Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/PostResponseDto.java

+public record PostResponseDto(String title, String content, LocalDateTime createdAt, LocalDateTime modifiedAt) {
+	@Builder
+	public PostResponseDto {
+	}


p5;
@Builder를 record 단에 붙일 수 있는 것으로 압니다! 어노테이션을 저기에 달아주신 이유가 있나여??

이 부분은 몰랐네요 가독성을 위해 수정하였습니다

Yiseull · 2023-08-05T08:28:44Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/PostService.java

+			.orElseThrow(() -> new RuntimeException("Post Not Found!"));
+
+		return PostResponseDto.toResponse(retrievedPost);
+	}


p1;
조회 같은 경우에는 성능을 위해 트랜잭션을 읽기 전용 모드로 사용하시는 것이 어떤가요??

오호 꿀팁 감사합니다~ 수정하였습니다~! abdc8c8

Yiseull · 2023-08-05T08:30:55Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/PostService.java

+			.orElseThrow(() -> new RuntimeException("Post Not Found!"));
+
+		retrievedPost.changeTitle(updatePostRequestDto.title());
+		retrievedPost.changeContents(updatePostRequestDto.content());


p2;
서비스에서 changeTitle, changeContents 를 각각 호출하기 보다 Post 내부에서 처리해주도록 하는 것은 어떤가여? 만약 메소드명이 변경될 경우 서비스까지 영향을 받을 것 같네요~

post 내부에서 처리하도록 수정하였습니다~! 54c57af

Yiseull · 2023-08-05T08:32:15Z

hehe-board/src/main/java/com/programmers/heheboard/domain/user/User.java

+	private Long id;
+
+	@Column
+	private String name;


p5;
컬럼에 따로 nullable 같은 세팅도 없고, 컬럼이라는 것을 명시적으로 표현하기 위해 @Column을 붙여주신 건가요??

전체적으로 유효성 검사를 하도록 수정하였습니다~! 3f95c3c

Yiseull · 2023-08-05T08:34:55Z

hehe-board/src/main/java/com/programmers/heheboard/global/ApiResponse.java

+	public static <T> ApiResponse<T> fail(int statusCode, T data) {
+		return new ApiResponse<>(statusCode, data);
+	}
+}


P4;
ApiSliceResponse와 공통적인 부분이 있는 것 같은데 상속을 활용해보는 것은 어떤가요??

컨트롤러에서 전체적으로 ApiResponse를 응답하도록 수정하였습니다! 5171145

born-A

준혁님 병곤님! 과제 진행하시느라 수고하셨어요!
다른 팀원분들이 리뷰를 정성스레 달아주셔서 공감하는 부분에 이모지 표시해두었습니다! 👍

born-A · 2023-08-06T07:55:52Z

hehe-board/src/main/java/com/programmers/heheboard/domain/user/UserController.java

+	private final UserService userService;
+
+	@PostMapping
+	public ApiResponse<UserResponseDto> createUser(@RequestBody CreateUserRequestDto createUserRequestDto) {


@Valid 를 사용해서 dto 검증을 진행하는것도 좋을거 같습니다!

@Valid를 사용하여 검증하도록 수정하였습니다! 3f95c3c

HandmadeCloud · 2023-08-06T12:15:41Z

hehe-board/src/main/java/com/programmers/heheboard/domain/post/PostService.java

+	@Transactional
+	public Slice<PostResponseDto> getPosts(int page, int size) {
+		PageRequest pageRequest = PageRequest.of(page, size);
+
+		return postRepository.findSliceBy(pageRequest)
+			.map(PostResponseDto::toResponse);
+	}


p1;
offset으로 구현한 걸로 알고 있었는데 이야기해보니 cursor 방식으로 구현하신 건가요?? 설명을 한번 해주시면 감사하겠습니다!

offset 방식으로 구현했는데 그 때 제가 잘 못 말했습니다.

0923kdh · 2023-09-24T13:50:41Z

라이브 리뷰 완료

Curry4182 added 9 commits August 1, 2023 01:10

init commit

2dec599

init commit

ecd61ec

feat: BaseEntity 및 JpaAuditingConfiguration 설정 파일 추가

a821939

feat: ApiResponse 공통 응답 모델 추가

75773a1

feat: user 관련 api 기능 추가

eff50c3

feat: post 관련 api 기능 추가

6d92014

test: user 테스트 기능 추가

a157d6f

test: post 테스트 기능 추가

767a062

docs: rest docs api 결과 docs 추가

e0ffc36

Curry4182 added 🔥 매운맛 Team-HiHi labels Jul 31, 2023

Curry4182 requested review from yuminhwan and 0923kdh July 31, 2023 16:42

Curry4182 assigned Curry4182 and hi-june Jul 31, 2023

docs: post.adoc 내용 수정

e684a26

HandmadeCloud reviewed Aug 4, 2023

View reviewed changes

BeommoKoo-dev reviewed Aug 4, 2023

View reviewed changes

Curry4182 added 2 commits August 5, 2023 15:41

refactor: cursor방식으로 post를 반환할 때 client에 필요한 정보만 넘길 수 있도록 수정

0db39ee

refactor: AllargsConstructor를 사용하지 않도록 수정, 클래스 이름 접미사DTO를 Dto로 모두 수정

f74b8d9

Curry4182 added 2 commits August 5, 2023 16:04

refactor: 사용하지 않는 setter는 삭제, setter의 이름을 set 대신 의도를 파악할 수 있는 이름으로 수정

c7107c4

refactor: 공통적으로 사용하는 부분은 @BeforeAll이 붙어있는 setUP메서드에서 실행될 수 있도록 수정

a9824bc

Yiseull reviewed Aug 5, 2023

View reviewed changes

born-A reviewed Aug 6, 2023

View reviewed changes

HandmadeCloud reviewed Aug 6, 2023

View reviewed changes

Curry4182 added 6 commits August 7, 2023 16:00

refactor: 클래스의 객체에 직접 접근하지 않고 메서드를 통해 속성을 변경할 수 있도록 수정

aac52b4

feat: dto와 entity에 유효성 검사 기능 추가, global exception 처리 기능 추가

3f95c3c

refactor: post에 update 메서드 추가, setter 메서드 private로 접근 외부에서 안되게 수정

54c57af

refactor: 단순 조회일 경우 Transactional을 readonly로 변경

abdc8c8

refactor: Lob 어노테이션 대신 Text를 사용하도록 수정

e279941

refactor: 전체적으로 ApiResponse를 응답하도록 수정

5171145

		Long postId = 1L;

		when(postService.findPost(postId)).thenReturn(responseDTO);

[4기 강병곤, 최준혁] Spring Boot JPA 게시판 구현 미션 제출합니다. #223

Are you sure you want to change the base?

[4기 강병곤, 최준혁] Spring Boot JPA 게시판 구현 미션 제출합니다. #223

Conversation

Curry4182 commented Jul 31, 2023 • edited

📌 과제 설명

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

✅ PR 포인트 & 궁금한 점

Curry4182 commented Jul 31, 2023 • edited

Rest docs 작성 파일 입니다!

게시글 문서

사용자 문서

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

Curry4182 Aug 5, 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

BeommoKoo-dev Aug 4, 2023 • edited

Choose a reason for hiding this comment

Curry4182 Aug 5, 2023 • edited

Choose a reason for hiding this comment

BeommoKoo-dev Aug 4, 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Yiseull 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

Curry4182 Aug 7, 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

Curry4182 Aug 7, 2023 • edited

Choose a reason for hiding this comment

born-A 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

0923kdh commented Sep 24, 2023

Curry4182 commented Jul 31, 2023 •

edited

Curry4182 commented Jul 31, 2023 •

edited

Curry4182 Aug 5, 2023 •

edited

BeommoKoo-dev Aug 4, 2023 •

edited

Curry4182 Aug 5, 2023 •

edited

BeommoKoo-dev Aug 4, 2023 •

edited

Curry4182 Aug 7, 2023 •

edited

Curry4182 Aug 7, 2023 •

edited