SpringBoot整合SpringData JPA

SpringBoot整合SpringData JPA

下一节直通车

JPA的一对一、一对多、多对多查询

简介

JPA(Java Persistence API)意即Java持久化API，是Sun官方在JDK5.0后提出的Java持久化规范（JSR 338，这些接口所在包为javax.persistence，详细内容可参考 https://github.com/javaee/jpa-spec
JPA的出现主要是为了简化持久层开发以及整合ORM技术，结束Hibernate、TopLink、JDO等ORM框架各自为营的局面。JPA是在吸收现有ORM框架的基础上发展而来，易于使用，伸缩性强。总的来说，JPA包括以下3方面的技术：

1. ORM映射元数据： 支持XML和注解两种元数据的形式，元数据描述对象和表之间的映射关系
2. API： 操作实体对象来执行CRUD操作
3. 查询语言： 通过面向对象而非面向数据库的查询语言（JPQL）查询数据，避免程序的SQL语句紧密耦合

JPA的优缺点

优点

1. 构建简单的SQL很容易
2. 通过实体类生成数据表的逆向工程很方便
3. 持久层只需要接口而不需要实现类
4. 占位符也很灵活，集合类型也不需要遍历
5. @Query中编写SQL，能够直接操作实体类，并且添加nativeQuery属性可以切换到原生SQL执行
6. 一对一、一对多、多对多查询都可以基于注解配置来实现
7. 分页很简便

适合简单SQL的场景和单表的场景，以及表关系明确，自定义（字段、SQL）较少的场景

缺点

1. 复杂SQL的处理办法繁琐，例如：连接查询取出不同字段，映射成实体类就非常麻烦（只能映射成接口的形式或先映射成Object[]，再转换成实体类）
2. 没有像mybatis一样可以在xml中编写复杂的SQL，只能在@Query中编写，或通过Criteria编码方式编写，拿取字段不灵活
   解决办法：直接使用实体类中一对一、一对多、多对多的查询注解，得到结果后再封装给自定义类型。

依赖Jar

<!--Spring data jpa-->
<dependency>
	<groupId>org.springframework.data</groupId>
	<artifactId>spring-data-jpa</artifactId>
	<version>2.6.4</version>
</dependency>
<!-- querydsl -->
<dependency>
	<groupId>com.querydsl</groupId>
	<artifactId>querydsl-jpa</artifactId>
	<version>5.0.0</version>
</dependency>
<!-- Hibernate对jpa的支持包 -->
<dependency>
	<groupId>org.hibernate</groupId>
	<artifactId>hibernate-entitymanager</artifactId>
	<version>5.6.9.Final</version>
</dependency>
<!--Spring aspect Auditor审计功能需要-->
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-aspects</artifactId>
</dependency>
<!-- MySQL-->
<dependency>
	<groupId>mysql</groupId>
	<artifactId>mysql-connector-java</artifactId>
	<version>8.0.13</version>
</dependency>
<!-- Druid-->
<dependency>
	<groupId>com.alibaba</groupId>
	<artifactId>druid-spring-boot-starter</artifactId>
	<version>1.1.16</version>
</dependency>
<!--Spring Boot相关-->
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-web</artifactId>
	<version>2.6.8</version>
</dependency>
<!--spring-test测试=-->
<dependency>
	<groupId>org.springframework</groupId>
	<artifactId>spring-test</artifactId>
	<version>5.3.20</version>
	<scope>test</scope>
</dependency>
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-test</artifactId>
	<version>2.6.8</version>
	<scope>test</scope>
</dependency>
<dependency>
	<groupId>com.devilvan</groupId>
	<artifactId>springcloud-api</artifactId>
	<version>1.0-SNAPSHOT</version>
</dependency>
<!--JUnit-->
<dependency>
	<groupId>junit</groupId>
	<artifactId>junit</artifactId>
	<version>4.13.2</version>
</dependency>
<!--Hutool 快速开发工具包-->
<dependency>
	<groupId>cn.hutool</groupId>
	<artifactId>hutool-all</artifactId>
	<version>5.8.9</version>
</dependency>

配置文件yml

server:
  port: 8306
spring:
  application:
	name: spring-data-jpa
  datasource:
	driver-class-name: com.mysql.cj.jdbc.Driver
	url: jdbc:mysql://localhost:3306/你的数据库?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai
	username: 你的账号
	password: 你的密码
	type: com.alibaba.druid.pool.DruidDataSource
	druid:
	  # 下面为连接池的补充设置，应用到上面所有数据源中
	  # 初始化大小，最小，最大
	  initial-size: 5
	  min-idle: 5
	  max-active: 20
  jpa:
	database: MYSQL
	database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
	show-sql: true
	open-in-view: true
	hibernate:
	  ddl-auto: update
	  naming:
		physical-strategy: org.hibernate.boot.model.naming.PhysicalNamingStrategyStandardImpl
	properties:
	  hibernate:
		enable_lazy_load_no_trans: true
  main:
allow-circular-references: true

JPA的实体类

小坑

实体类中使用到了一对一、一对多、多对多的注解，引入了其他类的对象时，不要使用@Data，因为生成的ToString包含这些其他类时，会造成循环调用导致内存溢出。

实体类

JPA遵循的是java的规范，使用到的java.persistence.* 都是基于java规范

/**
 * 用户表
 */
@Setter
@Getter
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
@Entity
@Table(name = "user")
public class User implements Serializable {
	private static final long serialVersionUID = 1L;

	@Id
	@GenericGenerator(name = "idGenerator", strategy = "uuid")
	@GeneratedValue(generator = "idGenerator")
	@Column(name = "id")
	private Long id;
	@Column(name = "username")
	private String username;
	@Column(name = "avatar")
	private String avatar;
	@Column(name = "email")
	private String email;
	@Column(name = "password")
	private String password;
	@Column(name = "status")
	private Integer status;
	@Column(name = "created")
	private Date created;
	@Column(name = "last_login")
	private Date lastLogin;
	@Column(name = "admin")
	private boolean admin;
	@Column(name = "telephone")
	private String telephone;
	@Column(name = "identification")
	private String identification;
	@Column(name = "introduction")
	private String introduction;

	@OneToMany(mappedBy = "user", cascade = CascadeType.ALL,fetch = FetchType.LAZY)
	private Set<Blog> blogs;

	@ManyToMany(targetEntity = Role.class, cascade = {CascadeType.PERSIST, CascadeType.MERGE}, fetch = FetchType.LAZY)
	@JoinTable(name = "tb_user_role",
			joinColumns = {@JoinColumn(name = "user_id", referencedColumnName = "id")},
			inverseJoinColumns = {@JoinColumn(name = "role_id", referencedColumnName = "id")})
	private Set<Role> roles;

	@Override
	public String toString() {
		return "User{" +
				"id=" + id +
				", username='" + username + '\'' +
				", avatar='" + avatar + '\'' +
				", email='" + email + '\'' +
				", password='" + password + '\'' +
				", status=" + status +
				", created=" + created +
				", lastLogin=" + lastLogin +
				", admin=" + admin +
				", telephone='" + telephone + '\'' +
				", identification='" + identification + '\'' +
				", introduction='" + introduction + '\'' +
				'}';
	}
}

注解

注解	描述
@Entity	标记该类与数据库表映射，默认字段名对应数据库字段名。但每个字段最好搭配@Column使用，规范java和数据库的命名
@Table	指定关联哪张表
@Column	指定该字段对应哪个数据库字段
@Id	标记该字段为表的主键
@GenericGenerator	需要搭配@GeneratedValue并在主键字段上使用，指定主键字段的自增规则，如果是自定义类，则strategy属性添加全类名
@GeneratedValue	引用@GenericGenerator的生成策略，generator值对应@GenericGenerator的name。如果没有@GenericGenerator，也可以指定JPA自带的生成策略，例如：

参考文章

SpringBoot学习笔记九：Spring Data Jpa的使用
Springboot Jpa自定义查询的结果集
Spring Data Jpa多表查询返回自定义实体