[스프링 부트] API 개발과 성능 최적화 Tip 1

조성우·2024년 8월 20일

스프링 부트

Spring Boot

목록 보기

12/12

본 포스팅은 실전! 스프링 부트와 JPA 활용2 - API 개발과 성능 최적화 강의를 듣고 정리한 내용입니다.

1. 엔티티를 Request Body에 직접 매핑?!

문제점

엔티티에 프레젠테이션 계층을 위한 로직이 추가된다.
엔티티에 API 검증을 위한 로직이 들어간다. (@NotEmpty 등등)
실무에서는 회원 엔티티를 위한 API가 다양하게 만들어지는데, 한 엔티티에 각각의 API를 위한 모든 요청 요구사항을 담기는 어렵다.
엔티티가 변경되면 API 스펙이 변한다.

결론 - 엔티티 대신에 DTO를 RequestBody에 매핑

API 요청 스펙에 맞추어 별도의 DTO를 파라미터로 받는다.

엔티티와 프레젠테이션 계층을 위한 로직을 분리할 수 있다.
엔티티와 API 스펙을 명확하게 분리할 수 있다.
엔티티가 변해도 API 스펙이 변하지 않는다.

실무에서는 절대 엔티티를 API 스펙에 노출하면 안된다!

참고

DTO에는 자체 로직이 들어있지 않기 때문에 @Data과 같은 Lombok을 자유롭게 사용하는 편이다

응답으로 엔티티를 직접 외부에 노출?!

문제점

엔티티에 프레젠테이션 계층을 위한 로직이 추가된다.
기본적으로 엔티티의 모든 값이 노출된다.
응답 스펙을 맞추기 위해 화면에 종속적인 로직이 추가된다. (@JsonIgnore, 별도의 뷰 로직 등등)
실무에서는 같은 엔티티에 대해 API가 용도에 따라 다양하게 만들어지는데, 한 엔티티에 각각의 API를 위한 프레젠테이션 응답 로직을 담기는 어렵다.
엔티티가 변경되면 API 스펙이 변한다.
추가로 컬렉션을 직접 반환하면 항후 API 스펙을 변경하기 어렵다. (별도의 Result<T> 클래스 생성으로 해결)

결론

API 응답 스펙에 맞추어 별도의 DTO를 반환한다.

예시

@GetMapping("/api/v2/members")
public Result membersV2() {
    
    List<Member> findMembers = memberService.findMembers();
    // 엔티티 -> DTO 변환
    List<MemberDto> collect = findMembers.stream()
        .map(m -> new MemberDto(m.getName()))
        .collect(Collectors.toList());
    return new Result(collect);
}

@Data
@AllArgsConstructor
static class Result<T> {
    private T data;
}

@Data
@AllArgsConstructor
static class MemberDto {
    private String name;
}

엔티티를 DTO로 변환해서 반환한다.
엔티티가 변해도 API 스펙이 변경되지 않는다.
추가로 Result 클래스로 컬렉션을 감싸서 향후 필요한 필드를 추가할 수 있다.

커맨드와 쿼리를 분리?

@PutMapping("/api/v2/members/{id}")
public UpdateMemberResponse updateMemberV2(@PathVariable("id") Long id, @RequestBody @Valid UpdateMemberRequest request) {
    memberService.update(id, request.getName());
    Member findMember = memberService.findOne(id);
    return new UpdateMemberResponse(findMember.getId(), findMember.getName());
}

public class MemberService {
    
    private final MemberRepository memberRepository;
    
    @Transactional
    public void update(Long id, String name) {
        Member member = memberRepository.findOne(id);
        member.setName(name);
    }
}