Spring: Pageable を使ってページ番号を 1から始める

Spring で Pageable を使うとき、標準では 0 Page から始まります。それを 1 から始めるようにするときの方法です。

環境

Spring 5
Spring Boot 2

方法

次の Configuration を追加します。 Java で書く場合と Kotlin で書く場合のコードを掲載します。

Java

package com.improve_future.sample.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.web.PageableHandlerMethodArgumentResolver;
import org.springframework.web.method.support.HandlerMethodArgumentResolver;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.List;
@Configuration
public class CustomMvcConfiguration implements
WebMvcConfigurer {
@Override
public void addArgumentResolvers(
List<HandlerMethodArgumentResolver> argumentResolvers) {
PageableHandlerMethodArgumentResolver resolver =
new PageableHandlerMethodArgumentResolver();
resolver.setOneIndexedParameters(true);
argumentResolvers.add(resolver);
}
}

package com.improve_future.sample.config;

import org.springframework.context.annotation.Configuration;

import org.springframework.data.web.PageableHandlerMethodArgumentResolver;

import org.springframework.web.method.support.HandlerMethodArgumentResolver;

import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

import java.util.List;

@Configuration

public class CustomMvcConfiguration implements

WebMvcConfigurer {

@Override

public void addArgumentResolvers(

List<HandlerMethodArgumentResolver> argumentResolvers) {

PageableHandlerMethodArgumentResolver resolver =

new PageableHandlerMethodArgumentResolver();

resolver.setOneIndexedParameters(true);

argumentResolvers.add(resolver);

}

Kotlin

package com.enjoy_your_sound.sample.config
import org.springframework.context.annotation.Configuration
import org.springframework.data.web.PageableHandlerMethodArgumentResolver
import org.springframework.web.method.support.HandlerMethodArgumentResolver
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer
@Configuration
open class WebMvcConfiguration : WebMvcConfigurer {
override fun addArgumentResolvers(argumentResolvers: MutableList<HandlerMethodArgumentResolver>?) {
val resolver = PageableHandlerMethodArgumentResolver()
resolver.setOneIndexedParameters(true)
argumentResolvers!!.add(resolver)
}
}

package com.enjoy_your_sound.sample.config

import org.springframework.context.annotation.Configuration

import org.springframework.data.web.PageableHandlerMethodArgumentResolver

import org.springframework.web.method.support.HandlerMethodArgumentResolver

import org.springframework.web.servlet.config.annotation.WebMvcConfigurer

@Configuration

open class WebMvcConfiguration : WebMvcConfigurer {

override fun addArgumentResolvers(argumentResolvers: MutableList<HandlerMethodArgumentResolver>?) {

val resolver = PageableHandlerMethodArgumentResolver()

resolver.setOneIndexedParameters(true)

argumentResolvers!!.add(resolver)

}

これでページ番号が 1 から始まるようになります。

例

たとえば次のようなコントローラメソッドが関係します。 Kotlin のコードです。

package com.improve_future.sample.presentation.sample
import com.improve_future.sample.domain.sample.service.SampleService
import com.improve_future.sample.presentation.core.Pager
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.data.domain.Pageable
import org.springframework.data.web.PageableDefault
import org.springframework.http.MediaType
import org.springframework.stereotype.Controller
import org.springframework.web.bind.annotation.*
import org.springframework.web.servlet.mvc.support.RedirectAttributes
import javax.servlet.http.HttpServletRequest
@Controller
@RequestMapping(value = "sample")
open class SampleController {
@Autowired
private lateinit var sampleService: SampleService
@GetMapping(
consumes = arrayOf(MediaType.APPLICATION_JSON_VALUE),
produces = arrayOf(MediaType.APPLICATION_JSON_VALUE))
@ResponseBody
fun list(
@PageableDefault(size = 30) pageable: Pageable
): Map<String, Any?> {
val samplePage = sampleService.findAll(pageable)
return SampleJsonView.list(samplePage)
}
}

package com.improve_future.sample.presentation.sample

import com.improve_future.sample.domain.sample.service.SampleService

import com.improve_future.sample.presentation.core.Pager

import org.springframework.beans.factory.annotation.Autowired

import org.springframework.data.domain.Pageable

import org.springframework.data.web.PageableDefault

import org.springframework.http.MediaType

import org.springframework.stereotype.Controller

import org.springframework.web.bind.annotation.*

import org.springframework.web.servlet.mvc.support.RedirectAttributes

import javax.servlet.http.HttpServletRequest

@Controller

@RequestMapping(value = "sample")

open class SampleController {

@Autowired

private lateinit var sampleService: SampleService

@GetMapping(

consumes = arrayOf(MediaType.APPLICATION_JSON_VALUE),

produces = arrayOf(MediaType.APPLICATION_JSON_VALUE))

@ResponseBody

fun list(

@PageableDefault(size = 30) pageable: Pageable

): Map<String, Any?> {

val samplePage = sampleService.findAll(pageable)

return SampleJsonView.list(samplePage)

}

このようにすると、 /sample でレコードが取得できます。 /sample?page=1 にアクセスすると、最初の30件のレコードを取得できます。

サービス、リポジトリを以下に掲載します。

package com.improve_future.sample.domain.sample.service
import com.improve_future.sample.domain.sample.model.Sample
import com.improve_future.sample.domain.sample.repository.SampleRepository
import com.improve_future.sample.domain.sample.repository.SampleSpecification
import org.springframework.beans.factory.annotation.Autowired
import org.springframework.data.domain.Page
import org.springframework.data.domain.Pageable
import org.springframework.stereotype.Service
@Service
class SampleService {
@Autowired
lateinit private var sampleRepository: SampleRepository
fun findAll(pageable: Pageable): Page<Sample> {
return sampleRepository.findAll(pageable)
}
}

package com.improve_future.sample.domain.sample.service

import com.improve_future.sample.domain.sample.model.Sample

import com.improve_future.sample.domain.sample.repository.SampleRepository

import com.improve_future.sample.domain.sample.repository.SampleSpecification

import org.springframework.beans.factory.annotation.Autowired

import org.springframework.data.domain.Page

import org.springframework.data.domain.Pageable

import org.springframework.stereotype.Service

@Service

class SampleService {

@Autowired

lateinit private var sampleRepository: SampleRepository

fun findAll(pageable: Pageable): Page<Sample> {

return sampleRepository.findAll(pageable)

}

package com.improve_future.sample.domain.sample.repository
import com.improve_future.sample.domain.sample.model.Sample
import org.springframework.data.jpa.repository.JpaRepository
import org.springframework.data.jpa.repository.JpaSpecificationExecutor
import org.springframework.data.repository.PagingAndSortingRepository
@org.springframework.stereotype.Repository
interface SampleRepository:
JpaRepository<Sample, Long>,
PagingAndSortingRepository<Sample, Long>,
JpaSpecificationExecutor<Sample>