Implement NativeQuery annotation.

Annotation to declare native queries directly on repository methods. NativeQuery acts as a shortcut for @query(nativeQuery = true)

See spring-projects#3155

Author: danvandeee

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/NativeQuery.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2024 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
+ *
+ *      https://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 org.springframework.core.annotation.AliasFor;
+import org.springframework.data.annotation.QueryAnnotation;
+
+import java.lang.annotation.*;
+
+/**
+ * Annotation to declare native queries directly on repository methods.
+ * <p>
+ * Specifically {@code @NativeQuery} is a <em>composed annotation</em> that
+ * acts as a shortcut for {@code @Query(nativeQuery = true)}.
+ *
+ * @author Danny van den Elshout
+ * @since 3.3
+ * @see Query
+ */
+
+@Retention(RetentionPolicy.RUNTIME)
+@Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })
+@QueryAnnotation
+@Documented
+@Query(nativeQuery = true)
+public @interface NativeQuery {
+
+    /**
+     * Alias for {@link Query#value()}
+     */
+    @AliasFor(annotation = Query.class)
+    String value() default "";
+
+    /**
+     * Alias for {@link Query#countQuery()}
+     */
+    @AliasFor(annotation = Query.class)
+    String countQuery() default "";
+
+    /**
+     * Alias for {@link Query#countProjection()}
+     */
+    @AliasFor(annotation = Query.class)
+    String countProjection() default "";
+
+    /**
+     * Alias for {@link Query#name()}
+     */
+    @AliasFor(annotation = Query.class)
+    String name() default "";
+
+    /**
+     * Alias for {@link Query#countName()}
+     */
+    @AliasFor(annotation = Query.class)
+    String countName() default "";
+
+    /**
+     * Alias for {@link Query#queryRewriter()}
+     */
+    @AliasFor(annotation = Query.class)
+    Class<? extends QueryRewriter> queryRewriter() default QueryRewriter.IdentityQueryRewriter.class;
+}

spring-data-jpa/src/main/java/org/springframework/data/jpa/repository/Query.java

@@ -25,12 +25,16 @@
 
 /**
  * Annotation to declare finder queries directly on repository methods.
+ * <p>
+ * When using a native query {@link NativeQuery @NativeQuery} variant is available.
  *
  * @author Oliver Gierke
  * @author Thomas Darimont
  * @author Christoph Strobl
  * @author Greg Turnquist
+ * @author Danny van den Elshout
  * @see Modifying
+ * @see NativeQuery
  */
 @Retention(RetentionPolicy.RUNTIME)
 @Target({ ElementType.METHOD, ElementType.ANNOTATION_TYPE })

spring-data-jpa/src/test/java/org/springframework/data/jpa/repository/query/SimpleJpaQueryUnitTests.java

@@ -43,6 +43,7 @@
 import org.springframework.data.domain.Sort;
 import org.springframework.data.jpa.domain.sample.User;
 import org.springframework.data.jpa.provider.QueryExtractor;
+import org.springframework.data.jpa.repository.NativeQuery;
 import org.springframework.data.jpa.repository.Query;
 import org.springframework.data.jpa.repository.QueryRewriter;
 import org.springframework.data.jpa.repository.sample.UserRepository;
@@ -65,6 +66,7 @@
  * @author Greg Turnquist
  * @author Krzysztof Krason
  * @author Erik Pellizzon
+ * @author Danny van den Elshout
  */
 @ExtendWith(MockitoExtension.class)
 @MockitoSettings(strictness = Strictness.LENIENT)
@@ -160,6 +162,26 @@ void discoversNativeQuery() throws Exception {
 		verify(em).createNativeQuery("SELECT u FROM User u WHERE u.lastname = ?1", User.class);
 	}
 
+	@Test // GH-3155
+	@SuppressWarnings({ "rawtypes", "unchecked" })
+	void discoversNativeQueryFromNativeQueryInterface() throws Exception {
+
+		Method method = SampleRepository.class.getMethod("findByLastnameNativeAnnotation", String.class);
+		JpaQueryMethod queryMethod = new JpaQueryMethod(method, metadata, factory, extractor);
+		AbstractJpaQuery jpaQuery = JpaQueryFactory.INSTANCE.fromMethodWithQueryString(queryMethod, em,
+				queryMethod.getAnnotatedQuery(), null, QueryRewriter.IdentityQueryRewriter.INSTANCE,
+				EVALUATION_CONTEXT_PROVIDER);
+
+		assertThat(jpaQuery).isInstanceOf(NativeJpaQuery.class);
+
+		when(em.createNativeQuery(anyString(), eq(User.class))).thenReturn(query);
+		when(metadata.getReturnedDomainClass(method)).thenReturn((Class) User.class);
+
+		jpaQuery.createQuery(new JpaParametersParameterAccessor(queryMethod.getParameters(), new Object[] { "Matthews" }));
+
+		verify(em).createNativeQuery("SELECT u FROM User u WHERE u.lastname = ?1", User.class);
+	}
+
 	@Test // DATAJPA-554
 	void rejectsNativeQueryWithDynamicSort() throws Exception {
 
@@ -271,6 +293,9 @@ interface SampleRepository {
 		@Query(value = "SELECT u FROM User u WHERE u.lastname = ?1", nativeQuery = true)
 		List<User> findNativeByLastname(String lastname);
 
+		@NativeQuery(value = "SELECT u FROM User u WHERE u.lastname = ?1")
+		List<User> findByLastnameNativeAnnotation(String lastname);
+
 		@Query(value = "SELECT u FROM User u WHERE u.lastname = ?1", nativeQuery = true)
 		List<User> findNativeByLastname(String lastname, Sort sort);