关于@Query注解的用法(Spring Data JPA)

更新时间：2022年03月12日 12:17:26 作者：迷失之路

这篇文章主要介绍了关于@Query注解的用法(Spring Data JPA)，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教

@Query注解的用法

1.一个使用@Query注解的简单例子

@Query(value = "select name,author,price from Book b where b.price>?1 and b.price<?2")
List<Book> findByPriceRange(long price1, long price2);

2.Like表达式

@Query(value = "select name,author,price from Book b where b.name like %:name%")
List<Book> findByNameMatch(@Param("name") String name);

3.使用Native SQL Query

所谓本地查询，就是使用原生的sql语句（根据数据库的不同，在sql的语法或结构方面可能有所区别）进行查询数据库的操作。

@Query(value = "select * from book b where b.name=?1", nativeQuery = true)
List<Book> findByName(String name);

4.使用@Param注解注入参数

@Query(value = "select name,author,price from Book b where b.name = :name AND b.author=:author AND b.price=:price")
List<Book> findByNamedParam(@Param("name") String name, @Param("author") String author,
        @Param("price") long price);

5.SPEL表达式(使用时请参考最后的补充说明)

'#{#entityName}'值为'Book'对象对应的数据表名称(book)。

public interface BookQueryRepositoryExample extends Repository<Book, Long>{
       @Query(value = "select * from #{#entityName} b where b.name=?1", nativeQuery = true)
       List<Book> findByName(String name);
}

6.一个较完整的例子

public interface BookQueryRepositoryExample extends Repository<Book, Long> {
    @Query(value = "select * from Book b where b.name=?1", nativeQuery = true) 
    List<Book> findByName(String name);// 此方法sql将会报错(java.lang.IllegalArgumentException)，看出原因了吗,若没看出来，请看下一个例子
    @Query(value = "select name,author,price from Book b where b.price>?1 and b.price<?2")
    List<Book> findByPriceRange(long price1, long price2);
    @Query(value = "select name,author,price from Book b where b.name like %:name%")
    List<Book> findByNameMatch(@Param("name") String name);
    @Query(value = "select name,author,price from Book b where b.name = :name AND b.author=:author AND b.price=:price")
    List<Book> findByNamedParam(@Param("name") String name, @Param("author") String author,
            @Param("price") long price);
}

7.解释例6中错误的原因

因为指定了nativeQuery = true，即使用原生的sql语句查询。使用java对象'Book'作为表名来查自然是不对的。只需将Book替换为表名book。

@Query(value = "select * from book b where b.name=?1", nativeQuery = true)
List<Book> findByName(String name);

补充说明：

有同学提出来了，例子5中用'#{#entityName}'为啥取不到值啊？

先来说一说'#{#entityName}'到底是个啥。从字面来看，'#{#entityName}'不就是实体类的名称么，对，他就是。

实体类Book,使用@Entity注解后，spring会将实体类Book纳入管理。默认'#{#entityName}'的值就是'Book'。

但是如果使用了@Entity(name = "book")来注解实体类Book,此时'#{#entityName}'的值就变成了'book'。

到此，事情就明了了，只需要在用@Entity来注解实体类时指定name为此实体类对应的表名。在原生sql语句中，就可以把'#{#entityName}'来作为数据表名使用。

@Query注解使用详情

常用属性

value : 取值,要么使用原生SQL,要么使用JPQL
nativeQuery ：表示是否采用原生SQL,诸如select * from tableName

取值方式

1、使用：形参名

示例：

单个形参的情况

:参数名

多个形参的情况：

:参数名

2、使用?数值,数值表示形参位置,1表示第一个形参,依次内推

示例：

单个形参的情况：

?数值

多个形参的情况：

?形参序列

特殊情况：数值也可不写,若不写具体的数值，默认是从1开始递增，如下图示例：

特殊情况

3、使用@Param("参数名")+:参数名

通常使用@Param注解都是在多个形参的情况下使用

@Param()

4、获取实体类名称,使用#{#entityName}

使用#{#entityName}

CRUD

使用@Query注解实现删、改、查、增的示例,如下所示：

@Modifying
@Transactional
@Query(value = "delete from User where id = ?1")
void deleteByUserId(Integer id);

?后面的数值1,表示第一个形参的值,以此类推，如果方法有多个形参,数值也会依次递增，特殊情况,数值也可不写,若不写具体的数值，默认是从1开始递增

@Modifying
@Transactional
@Query("update User set email = ?1 where id = ?2")
void updateUser(String email,Integer id);

@Query(value = "select * from tb_user  where  email like concat('%',?2,'%') and username like concat('%',?1,'%') ",nativeQuery = true)
User findByUsernameAndEmail( String username, String email);

@Modifying
@Transactional
@Query(value = "insert into tb_user(email,id_card,username,wage) values (:email,:idCard,:username,:wage)",nativeQuery = true)
void insertUser(String email,String idCard,String username,Double wage);

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

关于javaWeb中405错误的解决方法
下面小编就为大家带来一篇关于javaWeb中405错误的解决方法。小编觉得挺不错的，现在就分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2017-05-05
使用GSON库转换Java对象为JSON对象的进阶实例详解
这篇文章主要介绍了使用GSON库转换Java对象为JSON对象的进阶实例详解,包括注册TypeAdapter及处理Enum类型等实际运用中可能遇到的一些复杂问题,需要的朋友可以参考下
2016-06-06
SpringBoot调用DeepSeek接口的实现
本文主要介绍了SpringBoot调用DeepSeek接口的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
2025-02-02
jenkins+Maven从SVN上构建项目的方法
这篇文章主要介绍了jenkins+Maven从SVN上构建项目,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-09-09
SpringBoot整合OpenApi的实践
本文主要介绍了SpringBoot整合OpenApi，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2021-08-08
关于jdk环境变量配置以及javac不是内部或外部命令的解决
这篇文章主要介绍了关于jdk环境变量配置以及javac不是内部或外部命令的解决方案，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2023-01-01
Java实现多线程下载和断点续传
这篇文章主要为大家详细介绍了Java实现多线程下载和断点续传，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-06-06
Java使用Sftp和Ftp实现对文件的上传和下载
这篇文章主要介绍了Java使用Sftp和Ftp实现对文件的上传和下载，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-03-03
关于@JsonProperty和@JSONField注解的区别及用法
这篇文章主要介绍了关于@JsonProperty和@JSONField注解的区别及用法，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-08-08
java使用定时器实现监听数据变化
这篇文章主要为大家详细介绍了Java如何使用定时器监听数据变化,当满足某个条件时（例如没有数据更新）自动执行某项任务,有兴趣的可以了解下
2023-11-11