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

DATAJPA-170 - Add support for SpEL in query expressions.

Browse Source 
Introduced ExpressionBasedStringQuery to support the SpEL expression template rendering. This allows manually defined queries in either @Query or Spring Data named queries to use SpEL and reference the #entityName. Changed SimpleJpaQuery to use ExpressionBasedStringQuery by default. Added test case for repositories with SpEL expression based query methods.

Original pull request: #25.
This commit is contained in:
Thomas Darimont
2013-07-16 19:48:38 +02:00
committed by Oliver Gierke
parent f25032abfa
commit 528363e125
19 changed files with 589 additions and 38 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
src/test/java/org/springframework/data/jpa/domain/sample/AbstractMappedType.java Normal file
View File

@@ -0,0 +1,36 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.domain.sample;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;
import javax.persistence.MappedSuperclass;
/**
* @author Thomas Darimont
*/
@MappedSuperclass
public abstract class AbstractMappedType {
public AbstractMappedType() {}
public AbstractMappedType(String attribute1) {
this.attribute1 = attribute1;
}
@Id @GeneratedValue Long id;
String attribute1;
}

31
src/test/java/org/springframework/data/jpa/domain/sample/ConcreteType1.java Normal file
View File

@@ -0,0 +1,31 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.domain.sample;
import javax.persistence.Entity;
/**
* @author Thomas Darimont
*/
@Entity
public class ConcreteType1 extends AbstractMappedType {
public ConcreteType1() {}
public ConcreteType1(String attribute1) {
super(attribute1);
}
}

31
src/test/java/org/springframework/data/jpa/domain/sample/ConcreteType2.java Normal file
View File

@@ -0,0 +1,31 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.domain.sample;
import javax.persistence.Entity;
/**
* @author Thomas Darimont
*/
@Entity
public class ConcreteType2 extends AbstractMappedType {
public ConcreteType2() {}
public ConcreteType2(String attribute1) {
super(attribute1);
}
}

71
src/test/java/org/springframework/data/jpa/repository/MappedTypeRepositoryIntegrationTests.java Normal file
View File

@@ -0,0 +1,71 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.repository;
import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;
import java.util.List;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportResource;
import org.springframework.data.jpa.domain.sample.ConcreteType1;
import org.springframework.data.jpa.domain.sample.ConcreteType2;
import org.springframework.data.jpa.repository.config.EnableJpaRepositories;
import org.springframework.data.jpa.repository.sample.ConcreteRepository1;
import org.springframework.data.jpa.repository.sample.ConcreteRepository2;
import org.springframework.data.jpa.repository.sample.MappedTypeRepository;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import org.springframework.transaction.annotation.Transactional;
/**
* Integration tests for {@link MappedTypeRepository}.
*
* @author Thomas Darimont
*/
@Transactional
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration
public class MappedTypeRepositoryIntegrationTests {
@Configuration
@ImportResource("classpath:infrastructure.xml")
@EnableJpaRepositories
static class Config {}
@Autowired ConcreteRepository1 concreteRepository1;
@Autowired ConcreteRepository2 concreteRepository2;
/**
* @see DATAJPA-170
*/
@Test
public void supportForExpressionBasedQueryMethods() {
concreteRepository1.save(new ConcreteType1("foo"));
concreteRepository2.save(new ConcreteType2("foo"));
List<ConcreteType1> concretes1 = concreteRepository1.findAllByAttribute1("foo");
List<ConcreteType2> concretes2 = concreteRepository2.findAllByAttribute1("foo");
assertThat(concretes1.size(), is(1));
assertThat(concretes2.size(), is(1));
}
}

51
src/test/java/org/springframework/data/jpa/repository/query/ExpressionBasedStringQueryUnitTests.java Normal file
View File

@@ -0,0 +1,51 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.repository.query;
import static org.hamcrest.Matchers.*;
import static org.junit.Assert.*;
import static org.mockito.Mockito.*;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.springframework.data.jpa.repository.support.JpaEntityMetadata;
/**
* Unit tests for {@link ExpressionBasedStringQuery}.
*
* @author Thomas Darimont
* @author Oliver Gierke
*/
@RunWith(MockitoJUnitRunner.class)
public class ExpressionBasedStringQueryUnitTests {
@Mock JpaEntityMetadata<?> metadata;
/**
* @see DATAJPA-170
*/
@Test
public void shouldReturnQueryWithDomainTypeExpressionReplacedWithSimpleDomainTypeName() {
when(metadata.getEntityName()).thenReturn("User");
String source = "select from #{#entityName} u where u.firstname like :firstname";
StringQuery query = new ExpressionBasedStringQuery(source, metadata);
assertThat(query.getQuery(), is("select from User u where u.firstname like :firstname"));
}
}

7
src/test/java/org/springframework/data/jpa/repository/query/SimpleJpaQueryUnitTests.java
View File

@@ -42,6 +42,8 @@ import org.springframework.data.domain.Sort;
import org.springframework.data.jpa.domain.sample.User;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.jpa.repository.sample.UserRepository;
import org.springframework.data.jpa.repository.support.DefaultJpaEntityMetadata;
import org.springframework.data.jpa.repository.support.JpaEntityMetadata;
import org.springframework.data.repository.core.RepositoryMetadata;
import org.springframework.data.repository.query.Parameters;
@@ -67,24 +69,29 @@ public class SimpleJpaQueryUnitTests {
public @Rule ExpectedException exception = ExpectedException.none();
@Before
@SuppressWarnings({ "rawtypes", "unchecked" })
public void setUp() throws SecurityException, NoSuchMethodException {
when(em.createQuery(anyString())).thenReturn(query);
when(em.createQuery(anyString(), eq(Long.class))).thenReturn(query);
when(em.getEntityManagerFactory()).thenReturn(emf);
when(emf.createEntityManager()).thenReturn(em);
when(metadata.getDomainType()).thenReturn((Class) User.class);
when(metadata.getReturnedDomainClass(Mockito.any(Method.class))).thenReturn((Class) User.class);
Method setUp = UserRepository.class.getMethod("findByLastname", String.class);
method = new JpaQueryMethod(setUp, metadata, extractor);
}
@Test
@SuppressWarnings({ "rawtypes", "unchecked" })
public void prefersDeclaredCountQueryOverCreatingOne() throws Exception {
method = mock(JpaQueryMethod.class);
when(method.getCountQuery()).thenReturn("foo");
when(method.getParameters()).thenReturn(
new Parameters(SimpleJpaQueryUnitTests.class.getMethod("prefersDeclaredCountQueryOverCreatingOne")));
when(method.getEntityInformation()).thenReturn((JpaEntityMetadata) new DefaultJpaEntityMetadata<User>(User.class));
when(em.createQuery("foo", Long.class)).thenReturn(query);
SimpleJpaQuery jpaQuery = new SimpleJpaQuery(method, em, "select u from User u");

25
src/test/java/org/springframework/data/jpa/repository/sample/ConcreteRepository1.java Normal file
View File

@@ -0,0 +1,25 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.repository.sample;
import org.springframework.data.jpa.domain.sample.ConcreteType1;
/**
* @author Thomas Darimont
*/
public interface ConcreteRepository1 extends MappedTypeRepository<ConcreteType1> {
}

25
src/test/java/org/springframework/data/jpa/repository/sample/ConcreteRepository2.java Normal file
View File

@@ -0,0 +1,25 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.repository.sample;
import org.springframework.data.jpa.domain.sample.ConcreteType2;
/**
* @author Thomas Darimont
*/
public interface ConcreteRepository2 extends MappedTypeRepository<ConcreteType2> {
}

31
src/test/java/org/springframework/data/jpa/repository/sample/MappedTypeRepository.java Normal file
View File

@@ -0,0 +1,31 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.repository.sample;
import java.util.List;
import org.springframework.data.jpa.domain.sample.AbstractMappedType;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Query;
/**
* @author Thomas Darimont
*/
public interface MappedTypeRepository<T extends AbstractMappedType> extends JpaRepository<T, Long> {
@Query("from #{#entityName} t where t.attribute1=?1")
List<T> findAllByAttribute1(String attribute1);
}

63
src/test/java/org/springframework/data/jpa/repository/support/DefaultJpaEntityMetadataUnitTest.java Normal file
View File

@@ -0,0 +1,63 @@
/*
* Copyright 2013 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.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.data.jpa.repository.support;
import static org.hamcrest.CoreMatchers.*;
import static org.junit.Assert.*;
import javax.persistence.Entity;
import org.junit.Test;
/**
* Unit tests for {@link DefaultJpaEntityMetadata}.
*
* @author Oliver Gierke
*/
public class DefaultJpaEntityMetadataUnitTest {
@Test(expected = IllegalArgumentException.class)
@SuppressWarnings({ "rawtypes", "unchecked" })
public void rejectsNullDomainType() {
new DefaultJpaEntityMetadata(null);
}
@Test
public void returnsConfiguredType() {
DefaultJpaEntityMetadata<Foo> metadata = new DefaultJpaEntityMetadata<Foo>(Foo.class);
assertThat(metadata.getJavaType(), is(equalTo(Foo.class)));
}
@Test
public void returnsSimpleClassNameAsEntityNameByDefault() {
DefaultJpaEntityMetadata<Foo> metadata = new DefaultJpaEntityMetadata<Foo>(Foo.class);
assertThat(metadata.getEntityName(), is(Foo.class.getSimpleName()));
}
@Test
public void returnsCustomizedEntityNameIfConfigured() {
DefaultJpaEntityMetadata<Bar> metadata = new DefaultJpaEntityMetadata<Bar>(Bar.class);
assertThat(metadata.getEntityName(), is("Entity"));
}
static class Foo {}
@Entity(name = "Entity")
static class Bar {}
}