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

DATACMNS-460 - Repository metadata now supports array return types for query methods.

Browse Source 
Added array checks to AbstractRepositoryMetadata.getReturnedDomainClass() to detect array component types. QueryMethod now considers methods returning arrays to be collection query methods.
This commit is contained in:
Oliver Gierke
2014-03-05 08:17:48 +01:00
parent 2e2e53beb1
commit 61540f75dd
4 changed files with 77 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/main/java/org/springframework/data/repository/core/support/AbstractRepositoryMetadata.java
View File

@@ -56,7 +56,9 @@ public abstract class AbstractRepositoryMetadata implements RepositoryMetadata {
TypeInformation<?> returnTypeInfo = typeInformation.getReturnType(method);
Class<?> rawType = returnTypeInfo.getType();
return Iterable.class.isAssignableFrom(rawType) ? returnTypeInfo.getComponentType().getType() : rawType;
boolean needToUnwrap = Iterable.class.isAssignableFrom(rawType) || rawType.isArray();
return needToUnwrap ? returnTypeInfo.getComponentType().getType() : rawType;
}
/*

5
src/main/java/org/springframework/data/repository/query/QueryMethod.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2008-2013 the original author or authors.
* Copyright 2008-2014 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.
@@ -152,7 +152,8 @@ public class QueryMethod {
public boolean isCollectionQuery() {
Class<?> returnType = method.getReturnType();
return !isPageQuery() && org.springframework.util.ClassUtils.isAssignable(Iterable.class, returnType);
return !isPageQuery() && org.springframework.util.ClassUtils.isAssignable(Iterable.class, returnType)
|| returnType.isArray();
}
/**

30
src/test/java/org/springframework/data/repository/core/support/AbstractRepositoryMetadataUnitTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2011-2013 the original author or authors.
* Copyright 2011-2014 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.
@@ -27,6 +27,7 @@ import org.junit.Test;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.querydsl.User;
import org.springframework.data.repository.PagingAndSortingRepository;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.core.RepositoryMetadata;
@@ -38,6 +39,9 @@ import org.springframework.data.repository.core.RepositoryMetadata;
*/
public class AbstractRepositoryMetadataUnitTests {
/**
* @see DATACMNS-98
*/
@Test
public void discoversSimpleReturnTypeCorrectly() throws Exception {
@@ -56,6 +60,9 @@ public class AbstractRepositoryMetadataUnitTests {
assertThat(metadata.getReturnedDomainClass(method), is(typeCompatibleWith(User.class)));
}
/**
* @see DATACMNS-98
*/
@Test
public void determinesReturnTypeFromPageable() throws Exception {
@@ -71,6 +78,9 @@ public class AbstractRepositoryMetadataUnitTests {
assertThat(metadata.getReturnedDomainClass(method), is(typeCompatibleWith(GenericType.class)));
}
/**
* @see DATACMNS-98
*/
@Test
public void handlesGenericTypeInReturnedCollectionCorrectly() throws SecurityException, NoSuchMethodException {
@@ -79,6 +89,18 @@ public class AbstractRepositoryMetadataUnitTests {
assertThat(metadata.getReturnedDomainClass(method), is(typeCompatibleWith(Map.class)));
}
/**
* @see DATACMNS-471
*/
@Test
public void detectsArrayReturnTypeCorrectly() throws Exception {
RepositoryMetadata metadata = new DefaultRepositoryMetadata(PagedRepository.class);
Method method = PagedRepository.class.getMethod("returnsArray");
assertThat(metadata.getReturnedDomainClass(method), is(typeCompatibleWith(User.class)));
}
interface UserRepository extends Repository<User, Long> {
User findSingle();
@@ -102,6 +124,11 @@ public class AbstractRepositoryMetadataUnitTests {
List<Map<String, Object>> anotherMethod();
}
interface PagedRepository extends PagingAndSortingRepository<User, Long> {
User[] returnsArray();
}
class GenericType<T> {
}
@@ -120,5 +147,4 @@ public class AbstractRepositoryMetadataUnitTests {
return null;
}
}
}

62
src/test/java/org/springframework/data/repository/query/QueryMethodUnitTests.java
View File

@@ -1,5 +1,5 @@
/*
* Copyright 2008-2011 the original author or authors.
* Copyright 2008-2014 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,32 +15,31 @@
*/
package org.springframework.data.repository.query;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import java.io.Serializable;
import java.lang.reflect.Method;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.Mockito;
import org.mockito.runners.MockitoJUnitRunner;
import org.springframework.data.domain.Page;
import org.springframework.data.domain.Pageable;
import org.springframework.data.repository.Repository;
import org.springframework.data.repository.core.RepositoryMetadata;
import org.springframework.data.repository.core.support.DefaultRepositoryMetadata;
/**
* Unit tests for {@link QueryMethod}.
*
* @author Oliver Gierke
*/
@RunWith(MockitoJUnitRunner.class)
public class QueryMethodUnitTests {
@Mock
RepositoryMetadata metadata;
RepositoryMetadata metadata = new DefaultRepositoryMetadata(SampleRepository.class);
/**
* @see DATAJPA-59
*/
@Test(expected = IllegalStateException.class)
public void rejectsPagingMethodWithInvalidReturnType() throws Exception {
@@ -48,18 +47,27 @@ public class QueryMethodUnitTests {
new QueryMethod(method, metadata);
}
/**
* @see DATAJPA-59
*/
@Test(expected = IllegalArgumentException.class)
public void rejectsPagingMethodWithoutPageable() throws Exception {
Method method = SampleRepository.class.getMethod("pagingMethodWithoutPageable");
new QueryMethod(method, metadata);
}
/**
* @see DATACMNS-64
*/
@Test
public void setsUpSimpleQueryMethodCorrectly() throws Exception {
Method method = SampleRepository.class.getMethod("findByUsername", String.class);
new QueryMethod(method, metadata);
}
/**
* @see DATACMNS-61
*/
@Test
public void considersIterableMethodForCollectionQuery() throws Exception {
Method method = SampleRepository.class.getMethod("sampleMethod");
@@ -67,6 +75,9 @@ public class QueryMethodUnitTests {
assertThat(queryMethod.isCollectionQuery(), is(true));
}
/**
* @see DATACMNS-67
*/
@Test
public void doesNotConsiderPageMethodCollectionQuery() throws Exception {
Method method = SampleRepository.class.getMethod("anotherSampleMethod", Pageable.class);
@@ -75,33 +86,44 @@ public class QueryMethodUnitTests {
assertThat(queryMethod.isCollectionQuery(), is(false));
}
/**
* @see DATACMNS-171
*/
@Test
@SuppressWarnings({ "unchecked", "rawtypes" })
public void detectsAnEntityBeingReturned() throws Exception {
when(metadata.getDomainType()).thenReturn((Class) User.class);
when(metadata.getReturnedDomainClass(Mockito.any(Method.class))).thenReturn((Class) SpecialUser.class);
Method method = SampleRepository.class.getMethod("returnsEntitySubclass");
QueryMethod queryMethod = new QueryMethod(method, metadata);
assertThat(queryMethod.isQueryForEntity(), is(true));
}
/**
* @see DATACMNS-171
*/
@Test
@SuppressWarnings({ "unchecked", "rawtypes" })
public void detectsNonEntityBeingReturned() throws Exception {
when(metadata.getDomainType()).thenReturn((Class) User.class);
when(metadata.getReturnedDomainClass(Mockito.any(Method.class))).thenReturn((Class) Integer.class);
Method method = SampleRepository.class.getMethod("returnsProjection");
QueryMethod queryMethod = new QueryMethod(method, metadata);
assertThat(queryMethod.isQueryForEntity(), is(false));
}
interface SampleRepository {
/**
* @see DATACMNS-471
*/
@Test
public void detectsCollectionMethodForArrayRetrunType() throws Exception {
RepositoryMetadata repositoryMetadata = new DefaultRepositoryMetadata(SampleRepository.class);
Method method = SampleRepository.class.getMethod("arrayOfUsers");
assertThat(new QueryMethod(method, repositoryMetadata).isCollectionQuery(), is(true));
}
interface SampleRepository extends Repository<User, Serializable> {
String pagingMethodWithInvalidReturnType(Pageable pageable);
Page<String> pagingMethodWithoutPageable();
@@ -115,6 +137,8 @@ public class QueryMethodUnitTests {
SpecialUser returnsEntitySubclass();
Integer returnsProjection();
User[] arrayOfUsers();
}
class User {