SpringData和Spring DataJPA知识概括

415 阅读15分钟

@[TOC](SpringData和Spring DataJPA知识概括)

Spring Data概述

Spring Data定义:

  • Spring Data : Spring 的一个子项目。用于简化数据库访问,支持NoSQL 和关系数据存储。其主要目标是使数据库的访问变得方便快捷。
  • SpringData 项目所支持 NoSQL 存储: ①MongoDB (文档数据库) ②Neo4j(图形数据库) ③Redis(键/值存储) ④Hbase(列族数据库)
  • SpringData 项目所支持的关系数据存储技术: ①JDBC ②JPA
  • 注意:使用spring Data需要先下载 Spring Data Commons发布包,Commons 是 Spring Data 的公共基础包。

Spring Data Jpa简述与步骤

Spring DataJPA 概述:

  • 可以理解为JPA规范的再次封装抽象,底层还是使用了Hibernate的JPA技术实现,引用JPQL(Java PersistenceQuery Language)查询语言,属于Spring整个生态体系的一部分。
  • 随着Spring Boot和SpringCloud在市场上的流行,Spring Data JPA也逐渐进入大家的视野,它们组成有机的整体,使用起来比较方便,加快了开发的效率,使开发者不需要关心和配置更多的东西,完全可以沉浸在Spring的完整生态标准实现下。JPA上手简单,开发效率高,对对象的支持比较好,又有很大的灵活性,市场的认可度越来越高。
  • JPA Spring Data : 致力于减少数据访问层 (DAO) 的开发量. 开发者唯一要做的,就只是声明持久层的接口,其他都交给Spring Data JPA 来帮你完成!
  • 框架怎么可能代替开发者实现业务逻辑呢?比如:当有一个 UserDao.findUserById() 这样一个方法声明,大致应该能判断出这是根据给定条件的 ID 查询出满足条件的 User 对象。Spring Data JPA做的便是规范方法的名字,根据符合规范的名字来确定方法需要实现什么样的逻辑。

使用 Spring Data JPA 进行持久层开发需要的四个步骤:

  • 加入依赖 ①Spring Data Commons.jar <1>Commons 是 Spring Data 的基础包 ②Spring Data JPA.jar
  • 配置 Spring 整合 JPA
  • 在 Spring 配置文件中配置 Spring Data,让 Spring 为声明的接口创建代理对象。配置了 <jpa:repositories> 后,Spring 初始化容器时将会扫描 base-package 指定的包目录及其子目录,为继承 Repository 或其子接口的接口创建代理对象,并将代理对象注册为 Spring Bean,业务层便可以通过 Spring 自动封装的特性来直接使用该对象。
<!-- 加入  jpa 的命名空间 -->
<!-- base-package: 扫描 Repository Bean 所在的 package -->
<jpa:repositories base-package="com.george.springdata"
	entity-manager-factory-ref="entityManagerFactory"></jpa:repositories>
  • 声明持久层的接口,该接口继承 Repository,Repository 是一个标记型接口,它不包含任何方法,如必要,Spring Data 可实现 Repository 其他子接口,其中定义了一些常用的增删改查,以及分页相关的方法。
  • 在接口中声明需要的方法。Spring Data 将根据给定的策略来为其生成实现代码。
public interface customerRepository extends Repository<Customer,Integer> {
	customer getBycustomerId( Integer id);
}

Repository 接口

Repository 接口概述:

  • Repository 接口是 Spring Data 的一个核心接口,它不提供任何方法,开发者需要在自己定义的接口中声明需要的方法:
public interface Repository<T, ID extends Serializable> { } 
  • Spring Data可以让我们只定义接口,只要遵循 Spring Data的规范,就无需写实现类。
  • 与继承 Repository 等价的一种方式,就是在持久层接口上使用 @RepositoryDefinition 注解,并为其指定domainClass 和 idClass 属性。如下两种方式是完全等价的。
public interface UserDao extends Repository<AccountInfo, Long> {...... }

@RepositoryDefinition(domainClass = AccountInfo.class, idClass = Long.class)
public interface UserDao {...... }

Repository 的子接口:

  • 基础的 Repository 提供了最基本的数据访问功能,其几个子接口则扩展了一些功能。它们的继承关系如下: ①Repository: 仅仅是一个标识,表明任何继承它的均为仓库接口类 ②CrudRepository: 继承 Repository,实现了一组 CRUD 相关的方法 ③PagingAndSortingRepository: 继承 CrudRepository,实现了一组分页排序相关的方法 ④JpaRepository: 继承 PagingAndSortingRepository,实现一组 JPA 规范相关的方法 ⑤自定义的 XxxxRepository 需要继承 JpaRepository,这样的 XxxxRepository 接口就具备了通用的数据访问控制层的能力。 ⑥JpaSpecificationExecutor: 不属于Repository体系,实现一组 JPA Criteria 查询相关的方法
  • 因此JpaRepository接口是最厉害的!!!!!

Repository 的子接口详解:

  • CrudRepository接口:提供了最基本的对实体类的添删改查操作 ①T save(T entity);//保存单个实体 ②Iterable save(Iterable<? extends T> entities);//保存集合
    ③T findOne(ID id);//根据id查找实体
    ④boolean exists(ID id);//根据id判断实体是否存在
    ⑤Iterable findAll();//查询所有实体,不用或慎用!
    ⑥long count();//查询实体数量
    ⑦void delete(ID id);//根据Id删除实体
    ⑧void delete(T entity);//删除一个实体 ⑨void delete(Iterable<? extends T> entities);//删除一个实体的集合
    ⑩void deleteAll();//删除所有实体,不用或慎用!
  • PagingAndSortingRepository:该接口提供了分页与排序功能 ①Iterable findAll(Sort sort); //排序 ②Page findAll(Pageable pageable); //分页查询(含排序功能)
  • JpaRepository接口:该接口提供了JPA的相关功能 ①List findAll(); //查找所有实体 ②List findAll(Sort sort); //排序、查找所有实体 ③List save(Iterable<? extends T> entities);//保存集合 ④void flush();//执行缓存与数据库同步 ⑤T saveAndFlush(T entity);//强制执行持久化 ⑥void deleteInBatch(Iterable entities);//删除一个实体集合
  • JpaSpecificationExecutor接口:不属于Repository体系,实现一组 JPA Criteria 查询相关的方法 ①Specification:封装 JPA Criteria 查询条件。通常使用匿名内部类的方式来创建该接口的对象 在这里插入图片描述

自定义 Repository 方法:

  • 为某一个 Repository 上添加自定义方法 ①步骤: <1>定义一个接口: 声明要添加的, 并自实现的方法 <2>提供该接口的实现类: 类名需在要声明的 Repository 后添加 Impl, 并实现方法 <3>声明 Repository 接口, 并继承<1>声明的接口 ②注意: 默认情况下, Spring Data 会在 base-package 中查找 "接口名Impl" 作为实现类,也可以通过repository-impl-postfix声明后缀。
  • 为所有的 Repository 都添加自实现的方法 ①步骤: <1>声明一个接口, 在该接口中声明需要自定义的方法, 且该接口需要继承 Spring Data 的 Repository. <2>提供 <1> 所声明的接口的实现类. 且继承 SimpleJpaRepository, 并提供方法的实现 <3>定义 JpaRepositoryFactoryBean 的实现类, 使其生成 1) 定义的接口实现类的对象 <4>修改 <jpa:repositories /> 节点的 factory-class 属性指向 3) 的全类名 ②注意: 全局的扩展实现类不要用 Imp 作为后缀名, 或为全局扩展接口添加 @NoRepositoryBean 注解告知 Spring Data: Spring Data 不把其作为 Repository

为某一个 Repository 上添加自定义方法案例: 在这里插入图片描述

public interface EmployeeDao {
	void method();
}
/规约:命名必须符合:声明使用的Repository接口名+lmpl.
//在本例中: EmployeeRepository +Impl
public class EmployeeRepositoryImpl implements EmployeeDao{

	@PersistenceContext
	private EntityManager entityManager;
	
	@override
	public void method() {
		system.out.print1n( "method. . ." +entityManager);
	}
}

public interface EmployeeRepository extends 
	JpaRepository<Employee,Integer>,EmployeeDao{
}

SpringData 方法定义规范

SpringData 方法定义规范:

  • 简单条件查询: 查询某一个实体类或者集合
  • 按照 Spring Data 的规范,查询方法以 find | read | get 开头,涉及条件查询时,条件的属性用条件关键字连接,要注意的是:条件属性以首字母大写。
  • 例如:定义一个 Entity 实体类
class User{
	private String firstName;
	private String lastName; 
}

使用And条件连接时,应这样写: 
findByLastNameAndFirstName(String lastName,String firstName); 
条件的属性名称与个数要与参数的位置与个数一一对应

支持的关键字:

KeywordSampleJPQL snippet
AndfindByLastnameAndFirstname... where x.lastname = ?1 and x.firstname = ?2
orfindByLastnameOrFirstname... where x.lastname = ?1 or x.firstname = ?2
BetweenfindByStartDateBetween... where x.startDate between 1? and ?2
LessThanfindByAgeLessThan... where x.age e ?1
GreaterThanfindByAgeGreaterThan... where x.age > ?1
AfterfindByStartDateAfter... where x.startDate > ?1
BeforefindByStartDateBefore... where x.startDate < ?1
lsNullfindByAgelsNull... where x.age is null
lsNotNull,NotNullfindByAge(ls)NotNull... where x.age not null
LikefindByFirstnameLike... where x.firstname like ?1
NotLikefindByFirstnameNotL ike... 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 c> ?1
lnfindByAgeln(Collection<Age ages)... where x.age in ?1
NotInfindByAgeNotIn(Collection age)... where x.age not in ?1
TRUEfindByActiveTrue()... where x.active = true
FALSEfindByActiveFalse()... where x.active = fals

查询方法解析流程:

  • 假如创建如下的查询:findByUserDepUuid(),框架在解析该方法时,首先剔除findBy,然后对剩下的属性进行解析,假设查询实体为Doc ①先判断 userDepUuid (根据 POJO 规范,首字母变为小写)是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,继续第二步; ②从右往左截取第一个大写字母开头的字符串(此处为Uuid),然后检查剩下的字符串是否为查询实体的一个属性,如果是,则表示根据该属性进行查询;如果没有该属性,则重复第二步,继续从右往左截取;最后假设 user 为查询实体的一个属性; ③接着处理剩下部分(DepUuid),先判断 user 所对应的类型是否有depUuid属性,如果有,则表示该方法最终是根据 “ Doc.user.depUuid” 的取值进行查询;否则继续按照步骤 2 的规则从右往左截取,最终表示根据 “Doc.user.dep.uuid” 的值进行查询。 ④可能会存在一种特殊情况,比如 Doc包含一个 user 的属性,也有一个 userDep 属性,此时会存在混淆。可以明确在属性之间加上 "_" 以显式表达意图,比如 "findByUser_DepUuid()" 或者 "findByUserDep_uuid()"
  • 特殊的参数: 还可以直接在方法的参数上加入分页或排序的参数,比如: ①Page<UserModel> findByName(String name, Pageable pageable); ②List<UserModel> findByName(String name, Sort sort);

@Query注解

使用 @Query 注解:

  • 这种查询可以声明在 Repository 方法中,摆脱像命名查询那样的约束,将查询直接在相应的接口方法中声明,结构更为清晰,这是Spring data 的特有实现。
@Query("SELECT c FROM Customer c WHERE c.customerId = ?1")
Customer GetByCustomerId(Integer id);
  • 索引参数:索引值从1开始,查询中 ”?X” 个数需要与方法定义的参数个数相一致,并且顺序也要一致
  • 命名参数:(推荐使用这种方式)可以定义好参数名,赋值时采用@Param("参数名"),而不用管顺序。
@Query("SELECT p FROM Person p WHERE p.lastName = :lastName AND p.email = :email")
List<Person> QueryParams(@Param("email") String email, @Param("lastName") String lastName);
  • 如果是 @Query 中有 LIKE 关键字,后面的参数需要前面或者后面加 %,这样在传递参数值的时候就可以不加 %。
@Query("select o from UserModel o where o.name like ?1%")
public List<UserModel> findByUuidOrAge(String name);

@Query("select o from UserModel o where o.name like %?1")
public List<UserModel> findByUuidOrAge(String name);

@Query("select o from UserModel o where o.name like %?1%")
public List<UserModel> findByUuidOrAge(String name);
  • 还可以使用@Query来指定本地查询,只要设置nativeQuery为true,比如:
@Query(value="select * from tbl_user where name like %?1" ,nativeQuery=true)
public List<UserModel> findByUuidOrAge(String name);

@Modifying注解和事务

@Query 与 @Modifying 执行更新操作:

  • @Query 与 @Modifying 这两个annotation一起声明,可定义个性化更新操作,例如只涉及某些字段更新时最为常用,示例如下:
@Modifying
@Query("UPDATE Person p SET p.email = :email WHERE id = :id")
void updatePersonEmail(@Param("id") Integer id, @Param("email") String email);
  • 注意: ①方法的返回值应该是 int,表示更新语句所影响的行数 ②在调用的地方必须加事务,没有事务不能正常执行

事务:

  • Spring Data 提供了默认的事务处理方式,即所有的查询均声明为只读事务。
  • 对于自定义的方法,如需改变 Spring Data 提供的事务默认方式,可以在方法上注解@Transactional 声明
  • 进行多个 Repository 操作时,也应该使它们在同一个事务中处理,按照分层架构的思想,这部分属于业务逻辑层,因此,需要在Service 层实现对多个 Repository 的调用,并在相应的方法上声明事务。

@PersistenceContext注解

@PersistenceContext注解简介:

  • 这个是JPA中的注解,PersistenceContext,称为持久化上下文,它一般包含有当前事务范围内的,被管理的实体对象(Entity)的数据。
  • 每个EntityManager,都会跟一个PersistenceContext相关联。PersistenceContext中存储的是实体对象的数据,而关系数据库中存储的是记录。

@PersistenceContext与@Resource区别:

  • @PersistenceContext: ①注入的是实体管理器,执行持久化操作的,需要配置文件persistence.xml。 ②注入一堆保存实体类状态的数据结构,针对实体类的不同状态(四种,managedh或detached等)可以做出不同的反应(merge,persist等等),其实就是把数据从数据库里提出,然后在内存里处理的,再返回数据库的法则。
  • @Resource: ①是注入容器提供的资源对象,比如SessionContext MessageDrivenContext。 ②或者你那个name指定的JNDI对象,可以理解为资源->数据源->也就是数据连接,基本上就是告诉程序数据库在哪里

hibernate,jpa与spring data 与jpa三者之间的关系

简介:

  • Hibernate:Hibernate是一个开放源代码的对象关系映射框架,它对JDBC进行了非常轻量级的对象封装,它将POJO与数据库表建立映射关系,是一个全自动的orm框架,hibernate可以自动生成SQL语句,自动执行,使得Java程序员可以随心所欲的使用对象编程思维来操纵数据库。
  • JPA:JPA全称是Java Persistence API,即java持久化API,是sun公司推出的一套基于ORM的规范,内部由一系列的接口和抽象类构成。
  • JPA与Hibetnate的关系:JPA和Hibernate的关系就像JDBC和JDBC驱动的关系,JPA是规范,Hibernate除了作为ORM框架之外,它也是一种JPA实现。JPA怎么取代Hibernate呢?JDBC规范可以驱动底层数据库吗?答案是否定的,也就是说,如果使用JPA规范进行数据库操作,底层需要hibernate作为其实现类完成数据持久化工作。
  • Spring Data jpa:Spring Data JPA 让我们解脱了DAO层的操作,基本上所有CRUD都可以依赖于它来实现,在实际的工作工程中,推荐使用Spring Data JPA + ORM(如:hibernate)完成操作,这样在切换不同的ORM框架时提供了极大的方便,同时也使数据库层操作更加简单,方便解耦
  • Hibernate、JPA与Spring Data JPA之间的关系:JPA是一套规范,内部是有接口和抽象类组成的。 ②hibernate是一套成熟的ORM框架,而且Hibernate实现了JPA规范,所以也可以称hibernate为JPA的一种实现方式,我们使用JPA的API编程,意味着站在更高的角度上看待问题(面向接口编程)Spring Data ③JPA是Spring提供的一套对JPA操作更加高级的封装,是在JPA规范下的专门用来进行数据持久化的解决方案。
  • 总结:JPA是一种规范,Hibernate实现了JPA规范,即Hibernate为JPA的一种实现;而Spring Data JPA是对JPA进行更高级的封装,让其dao编码变得更简单。

Spring DAO vs Spring ORM vs Spring JDBC vsSpring-Data

简介:

  • Spring-DAO:Spring-DAO 并非 Spring 的一个模块,它实际上是指示你写 DAO 操作、写好 DAO 操作的一些规范。因此,对于访问你的数据它既没有提供接口也没有提供实现更没有提供模板。在写一个 DAO 的时候,你应该使用 @Repository 对其进行注解,这样底层技术(JDBC,Hibernate,JPA,等等)的相关异常才能一致性地翻译为相应的 DataAccessException 子类。
  • Spring-JDBC:Spring-JDBC 提供了 Jdbc 模板类,它移除了连接代码以帮你专注于 SQL 查询和相关参数。你只需给它配置一个 DataSource ,然后你就可以这样进行写代码了。
  • Spring-ORM:Spring-ORM 是一个囊括了很多持久层技术(JPA,JDO,Hibernate,iBatis)的总括模块。对于这些技术中的每一个,Spring 都提供了集成类,这样每一种技术都能够在遵循 Spring 的配置原则下进行使用,并平稳地和 Spring 事务管理进行集成。
  • Spring-Data:Spring-Data 是一个提供了一个通用 API 来定义如何以一个更通用的方式访问数据(DAO + 注解)的总括模块,包括 SQL 和 NOSQL 数据源。
  • 链接:Spring DAO vs Spring ORM vs Spring JDBC vsSpring-Data

springboot整合SpringDataJPA

步骤:

  • 导入依赖:
<!-- springData JPA的启动器--><dependency>
groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId></dependency>
  • 编写application.properties配置文件:
spring.datasource.driverClassName=com.mysq1.jdbc.Driver
spring.datasource.ur1=jdbc:mysq1://localhost:3306/ssm
spring.datasource.username=root
spring.datasource.password=root

spring.datasource.type=com. alibaba. druid.poo1.DruidDataSource

#jpa的正向工程
spring.jpa.hibernate.dd1-auto=update
#显示sql
spring.jpa.show-sq1=true
  • 编写实体类:
import javax.persistence.*;

@Entity
@Table(name="t_users")
public class Users {

	@Id	//主键id
	@GeneratedValue(strategy=GenerationType.IDENTITY)//主键生成策略
	@Column(name="id")//数据库字段名
	private Integer id;
	
	@Column(name="name")
	private String name;
	
	@Column(name="age")
	private Integer age;
	
	@Column(name="address")
	private String address;

	@ManyToOne(cascade = CascadeType.PERSIST)	//表示多方
	@JoinColumn(name ="role_id")	//维护一个外键,外键在Users一侧
	private Roles roles;

	public Roles getRoles() {
		return roles;
	}

	public void setRoles(Roles roles) {
		this.roles = roles;
	}

	public Integer getId() {
		return id;
	}

	public void setId(Integer id) {
		this.id = id;
	}

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public Integer getAge() {
		return age;
	}

	public void setAge(Integer age) {
		this.age = age;
	}

	public String getAddress() {
		return address;
	}

	public void setAddress(String address) {
		this.address = address;
	}

	@Override
	public String toString() {
		final StringBuffer sb = new StringBuffer("Users{");
		sb.append("id=").append(id);
		sb.append(", name='").append(name).append('\'');
		sb.append(", age=").append(age);
		sb.append(", address='").append(address).append('\'');
		sb.append(", roles=").append(roles);
		sb.append('}');
		return sb.toString();
	}
}
  • 编写Dao接口:
import org.springframework.data.jpa.repository.JpaRepository;

import com.bjsxt.pojo.Users;
/**
 * 参数一 T :当前需要映射的实体
 * 参数二 ID :当前映射的实体中的OID的类型
 *
 */
public interface UsersRepository extends JpaRepository<Users,Integer> {

}

springboot整合SpringDataJPA详解:

  • 在Springboot应用开发中使用JPA时,通常在主应用程序所在包或者其子包的某个位置定义我们的Entity和Repository,这样基于Springboot的自动配置,无需额外配置,我们定义的Entity和Repository即可被发现和使用。
  • 但有时候我们需要定义Entity和Repository不在应用程序所在包及其子包,那么这时候就需要使用@EntityScan和@EnableJpaRepositories了。
  • @EntityScan :@EntityScan用来扫描和发现指定包及其子包中的Entity定义。
  • @EnableJpaRepositories:@EnableJpaRepositories用来扫描和发现指定包及其子包中的Repository定义。