[JSCODE] 2회차

🎯 목표

• 엔티티 생성
• 기본적인 CRUD 활용
• 요청부터 응답까지 전체 과정 경험
• REST API 설계
• HTTP Status Code

✏️ 내용

1. Entity 개발

setter 지양

엔티티에서 setter를 사용하는 경우 사용한 의도를 쉽게 파악하기 어려우며, 일관성을 유지하기도 어렵다고 한다.

따라서, 엔티티의 값을 수정할 때는 setter를 지양하고, 사용한 의도를 알 수 있는 메서드 혹은 빌더 패턴을 사용하였다.

@NoArgsConstructor(access = AccessLevel.PROTECTED)

무분별한 객체 생성을 막기 위해서(기본 생성자를 막기 위해서) 엔티티에 @NoArgsConstructor(access = AccessLevel.PROTECTED) 어노테이션을 사용했다.

2. Repository, Service 계층 개발

• Repository: 데이터베이스에 접근하여 객체를 DB에 저장하고 관리하는 계층
  

• Service: 핵심 비즈니스 로직을 구현하는 계층
  

3. Controller 개발

API 스펙에 Entity 노출🙅🏻

엔티티를 API 스펙에 노출하는 경우 엔티티에 API 검증 로직과 프레젠테이션 계층을 위한 로직이 추가되거나, 엔티티가 변경되면 API 스펙 자체도 변경되는 문제가 발생한다.

그러므로 API 스펙에 엔티티 대신 별도로 생성한 DTO를 매핑하자.

유연한 Json 객체 반환

전체 게시글을 조회하는 기능에서 반환 타입이 List<Post>라면, Json 객체는 [{Post1}, {Post2}, {Post3}, ...] 형태로 반환된다.

만약 Post뿐만 아니라 Post의 개수같은 다른 데이터를 추가 요청하는 경우 Json 객체를 반환하기 까다로워진다.

따라서, {"count":2, "Post":[{Post1}, {Post2}]} 형태로 유연한 Json 객체 반환을 위해서 Result 클래스로 컬렉션을 감싸서 반환한다.

HTTP Status Code

200 OK와 같은 HTTP 상태 코드뿐만 아니라, 상황에 따라 명확한 정보를 전달할 수 있는 HTTP 상태 코드들도 사용했다.

• 200 OK: 요청이 성공적으로 완료되었을 때 사용
• 201 Created: 새로운 리소스가 생성되었을 때 사용
• 204 No Content: 리소스의 삭제가 정상 처리되었을 때 사용

소스 코드

@RestController
@RequiredArgsConstructor
public class PostApiController {

    private final PostService postService;

    @ResponseStatus(HttpStatus.CREATED)
    @PostMapping("/posts")
    public PostDto writePost(@RequestBody PostDto postDto) {
        Post post = Post.builder()
                .title(postDto.getTitle())
                .content(postDto.getContent())
                .build();
        postService.writePost(post);
        return PostDto.from(post);
    }

    @ResponseStatus(HttpStatus.OK)
    @GetMapping("/posts")
    public Result<PostDto> findAllPostBy() {
        List<Post> findPost = postService.findAllPost();
        List<PostDto> findPostDto = findPost.stream()
                .map(m -> PostDto.from(m))
                .collect(Collectors.toList());
        return Result.from(findPostDto);
    }

    @ResponseStatus(HttpStatus.OK)
    @GetMapping("/posts/{id}")
    public PostDto findById(@PathVariable("id") Long id) {
        Post findPost = postService.findPost(id);
        return PostDto.from(findPost);
    }

    @ResponseStatus(HttpStatus.OK)
    @PatchMapping("/posts/{id}")
    public PostDto updatePost(@PathVariable("id") Long id, @RequestBody PostDto postDto) {
        Post updatePost = postService.updatePost(id, postDto);
        return PostDto.from(updatePost);
    }

    @ResponseStatus(HttpStatus.NO_CONTENT)
    @DeleteMapping("/posts/{id}")
    public String deletePost(@PathVariable("id") Long id) {
        postService.deletePost(id);
        return "ok";
    }
}

💬 후기

이번 회차부터 본격적인 API 개발을 시작했다.
사실 강의를 통해서 CRUD 개발을 경험해본 적은 있지만, 혼자 힘으로 하는 것은 거의 처음이다.
우선 느낌 가는대로 구현은 성공했지만 부족한 부분이 많아서 다양한 예제를 보며 점차 개선시킬 생각이다.

어려웠던 부분 & 개선 방향

• 서비스 계층에 있어야 할 로직이 컨트롤러 계층에 있는 등 각 계층별 어떠한 역할을 수행해야 하는지 감이 완전히 잡히지 않은 듯 하다.
  -> 개발을 시작하기 전 설계에 고민하는 시간을 늘리기

• DTO를 어떻게 설계하고, 어떻게 사용할지에 대해 많이 부족하다.
  -> DTO를 왜 사용하는지 명확하게 받아들인 후에 다양한 예제 코드를 보며 학습하기

• 각각의 어노테이션을 언제, 어디서, 어떻게, 왜 사용하는지에 대한 이해가 부족하다.
  -> 스프링 충분히 복습하기