Spring Boot学习（十一）：Spring Boot整合和使用JPA，详细易懂！

前言

Spring Boot系列: 点击查看Spring Boot系列文章

JPA是什么?

JPA(Java Persistence API)是Sun官方提出的Java持久化规范. 为Java开发人员提供了一种对象/关联映射工具来管理Java应用中的关系数据. 它的出现是为了简化现有的持久化开发工作和整合ORM技术. 结束各个ORM框架各自为营的局面.

JPA仅仅是一套规范,不是一套产品, 也就是说Hibernate, TopLink等是实现了JPA规范的一套产品.

Spring Data JPA

Spring Data JPA是Spring基于ORM框架、JPA规范的基础上封装的一套JPA应用框架,是基于Hibernate之上构建的JPA使用解决方案,用极简的代码实现了对数据库的访问和操作,包括了增、删、改、查等在内的常用功能.

SpringBoot整合SpringData JPA

SpringBoot版本：2.3.0

1、添加依赖

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

2、进行JPA配置

#JPA配置

#是否在日志中打印出自动生成的 SQL，方便调试的时候查看
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=update
#格式化SQL语句
spring.jpa.hibernate.format_sql=true

spring.jpa.hibernate.ddl-auto，其属性值作用区别介绍如下：

create：
每次加载hibernate时都会删除上一次的生成的表，然后根据你的model类再重新来生成新表，哪怕两次没有任何改变也要这样执行，这就是导致数据库表数据丢失的一个重要原因。

create-drop ：
每次加载hibernate时根据model类生成表，但是sessionFactory一关闭,表就自动删除。

update：
最常用的属性，第一次加载hibernate时根据model类会自动建立起表的结构（前提是先建立好数据库），以后加载hibernate时根据 model类自动更新表结构，即使表结构改变了但表中的行仍然存在不会删除以前的行。要注意的是当部署到服务器后，表结构是不会被马上建立起来的，是要等 应用第一次运行起来后才会。

validate ：
每次加载hibernate时，验证创建数据库表结构，只会和数据库中的表进行比较，不会创建新表，但是会插入新值。

none：
不使用

3、创建JPA实体类

通常，JPA实体类被定义到一个persistence.xml文件，在Spring Boot中，这个文件被实体扫描取代。默认情况，Spring Boot会查找主配置类（被@EnableAutoConfiguration或@SpringBootApplication注解的类）下的所有包。

任何被@Entity，@Embeddable或@MappedSuperclass注解的类都将被考虑。

以下创建一个简单的JPA实体类

@Entity
@Data
@NoArgsConstructor
public class User {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(nullable = false, unique = true)
    private String userName;

    @Column(nullable = false)
    private String passWord;


}

启动项目，会看到控制台输出创建表的SQL语句

Hibernate: create table user (id bigint not null auto_increment, pass_word varchar(255) not null, user_name varchar(255) not null, primary key (id)) engine=InnoDB

启动项目，出现了以下警告

2020-06-08 16:53:24.753  WARN 89076 --- [           main] JpaBaseConfiguration$JpaWebConfiguration : spring.jpa.open-in-view is enabled by default. Therefore, database queries may be performed during view rendering. Explicitly configure spring.jpa.open-in-view to disable this warning

设置spring.jpa.open-in-view属性即可

spring.jpa.open-in-view = false

注解介绍:
@Entity(name=“EntityName”) 必须，用来标注一个数据库对应的实体，数据库中创建的表名默认和类名一致。其中，name 为可选，对应数据库中一个表，使用此注解标记 Pojo 是一个 JPA 实体。

@Table(name=""，catalog=""，schema="") 可选，用来标注一个数据库对应的实体，数据库中创建的表名默认和类名一致。通常和 @Entity 配合使用，只能标注在实体的 class 定义处，表示实体对应的数据库表的信息。

@Id 必须，@Id 定义了映射到数据库表的主键的属性，一个实体只能有一个属性被映射为主键。
@GeneratedValue(strategy=GenerationType，generator="") 可选，strategy: 表示主键生成策略，有 AUTO、INDENTITY、SEQUENCE 和 TABLE 4 种，generator: 表示主键生成器的名称。

strategy属性：提供四种值:

-AUTO主键由程序控制, 是默认选项 ,不设置就是这个

-IDENTITY 主键由数据库生成, 采用数据库自增长, Oracle不支持这种方式

-SEQUENCE 通过数据库的序列产生主键, MYSQL 不支持

-Table 提供特定的数据库产生主键, 该方式更有利于数据库的移植

如果我们想要使用自定义的主键生成策略，可以使用@GenericGenerator+@GeneratedValue实现
@GenericGenerator注解是hibernate所提供的自定义主键生成策略生成器，由@GenericGenerator实现多定义的策略。所以，它要配合@GeneratedValue一起使用，并且@GeneratedValue注解中的”generator”属性要与@GenericGenerator注解中name属性一致，strategy属性表示hibernate的主键生成策略
例：
@GeneratedValue(generator = “myGenerator”)
//strategy 为自己的ID生成类
@GenericGenerator(name = “myGenerator”, strategy = “com.test.demo.uuidgenerator”)

@Column(name = “user_code”， nullable = false， length=32,unique =true) 可选，@Column 描述了数据库表中该字段的详细定义，这对于根据 JPA 注解生成数据库表结构的工具。name: 表示数据库表中该字段的名称，默认情形属性名称一致；nullable: 表示该字段是否允许为 null，默认为 true；unique: 表示该字段是否是唯一标识，默认为 false；length: 表示该字段的大小，对 String 类型的字段有效。

@Transient可选，@Transient 表示该属性并非一个到数据库表的字段的映射，ORM 框架将忽略该属性。

@Enumerated 可选，使用枚举的时候，我们希望数据库中存储的是枚举对应的 String 类型，而不是枚举的索引值，需要在属性上面添加 @Enumerated(EnumType.STRING) 注解。

4.创建操作数据库的 Repository 接口

Spring Data JPA仓库（repositories）是用来定义访问数据的接口。根据你的方法名，JPA查询会被自动创建相应的SQL。
如findAll()方法就表示查询该表的所有数据

Spring Data仓库通常继承自Repository或CrudRepository接口。

在spring data中，已经有一个现成的JpaRepository了，它实现一组 JPA 规范相关的方法（增删改查和分页）

public interface JpaRepository<T, ID> extends PagingAndSortingRepository<T, ID>, QueryByExampleExecutor<T> {
    List<T> findAll();

    List<T> findAll(Sort var1);

    List<T> findAllById(Iterable<ID> var1);

    <S extends T> List<S> saveAll(Iterable<S> var1);

    void flush();

    <S extends T> S saveAndFlush(S var1);

    void deleteInBatch(Iterable<T> var1);

    void deleteAllInBatch();

    T getOne(ID var1);

    <S extends T> List<S> findAll(Example<S> var1);

    <S extends T> List<S> findAll(Example<S> var1, Sort var2);
}

有些童鞋可能还见过CrudRepository，其实JpaRepository也是继承了CrudRepository

可以看到JpaRepository继承自PagingAndSortingRepository和QueryByExampleExecutor，而PagingAndSortingRepository就是继承了CrudRepository

public interface PagingAndSortingRepository<T, ID> extends CrudRepository<T, ID> {
    Iterable<T> findAll(Sort var1);

    Page<T> findAll(Pageable var1);
}

总结一下：

JpaRepository继承自PagingAndSortingRepository，额外实现了一组 JPA 规范相关的方法

PagingAndSortingRepository继承了CrudRepository，额外实现了分页和排序的方法

CrudRepository继承了Repository，实现了CRUD的方法

例子：

注：JpaRepository的两个参数，第一个是JPA实体类，第二个是实体类的主键类型

@Repository
public interface UserRepository  extends JpaRepository<User, Long> {
    
    List<User> findAll();

    
    Optional<User> findById(Long aLong);
}

测试
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest
public class JpaTest {

    //	注入jpa的Repository
    @Autowired
    private UserRepository userRepository;

    @Test
    public void queryStudent() {
        List<User> all = userRepository.findAll();
        System.out.println(all);
    }
}

成功输出表中的数据

JPA常用方法

//查询所有用户
List findAll();

//保存用户，JPA更新数据也是用save方法
User save(User user);

JPA更新数据的方式：
先获取到需要更新的对象，进行修改，再调用save方法。
例：

    Optional<User> user = userRepository.findById(2L);
    User user1 = user.get();
    user1.setUserName("xxx");
    userRepository.save(user1);

//根据 id 查找用户
Optional findById(Long aLong);

//根据 id 删除用户
void deleteById(Long aLong);

JPA可以很灵活的用关键字来创建出我们需要的SQL，下面是一些JPA常用关键字和解释

JPA自定义SQL

对于比较复杂的查询，可能JPA自带的关键字已经无法满足你，这时候我们就需要自定义自己的SQL语句。使用@Query注解就可以自定义我们的SQL语句

@Query自定义语句的SQL参数使用 :参数 或者 ?n（n表示第几个参数）

例：

    @Query("select user_name from user where id = :id")
    String findPersonNameById(@Param("id") Long id);


    @Modifying
    @Query("update user  set user= ?1 where id = ?2")
    void updateUserNameById(String name, Long id);

自定义SQL实现分页操作

//@Query注解中需要添加countQuery 属性，用来返回总条数。自定义sql中使用的是实体类中字段的名称

    @Query(value = "select id,userName from User",
            countQuery= "select count(id) from User")
    Page<User> getUserPage(Pageable pageable);

//使用

		//创建PageRequest分页对象，of()方法第一个参数为page页数（从0页开始），第二个是size页面显示多少条数据
		PageRequest pageRequest = PageRequest.of(1, 3);

        Page<User> userPage = userRepository.getUserPage(pageRequest);
		//getContent获取数据
        List<User> content = userPage.getContent();
		//总条数
        System.out.println(userPage.getTotalElements());
		//总页数
        System.out.println(userPage.getTotalPages());