数据持久化

项目在运行过程中会产生很多业务数据，一般我们把数据保存起来的这个过程称为数据持久化。数据可以保存在内存、文件和数据库中，最普遍的方式是把数据保存到数据库中。

因为经常要把数据保存到数据库中，所以Spring抽象出了一套数据库访问框架——Spring Data JPA，它集成了多种数据访问技术，支持JDBC、MyBatis、Hibernate和JPA等数据持久化框架。

认识SpringDataJPA与ORM

在介绍Spring Data JPA之前需要先介绍下JPA（Java PersistenceAPI，Java持久化API），它是Sun公司在JDK 1.5发布后提出的Java持久化规范（JSR 338）。JPA规范定义了一系列的标准接口，让实体类和数据库的表之间建立了一个对应关系，当在代码中将数据保存到数据库中时，可以不写SQL就能操作数据库中的数据表。

JPA的实现思想即ORM（Object Relation Mapping，对象关系映射），用于在关系型数据库和实体对象之间建立一种映射关系。JPA规范是为了简化项目开发中的数据持久化以及整合不同的ORM技术。JPA是在现有的ORM框架基础上发展而来的，具有易于使用和伸缩性强的特点。

Spring Data JPA是基于Spring团队在JPA接口之上添加的一层抽象接口（Repository层的实现）所形成的ORM框架，它极大地降低了持久层开发及ORM框架切换的成本。Spring Data JPA底层是使用Hibernate的JPA技术实现的，它提供了包括增、删、改、查等常用的功能。在使用Spring Data JPA时不需要手写SQL语句，因为框架在底层已经自动生成了操作数据库的SQL，只需要在使用过程中遵守JPA的规范即可。

Spring Boot Validate参数校验

在接口开发的过程中，一个非常重要的原则就是不信任任何的输入，开发者根本不知道传递的是什么参数，因此需要对入参进行参数的校验，否则极有可能引发系统故障，或者造成业务数据的错误。

传统的if…else校验

以前，开发者经常在Controller中对参数进行if…else判断，如果参数不符合要求，就提示用户参数错误，流程不再进行下去，类似下面的代码：

package com.springboot.demo;

import org.springframework.web.bind.annotation.PostMapping;

import org.springframework.web.bind.annotation.RequestBody;

import org.springframework.web.bind.annotation.RestController;

@RestController

public class UserController1 {

/**

* 保存新的用户

* @param user

*/

@PostMapping("/save")

public void saveUser(@RequestBody User user) {

if (user.getAge() > 120) {

throw new IllegalArgumentException("最大年龄小于120");

}

if (user.getAge() < 1) {

throw new IllegalArgumentException("最小年龄大于1");

}

if (user.getUserName() == null) {

throw new IllegalArgumentException("用户名不能为空");

} if (user.getUserName().length() > 10) {

throw new IllegalArgumentException("用户名长度不能超过10");

}

if(user.getPassword()==null){

throw new IllegalArgumentException("密码不能为空");

}

//saveTheUser

}

}

以上代码中对应的User实体类的代码如下：

package com.springboot.demo;

import lombok.Data;

import javax.persistence.Column;

import javax.persistence.Entity;

import javax.persistence.GeneratedValue;

import javax.persistence.Id;

@Entity

@Data

public class User {

@Id

@GeneratedValue

private long id;

@Column(nullable = false, unique = true)

private String userName;

@Column(nullable = false)

private String password;

@Column(nullable = false)

private int age;

}

Controller中的if代码能够满足参数校验功能的需要，但是代码逻辑非常“丑陋”，没有一点优雅、复用性可言。Spring Boot中是怎么处理的呢？

实战：现代的Spring Boot Validate校验

在Spring Boot项目中，可以使用Spring Boot Validate进行参数的校验，开发人员只需要简单地标记注解就能完成参数的校验。下面演示SpringBoot的参数校验。

（1）在pom.xml中添加校验的依赖如下：

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-validation</artifactId>

</dependency>

（2）首先新建包com.springboot.demo，再新建一个类UserController2用于参数校验，执行新建用户的保存方法。

package com.springboot.demo;

import org.springframework.web.bind.annotation.*;

import javax.validation.Valid;

@RestController

public class UserController2 {

/**

* 保存新的用户

* @param user

*/

@PostMapping("/save")

public void saveUser(@Valid @RequestBody User user) {

//saveTheUser }

}

（3）在包com.springboot.demo中新建User实体类并在其中配置校验，代码如下：

package com.springboot.demo;

import lombok.Data;

import org.hibernate.validator.constraints.Length;

import javax.persistence.*;

import javax.validation.constraints.Max;

import javax.validation.constraints.Min;

import javax.validation.constraints.NotBlank;

@Entity

@Data

public class User {

@Id

@GeneratedValue

private long id;

@NotBlank

@Length(max = 10, message = "用户名长度不能超过10")

@Column(nullable = false, unique = true)

private String userName;

@NotBlank(message = "密码不能为空")

@Column(nullable = false)

private String password;

@Max(value = 120, message = "最大年龄小于120")

@Min(value = 1, message = "最小年龄大于1")

@Column(nullable = false)

private int age;

}

（4）在UserController2的方法中给要校验的参数标记上@Valid注解，再使用如@Not- Blank、@Min和@Max注解并且加上提示信息就能完成参数的校验。

（5）为了系统的完整性，在Spring Boot项目中增加系统异常的处理，需要给用户返回统一的结果并在结果中提示入参的具体错误。在包com.springboot.demo中新建ValidateCommonHandler异常处理类，代码如下：

package com.springboot.demo;

import org.springframework.http.*;

import org.springframework.validation.FieldError;

import org.springframework.web.bind.MethodArgumentNotValidException;

import org.springframework.web.context.request.WebRequest;

import org.springframework.web.servlet.mvc.method.annotation.Response

EntityExceptionHandler;

public class ValidateCommonHandler extends

ResponseEntityExceptionHandler {

@Override

protected ResponseEntity<Object> handleMethodArgumentNotValid(

MethodArgumentNotValidException ex,

HttpHeaders headers, HttpStatus status,

WebRequest request) {

ResponeVo vo = new ResponeVo();

vo.setCode(500);

for (FieldError fieldError :

ex.getBindingResult().getFieldErrors()) {

String defaultMessage = fieldError.getDefaultMessage();

vo.setMessage(defaultMessage);

Object value = fieldError.getRejectedValue();

vo.setData(value);

break;

}

return new ResponseEntity(vo, HttpStatus.OK); }

}

新建一个ValidateCommonHandler类继承自
ResponseEntityExceptionHandler接口，并且重写该接口的
handleMethodArgumentNotValid()方法，
ResponseEntityExceptionHandler是统一处理所有经过Valid注解的接口，此处统一返回类ResponeVo的信息，用这个类和前端进行Restful交互，只要出现校验命中的就会执行此方法，并且携带具体的错误信息。

（6）在包com.springboot.demo中新建统一返回实体信息类ResponeVo：

package com.springboot.demo;

import lombok.Data;

@Data

public class ResponeVo {

private int code;

private String message;

private Object data;

}

上述代码中，code返回一个标识码，message字段用于返回校验的信息，data返回具体的数据。

Validate校验常用的注解

Spring Boot Validate的参数校验依赖于注解，可以对不同类型的参数配置相应的注解校验，常用的注解如表3.1所示。

表3.1 Validate注解

实战：使用Spring Data JPA保存数据

前面介绍了Spring Boot Validate的参数校验，现在演示在SpringBoot项目中如何使用Spring Data JPA保存数据，详细步骤如下：

（1）在pom.xml中添加Spring Data JPA依赖和MySQL的驱动依赖：

<dependencies>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-web</artifactId>

</dependency>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-test</artifactId>

</dependency>

<dependency>

<groupId>mysql</groupId>

<artifactId>mysql-connector-java</artifactId>

</dependency>

<dependency>

<groupId>org.springframework.boot</groupId>

<artifactId>spring-boot-starter-data-jpa</artifactId>

</dependency>

<dependency>

<groupId>org.projectlombok</groupId>

<artifactId>lombok</artifactId>

</dependency>

</dependencies>

（2）在application.properties中添加项目的配置文件，包括MySQL的链接、用户名、密码、驱动类及Spring JPA的配置：

spring.datasource.url=jdbc:mysql://localhost:3306/test?

useUnicode=true&

characterEncoding=utf-8&serverTimezone=UTC&useSSL=true

spring.datasource.username=root

spring.datasource.password=q123456.

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

spring.jpa.properties.hibernate.hbm2ddl.auto=update

spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5In

n

oDBDialect

spring.jpa.show-sql=true

（3）在包com.springboot.demo中添加User的实体类：

package com.springboot.demo;

import lombok.Data;

import javax.persistence.*;

@Entity

@Data

public class User {

@Id

@GeneratedValue

private long id;

@Column(nullable = false, unique = true)

private String userName;

@Column(nullable = false)

private String password;

@Column(nullable = false)

private int age;

}

（4）在包com.springboot.demo中添加数据库的操作Dao接口代码如下：

package com.springboot.demo;

import org.springframework.data.jpa.repository.JpaRepository;

public interface UserRepository extends JpaRepository<User, Long> {

//根据名字查询用户

User findByUserName(String userName);

}

（5）在包com.springboot.demo中新增Spring Boot的启动类代码如下：

package com.springboot.demo;

import org.springframework.boot.SpringApplication;

import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication

public class App {

public static void main(String[] args) {

SpringApplication.run(App.class,args);

}

}

（6）在包com.springboot.demo中增加使用Spring Data JPA操作数据库的测试类代码如下：

package com.springboot.demo;

import lombok.extern.slf4j.Slf4j;

import org.junit.Assert;

import org.junit.Test;

import org.junit.runner.RunWith;

import org.springframework.beans.factory.annotation.Autowired;

import org.springframework.boot.test.context.SpringBootTest;

importorg.springframework.test.context.junit4.SpringJUnit4ClassRunner;

import java.util.Optional;

@Slf4j

@RunWith(SpringJUnit4ClassRunner.class)

@SpringBootTest(classes = App.class)

public class UserTest {

@Autowired

private UserRepository userRepository;

@Test

public void userTest() {

User user = new User();

user.setUserName("myCc");

user.setAge(18);

user.setPassword("123");

//保存用户

userRepository.save(user);

//根据名字查询用户

User item = userRepository.findByUserName("myCc");

System.out.println(item);

Assert.assertNotNull(item);

//ID为1的用户是否存在

Assert.assertEquals(true, userRepository.existsById(1L));

//根据ID查询用户

Optional<User> byId = userRepository.findById(1L);

Assert.assertEquals(true, byId.isPresent());

Assert.assertEquals(true,

userRepository.findById(2L).isPresent());

//删除ID为1的用户

userRepository.deleteById(1L);

//判断ID为1的用户是否存在

Assert.assertEquals(false, userRepository.existsById(1L));

}

}

至此，项目代码的书写工作就完成了，当前整个项目的结构如图3.1所示。

运行UserTest测试类执行全部的测试用例，完成后使用客户端连接数据库查看user表中的数据，如图3.2所示，程序已经成功地把数据插入数据库中。

JPA与SQL语法

Spring Data JPA会根据方法名字自动解析方法名后拼接成SQL语句，然后设置参数，最后再执行SQL语句，完成数据库的操作。

前面的UserRepository接口继承自JpaRepository，该接口中自定义了方法findByUserName()。同理，还可以在UserRepository接口中定义以下方法：

Long deleteById(Long id);

List<User> findByUserNameOrEmail(String username, String email);

List<User> findByUserNameIgnoreCase(String userName);

Long countByUserName(String userName);

List<User> findByEmailLike(String email);

List<User> findByUserNameOrderByEmailDesc(String email);

在Spring Data JPA中，根据方法名字生成对应的SQL语句的规则如表3.2所示，在接口中自定义的方法会根据关键字生成SQL语句，从而在开发中不需要手写SQL语句。

表3.2 Spring Data JPA的SQL语句生成规则

Spring Data JPA也支持手写SQL语句。例如，在UserRepository中添加一个根据ID查询User的方法，然后在@Query注解中完成对自定义SQL语句的编写和参数设置，注意Spring Data JPA的参数是从1开始，取第一个参数即为?1，代码如下：

/**

* 根据ID查询用户

*/

@Query("select * from user where id=?1")

User queryById(Long id);

在@Query注解中完成对SQL执行语句和参数的设置，然后调用queryById方法完成查询功能。在项目开发中使用Spring Data JPA这种ORM的框架能够极大地提高开发效率，它使用面向对象的方式直接对数据库进行操作，不用每一个操作都写SQL语句，只有遇到复杂的查询需求时，才手写SQL语句完成CRUD。

说明：CRUD一般对应数据库常见的增、查、改、删操作。