Spring Data JPA | Web 확장 - 도메인 클래스 컨버터, 페이징과 정렬

도메인 클래스 컨버터

HTTP 파라미터로 넘어온 엔티티의 아이디로 엔티티 객체를 찾아서 바인딩

 

도메인 클래스 컨버터 사용 전

@RestController
@RequiredArgsConstructor
public class MemberController {
	private final MemberRepository memberRepository;

	@GetMapping("/members/{id}")
	public String findMember(@PathVariable("id") Long id) {
		Member member = memberRepository.findById(id).get();
		return member.getUsername();
	}

	@PostConstruct
	public void init() {
		memberRepository.save(new Member("userA"));
	}

도메인 클래스 컨버터 사용 후

@GetMapping("/members2/{id}")
	public String findMember2(@PathVariable("id") Member member) {
		return member.getUsername();
	}

• HTTP 요청은 회원 id를 받지만 도메인 클래스 컨버터가 중간에 동작해서 회원 엔티티 객체를 반환 
• 도메인 클래스 컨버터도 리파지토리를 사용해서 엔티티를 찾음

주의: 도메인 클래스 컨버터로 엔티티를 파라미터로 받으면, 이 엔티티는 단순 조회용으로만 사용해야 한다. (트랜잭션이 없는 범위에서 엔티티를 조회했으므로, 엔티티를 변경해도 DB에 반영되지 않는다.)

 

페이징과 정렬

스프링 데이터가 제공하는 페이징과 정렬 기능을 스프링 MVC에서 편리하게 사용할 수 있다.

 

예제)

MemberController

        @GetMapping("/members")
	public Page<Member> list(Pageable pageable) {
		Page<Member> page = memberRepository.findAll(pageable);
		return page;
	}

	@PostConstruct
	public void init() {
		for (int i = 0; i < 100; i++) {
			memberRepository.save(new Member("user" + i, i));
		}
	}

• 파라미터로 Pageable 을 받을 수 있다.
• Pageable 은 인터페이스, 실제는 org.springframework.data.domain.PageRequest 객체 생성

Postman으로 확인해보기

요청 파라미터

http://localhost:8080/members?page=0&size=3&sort=id,desc&sort=username,desc

• page: 현재 페이지, 0부터 시작한다.
• size: 한 페이지에 노출할 데이터 건수
• sort: 정렬 조건을 정의한다. 예) 정렬 속성,정렬 속성...(ASC | DESC), 정렬 방향을 변경하고 싶으면 sort 파라미터 추가 ( asc 생략 가능)

 

기본값

글로벌 설정: 스프링 부트 application.yml에 세팅하기

  data:
    web:
      pageable:
        default-page-size: 10 /# 기본 페이지 사이즈/ 
        max-page-size: 2000  /# 최대 페이지 사이즈/

개별 설정: @PageableDefault 어노테이션을 사용

@RequestMapping(value = "/members_page", method = RequestMethod.GET)
  public String list(@PageableDefault(size = 12, sort = “username”,
... }

 

접두사

• 페이징 정보가 둘 이상이면 접두사로 구분
• @Qualifier 에 접두사명 추가 "{접두사명}_xxx”
• 예제: /members?member_page=0&order_page=1

  public String list(
      @Qualifier("member") Pageable memberPageable,
      @Qualifier("order") Pageable orderPageable, ...

 

Page 내용을 DTO로 변환하기

• 엔티티를 API로 노출하면 다양한 문제가 발생한다. 그래서 엔티티를 꼭 DTO로 변환해서 반환해야 한다.
• Page는 map() 을 지원해서 내부 데이터를 다른 것으로 변경할 수 있다.

@GetMapping("/members")
	public Page<MemberDto> list(@PageableDefault(size = 5) Pageable pageable) {
		Page<Member> page = memberRepository.findAll(pageable);
		return page.map(member -> new MemberDto(member.getId(), member.getUsername(), null));
	}

 

참고: DTO는 엔티티를 받아서 사용해도 괜찮다.

즉, MemberDTO는 다음과 같고

public MemberDto(Member member) {
		this.id = member.getId();
		this.username = member.getUsername();
	}

이를 MemberController에서 다음과 같이 사용한다. (inline으로 최적화 한 코드이다.)

	@GetMapping("/members")
	public Page<MemberDto> list(@PageableDefault(size = 5) Pageable pageable) {
		return memberRepository.findAll(pageable)
				.map(MemberDto::new);
	}

 

Page를 1부터 시작하기

스프링 데이터는 Page를 0부터 시작한다. 만약 1부터 시작하려면?

1. Pageable, Page를 파리미터와 응답 값으로 사용히지 않고, 직접 클래스를 만들어서 처리한다. 그리고 직접 PageRequest(Pageable 구현체)를 생성해서 리포지토리에 넘긴다. 물론 응답값도 Page 대신에 직접 만들어서 제공해야 한다.

 

2. spring.data.web.pageable.one-indexed-parameters 를 true 로 설정한다. 그런데 이 방법은 web에서 page 파라미터를 -1 처리 할 뿐이다. 따라서 응답값인 Page 에 모두 0 페이지 인덱스를 사용하는 한계가 있다.