SpringDataJPA接口总结

2018-06-20 本文已影响114人 Mr_欢先生

一.什么是SpringDataJPA

Spring Data 是Spring的一个子项目，用于简化数据库访问，，并支持云服务的开源框架。其主要目标是使得对数据的访问变得方便快捷。
SpringDataJPA 则是致力于减少数据访问层的开发量，开发者唯一要做的就是声明持久层的接口，其他都交给SpringDataJPA来帮你完成。

二.SpringDataJPA的接口学习

Spring Data JPA接口继承关系图

1.Repository 接口

简介：Repository 接口是 Spring Data 的一个核心接口，它不提供任何方法，开发者需要在自己定义的接口中声明需要的方法
说明：
User 表示实体类
t_user 表示数据库中表名

1).简单条件查询

查询某一个实体类或者集合,按照 Spring Data 的规范，查询方法以 find | read | get 开头，涉及条件查询时，条件的属性用条件关键字连接。要注意的是：条件属性以首字母大写。

举例：通过姓名来查找用户

List<User> findByName(String name);

2).关键字

直接在接口中定义查询方法，如果是符合规范的，可以不用写实现，目前支持的关键字写法如下:

举例：通过模糊字段来查找用户

List<User> findByNameLike(String str);

3).@Query自定义查询

a.这种查询可以声明在 Repository 方法中，摆脱像命名查询那样的约束，将查询直接在相应的接口方法中声明，结构更为清晰，这是 Spring data 的特有实现。
b.还可以使用@Query来指定本地查询，只要设置nativeQuery为true

举例：通过模糊字段来查找用户

@Query("select * from User where name = ?1")
List<User> testFindByName(String name);
//本地查询
@Query(value="select * from t_user where name like %?1" ,nativeQuery=true)
    public List<User> testFindByName(String str);

4).索引参数与命名参数

a.索引参数如下所示，索引值从1开始，查询中 ?X 个数需要与方法定义的参数个数相一致，并且顺序也要一致
b.命名参数（推荐使用这种方式）：可以定义好参数名，赋值时采用@Param("参数名")，而不用管顺序。

举例：

//索引参数
@Query("select * from User where name = ?1 and password = ?2")
List<User> testFindByNameAndPassword(String name,String password);
@Query("select * from User where name = ?1%")
List<User> testFindByNameLike(String str);
//命名参数
@Query("select * from User where name = :name and password = :password")
List<User> testFindByNameAndPassword(@Param("password")String password,@Param("name")String name);

5).@Modifying 注解和事务

a.@Query 与 @Modifying 这两个注解一起声明，可定义个性化更新操作，例如只涉及某些字段更新时最为常用
注意：在调用的地方必须加事务，没有事务不能正常执行
注意JPQL不支持insert操作

举例：修改用户名

//service 层需要添加事务
@Service
public class UserService {

    @Autowired
    private UserRepository userRepository;

//@Transactional 该注解将为此方法添加事务
    @Transactional
    public void testUpdateUserName(String name){
        userRepository.testUpdateUserName(name);
    }
}
//dao层接口
@Modifying
@Query("update User set name = ?1")
void testUpdateUserName(String name);

2.CrudRepository 接口

简介：CrudRepository 接口提供了最基本的对实体类的添删改查操作,用法同上、

接口中新增的方法：

T save(T entity);//保存单个实体 
Iterable<T> save(Iterable<? extends T> entities);//保存集合        
T findOne(ID id);//根据id查找实体         
boolean exists(ID id);//根据id判断实体是否存在         
Iterable<T> findAll();//查询所有实体,不用或慎用!         
long count();//查询实体数量         
void delete(ID id);//根据Id删除实体         
void delete(T entity);//删除一个实体 
void delete(Iterable<? extends T> entities);//删除一个实体的集合         
void deleteAll();//删除所有实体,不用或慎用!

举例：保存多条数据

@Service
public class UserService {

    @Autowired
    private UserRepsotory userRepsotory;
    
    @Transactional
    public void saveUser(List<User> users){
        userRepsotory.save(users);
    }
}

3.PagingAndSortingRepository 接口

简介：该接口提供了分页与排序功能，用法同上

接口中新增的方法：

Iterable<T> findAll(Sort sort); //排序 
Page<T> findAll(Pageable pageable); //分页查询（含排序功能）

举例：

@Test
    public void testPagingAndSortingRespository(){
        //pageNo 从 0 开始. 
        int pageNo = 6 - 1;
        int pageSize = 5;
        //Pageable 接口通常使用的其 PageRequest 实现类. 其中封装了需要分页的信息
        //排序相关的. Sort 封装了排序的信息
        //Order 是具体针对于某一个属性进行升序还是降序. 
        Order order1 = new Order(Direction.DESC, "id");
        Order order2 = new Order(Direction.ASC, "email");
        Sort sort = new Sort(order1, order2);
        
        PageRequest pageable = new PageRequest(pageNo, pageSize, sort);
        Page<User> page = userRepsotory.findAll(pageable);
        
        System.out.println("总记录数: " + page.getTotalElements());
        System.out.println("当前第几页: " + (page.getNumber() + 1));
        System.out.println("总页数: " + page.getTotalPages());
        System.out.println("当前页面的 List: " + page.getContent());
        System.out.println("当前页面的记录数: " + page.getNumberOfElements());
    }

4.JpaRepository 接口

简介：该接口提供了JPA的相关功能

接口中新增的方法：

List<T> findAll(); //查找所有实体 
List<T> findAll(Sort sort); //排序、查找所有实体 
List<T> save(Iterable<? extends T> entities);//保存集合 
void flush();//执行缓存与数据库同步 
T saveAndFlush(T entity);//强制执行持久化 
void deleteInBatch(Iterable<T> entities);//删除一个实体集合

举例：

    @Test
    public void testJpaRepository(){
        User user = new User();
        user.setBirth(new Date());
        iuser.setEmail("12345@qq.com");
        user.setName("xiaoming");
        user.setId(5);
        
        User User2 = userRepsotory.saveAndFlush(user);
    }

5.JpaSpecificationExecutor接口

简介：不属于Repository体系，实现一组 JPA Criteria 查询相关的方法

T findOne(Specification<T> spec);
List<T> findAll(Specification<T> spec);
Page<T> findAll(Specification<T> spec, Pageable pageable);
List<T> findAll(Specification<T> spec, Sort sort);
long count(Specification<T> spec);

@Test
    public void testJpaSpecificationExecutor(){
        int pageNo = 2 - 1;
        int pageSize = 10;
        PageRequest pageable = new PageRequest(pageNo, pageSize);
        
        //通常使用 Specification 的匿名内部类
        Specification<User> specification = new Specification<User>() {
            /**
             * @param *root: 代表查询的实体类. 
             * @param query: 可以从中可到 Root 对象, 即告知 JPA Criteria 查询要查询哪一个实体类. 还可以
             * 来添加查询条件, 还可以结合 EntityManager 对象得到最终查询的 TypedQuery 对象. 
             * @param *cb: CriteriaBuilder 对象. 用于创建 Criteria 相关对象的工厂. 当然可以从中获取到 Predicate 对象
             * @return: *Predicate 类型, 代表一个查询条件. 
             */
            @Override
            public Predicate toPredicate(Root<User> root,
                    CriteriaQuery<?> query, CriteriaBuilder cb) {
                Path path = root.get("id");
                Predicate predicate = cb.gt(path, 5);
                return predicate;
            }
        };
        
        Page<User> page = userRepsotory.findAll(specification, pageable);
    
        System.out.println("总记录数: " + page.getTotalElements());
        System.out.println("当前第几页: " + (page.getNumber() + 1));
        System.out.println("总页数: " + page.getTotalPages());
        System.out.println("当前页面的 List: " + page.getContent());
        System.out.println("当前页面的记录数: " + page.getNumberOfElements());
    }

SpringDataJPA接口总结

一.什么是SpringDataJPA

二.SpringDataJPA的接口学习

1.Repository 接口

1).简单条件查询

2).关键字

3).@Query自定义查询

4).索引参数与命名参数

5).@Modifying 注解和事务

2.CrudRepository 接口

3.PagingAndSortingRepository 接口

4.JpaRepository 接口

5.JpaSpecificationExecutor接口

猜你喜欢

热点阅读