SpringBoot 实战 (八) | 使用 Spring Data JPA 访问 Mysql 数据库

红太狼 2022-03-08 14:06 156阅读 0赞

> 微信公众号：一个优秀的废人  
> 如有问题或建议，请后台留言，我会尽力解决你的问题。

#### 前言 ####

如题，今天介绍 Spring Data JPA 的使用。

#### 什么是 Spring Data JPA ####

在介绍 Spring Data JPA 之前，首先介绍 Hibernate 。 Hibernate 使用 O/R 映射 （Object-Relation Mapping） 技术实现数据访问， O/R 映射即将领域模型类与数据库的表进行映射，通过程序操作对象而实现表数据操作的能力，让数据访问操作无需关注数据库相关技术。

Hibernate 主导了 EJB 3.0 的 JPA 规范， JPA 即 Java Persistence API。JPA 是一个基于 O/R 映射的标准协议（目前最新版本是 JPA 2.1）。所谓规范即只定义标准规制（如注解、接口），不提供实现，软件提供商可以按照标准规范来实现，而使用者只需按照规范中定义的方式来使用，而不用和软件提供商的实现打交道。JPA 的主要实现由 Hibernate 、 EclipseLink 和 OpenJPA 等完成，我们只要使用 JPA 来开发，无论是哪一个开发方式都是一样的。

Spring Data JPA 是 Spring Data 的一个子项目，它通过基于 JPA 的 Repository 极大地减少了 JPA 作为数据访问方案的代码量。

**简而言之，JPA 是一种 ORM 规范，但并未提供 ORM 实现，而 Hibernate 是一个 ORM 框架，它提供了 ORM 实现。**

#### 准备工作 ####

*  IDEA
 *  JDK1.8
 *  SpringBoot 2.1.3

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 http://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.3.RELEASE</version>
 <relativePath/> 
 </parent>
 <groupId>com.nasus</groupId>
 <artifactId>jpa</artifactId>
 <version>0.0.1-SNAPSHOT</version>
 <name>jpa</name>
 <description>jpa Demo project for Spring Boot</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>

简单说下，加入 JPA 依赖；mysql 连接类用于连接数据；web 启动类，但凡是 web 应用都需要依赖它；lombok 用于简化实体类。不会的看这篇旧文介绍：[SpringBoot 实战 (三) | 使用 LomBok][SpringBoot _ _ _ _ LomBok]

#### application.yaml 配置文件 ####

spring:
    # 数据库相关
      datasource:
        driver-class-name: com.mysql.jdbc.Driver
        url: jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC&useSSL=true
        username: root
        password: 123456
    # JPA 相关
      jpa:
        hibernate:
          ddl-auto: update   #ddl-auto:设为 create 表示每次都重新建表
        show-sql: true

#### repository (dao) 层 ####

package com.nasus.jpa.repository;
 
 import com.nasus.jpa.entity.Student;
 import org.springframework.data.jpa.repository.JpaRepository;
 import org.springframework.data.repository.CrudRepository;
 import org.springframework.stereotype.Repository;
 
 /**
 * Project Name:springboot_jpa_demo 
 * Package Name:com.nasus.jpa.repository 
 * Date:2019/2/19 21:37 
 * Description: TODO: 描述该类的作用 
 * @author <a href="turodog@foxmail.com">nasus</a> 
 */
 @Repository
 public interface StudentRepository extends JpaRepository<Student,Integer>, CrudRepository<Student, Integer> {
 }

![JPARepository 继承关系][JPARepository]

从上图，可以看出 JpaRepository 继承于 PangingAndSortingRepository 继承于 CrudRepository 。

CrudRepository 提供基本的增删改查PagingAndSortingRepository 提供分页和排序方法；JpaRepository 提供 JPA 需要的方法。在使用的时候，可以根据具体需要选中继承哪个接口。

使用这些接口的好处有：

1.  继承这些接口，可以使Spring找到自定义的数据库操作接口，并生成代理类，后续可以注入到Spring容器中；
2.  可以不写相关的sql操作，由代理类生成

#### service 层 ####

package com.nasus.jpa.service;
 
 import com.nasus.jpa.entity.Student;
 import java.util.List;
 
 /**
 * Project Name:springboot_jpa_demo 
 * Package Name:com.nasus.jpa.service 
 * Date:2019/2/19 21:41 
 * Description: TODO: 描述该类的作用 
 * @author <a href="turodog@foxmail.com">nasus</a> 
 */
 public interface StudentService {
 
 Student save(Student student);
 
 Student findStudentById(Integer id);
 
 void delete(Integer id);
 
 void updateStudent(Student student);
 
 List<Student> findStudentList();
 }

实现类：

package com.nasus.jpa.service.impl;
 
 import com.nasus.jpa.entity.Student;
 import com.nasus.jpa.repository.StudentRepository;
 import com.nasus.jpa.service.StudentService;
 import java.util.List;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
 
 /**
 * Project Name:springboot_jpa_demo 
 * Package Name:com.nasus.jpa.service.impl 
 * Date:2019/2/19 21:43 
 * Description: TODO: 描述该类的作用 
 * @author <a href="turodog@foxmail.com">nasus</a> 
 */
 @Service
 public class StudentServiceImpl implements StudentService {
 
 @Autowired
 private StudentRepository studentRepository;
 
 /**
 * 保存学生信息
 * @param student
 * @return
 */
 @Override
 public Student save(Student student) {
 return studentRepository.save(student);
 }
 
 /**
 * 根据 Id 查询学生信息
 * @param id
 * @return
 */
 @Override
 public Student findStudentById(Integer id) {
 return studentRepository.findById(id).get();
 }
 
 /**
 * 删除学生信息
 * @param id
 */
 @Override
 public void delete(Integer id) {
 Student student = this.findStudentById(id);
 studentRepository.delete(student);
 }
 
 /**
 * 更新学生信息
 * @param student
 */
 @Override
 public void updateStudent(Student student) {
 studentRepository.save(student);
 }
 
 /**
 * 查询学生信息列表
 * @return
 */
 @Override
 public List<Student> findStudentList() {
 return studentRepository.findAll();
 }
 }

#### controller 层构建 restful API ####

package com.nasus.jpa.controller;
 
 import com.nasus.jpa.entity.Student;
 import com.nasus.jpa.service.StudentService;
 import java.util.List;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.PutMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
 /**
 * Project Name:springboot_jpa_demo 
 * Package Name:com.nasus.jpa.controller 
 * Date:2019/2/19 21:55 
 * Description: TODO: 描述该类的作用 
 * @author <a href="turodog@foxmail.com">nasus</a> 
 */
 @RestController
 @RequestMapping("/student")
 public class StudentController {
 
 @Autowired
 private StudentService studentService;
 
 @PostMapping("/save")
 public Student saveStudent(@RequestBody Student student){
 return studentService.save(student);
 }
 
 @GetMapping("/{id}")
 public Student findStudentById(@PathVariable("id") Integer id){
 return studentService.findStudentById(id);
 }
 
 @GetMapping("/list")
 public List<Student> findStudentList(){
 return studentService.findStudentList();
 }
 
 @DeleteMapping("/{id}")
 public void deleteStudentById(@PathVariable("id") Integer id){
 studentService.delete(id);
 }
 
 @PutMapping("/update")
 public void updateStudent(@RequestBody Student student){
 studentService.updateStudent(student);
 }
 }

#### 测试结果 ####

![根据 Id 查询学生信息的测试结果][Id]

其他接口已通过 postman 测试，无问题。

源码下载：[https://github.com/turoDog/De...][https_github.com_turoDog_De...]

#### 后语 ####

以上为 SpringBoot 使用 Spring Data JPA 访问 Mysql 数据库的教程。最后，对 Python 、Java 感兴趣请长按二维码关注一波，我会努力带给你们价值，如果觉得本文对你哪怕有一丁点帮助，请帮忙点好看，让更多人知道。

另外，关注之后在发送 **1024** 可领取免费学习资料。资料内容详情请看这篇旧文：[Python、C++、Java、Linux、Go、前端、算法资料分享][Python_C_Java_Linux_Go]

![一个优秀的废人][1240]

[SpringBoot _ _ _ _ LomBok]: https://www.jianshu.com/p/d8b206ec1f7d
[JPARepository]: /images/20220308/e9229a2be6414f918a1279ea5e080a0c.png
[Id]: /images/20220308/5bbc5273af3e44569f82bab644e13116.png
[https_github.com_turoDog_De...]: https://github.com/turoDog/Demo/tree/master/springboot_jpa_demo
[Python_C_Java_Linux_Go]: https://www.jianshu.com/p/ed43dc8aa11e
[1240]: /images/20220308/4090a4464e2a42039190e31d2584f8f8.png