详解 JPA 中的 @Query 注解的用法和教程

JAVA herman 36浏览

@Query 注解是 JPA 中的一个注解,使用的比较频繁。今天有同事问题,@Query 注解中 ? 和 : 有啥区别?借这个机会我给大家讲一讲!

@Query 注解的定义在 org.springframework.data.jpa.repository.Query 中。大家可以到这里看它的具体的解释。从官方的文档中,我看到,JPA 其实首推的是 @NamedQuery 或者是将查询语句定义在 orm.xml 文件中。

@Query 注解中,如果用到 ?的形式获取参数。那么它是按照方法的参数顺序来取值的。如下面的例子:

@Query("select u from User u where u.emailAddress = ?1 and name = ?2")
User findByEmailAndName(String emailAddress, String name);

?1 对应的就是 emailAddress 参数,?2 对应的就是 name 参数。

如果有两条 SQL 语句,那么两条 SQL 会分别按顺序取参数。

@Query(value = "SELECT * FROM USERS WHERE LASTNAME = ?1",
    countQuery = "SELECT count(*) FROM USERS WHERE LASTNAME = ?1",
    nativeQuery = true)
Page<User> findByLastname(String lastname, Pageable pageable);

nativeQuery = true 代表的本地查询。countQuery 就是分页的总条数。

? 取参数值的形式,还可以在 Like 和 in 中使用。我就不列举了,大家自己去尝试。

@Query 注解还支持命名参数的形式绑定查询中的名称。这种绑定不需要严格限制参数的顺序。而是按照绑定的参数来赋值。

@Query("select u from User u where u.firstname = :firstname or u.lastname = :lastname")
User findByLastnameOrFirstname(@Param("lastname") String lastname,
                                 @Param("firstname") String firstname);

@Query("select u from User u where u.firstname = :firstname or u.lastname = :lastname")
User findByLastnameOrFirstname(@Param("firstname") String firstname, @Param("lastname") String lastname);

上面的两个 @Query 注解用法都是正确的。

从 Spring Data JPA 1.4 版开始,@Query 还支持 SpEL 模板表达式。

它的用法是select x from #{#entityName} x。它插入 entityName 与给定存储库关联的域类型。该entityName解决如下:如果域类型已设置的 name 属性 @Entity 的注释,它被使用。否则,使用域类型的简单类名。

@Entity
public class User {

  @Id
  @GeneratedValue
  Long id;

  String lastname;
}

public interface UserRepository extends JpaRepository<User,Long> {

  @Query("select u from #{#entityName} u where u.lastname = ?1")
  List<User> findByLastname(String lastname);
}

如果 @Entity 注解中使用了 name 熟悉。@Entity(name = "my_user")。那么 #{#entityName} 对应的就是 my_user 表。

如果 @Query 和 @Modifying 组合使用,那么将会变成修改语句。也就是说支持 update、delete 等,相当于 @Update 注解,不过一般很少有人这样用。

@Modifying
@Query("update User u set u.firstname = ?1 where u.lastname = ?2")
int setFixedFirstnameFor(String firstname, String lastname);

JPA 中还有很多高级的注解,后面有时间了,我再来写,今天就先到这里。

参考资料

业余草公众号

最后,欢迎关注我的个人微信公众号:业余草(yyucao)!可加QQ1群:135430763(2000人群已满),QQ2群:454796847,QQ3群:187424846。QQ群进群密码:xttblog,想加微信群的朋友,可以微信搜索:xmtxtt,备注:“xttblog”,添加助理微信拉你进群。备注错误不会同意好友申请。再次感谢您的关注!后续有精彩内容会第一时间发给您!原创文章投稿请发送至532009913@qq.com邮箱。商务合作可添加助理微信进行沟通!

本文原文出处:业余草: » 详解 JPA 中的 @Query 注解的用法和教程