黑马程序员技术交流社区

标题: 【石家庄校区】Spring Data Jpa 使用入门 [打印本页]

作者: 梦想飞翔的猪    时间: 2017-11-26 09:57
标题: 【石家庄校区】Spring Data Jpa 使用入门
本帖最后由 梦想飞翔的猪 于 2017-11-28 10:59 编辑

【石家庄校区】Spring Data Jpa 使用入门

最近使用了spring data jpa来完成数据访问层的实现。感觉比较强大,也比较复杂,中间还有不少限制。例如多条件查询,刚看的同学可能第一反应就是what's the fuck?,但是呢它的确解决了很多问题。下面我们就来说说Spring Data jpa。

1.Spring Data是什么?

     Spring Data是一个用于简化数据库访问,并支持云服务的开源框架。其主要目标是使得对数据的访问变得方便快捷,并支持map-reduce框架和云计算数据服务。

2.Spring Data JPA能干什么

     可以极大的简化JPA的写法,可以在几乎不用写实现的情况下,实现对数据的访问和操作。除了CRUD外,还包括如分页、排序等一些常用的功能。

3.Spring Data JPA有什么

     主要来看看Spring Data JPA提供的接口,也是Spring Data JPA的核心概念:

            3.1:Repository:最顶层的接口,是一个空的接口,目的是为了统一所有Repository的类型,且能让组件扫描的时候自动识别。

            3.2:CrudRepository :是Repository的子接口,提供CRUD的功能
            3.3:PagingAndSortingRepository:是CrudRepository的子接口,添加分页和排序的功能
            3.4:JpaRepository:是PagingAndSortingRepository的子接口,增加了一些实用的功能,比如:批量操作等。
            3.5:JpaSpecificationExecutor:用来做负责查询的接口
            3.6:Specification:是Spring Data JPA提供的一个查询规范,要做复杂的查询,只需围绕这个规范来设置查询条件即可

4. 基本使用方法

   4.1 如果只是简单的CRUD操作的话只需要继承CrudRepository 接口即可,如下代码

[Java] 纯文本查看 复制代码
public interface StandardDao extends CrudRepository<T, Serializable> {

// T为表名称对应的pojo
// 第二个参数为表id的字段类型
}
4.2 如果只是简单的CRUD操作并完成分页和排序功能需要继承PagingAndSortingRepository,代码如下
[Java] 纯文本查看 复制代码
public interface MyRepository extends PagingAndSortingRepository<T, ID>{

// T为表名称对应的pojo
// 第二个参数为表id的字段类型
}

4.3 如果需要在4.2的基础上扩展批量操作功能只需要继承JpaRepository接口即可代码如下:
[Java] 纯文本查看 复制代码
public interface StandardDao extends JpaRepository<Standard, Integer> {

// T为表名称对应的pojo
// 第二个参数为表id的字段类型
}

4.4 @Query注解使用,对于复杂但又相对固定的查询,可以使用JPQL和Native Sql,即@Query直接写JPQL语句的方式。这部分也不难,简单给个例子,需要注意的是返回结果如果是多个值并且返回多组,那应该以Object[][]表示,具体代码如下:
[Java] 纯文本查看 复制代码
@Query(value = "SELECT su.id, su.name_CN, avg(s.rate), count(b.id), count(concat(b.key, '@', s.admin)) "  

            + "FROM  " + CommonConstants.SCHEMA_PREFIX + "Submarket su,  " + CommonConstants.SCHEMA_PREFIX + "Building b,  " + CommonConstants.SCHEMA_PREFIX + "Space s,  " + CommonConstants.SCHEMA_PREFIX + "Market m,  " + CommonConstants.SCHEMA_PREFIX + "City c "  
            + "where b.submarket_id = su.id and s.building_id = b.id and su.market_id = m.id and m.city_id = c.id and c.country_id = ?1 group by su.id", nativeQuery=true)  
    Object[][] findAreaInfoByCountryId(int parentId);  

4.5 如果想想要执行更新的话需要加上@Modifying注解具体代码如下:

[Java] 纯文本查看 复制代码
@Query("update Courier set deltag = '1' where id = ?")
        @Modifying
        void updateDelTag(Integer id);
5.查询关键字


Keyword
Sample
JPQL snippet
AndfindByLastnameAndFirstname… where x.lastname = ?1 and x.firstname = ?2
OrfindByLastnameOrFirstname… where x.lastname = ?1 or x.firstname = ?2
Is,EqualsfindByFirstname,findByFirstnameIs,findByFirstnameEquals… where x.firstname = ?1
BetweenfindByStartDateBetween… where x.startDate between ?1 and ?2
LessThanfindByAgeLessThan… where x.age < ?1
LessThanEqualfindByAgeLessThanEqual… where x.age <= ?1
GreaterThanfindByAgeGreaterThan… where x.age > ?1
GreaterThanEqualfindByAgeGreaterThanEqual… where x.age >= ?1
AfterfindByStartDateAfter… where x.startDate > ?1
BeforefindByStartDateBefore… where x.startDate < ?1
IsNullfindByAgeIsNull… where x.age is null
IsNotNull,NotNullfindByAge(Is)NotNull… where x.age not null
LikefindByFirstnameLike… where x.firstname like ?1
NotLikefindByFirstnameNotLike… where x.firstname not like ?1
StartingWithfindByFirstnameStartingWith… where x.firstname like ?1(parameter bound with appended %)
EndingWithfindByFirstnameEndingWith… where x.firstname like ?1(parameter bound with prepended %)
ContainingfindByFirstnameContaining… where x.firstname like ?1(parameter bound wrapped in %)
OrderByfindByAgeOrderByLastnameDesc… where x.age = ?1 order by x.lastname desc
NotfindByLastnameNot… where x.lastname <> ?1
InfindByAgeIn(Collection ages)… where x.age in ?1
NotInfindByAgeNotIn(Collection age)… where x.age not in ?1
TruefindByActiveTrue()… where x.active = true
FalsefindByActiveFalse()… where x.active = false
IgnoreCasefindByFirstnameIgnoreCase… where UPPER(x.firstame) = UPPER(?1)


      Spring Data JPA框架在进行方法名解析时,会先把方法名多余的前缀截取掉,比如 find、findBy、read、readBy、get、getBy,然后对剩下部分进行解析。
假如创建如下的查询:findByUserDepUuid(),框架在解析该方法时,首先剔除 findBy,然后对剩下的属性进行解析,假设查询实体为Doc
1:先判断 userDepUuid (根据 POJO 规范,首字母变为小写)是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,继续第二步;
2:从右往左截取第一个大写字母开头的字符串此处为Uuid),然后检查剩下的字符串是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,则重复第二步,继续从右往左截取;最后假设user为查询实体的一个属性;
3:接着处理剩下部分(DepUuid),先判断 user 所对应的类型是否有depUuid属性,如果有,则表示该方法最终是根据 “ Doc.user.depUuid” 的取值进行查询;否则继续按照步骤 2 的规则从右往左截取,最终表示根据 “Doc.user.dep.uuid” 的值进行查询。
4:可能会存在一种特殊情况,比如 Doc包含一个 user 的属性,也有一个 userDep 属性,此时会存在混淆。可以明确在属性之间加上 "_" 以显式表达意图,比如 "findByUser_DepUuid()" 或者 "findByUserDep_uuid()"
特殊的参数: 还可以直接在方法的参数上加入分页或排序的参数,比如:
Page<UserModel> findByName(String name, Pageable pageable);
List<UserModel> findByName(String name, Sort sort);
6、Specifications查询
    Spring Data JPA支持JPA2.0的Criteria查询,相应的接口是JpaSpecificationExecutor。
    Criteria 查询:是一种类型安全和更面向对象的查询
    这个接口基本是围绕着Specification接口来定义的, Specification接口中只定义了如下一个方法:
    Predicate toPredicate(Root<T> root, CriteriaQuery<?> query, CriteriaBuilder cb);
    要理解这个方法,以及正确的使用它,就需要对JPA2.0的Criteria查询有一个足够的熟悉和理解,因为这个方法的参数和返回值都是JPA标准里面定义的对象。
6.1 Criteria查询基本概念
    Criteria 查询是以元模型的概念为基础的,元模型是为具体持久化单元的受管实体定义的,这些实体可以是实体类,嵌入类或者映射的父类。
    CriteriaQuery接口:代表一个specific的顶层查询对象,它包含着查询的各个部分,比如:select 、from、where、group by、order by等
    注意:CriteriaQuery对象只对实体类型或嵌入式类型的Criteria查询起作用
    Root接口:代表Criteria查询的根对象,Criteria查询的查询根定义了实体类型,能为将来导航获得想要的结果,它与SQL查询中的FROM子句类似
        1:Root实例是类型化的,且定义了查询的FROM子句中能够出现的类型。
        2:查询根实例能通过传入一个实体类型给 AbstractQuery.from方法获得。
        3:Criteria查询,可以有多个查询根。
        4:AbstractQuery是CriteriaQuery 接口的父类,它提供得到查询根的方法。
        CriteriaBuilder接口:用来构建CritiaQuery的构建器对象
        Predicate:一个简单或复杂的谓词类型,其实就相当于条件或者是条件组合。
6.2 Criteria查询
    基本对象的构建
        1:通过EntityManager的getCriteriaBuilder或EntityManagerFactory的getCriteriaBuilder方法可以得到CriteriaBuilder对象
        2:通过调用CriteriaBuilder的createQuery或createTupleQuery方法可以获得CriteriaQuery的实例
        3:通过调用CriteriaQuery的from方法可以获得Root实例
    过滤条件
        1:过滤条件会被应用到SQL语句的FROM子句中。在criteria 查询中,查询条件通过Predicate或Expression实例应用到CriteriaQuery对象上。
        2:这些条件使用 CriteriaQuery .where 方法应用到CriteriaQuery 对象上
        3:CriteriaBuilder也作为Predicate实例的工厂,通过调用CriteriaBuilder 的条件方法( equal,notEqual, gt, ge,lt, le,between,like等)创建Predicate对象。
        4:复合的Predicate 语句可以使用CriteriaBuilder的and, or andnot 方法构建。
构建简单的Predicate示例:
[Java] 纯文本查看 复制代码
Predicate p1=cb.like(root.get(“name”).as(String.class), “%”+uqm.getName()+“%”);
Predicate p2=cb.equal(root.get("uuid").as(Integer.class), uqm.getUuid());
Predicate p3=cb.gt(root.get("age").as(Integer.class), uqm.getAge());
//构建组合的Predicate示例:
Predicate p = cb.and(p3,cb.or(p1,p2));
示例代码如下:
[Java] 纯文本查看 复制代码
Specification<UserModel> spec = new Specification<UserModel>() { 
public Predicate toPredicate(Root<UserModel> root,  
        CriteriaQuery<?> query, CriteriaBuilder cb) {  
    List<Predicate> list = new ArrayList<Predicate>();  
         
    if(um.getName()!=null && um.getName().trim().length()>0){  
        list.add(cb.like(root.get("name").as(String.class), "%"+um.getName()+"%"));  
    }  
    if(um.getUuid()>0){  
        list.add(cb.equal(root.get("uuid").as(Integer.class), um.getUuid()));  
    }  
    Predicate[] p = new Predicate[list.size()];  
    return cb.and(list.toArray(p));  
}  
};
也可以使用CriteriaQuery来得到最后的Predicate,示例如下:
[Java] 纯文本查看 复制代码
Specification<UserModel> spec = new Specification<UserModel>() { 
    public Predicate toPredicate(Root<UserModel> root,  
            CriteriaQuery<?> query, CriteriaBuilder cb) {  
        Predicate p1 = cb.like(root.get("name").as(String.class), "%"+um.getName()+"%");  
        Predicate p2 = cb.equal(root.get("uuid").as(Integer.class), um.getUuid());  
        Predicate p3 = cb.gt(root.get("age").as(Integer.class), um.getAge());  
        //把Predicate应用到CriteriaQuery中去,因为还可以给CriteriaQuery添加其他的功能,比如排序、分组啥的  
        query.where(cb.and(p3,cb.or(p1,p2)));  
        //添加排序的功能  
        query.orderBy(cb.desc(root.get("uuid").as(Integer.class)));  
         
        return query.getRestriction();  
    }  
};  
多表关联查询:
n多表连接查询稍微麻烦一些,下面演示一下常见的1:M,顺带演示一下1:1
n使用Criteria查询实现1对多的查询
1:首先要添加一个实体对象DepModel,并设置好UserModel和它的1对多关系,如下:
[Java] 纯文本查看 复制代码
@Entity
@Table(name="tbl_user")
public class UserModel {
@Id
private Integer uuid;
private String name;
private Integer age;
@OneToMany(mappedBy = "um", fetch = FetchType. LAZY, cascade = {CascadeType. ALL})
private Set<DepModel> setDep;
//省略getter/setter
}
[Java] 纯文本查看 复制代码
@Entity
@Table(name="tbl_dep")
public class DepModel {
@Id
private Integer uuid;
private String name;
@ManyToOne()
  @JoinColumn(name = "user_id", nullable = false)
//表示在tbl_dep里面有user_id的字段
private UserModel um = new UserModel();
//省略getter/setter
}
2:配置好Model及其关系后,就可以在构建Specification的时候使用了,示例如下:
[Java] 纯文本查看 复制代码
Specification<UserModel> spec = new Specification<UserModel>() {
public Predicate toPredicate(Root<UserModel> root, CriteriaQuery<?> query, CriteriaBuilder cb) {
Predicate p1 = cb.like(root.get("name").as(String.class), "%"+um.getName()+"%");
Predicate p2 = cb.equal(root.get("uuid").as(Integer.class), um.getUuid());
Predicate p3 = cb.gt(root.get("age").as(Integer.class), um.getAge());
SetJoin<UserModel,DepModel> depJoin = root.join(root.getModel().getSet("setDep",DepModel.class) , JoinType.LEFT);
Predicate p4 = cb.equal(depJoin.get("name").as(String.class), "ddd");
//把Predicate应用到CriteriaQuery去,因为还可以给CriteriaQuery添加其他的功能,比如排序、分组啥 的
query.where(cb.and(cb.and(p3,cb.or(p1,p2)),p4));
//添加分组的功能
query.orderBy(cb.desc(root.get("uuid").as(Integer.class)));
return query.getRestriction();
}};
n接下来看看使用Criteria查询实现1:1的查询
1:在UserModel中去掉setDep的属性及其配置,然后添加如下的属性和配置:
[Java] 纯文本查看 复制代码
@OneToOne()
@JoinColumn(name = "depUuid")
private DepModel dep;
public DepModel getDep() { return dep;}
public void setDep(DepModel dep) {this.dep = dep;  }
2:在DepModel中um属性上的注解配置去掉,换成如下的配置:
[Java] 纯文本查看 复制代码
@OneToOne(mappedBy = "dep", fetch = FetchType. EAGER, cascade = {CascadeType. ALL})
3:在Specification实现中,把SetJoin的那句换成如下的语句:
[Java] 纯文本查看 复制代码
3:在Specification实现中,把SetJoin的那句换成如下的语句:
Join<UserModel,DepModel> depJoin =
root.join(root.getModel().getSingularAttribute("dep",DepModel.class),JoinType.LEFT);
//root.join(“dep”,JoinType.LEFT); //这句话和上面一句的功能一样,更简单






欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2