[JPA] Spring Data JPA - Web 확장 기능

Spring Data JPA는 MVC에서 사용할 수 있는 편리한 기능을 제공합니다.

 

도메인 클래스 컨버터 기능

도메인 클래스 컨버터는 HTTP 파라미터로 넘어온 엔티티의 아이디로 엔티티 객체를 찾아서 바인딩해줍니다.

 

기존에는 아래와 같이 식별자를 Service계층이나 Repository계층에서 메소드를 통해 찾게 했지만,

@GetMapping("/members/{id}")
@ResponseBody
public String findMember(@PathVariable("id") Long id){
	return memberRepository.findById(id).getName()
}

Spirng Data JPA가 제공하는 도메인 클래스 컨버터를 사용하면 식별자를 파라미터로 받아 엔티티의 아이디로 엔티티 객체를 찾아서 바인딩할 수 있습니다.

@GetMapping("/members/{id}")
public String findMember(@PathVariable("id") Member member) {
    return member.getName();
}

주의할 점 : 트랜잭션이 없는 범위에서 엔티티를 조회했기 때문에, 엔티티를 변경해도 DB에 반영되지 않습니다!

따라서 이 기능은 단순히 조회용으로만 사용해야 합니다.

페이징 및 정렬 기능

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

• 페이징 기능 : PageableHandlerMethodArgumentResolver
• 정렬 기능 : SortHandlerMethodArgumentResolver

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

HandlerMethodArgumentResolver를 제공하기 때문에, 파라미터로 Pageable을 받을 수 있습니다.

 

요청 파라미터

• page : 현재 페이지, 0부터 시작
• size : 한 페이지에 노출할 데이터 건수
• sort : 정렬 조건 정의 

ex) /members?page=0&size=3&sort=id,desc&sort=username,desc

 

추가1 : 요청 파라미터 정보 디폴트 값을 application.properties에 등록해서 사용할 수 있습니다.

spring.data.web.pageable.default-page-size=20 /# 기본 페이지 사이즈/ 
spring.data.web.pageable.max-page-size=2000 /# 최대 페이지 사이즈/

추가1-1 : 개별설정은 @PageableDefulat 어노테이션 사용

public String list(@PageableDefault(size = 12, sort = “username”,
				direction = Sort.Direction.DESC) Pageable pageable) {
	... 
}

추가 2 : 페이징 정보가 둘 이상인 경우 - 이 때 @Qualifier에 접두사명을 추가해 추가 구분자를 등록해 줍시다.

Spring / @Qualifier, @Primary

@GetMapping("/members")
public String list(
	@Qualifier("member") Pageable memberPageable,
    @Qualifier("order") Pageable orderPageable, ...){
	...
}

ex) /members?member_page=0&order_page=1&member_size=5&order_size=3

 

추가 3 : 엔티티를 그대로 노출하는 것은 언제나 위험합니다. 페이징을 사용할 때 또한 엔티티를 그대로 노출하지 말고 DTO를 사용합시다 !

Page는 map()을 지원해서 내부 데이터를 다른 것으로 변경할 수 있습니다.

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

추가 4 : 페이지를 1부터 시작하고 싶으면 PageableHandlerMethodArgumentResolver를 스프링 빈으로 직접 등록한 이후 setOneIndexedParameters를 true로 설정

@Configuration
public class CustomPageableConfiguration {
    @Bean
    public PageableHandlerMethodArgumentResolverCustomizer customize() {
        return p -> p.setOneIndexedParameters(true);
    }
}

또는 application.properties에 설정 추가 

spring.data.web.pageable.one-indexed-parameters=true

이 방법들은 web에서 page 파라미터를 -1 처리할 뿐이기 때문에 따라서 파라미터나 메소드를를 통해 입력받는 값과 -1씩 차이가 나기 때문에 현재 페이지 index를 반환하고 싶다면 반드시 입력 값에 -1을 해주어야 합니다. 

 

<참고 자료>

스프링 MVC 2편 - 백엔드 웹 개발 활용 기술 - 인프런 | 강의

 

Spring Data JPA의 Slice & Page

 

Spring Data JPA에서의 페이지네이션과 정렬

 

자바 ORM 표준 JPA 프로그래밍