使用Spring Data JPA 本机查询

迷南。 2023-09-25 13:54 82阅读 0赞

Spring Data JPA支持从数据库中检索数据的各种方法。有些非常易于使用，例如[派生查询][Link 1]。其他方法提供了极大的灵活性，使您能够以各种方式读取和转换数据，例如[自定义查询][Link 2]。本机查询是第二类的极端。它们是读取数据最灵活、最强大的选项。

正如我在上一篇关于[JPA 中本机查询][JPA]的文章中所解释的那样，它们使您可以访问数据库支持的所有功能。这使得它们非常适合需要复杂查询来提取所需信息的所有用例。当然，如果您将本机查询与 Spring Data JPA 一起使用，情况也是如此，因为您在内部使用相同的机制。Spring Data JPA 只是使本机查询的定义和执行变得更容易一些。

内容\[[隐藏][Link 3]\]

*  [1定义本机查询][1]
    
     *  [1.1将操作写入为本机查询][1.1]
 *  [阿拉伯数字使用 Spring 数据 JPA 进行本机查询的限制][Spring _ JPA]
    
     *  [2.1添加计数查询以启用分页][2.1]
     *  [2.2无动态排序][2.2]
 *  [3结论][3]

### 定义本机查询 ###

使用纯 JPA 或休眠时，定义和执行本机查询需要多个步骤。Spring Data 的*@Query*注释删除了所有样板代码。我们已经在上一篇文章中使用了该注释来[定义自定义 JPQL 查询][Link 2]。

定义本机查询时，使用 *@Query* 注释存储库方法，将其*nativeQuery*属性设置为*true*，并提供 SQL 语句作为*值*。如以下代码片段所示，您可以像在自定义 JPQL 查询中一样使用绑定参数。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 </td> 
 <td> <code>@Repository</code> <code>public</code> <code>interface</code> <code>AuthorRepository </code><code>extends</code> <code>CrudRepository&lt;Author, Long&gt;, PagingAndSortingRepository&lt;Author, Long&gt; { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Query</code><code>(value=</code><code>"select * from author a where a.first_name= :firstName"</code><code>, nativeQuery=</code><code>true</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>List&lt;Author&gt; getAuthorsByFirstName(String firstName);</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

完成此操作后，只需将存储库注入到其中一个服务中，并使用要搜索的*firstName*调用*getAuthorsByFirstName*方法。

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>List&lt;Author&gt; authors = authorRepository.getAuthorsByFirstName(</code><code>"Janssen"</code><code>);</code> </td> 
 </tr> 
 </tbody> 
</table>

然后，Spring Data 的存储库实现提供所需的代码来实例化对注释中提供的语句的查询*@Query*。然后，它将提供的值设置为该查询的绑定参数并执行它。

#### 将操作写入为本机查询 ####

正如我在 Hibernate 性能调优在线培训中详细解释的那样，批量操作通常是更改或删除大量数据库记录的更好选择。您可以使用 JPQL、[条件][Link 4]或[本机查询][Link 5]来实现这些操作。

您可以使用*@Query*注释来定义此类 JPQL 或本机 SQL 语句。由于写入操作的执行方式与读取操作不同，因此还需要使用*@Modifying*注释来批注存储库方法。这是与前面讨论的本机 SQL SELECT 语句的唯一区别。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 </td> 
 <td> <code>@Repository</code> <code>public</code> <code>interface</code> <code>AuthorRepository </code><code>extends</code> <code>CrudRepository&lt;Author, Long&gt;, PagingAndSortingRepository&lt;Author, Long&gt; { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Modifying</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Query</code><code>(value=</code><code>"delete from author a where a.last_name= :lastName"</code><code>, nativeQuery = </code><code>true</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>void</code> <code>deleteAuthorByLastName(</code><code>@Param</code><code>(</code><code>"lastName"</code><code>) String lastName);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Modifying</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Query</code><code>(value=</code><code>"update author set last_name= :lastName where first_name = :firstName"</code><code>, nativeQuery=</code><code>true</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>void</code> <code>updateAuthorByFirstName(String firstName, String lastName);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

### 使用 Spring 数据 JPA 进行本机查询的限制 ###

使用本机查询时，需要注意 2 个限制：

1.  Spring Data JPA 和持久性提供程序不会将查询调整为数据库的特定 SQL 方言。因此，您需要确保应用程序支持的所有 RDBMS 都可以处理提供的语句。
2.  本机查询结果的分页需要一个额外的步骤。
3.  Spring Data JPA 不支持本机 SQL 语句的动态排序。

让我们仔细看看第 2 个和第 3 个限制。

#### 添加计数查询以启用分页 ####

使用自定义 JPQL 查询时，可以将*可分页*类型的参数添加到存储库方法。这将为查询结果启用分页。然后，Spring Data JPA 添加所有必需的样板代码，一次检索一页的查询结果。

对本机查询执行相同操作需要额外的步骤。您需要提供一个计数查询，该查询返回非分页结果中包含的记录总数。一种方法是提供查询*字符串*作为*@Query*注释的*countQuery*属性的值。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 </td> 
 <td> <code>@Repository</code> <code>public</code> <code>interface</code> <code>AuthorRepository </code><code>extends</code> <code>CrudRepository&lt;Author, Long&gt;, PagingAndSortingRepository&lt;Author, Long&gt; { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>@Query</code><code>(value=</code><code>"select * from author a where a.last_name= ?1"</code><code>, </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>countQuery = </code><code>"select count(id) from author a where a.last_name= ?1"</code><code>, </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>nativeQuery = </code><code>true</code><code>)</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Page&lt;Author&gt; getAuthorsByLastName(String lastname, Pageable page);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code>&nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>...</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

如果[存储库方法引用命名本机][Link 6]查询，则需要将计数查询作为第二个命名查询提供，并在其名称中添加后缀 *sendix.count*。

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 </td> 
 <td> <code>@NamedNativeQuery</code><code>(name = </code><code>"Author.getAuthorsByLastName"</code><code>, </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>query = </code><code>"select * from author a where a.last_name= ?1"</code><code>, </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>resultClass = Author.</code><code>class</code><code>)</code> <code>@NamedNativeQuery</code><code>(name = </code><code>"Author.getAuthorsByLastName.count"</code><code>, </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>query = </code><code>"select count(id) from author a where a.last_name= ?1"</code><code>)</code> <code>@Entity</code> <code>public</code> <code>class</code> <code>Author { ... }</code> </td> 
 </tr> 
 </tbody> 
</table>

#### 无动态排序 ####

使用 JPQL 查询时，可以将*类型为 Sort*的参数添加到存储库方法中。这使您能够在运行时定义排序条件。然后，Spring Data JPA 根据提供的参数值生成所需的 ORDER BY 子句。

不幸的是，Spring Data JPA 不支持本机查询的此功能。这样做需要 Spring Data 分析提供的语句，并以特定于数据库的方言生成 ORDER BY 子句。这将是一个非常复杂的操作，目前不受Spring Data JPA的支持。

当然，您可以将自己的 ORDER BY 子句添加到查询中。但这限制了每个查询只能进行一个特定的排序。如果需要支持多个存储库，使用[复合存储库][Link 7]通常是更好的方法。然后，您可以使用 JPA 的条件 API 实现自己的查询方法，并根据提供的输入参数指定 ORDER BY 子句。

### 结论 ###

本机查询是实现读取操作的最强大、最灵活的方法。它们使您能够使用数据库支持的所有功能，并且 Spring Data JPA 处理几乎所有必需的样板代码。

但是使用它们比[派生查询][Link 1]需要付出更多的努力，并且与[自定义 JPQL 查询][Link 2]相比，它们提供了一些限制。最值得注意的是：

1.  若要对查询结果使用分页，需要提供计数查询。您可以通过设置 *@Query*注释的*countQuery*属性来执行此操作。
2.  Spring Data JPA 不支持本机查询的动态排序。如果要按特定顺序检索查询结果，则需要在查询中包含 ORDER BY 子句。
3.  Spring Data JPA 和持久性提供程序不会将本机查询语句调整为数据库的 SQL 方言。因此，您需要确保所有受支持的 DBMS 都支持您的 SQL 语句。

[Link 1]: https://thorben-janssen.com/ultimate-guide-derived-queries-with-spring-data-jpa/
[Link 2]: https://thorben-janssen.com/spring-data-jpa-query-annotation/
[JPA]: https://thorben-janssen.com/jpa-native-queries/
[Link 3]: https://thorben-janssen.com/native-queries-with-spring-data-jpa/#
[1]: https://thorben-janssen.com/native-queries-with-spring-data-jpa/#Defining_a_Native_Query
[1.1]: https://thorben-janssen.com/native-queries-with-spring-data-jpa/#Write_Operations_as_Native_Queries
[Spring _ JPA]: https://thorben-janssen.com/native-queries-with-spring-data-jpa/#Limitations_of_Native_Queries_With_Spring_Data_JPA
[2.1]: https://thorben-janssen.com/native-queries-with-spring-data-jpa/#Add_a_Count_Query_to_Enable_Pagination
[2.2]: https://thorben-janssen.com/native-queries-with-spring-data-jpa/#No_Dynamic_Sorting
[3]: https://thorben-janssen.com/native-queries-with-spring-data-jpa/#Conclusion
[Link 4]: https://thorben-janssen.com/criteria-updatedelete-easy-way-to/
[Link 5]: https://thorben-janssen.com/use-native-queries-perform-bulk-updates/
[Link 6]: https://thorben-janssen.com/spring-data-jpa-named-queries/
[Link 7]: https://thorben-janssen.com/composite-repositories-spring-data-jpa/