본문 바로가기

spring boot

실전! 스프링 부트와 JPA 활용2 - 1주차

저번 강의에 이어서 API개발을 한다.

postman은 이미 설치가 되어 있음.

 

1. 회원 등록 API

 

package jpabook.jpashop.api;
@RestController
@RequiredArgsConstructor
public class MemberApiController {
 private final MemberService memberService;
 /**
 * 조회 V1: 응답 값으로 엔티티를 직접 외부에 노출한다.
 * 문제점
 * - 엔티티에 프레젠테이션 계층을 위한 로직이 추가된다.
 * - 기본적으로 엔티티의 모든 값이 노출된다. * - 응답 스펙을 맞추기 위해 로직이 추가된다. (@JsonIgnore, 별도의 뷰 로직 등등)
 * - 실무에서는 같은 엔티티에 대해 API가 용도에 따라 다양하게 만들어지는데, 한 엔티티에 각각의
API를 위한 프레젠테이션 응답 로직을 담기는 어렵다.
 * - 엔티티가 변경되면 API 스펙이 변한다.
 * - 추가로 컬렉션을 직접 반환하면 항후 API 스펙을 변경하기 어렵다.(별도의 Result 클래스 생성
으로 해결)
 * 결론
 * - API 응답 스펙에 맞추어 별도의 DTO를 반환한다.
 */
 //조회 V1: 안 좋은 버전, 모든 엔티티가 노출, @JsonIgnore -> 이건 정말 최악, api가 이거 하나인가! 화면에 종속적이지 마라!
 @GetMapping("/api/v1/members")
 public List<Member> membersV1() {
 return memberService.findMembers();
 }
 
  /**
 * 조회 V2: 응답 값으로 엔티티가 아닌 별도의 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;
 }
}
  • RequestBody에 엔티티를 매핑하면 여러 문제점이 있다.
  • 한 엔티티에 각 API를 위한 모든 요구사항을 담기 어렵고, 엔티티가 변경되면 API 스펙이 변한다.ㄷ
  • 따라서 API 요청 스펙에 맞추어 별도의 DTO를 파라미터로 받는다.
  • 즉, CreateMemberRequest를 Member 엔티티 대신에 RequestBody와 매핑한다.
  • 이렇게 하면 엔티티와 프레젠테이션 계층을 위한 로직을 분리할 수 있다.
  • 또, 엔티티와 API 스펙을 분리하여 엔티티가 변해도 API 스펙이 변하지 않는다.

post


2. 회원 수정 API

 

/**
 * 수정 API
 */
@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());
}
@Data
static class UpdateMemberRequest {
 private String name;
}
@Data
@AllArgsConstructor
static class UpdateMemberResponse {
 private Long id;
 private String name;
}
  • 마찬가지로 DTO를 요청 파라미터에 매핑한다.
// MemberService
/**
 * 회원 수정
 */
 @Transactional
 public void update(Long id, String name) {
 Member member = memberRepository.findOne(id);
 member.setName(name);
 }
  • memberService.update를 통해 변경 감지를 사용해서 데이터를 수정한다.

put


3. 회원 조회 API

 

/**
 * 조회 V2: 응답 값으로 엔티티가 아닌 별도의 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를 사용한다.
  • 추가로 Result 클래스로 컬렉션을 감싸소 필요한 필드를 추가할 수도 있다.

오류

  • "Content-Type 'text/plain;charset=UTF-8' is not supported.

django로 할 때랑 다르게 form-data 형식은 지원하지 않아서 raw로 설정하고 데이터를 보내야 한다.

이때 postman은 기본으로 text가 설정되어 있어서, 이부분을 JSON으로 바꿔준다.

 

  • rerun하면 데이터 날라감...자꾸 까먹어서 오류 뜬다.