Spring/spring-data-commons
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DATACMNS-146 - PageableDefaults now takes sorting info as well.

Browse Source 
PageableDefaults now has a sort and sortDir attribute to allow defining the default sorting options applied to the pageable.
This commit is contained in:
Oliver Gierke
2012-09-17 10:48:32 +02:00
parent 9b4cbb48f1
commit 936facac88
3 changed files with 98 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
spring-data-commons-core/src/main/java/org/springframework/data/web/PageableArgumentResolver.java
View File

@@ -20,6 +20,7 @@ import java.lang.annotation.Annotation;
import java.lang.reflect.Method;
import java.util.HashSet;
import java.util.Set;
import javax.servlet.ServletRequest;
import org.springframework.beans.PropertyValue;
@@ -118,9 +119,7 @@ public class PageableArgumentResolver implements WebArgumentResolver {
// search for PageableDefaults annotation
for (Annotation annotation : methodParameter.getParameterAnnotations()) {
if (annotation instanceof PageableDefaults) {
PageableDefaults defaults = (PageableDefaults) annotation;
// +1 is because we substract 1 later
return new PageRequest(defaults.pageNumber() + 1, defaults.value());
return getDefaultPageRequestFrom((PageableDefaults) annotation);
}
}
@@ -130,6 +129,19 @@ public class PageableArgumentResolver implements WebArgumentResolver {
return new PageRequest(fallbackPagable.getPageNumber(), fallbackPagable.getPageSize(), fallbackPagable.getSort());
}
private static Pageable getDefaultPageRequestFrom(PageableDefaults defaults) {
// +1 is because we substract 1 later
int defaultPageNumber = defaults.pageNumber() + 1;
int defaultPageSize = defaults.value();
if (defaults.sort().length == 0) {
return new PageRequest(defaultPageNumber, defaultPageSize);
}
return new PageRequest(defaultPageNumber, defaultPageSize, defaults.sortDir(), defaults.sort());
}
/**
* Resolves the prefix to use to bind properties from. Will prepend a possible {@link Qualifier} if available or
* return the configured prefix otherwise.

17
spring-data-commons-core/src/main/java/org/springframework/data/web/PageableDefaults.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2008-2011 the original author or authors.
* Copyright 2008-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -21,6 +21,7 @@ import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.data.domain.Pageable;
import org.springframework.data.domain.Sort.Direction;
/**
* Annotation to set defaults when injecting a {@link Pageable} into a controller method.
@@ -42,4 +43,18 @@ public @interface PageableDefaults {
* parameter defined in request (default is 0).
*/
int pageNumber() default 0;
/**
* The properties to sort by by default. If unset, no sorting will be applied at all.
*
* @return
*/
String[] sort() default {};
/**
* The direction to sort by. Defaults to {@link Direction#ASC.
*
* @return
*/
Direction sortDir() default Direction.ASC;
}

85
spring-data-commons-core/src/test/java/org/springframework/data/web/PageableArgumentResolverUnitTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2008-2011 the original author or authors.
* Copyright 2008-2012 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
*/
package org.springframework.data.web;
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import java.lang.reflect.Method;
@@ -33,14 +34,12 @@ import org.springframework.web.context.request.ServletWebRequest;
/**
* Unit test for {@link PageableArgumentResolver}.
*
* @author Oliver Gierke - gierke@synyx.de
* @author Oliver Gierke
*/
public class PageableArgumentResolverUnitTests {
Method correctMethod;
Method failedMethod;
Method invalidQualifiers;
Method defaultsMethod;
Method correctMethod, failedMethod, invalidQualifiers, defaultsMethod, defaultsMethodWithSort,
defaultsMethodWithSortAndDirection;
MockHttpServletRequest request;
@@ -52,6 +51,9 @@ public class PageableArgumentResolverUnitTests {
invalidQualifiers = SampleController.class.getMethod("invalidQualifiers", Pageable.class, Pageable.class);
defaultsMethod = SampleController.class.getMethod("defaultsMethod", Pageable.class);
defaultsMethodWithSort = SampleController.class.getMethod("defaultsMethodWithSort", Pageable.class);
defaultsMethodWithSortAndDirection = SampleController.class.getMethod("defaultsMethodWithSortAndDirection",
Pageable.class);
request = new MockHttpServletRequest();
@@ -92,16 +94,14 @@ public class PageableArgumentResolverUnitTests {
@Test
public void assertDefaults() throws Exception {
MethodParameter parameter = new MethodParameter(defaultsMethod, 0);
NativeWebRequest webRequest = new ServletWebRequest(new MockHttpServletRequest());
PageableArgumentResolver resolver = new PageableArgumentResolver();
Object argument = resolver.resolveArgument(parameter, webRequest);
Object argument = setupAndResolve(defaultsMethod);
assertTrue(argument instanceof Pageable);
assertThat(argument, is(instanceOf(Pageable.class)));
Pageable pageable = (Pageable) argument;
assertEquals(SampleController.DEFAULT_PAGESIZE, pageable.getPageSize());
assertEquals(SampleController.DEFAULT_PAGENUMBER, pageable.getPageNumber());
assertThat(pageable.getPageSize(), is(SampleController.DEFAULT_PAGESIZE));
assertThat(pageable.getPageNumber(), is(SampleController.DEFAULT_PAGENUMBER));
assertThat(pageable.getSort(), is(nullValue()));
}
@Test
@@ -124,6 +124,38 @@ public class PageableArgumentResolverUnitTests {
assertEquals(sizeParam - 1, pageable.getPageNumber());
}
/**
* @see DATACMNS-146
*/
@Test
public void appliesDefaultSort() {
Object argument = setupAndResolve(defaultsMethodWithSort);
assertThat(argument, is(instanceOf(Pageable.class)));
Pageable pageable = (Pageable) argument;
assertThat(pageable.getPageSize(), is(SampleController.DEFAULT_PAGESIZE));
assertThat(pageable.getPageNumber(), is(SampleController.DEFAULT_PAGENUMBER));
assertThat(pageable.getSort(), is(new Sort("foo")));
}
/**
* @see DATACMNS-146
*/
@Test
public void appliesDefaultSortAndDirection() {
Object argument = setupAndResolve(defaultsMethodWithSortAndDirection);
assertThat(argument, is(instanceOf(Pageable.class)));
Pageable pageable = (Pageable) argument;
assertThat(pageable.getPageSize(), is(SampleController.DEFAULT_PAGESIZE));
assertThat(pageable.getPageNumber(), is(SampleController.DEFAULT_PAGENUMBER));
assertThat(pageable.getSort(), is(new Sort(Direction.DESC, "foo")));
}
private void assertSizeForPrefix(int size, Sort sort, int index) throws Exception {
MethodParameter parameter = new MethodParameter(correctMethod, index);
@@ -132,18 +164,25 @@ public class PageableArgumentResolverUnitTests {
PageableArgumentResolver resolver = new PageableArgumentResolver();
Object argument = resolver.resolveArgument(parameter, webRequest);
assertTrue(argument instanceof Pageable);
assertThat(argument, is(instanceOf(Pageable.class)));
Pageable pageable = (Pageable) argument;
assertEquals(size, pageable.getPageSize());
assertThat(pageable.getPageSize(), is(size));
if (null != sort) {
assertEquals(sort, pageable.getSort());
assertThat(pageable.getSort(), is(sort));
}
}
@SuppressWarnings("unused")
private class SampleController {
private Object setupAndResolve(Method method) {
MethodParameter parameter = new MethodParameter(method, 0);
NativeWebRequest webRequest = new ServletWebRequest(new MockHttpServletRequest());
PageableArgumentResolver resolver = new PageableArgumentResolver();
return resolver.resolveArgument(parameter, webRequest);
}
static class SampleController {
static final int DEFAULT_PAGESIZE = 198;
static final int DEFAULT_PAGENUMBER = 42;
@@ -153,6 +192,16 @@ public class PageableArgumentResolverUnitTests {
}
public void defaultsMethodWithSort(
@PageableDefaults(value = DEFAULT_PAGESIZE, pageNumber = DEFAULT_PAGENUMBER, sort = "foo") Pageable pageable) {
}
public void defaultsMethodWithSortAndDirection(
@PageableDefaults(value = DEFAULT_PAGESIZE, pageNumber = DEFAULT_PAGENUMBER, sort = "foo", sortDir = Direction.DESC) Pageable pageable) {
}
public void correctMethod(@Qualifier("foo") Pageable first, @Qualifier("bar") Pageable second) {
}