[HW/#7] 3차 세미나 실습과제

[PicturePark1101]

3차 세미나 pr

• closes [HW] 3차 세미나 실습과제 #7

명세서

API 명세서

공통부분

SuccessStatusResponse

• 제네릭 타입의 result 필드를 추가해서 DTO를 리턴할 수 있도록 했습니다.

public record SuccessStatusResponse<T>(
    int status,
    String message,
    T result
) {

  public static SuccessStatusResponse of(SuccessMessage successMessage) {
    return new SuccessStatusResponse(successMessage.getStatus(), successMessage.getMessage(), null);
  }

  public static <T> SuccessStatusResponse of(SuccessMessage successMessage, T responseDto) {
    return new SuccessStatusResponse(successMessage.getStatus(), successMessage.getMessage(), responseDto);
  }

}

<응답 예시>

CustomValidateException

• 커스텀 validate 예외를 추가했습니다.
• ValidateException은 자바에 이미 존재하는 Exception이라 CustomValidateException이라고 지었습니다.

@Getter
public class CustomValidateException extends BusinessException {

  public CustomValidateException(ErrorMessage errorMessage) {
    super(errorMessage);
  }

}

• CustomValidateException 생성 후 GlobalExceptionHandler에 추가했습니다.

@RestControllerAdvice
public class GlobalExceptionHandler {
  ....생략

  @ExceptionHandler(CustomValidateException.class)
  protected ResponseEntity<ErrorResponse> handleNotFoundException(CustomValidateException e) {
    return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ErrorResponse.of(e.getErrorMessage()));
  }

}

블로그 소유주 검증

BlogService

• 만약 blogId로 찾은 Blog의 memberId와 요청으로 받은 memberId가 일치하지 않는다면 CustomValidateException 발생
• 일치하면 찾은 blog 객체 리턴

 public Blog validateOwner(Long blogId, Long requestMemberId) {

    Blog blog = findById(blogId);
    Long findMemberId = blog.getMember().getId();

    if (!requestMemberId.equals(findMemberId)) {
      throw new CustomValidateException(ErrorMessage.BLOG_UNAUTHORIZED);
    }

    return blog;
  }

postId로 조회하는 메서드 추가

PostService

• postId로 Post 테이블에서 데이터 조회하는 공통 메서드

 public Post findById(Long postId) {
    return postRepository.findById(postId).orElseThrow(
        () -> new NotFoundException(ErrorMessage.POST_NOT_FOUND)
    );
  }

---

Post 작성 API

dto

• post 작성 요청 DTO입니다.
• name과 content 모두 null 혹은 공백은 비허용하도록 하였습니다.

public record PostCreateRequest(
    @NotBlank(message = "글의 제목은 필수입니다.")
    String name,

    @NotBlank(message = "글의 내용은 필수입니다.")
    String content

){}

controller

• API URL은 /api/v1/post/{blogId} 로 하였습니다.
• memberId는 RequestHeader로, blogId는 PathVariable로 받게 하였습니다.
• 리턴값으로 헤더에 post의 Id를, body에 성공 메시지를 받게 했습니다.

@PostMapping("post/{blogId}")
  public ResponseEntity<SuccessStatusResponse> publishPost(
      @RequestHeader(name = "memberId") Long memberId,
      @PathVariable(name = "blogId") Long blogId,
      @Valid @RequestBody PostCreateRequest postCreateRequest
  ) {

    // Location은 생성된 리소스의 위치를 나타낸다. 이 코드의 경우 생성된 post의 id
    return ResponseEntity.status(HttpStatus.CREATED).header(
            "Location",
            postService.create(memberId, blogId, postCreateRequest))
      .body(SuccessStatusResponse.of(SuccessMessage.POST_CREATE_SUCCESS));
  }

service

• blogService의 validateOwner 를 이용하여 블로그 소유주를 검증합니다.
• 만약에 소유주가 맞다면 blog 객체를 전달받습니다.
• 새 post를 생성한뒤 생성한 post의 id를 리턴합니다.

 @Transactional
  public String create(Long memberId, Long blogId, PostCreateRequest postCreateRequest)
  {
    // 요청한 사람이 블로그 소유주인지 확인, 맞으면 블로그 객체 리턴
    Blog findBlog = blogService.validateOwner(blogId, memberId);
    Post post = postRepository.save(Post.create(findBlog, postCreateRequest));

    // 블로그 글 생성하고 DB에 저장 후 생성된 id 반환
    return post.getId().toString();
  }

---

Post 개별조회 API

dto

• post를 개별조회할 때 사용하는 DTO입니다.

public record PostFindDto(
    String name,

    String content

) {
  public static PostFindDto of(
      Post post
  ) {
    return new PostFindDto(post.getName(), post.getContent());
  }
}

controller

• API URL은 /api/v1/post/{blogId}/{postId} 로 하였습니다.
• memberId는 RequestHeader로, blogId와 postId는 PathVariable로 받게 하였습니다.
• 리턴값으로 성공메시지(SuccessMessage.POST_FIND_SUCCESS) 와 PostFindDto를 리턴합니다.

@GetMapping("post/{blogId}/{postId}")
  public ResponseEntity<SuccessStatusResponse> findPost(
      @RequestHeader(name = "memberId") Long memberId,
      @PathVariable(name = "blogId") Long blogId,
      @PathVariable(name = "postId") Long postId
  ) {

    PostFindDto post = postService.findPost(memberId, blogId, postId);

    return ResponseEntity.ok(SuccessStatusResponse.of(
        SuccessMessage.POST_FIND_SUCCESS,
        post
    ));

  }

service

• blogService의 validateOwner 를 이용하여 블로그 소유주를 검증합니다.
• 전달받은 postId를 통해 post를 조회해서 DTO로 변경한 뒤 리턴합니다.

 public PostFindDto findPost(Long memberId, Long blogId, Long postId){

    blogService.validateOwner(blogId, memberId);
    return PostFindDto.of(findById(postId));
  }

Post 전체조회 API

dto

• post를 전체조회할 때 사용하는 DTO입니다.
• PostFindDto를 요소로 가지는 postList를 필드로 가지고 있습니다.

public record PostListFindDto(
    List<PostFindDto> postList

) {
  public static PostListFindDto of(
      List<Post> posts
  ) {
    List<PostFindDto> postFindDtoList = posts.stream()
        .map(PostFindDto::of)
        .toList();
    return new PostListFindDto(postFindDtoList);
  }
}

controller

• API URL은 /api/v1/post/{blogId} 로 하였습니다.
• memberId는 RequestHeader로, blogId는 PathVariable로 받게 하였습니다.
• 리턴값으로 성공메시지(SuccessMessage.POST_FIND_SUCCESS) 와 PostListFindDto를 리턴합니다.

@GetMapping("post/{blogId}")
  public ResponseEntity<SuccessStatusResponse> findPostList(
      @RequestHeader(name = "memberId") Long memberId,
      @PathVariable(name = "blogId") Long blogId
      ) {

    PostListFindDto postList = postService.findAllPost(memberId, blogId);

    return ResponseEntity.ok(SuccessStatusResponse.of(
        SuccessMessage.POST_FIND_SUCCESS,
        postList
    ));

  }

service

• blogService의 validateOwner 를 이용하여 블로그 소유주를 검증합니다.
• 만약에 소유주가 맞다면 blog 객체를 전달받습니다.
• 리턴받은 blog를 통해서 해당 blog에 존재하는 post들을 찾아 PostListFindDto로 변환해 리턴합니다.

  public PostListFindDto findAllPost(Long memberId, Long blogId){

    Blog findBlog = blogService.validateOwner(blogId, memberId);
    return PostListFindDto.of(postRepository.findByBlog(findBlog));
  }

고민

API URL

• 개별조회 URL의 경우 /api/v1/post/{blogId}/{postId} 로 했는데 적절한지 의문입니다..
• post의 경우 blog에 속해있으니/api/v1/blog/posts 로 설정해야해도 괜찮을까요..?

blog 소유주 검증 위치

• 일단 blog의 member을 검사해야하니 BlogService에 만들었는데, 이게 적절한지 의문입니다.
• 메소드 이름 은 validateOwner 인데 return 타입은 Blog라 좋은 코드인지 잘 모르겠습니다.(뭔가 Boolean이 더 적절해보여서..)
• PostService에선 검증없이 리턴값을 바로 받아서 사용하는데, 해당 메소드 안에서 CustomValidateException 예외처리를 해주니 그냥 사용해도 괜찮을까요..? 뭔가 정말 예기치 않은 오류가 터질까 불안해서..

 public Blog validateOwner(Long blogId, Long requestMemberId) {

    Blog blog = findById(blogId);
    Long findMemberId = blog.getMember().getId();

    if (!requestMemberId.equals(findMemberId)) {
      throw new CustomValidateException(ErrorMessage.BLOG_UNAUTHORIZED);
    }

    return blog;
  }

[Parkjyun]

서진님 과제 하시느라 고생 많으셨습니다~

[Parkjyun]

SuccessStatusResponse처럼 반환타입에도 제네릭을 붙여주세요.
현재 코드에서 는 responseDto에만 적용되어 responseDto에만 타입 안전성이 보장됩니다.
반환타입에도 붙이면 가독성, 안전성을 향상시킬 수 있습니다!

[Parkjyun]

rest api에서는 복수형이 선호된다고 알고 있습니다.
그리고 endpoint를 /blogs/{blogId}/posts 로 하는 것은 어떨까요?
조금 더 rest에 부합한다고 생각합니다. 블로그중 blogId에 해당하는 blog에 post를 작성하는 것이니까요

[PicturePark1101]

오 endpoint에 대한 고민이 많았는데 조언해주신대로 바꿔보겠습니다 감사합니다!

[Parkjyun]

.created()를 사용해도 좋을 것 같습니다

[PicturePark1101]

.created() 등 관련된 메소드에 대해서 잘 몰랐는데 이 기회에 더 공부해보겠습니다 👍 👍

[Parkjyun]

BLOG_UNAUTHORIZED가 404를 갖고 있는데 이 경우에는 권한이 없다는 403이 더 적합하지 않을까요?

[lreowy]

동의합니당 404를 쓰기에는 적절하지 않은 것 같아요!

[Parkjyun]

마찬가지로 /blogs/{blogId}/posts가 더 적합해 보입니다.

[Parkjyun]

여기에 검증 로직을 추가하신 이유가 따로 있으실까요?
블로그의 글들은 블로그의 주인이 아닌 모두가 볼 수 있어야하지 않을까요?

[minwoo0419]

조회는 모든 사람들이 볼 수 있도록 해주는 것이 좋을 것 같은데 validateOwner를 추가하신 이유가 궁금합니다!

[PicturePark1101]

오... 요구사항 로직이 머릿속에서 꼬여서 이렇게 해버린 것 같습니다..ㅎㅎ 바꿔보도록하겠습니다!

[Parkjyun]

여기는 /posts/{postId} 또는 /blogs/{blogId}/posts/{postId} 둘중에 하나가 rest에 더 부합하는 것 같습니다

[Parkjyun]

전체 조회와 마찬가지로 검증 로직에 의문이 드네요

[minwoo0419]

과제 하시느라 고생하셨습니다! 전체적으로 잘 구현하신 것 같네요!

[lreowy]

서진님 고생하셨습니당~! 갓재연님이 좋은 리뷰 많이 달아주셔서 구경 겸... 조금씩 보이는거 리뷰 달아봤어요
전반적으로 코드가 깔끔해서 알아보기 편하고 좋았습니다 ㅎㅁㅎ

[lreowy]

동의합니당 404를 쓰기에는 적절하지 않은 것 같아요!

[lreowy]

블로그 제목이나 내용에도 글자수 제한 같은 걸 걸어주면 생각하지 못한 예외를 방지하는데 도움이 될 것 같아요!

[sebbbin]

커밋 기록을 보니 코드 구현하실 때 고민을 많이 하신 흔적을 볼 수 있어서 좋았습니다 - ! 다른 분들께서 좋은 조언 해주셔서 같이 배우고 갈 수 있었습니다 :) 수고하셨어요 !

[sohyundoh]

과제하느라 고생했어요!

이미 좋은 리뷰가 많이 달려있어서 구경했네요! 코멘트 확인하고 반영하면 좋을 것 같아요!

[sohyundoh]

Status가 Unauthorized 가 아니네요! 한 번 확인해보시는 걸 추천드립니다!

[sohyundoh]

요 네줄은 사용되지 않으니 클린코드를 위해 지우는 방향이 어떨까요?