[4기 유명한 & 나영경] Springboot-board-JPA 1차 PR 입니다. #230

yumyeonghan · 2023-08-01T13:55:35Z

📌 과제 설명

유명한, 나영경 페어를 이루어 프로그래밍을 진행했습니다.

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

SpringDataJPA 를 설정한다.

datasource : h2 or 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를 구현한다.

게시글 조회
- 페이징 조회 (GET "/posts")
- 단건 조회 (GET "/posts/{id}")
게시글 작성 (POST "/posts")
게시글 수정 (POST "/posts/{id}")

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

response에 대해서는 PostDto->PostResponseDto로 반환하도록 변경

- Long 타입의 식별자를 응답하기 위한 record 생성

dojinyou

수고하셨습니다!

src/main/java/com/programmers/domain/post/entity/Post.java

seung-hun-h · 2023-08-04T08:24:03Z

src/test/java/com/programmers/domain/post/application/PostServiceImplTest.java

+
+import static org.assertj.core.api.Assertions.assertThat;
+
+@DataJpaTest


@DataJpaTest는 보통 영속성 레이어 테스트에서 많이 사용하는데, 다른 방법은 없을까요?

서비스 레이어의 단위테스트는

빠르게 실행되어야 하고

다른 테스트로부터 영향을 받으면 안되고

DB에 의존하면 안된다고 생각합니다

따라서 DB에 직접적인 연관을 하고있는 Repository 레이어에 대한 의존성을 제거하고, 서비스 레이어만 독립적으로 테스트할 수 있도록
@DataJpaTest 대신, Mock을 사용했습니다.
3bb298f

@DataJpaTest

- 영속성 레이어 테스트가 아닌, 서비스 레이어의 단위테스트 이기 때문에 @DataJpaTest 대신 Mock 사용

dojinyou · 2023-08-05T20:42:29Z

src/main/java/com/programmers/domain/post/application/PostServiceImpl.java

+    private final PostRepository postRepository;
+    private final UserRepository userRepository;


다른 도메인의 Repository 직접 참조하시는 이유가 있나요?

다른 도메인의 레포나 서비스를 참조해도 되는지, 이부분도 고민이 많이 됐고, 실제 팀원들과 얘기할때도 명확하게 답을 내리지 못했습니다.

우선은 Post를 생성하기 위해선 반드시 User 엔티티가 필요하기 때문에 Repository를 참조해서 User 엔티티를 조회하는데 사용했습니다.

이 부분에 대해서 멘토님들의 의견은 어떠신지 궁금합니다.!

Service, Repository 중 어느 것에 의존할 것이냐는 항상 의견이 나뉘는 것 같아요. 장단점이 어떤게 있을 지 생각해보면 좋을 것 같네요.

예를들어 userId에 해당하는 User가 없을 때 어떤 정책을 세웠을 텐데 Repository에 의존하면 해당 로직에 대한 코드가 중복될 수 있겠네요. 특정 비즈니스에 종속적이지 않고 단순히 영속성 계층에서 데이터를 조회하거나 영속화 하고 싶다면 Repository에 의존할 수도 있을 것 같네요.

저는 개인적으로 Service가 다른 Service를 참조하는 걸 선호하는 편입니다!

dojinyou · 2023-08-05T20:46:00Z

src/main/java/com/programmers/domain/post/application/converter/PostConverter.java

+import com.programmers.domain.user.entity.User;
+import org.springframework.stereotype.Component;
+
+@Component


@Component로 관리하는 이유가 있나요?

처음엔 유틸 관련 기능이라 static 활용을 고려했습니다.
그런데 해당 클래스는 PostService에서만 사용을 하기 때문에, 먼가 static 보단
빈으로 등록해서 관리를 하는게 더 나을거 같다고 생각을 했습니다.

혹시 유틸 기능이니깐 static으로 사용해야할까요?
아니면 컨버터 대신 Dto에 변환 메서드를 구현해서 사용하는 방법도 좋은 방법일까요?

딱히 답이 있는 문제는 아닌 것 같아요.
여러 장 단점이 있는데 중요한 건 명확한 근거가 필요하다는 점인 것 같아요.
한번 고민해보시죠. dto에 변환 메서드를 구현하는 방법도 고민해볼 수 있을 것 같아요

src/main/java/com/programmers/domain/post/entity/Post.java

src/main/java/com/programmers/domain/post/ui/dto/PostDto.java

src/main/java/com/programmers/domain/user/entity/User.java

src/test/java/com/programmers/domain/post/application/PostServiceImplTest.java

seung-hun-h · 2023-08-06T02:31:18Z

src/test/java/com/programmers/domain/post/application/PostServiceImplTest.java

+    @Mock
+    private PostConverter postConverter;


이정도는 모킹할 필요가 없지 않을까요?

승훈님의 질문을 PostConverter는 실제 구현체를 쓰는게 낫다라고 이해를 했습니다.

현재 테스트하고있는 PostServiceImpl는 단위 테스트를 하기위해 Mock으로 되어있습니다.
따라서 해당 클래스가 의존하고 있는 빈들을 모킹을 했는데, 그중 PostConverter 빈만 실제 구현체를 사용해서 PostServiceImpl에 주입할 수는 없는것 같습니다.

혹시 제가 질문을 잘못 이해했을까요?
(아니면 컨버터 역할을 하는 객체를 static으로 만들라는 뜻일까요?)

PostServiceImpl은 목이 아니지 않나요?

seung-hun-h · 2023-08-06T02:32:44Z

src/main/java/com/programmers/exception/ApiExceptionHandler.java

+    @ExceptionHandler(IllegalArgumentException.class)
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    private ErrorResult handleIllegalArgumentException(IllegalArgumentException e) {
+        return new ErrorResult(HttpStatus.BAD_REQUEST.value(), e.getMessage());
+    }
+
+    @ExceptionHandler(NoSuchElementException.class)
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    private ErrorResult handleNoSuchElementException(NoSuchElementException e) {
+        return new ErrorResult(HttpStatus.BAD_REQUEST.value(), e.getMessage());
+    }


예외 메시지를 그대로 클라이언트에게 전달해주면 안될 것 같네요~

IllegalArgumentException 또는 NoSuchElementException 같이 자바 기본 예외를 사용하면, 제가 직접 던진 부분 이외에 예상치 못하게 서버에서 발생해버리면, 결국에는 기본 예외 메세지가 나갈것같습니다.
이렇게 발생한 예외 메세지(제가 직접 던진 예외 메세지 + 해당 예외의 기본 메세지)들을 하나하나 구분해서 핸들링 하는것보다

차라리 사용자 정의 예외를 만들어서 처리하고,
그 이외에 자바 기본 예외가 발생하는 것들은

@ExceptionHandler(Exception.class) @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR) private ErrorResult handleException() { return new ErrorResult(HttpStatus.INTERNAL_SERVER_ERROR.value(), INTERNAL_SERVER_ERROR_MESSAGE); }

해당 로직으로 한번에 "예상치 못한 예외" 같은걸로 처리하도록 설계하고자 하는데, 혹시 이러한 방법으로 설계해도 될까요?

네 좋을 것 같아요

seung-hun-h · 2023-08-07T08:13:44Z

src/main/java/com/programmers/domain/post/application/PostServiceImpl.java

+    private final PostRepository postRepository;
+    private final UserRepository userRepository;


Service, Repository 중 어느 것에 의존할 것이냐는 항상 의견이 나뉘는 것 같아요. 장단점이 어떤게 있을 지 생각해보면 좋을 것 같네요.

예를들어 userId에 해당하는 User가 없을 때 어떤 정책을 세웠을 텐데 Repository에 의존하면 해당 로직에 대한 코드가 중복될 수 있겠네요. 특정 비즈니스에 종속적이지 않고 단순히 영속성 계층에서 데이터를 조회하거나 영속화 하고 싶다면 Repository에 의존할 수도 있을 것 같네요.

seung-hun-h · 2023-08-07T08:14:39Z

src/main/java/com/programmers/domain/user/application/UserServiceImpl.java

+    @Override
+    public UserDto findUser(Long userId) {
+        User user = userRepository.findById(userId)
+                .orElseThrow(() -> new NoSuchElementException(USER_NOT_FOUND));


어떤 id가 들어왔는지 함께 나타내주면 좋을 것 같네요

dojinyou

수고하셨습니다.

- PostConverter는 실제 구현체 사용

yumyeonghan and others added 26 commits July 30, 2023 23:41

init

4cb2dc4

feat: application.yml 설정

45c9db9

feat: BaseEntity 설정

f4661f5

feat: User 엔티티 생성

e682cde

feat: Post 엔티티 생성

7f6149e

feat: PostRepository 생성

25af2bf

feat: UserRepository 생성

bbad777

feat: Post 엔티티, 수정 기능 추가

2a4cdb1

feat: PostService, 생성, 조회, 수정 기능 구현

15eb3b2

feat: UserService, 생성, 조회 기능 구현

62faed8

refactor: 경로 수정

7b0595f

feat: Post 엔티티, BaseEntity 상속

c39b53b

feat: PostUpdateDto, Long postId 삭제

5407211

feat: PostService, updatePost 수정

6f1a338

feat: PostController 구현

07578e1

feat: ApiExceptionHandler 구현

f9f7735

refactor: 경로 수정

f7665fc

feat: Service 인터페이스 추가

e6f3157

feat: ApiResponse 생성

f42dced

feat: findAll 반환 타입 수정

82a4af9

refactor: 인터페이스 public 접근제어자 제거

2b1fd49

test: PostControllerTest 테스트 코드 작성

7a6c5b3

test: PostServiceImpl 테스트코드 작성

c22e210

feat: .adoc 작성 (미완성)

d3cc26b

feat: index.adoc 설정

27f78ef

feat: index.adoc 설정

9ccaa64

yumyeonghan added 🔥 매운맛 Team-Seunghoon labels Aug 1, 2023

yumyeonghan requested review from seung-hun-h and dojinyou August 1, 2023 13:55

yumyeonghan and others added 9 commits August 3, 2023 17:08

refactor: Use single class import

8fa78fb

feat: PostResponseDto 사용

d168381

response에 대해서는 PostDto->PostResponseDto로 반환하도록 변경

test: findPost 테스트 코드 ID 검증하도록 수정

672428a

feat: ApiIdResponse 생성

ed18262

- Long 타입의 식별자를 응답하기 위한 record 생성

feat: createPost 반환 타입 수정

478fd87

test: PostControllerTest 테스트 코드 수정

6b3bb52

refactor: BaseEntity 추상 클래스로 정의

8cb1a9d

feat: TIMESTAMP precision 지정

512e224

feat: 제목 데이터에 대한 길이 체크 로직 추가

de8fc1b

dojinyou reviewed Aug 4, 2023

View reviewed changes

src/main/java/com/programmers/domain/post/entity/Post.java Outdated Show resolved Hide resolved

seung-hun-h reviewed Aug 4, 2023

View reviewed changes

yumyeonghan added 2 commits August 5, 2023 15:12

refactor: 상수명 수정

f4bd962

test: Mock 사용해서 테스트 코드 수정

3bb298f

- 영속성 레이어 테스트가 아닌, 서비스 레이어의 단위테스트 이기 때문에 @DataJpaTest 대신 Mock 사용

yumyeonghan requested review from seung-hun-h, dojinyou and na-yk August 5, 2023 08:03

dojinyou reviewed Aug 5, 2023

View reviewed changes

seung-hun-h reviewed Aug 6, 2023

View reviewed changes

yumyeonghan added 5 commits August 6, 2023 19:05

chore: ddl-auto: create-drop 수정

c91c2f4

refactor: 잘못된 메서드 사용 수정

fb8e1cb

refactor: 생성 요청에 맞게 레코드명 수정

fbc1eae

feat: 길이 검증 로직 추가

d697ed8

test: 테스트 코드 수정

c51969f

yumyeonghan requested review from seung-hun-h and dojinyou August 6, 2023 14:49

refactor: 상수 사용

565f609

seung-hun-h reviewed Aug 7, 2023

View reviewed changes

dojinyou approved these changes Aug 8, 2023

View reviewed changes

yumyeonghan added 2 commits August 12, 2023 17:40

test: PostServiceImplTest 수정

9c1dbc9

- PostConverter는 실제 구현체 사용

feat: 예외 메세지에 어떤 id가 들어왔는지 추가

4cfbb14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[4기 유명한 & 나영경] Springboot-board-JPA 1차 PR 입니다. #230

[4기 유명한 & 나영경] Springboot-board-JPA 1차 PR 입니다. #230

yumyeonghan commented Aug 1, 2023

dojinyou left a comment

seung-hun-h Aug 4, 2023

yumyeonghan Aug 5, 2023

dojinyou Aug 5, 2023

yumyeonghan Aug 6, 2023

seung-hun-h Aug 7, 2023

dojinyou Aug 8, 2023

dojinyou Aug 5, 2023

yumyeonghan Aug 6, 2023

dojinyou Aug 8, 2023

seung-hun-h Aug 6, 2023

yumyeonghan Aug 6, 2023 •

edited

seung-hun-h Aug 7, 2023

seung-hun-h Aug 6, 2023

yumyeonghan Aug 6, 2023

seung-hun-h Aug 7, 2023

seung-hun-h Aug 7, 2023

seung-hun-h Aug 7, 2023

dojinyou left a comment


		import static org.assertj.core.api.Assertions.assertThat;

		@DataJpaTest

		private final PostRepository postRepository;
		private final UserRepository userRepository;

[4기 유명한 & 나영경] Springboot-board-JPA 1차 PR 입니다. #230

Are you sure you want to change the base?

[4기 유명한 & 나영경] Springboot-board-JPA 1차 PR 입니다. #230

Conversation

yumyeonghan commented Aug 1, 2023

📌 과제 설명

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

SpringDataJPA 를 설정한다.

엔티티를 구성한다

API를 구현한다.

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

dojinyou 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

yumyeonghan Aug 6, 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

dojinyou left a comment

Choose a reason for hiding this comment

yumyeonghan Aug 6, 2023 •

edited