Spring Boot （三）： ORM 框架 JPA 与链接池 Hikari

前面两篇文章咱们介绍了如何快速建立一个 Spring Boot 工程《Spring Boot（一）：快速开始》和在 Spring Boot 中如何使用模版引擎 Thymeleaf 渲染一个Web页面《Spring Boot （二）：模版引擎 Thymeleaf 渲染 Web 页面》，本篇文章咱们继续介绍在 Spring Boot 中如何使用数据库。

1. 概述

数据库方面咱们选用 Mysql ， Spring Boot 提供了直接使用 JDBC 的方式链接数据库，毕竟使用 JDBC 并非很方便，须要咱们本身写更多的代码才能使用，通常而言在 Spring Boot 中咱们经常使用的 ORM 框架有 JPA 和 Mybaties ，本篇文章咱们要介绍的就是 JPA 的使用姿式。

说道使用 ORM 框架，就不得不顺便聊一下链接池，市面上不少成熟的数据库链接池，如 C3P0 、 Tomcat 链接池、 BoneCP 等等不少产品，可是咱们为何要介绍 Hikari ？这个要从 BoneCP 提及。

由于，传说中 BoneCP 在快速这个特色上作到了极致，官方数据是C3P0等的25倍左右。不相信？其实我也不怎么信。但是，有图有真相啊，传说图片来源于官网，然而笔者在官网并无找到，你们看一下：

看起来是否是彻底吊打，可是当 HikariCP 横空出世之后，这个局面就被彻底改写了， BoneCP 被 HikariCP 彻底吊打，看了一下 BoneCP Github 上面的版本更新，发如今2013年10月23日之后就再也没有更新过了，包括在仓库介绍上面都写着建议你们使用 HikariCP ，看来做者已经彻底心灰意冷了。

Hikari 这个词来源于日文，是“光”的意思，估计做者的意思是这个链接池将会和光同样快，不知道做者是否是日本人。

HikariCP 的口号是快速，简单，可靠。不知道是否真的如它本身宣传的同样，官方又提供了一张图，你们感觉一下，这张图来源于：https://github.com/brettwooldridge/HikariCP 。

更多有关 HikariCP 的信息，你们能够访问官方的 Github 仓库了解：https://github.com/brettwooldridge/HikariCP ，笔者这里很少作介绍，毕竟咱们更关注的如何使用。

2. JPA 介绍

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

值得注意的是，JPA 是在充分吸取了现有 Hibernate，TopLink，JDO 等 ORM 框架的基础上发展而来的，具备易于使用，伸缩性强等优势。从目前的开发社区的反应上看， JPA 受到了极大的支持和赞赏，其中就包括了 Spring 与 EJB3. 0的开发团队。

注意: JPA 是一套规范，不是一套产品，那么像 Hibernate,TopLink,JDO 他们是一套产品，若是说这些产品实现了这个 JPA 规范，那么咱们就能够叫他们为 JPA 的实现产品。

Spring Boot JPA 是 Spring 基于 ORM 框架、 JPA 规范的基础上封装的一套 JPA 应用框架，可以使开发者用极简的代码便可实现对数据的访问和操做。它提供了包括增删改查等在内的经常使用功能，且易于扩展！学习并使用 Spring Data JPA 能够极大提升开发效率！

Spring Boot JPA 让咱们解脱了 DAO 层的操做，基本上全部 CRUD 均可以依赖于它来实现。

Spring Boot JPA 帮咱们定义了不少自定义的简单查询，而且能够根据方法名来自动生成 SQL ，主要的语法是 findXXBy , readAXXBy , queryXXBy , countXXBy , getXXBy 后面跟属性名称：

public interface UserRepository extends JpaRepository<UserModel, Long> {
    UserModel getByIdIs(Long id);

    UserModel findByNickName(String nickName);

    int countByAge(int age);

    List<UserModel> findByNickNameLike(String nickName);
}复制代码

具体的关键字，使用方法和生产成SQL以下表所示：

Keyword	Sample	JPQL snippet
And	findByLastnameAndFirstname	… where x.lastname = ?1 and x.firstname = ?2
Or	findByLastnameOrFirstname	… where x.lastname = ?1 or x.firstname = ?2
Is,Equals	findByFirstname,findByFirstnameIs,findByFirstnameEquals	… where x.firstname = 1?
Between	findByStartDateBetween	… where x.startDate between 1? and ?2
LessThan	findByAgeLessThan	… where x.age < ?1
LessThanEqual	findByAgeLessThanEqual	… where x.age <= ?1
GreaterThan	findByAgeGreaterThan	… where x.age > ?1
GreaterThanEqual	findByAgeGreaterThanEqual	… where x.age >= ?1
After	findByStartDateAfter	… where x.startDate > ?1
Before	findByStartDateBefore	… where x.startDate < ?1
IsNull	findByAgeIsNull	… where x.age is null
IsNotNull,NotNull	findByAge(Is)NotNull	… where x.age not null
Like	findByFirstnameLike	… where x.firstname like ?1
NotLike	findByFirstnameNotLike	… where x.firstname not like ?1
StartingWith	findByFirstnameStartingWith	… where x.firstname like ?1 (parameter bound with appended %)
EndingWith	findByFirstnameEndingWith	… where x.firstname like ?1 (parameter bound with prepended %)
Containing	findByFirstnameContaining	… where x.firstname like ?1 (parameter bound wrapped in %)
OrderBy	findByAgeOrderByLastnameDesc	… where x.age = ?1 order by x.lastname desc
Not	findByLastnameNot	… where x.lastname <> ?1
In	findByAgeIn(Collection ages)	… where x.age in ?1
NotIn	findByAgeNotIn(Collection age)	… where x.age not in ?1
True	findByActiveTrue()	… where x.active = true
False	findByActiveFalse()	… where x.active = false
IgnoreCase	findByFirstnameIgnoreCase	… where UPPER(x.firstame) = UPPER(?1)

3. 工程实战

这里咱们建立工程 spring-boot-jpa-hikari 。

3.1 工程依赖 pom.xml

代码清单：spring-boot-jpa-hikari/pom.xml***

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.8.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.springboot</groupId>
    <artifactId>spring-boot-jpa-hikari</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>spring-boot-jpa-hikari</name>
    <description>spring-boot-jpa-hikari</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

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

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>复制代码

• mysql-connector-java：mysql链接驱动
• spring-boot-starter-data-jpa：jpa相关的依赖包，这个包里包含了不少内容，包括咱们使用的链接池 HikariCP ，从 Spring Boot 2.x 开始， Spring Boot 默认的链接池更换成为 HikariCP ，在当前的 Spring Boot 2.1.8 RELEASE 版本中，所使用的 HikariCP 版本为 3.2.0 ，如图：

3.2 配置文件 application.yml

代码清单：spring-boot-jpa-hikari/src/main/resources/application.yml***

server:
  port: 8080
spring:
  application:
    name: spring-boot-jpa-hikari
  jpa:
    database: mysql
    show-sql: true
    generate-ddl: true
    database-platform: org.hibernate.dialect.MySQL5InnoDBDialect
    hibernate:
      ddl-auto: update
  datasource:
    url: jdbc:mysql://192.168.0.128:3306/test?serverTimezone=Asia/Shanghai&useUnicode=true&characterEncoding=UTF-8&useSSL=false
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.zaxxer.hikari.HikariDataSource
    hikari:
      auto-commit: true
      minimum-idle: 2
      idle-timeout: 60000
      connection-timeout: 30000
      max-lifetime: 1800000
      pool-name: DatebookHikariCP
      maximum-pool-size: 5复制代码

注意：

1. 有关 JPA 的配置有一点须要的， spring.jpa.hibernate.ddl-auto ，这个属性需谨慎配置，它的几个值的含义对数据库来说都是高危操做，笔者这里方便起见配置了 update ，各位读者请根据具体使用场景配置。
   • create ：每次加载hibernate时都会删除上一次的生成的表，而后根据你的model类再从新来生成新表，哪怕两次没有任何改变也要这样执行，这就是致使数据库表数据丢失的一个重要缘由。
   • create-drop ：每次加载hibernate时根据model类生成表，可是sessionFactory一关闭,表就自动删除。
   • update ：最经常使用的属性，第一次加载hibernate时根据model类会自动创建起表的结构（前提是先创建好数据库），之后加载hibernate时根据 model类自动更新表结构，即便表结构改变了但表中的行仍然存在不会删除之前的行。要注意的是当部署到服务器后，表结构是不会被立刻创建起来的，是要等 应用第一次运行起来后才会。
   • validate ：每次加载hibernate时，验证建立数据库表结构，只会和数据库中的表进行比较，不会建立新表，可是会插入新值。
   • none ：不作任何操做
2. 有关 HikariCP 更多的配置能够参考源码类 com.zaxxer.hikari.HikariConfig ，笔者这里仅简单配置了自动提交、超时时间、最大最小链接数等配置。

3.3 映射实体类 UserModel.java

代码清单：spring-boot-jpa-hikari/src/main/java/com/springboot/springbootjpahikari/model/UserModel.java***

@Entity
@Data
@Table(name = "user")
public class UserModel {
    @Id
    @GeneratedValue(generator = "paymentableGenerator")
    @GenericGenerator(name = "paymentableGenerator", strategy = "uuid")
    @Column(name ="ID",nullable=false,length=36)
    private String id;
    @Column(nullable = true, unique = true)
    private String nickName;
    @Column(nullable = false)
    private int age;
}复制代码

• unique ： 惟一约束
• 主键生成策略为uuid

3.4 资源类 UserRepository.java

代码清单：spring-boot-jpa-hikari/src/main/java/com/springboot/springbootjpahikari/repository/UserRepository.java***

public interface UserRepository extends JpaRepository<UserModel, Long> {
    UserModel getByIdIs(Long id);

    UserModel findByNickName(String nickName);

    int countByAge(int age);

    List<UserModel> findByNickNameLike(String nickName);
}复制代码

3.5 接口测试类 UserController.java

代码清单：spring-boot-jpa-hikari/src/main/java/com/springboot/springbootjpahikari/controller/UserController.java***

@RestController
public class UserController {

    @Autowired
    UserRepository userRepository;

    /**
     * 查询用户列表
     * @return
     */
    @GetMapping("/user")
    public List<UserModel> user() {
        return userRepository.findAll(Sort.by("id").descending());
    }

    /**
     * 新增或更新用户信息
     * @param user
     * @return
     */
    @PostMapping("/user")
    public UserModel user(UserModel user) {
        return userRepository.save(user);
    }

    /**
     * 根据id删除用户
     * @param id
     * @return
     */
    @DeleteMapping("/user")
    public String deleteUserById(Long id) {
        userRepository.deleteById(id);
        return "success";
    }
}复制代码

4. 测试

测试咱们借助工具 PostMan ，启动工程，首先咱们新增一个用户信息，如图：

若是咱们参数中加入 id ，而且 id 的值和数据库中的 id 维持一致，这是会更新当前 id 的数据，如图：

咱们执行查询操做，如图：

执行删除操做，如图：

至此，测试完成。

5. 示例代码

示例代码-Github

示例代码-Gitee

6. 参考

https://github.com/brettwooldridge/HikariCP

https://docs.spring.io/spring-data/jpa/docs/current/reference/html/

http://www.ityouknow.com/springboot/2016/08/20/spring-boot-jpa.html