名词解释
- JPA:JPA是Java Persistence API的简称,由sun公司提出的ORM规范,具体实现由各个ORM框架(Hibernate,Toplink)去实现,统一了ORM框架的使用,开发人员更容易切换和学习ORM框架.
- Spring Data:是一个用于简化数据库访问,并支持云服务的开源框架。其主要目标是使得对数据的访问变得方便快捷,并支持map-reduce框架和云计算数据服务。 Spring Data 包含多个子项目包括JPA Hadoop 等
- Spring Data JPA:Spring Data其中的一个项目,整合JPA的使用,实现了基本的增删改查,分页的操作。
下图展示了这个关系图,出处
基础知识
基本框架的搭建和使用,可以参考这个两个大神的博客纯洁的微笑,程序员DD
这两篇博客中有点没有提到,我们的dao继承了JpaRepository之后已经可以对数据做简单的增删改查了。还有一个JpaSpecificationExecutor可以继承,继承之后可以使用jpa的模式进行查询.
查询
在spring data jpa中有4种查询方式,下面介绍每种方式和简介
自定义简单查询
- 简介: 在dao中增加接口方法,并按照spring data jpa支持的模式命名方法,spring data jpa会按照指定规则生成sql语句,详细匹配规则可以参照纯洁的微笑博客中“自定义简单查询”部分
- 示例:
public interface TestDao extends JpaRepository<Test, Long> {
List<Test>findByKeyword(String keyword);
}
通过Example查询
- 简介:JpaRepository接口中包含了QueryByExampleExecutor,这个接口支持将实体作为参考进行查询
- 示例:
//service中使用继承了JpaRepository接口的dao
public List<Test> findTests() {
Test test = new Test();
test.setName("aaa");
return testDao.findAll(Example.of(test));
}
- 注意事项:实体中只要有值的内容都会被放进查询条件中,若实体中包含基础类型例如int 就会以0进行匹配。
@Query注解查询
- 简介: 在dao中增加接口方法并在方法上增加@Query注解并在注解中写hql语句来进行查询
- 示例:
public interface TestDao extends JpaRepository<Test, Long> {
@Query("select t from Test t where t.name = :keyWord")
List<Test>findTest(@Param("keyWord") String keyWord);
}
@Query参数说明:
名称 | 简介 |
---|---|
value | 指定JPQL语句,当nativeQuery=true时是原生的sql语句 |
countQuery | 指定count的JPQL语句,不指定则自动生成,当nativeQuery=true时是原生的sql语句 |
countProjection | 依据哪个字段来count一般默认即可 |
nativeQuery | 默认是false,表示value 里面是不是原生的Sql 语句 |
name | 指定一个query 的名字,必须是唯一的。 如果不指定,默认的生成规则是:{$domainClass}.${queryMethodName} |
countName | 指定一个count 的query 名字,必须是唯一的。如果不指定,默认的生成规则是:{$domainClass}.${queryMethodName}.count |
查询结果格式
Entity-List
使用默认形式即可
Map-List
- 注意:其中as name必须写,不写则map中key为下标。
@Query("select new map(t.name as name,t.value as value) from Test t where t.name = :keyWord")
List<Map<String,Object>>findTest(@Param("keyWord") String keyWord);
Vo-List
- 注意:与Map类似,使用构造方法的形式进行初始化,传入顺序必须与构造函数顺序一致
@Query("select new TestVo(t.name as name,t.value as value) from Test t where t.name = :keyWord")
List<TestVo>findTest(@Param("keyWord") String keyWord);
public class TestVo{
private String name;
private String value;
public TestVo(String name,String value){
this.name = name;
this.value = value;
}
// get..set..
}
Projection-List
- 注意:TestProjection为接口,有对应的get方法,这种模式就不需要使用new的方式传值
@Query("select t.name as name,t.value as value from Test t where t.name = :keyWord")
List<TestProjection>findTest(@Param("keyWord") String keyWord);
public interface TestProjection{
String getName();
String getValue();
}
排序
- 静态排序: 直接在jpql语句中直接写就可以了
- 参数排序:
- JpaSort.unsafe("排序规则"):会把排序语句直接追加到sql之后,当排序规则不单纯是属性而是需要进行一定处理时使用,例如:length(属性名)
- Sort.by("属性名") :会进行安全检查,属性名必须是实体中属性
@Query("select t.name as name,t.value as value from Test t where t.name = :keyWord")
List<TestProjection>findTest(@Param("keyWord") String keyWord,Sort sort);
//service中
List<TestProjection>findTest(String keyWord,String prop){
testdao.findTest(keyWord,Sort.by(prop))
}
分页
在dao方法中增加Pageable pageable参数即可org.springframework.data.domain.Pageable,
@Query("select t from Test t where t.name = :keyWord")
Page<Test> findTest(@Param("keyWord") String keyWord,Pageable pageable);
下一篇详细介绍最后一种 Specification查询,就是使用jpa api去查询
参考资料
https://www.cnblogs.com/zj0208/p/6008627.html
https://www.cnblogs.com/ityouknow/p/5891443.html
http://blog.didispace.com/springbootdata2/
https://blog.csdn.net/Phapha1996/article/details/78994395
https://www.baeldung.com/spring-data-jpa-query