Spring Boot数据访问——整合Spring Data JPA篇！超详细！

fortitude_️

2689人浏览 · 2025-04-17 23:02:40

fortitude_️ · 2025-04-17 23:02:40 发布

前言：

Spring Data JPA 提供了很多模板代码，易于扩展，可以大幅提高开发效率，使开发者用极简的代码即可实现对数据的访问。基于SpringDataJPA的规范可以提升数据访问层的开发效率和灵活性，开发人员在使用 Spring Data JPA 时，应基于 Spring Data JPA 的规范同时也需要遵守团队的代码规范和风格，保证代码清晰易读，从而开发高质量的程序。
使用Spring Data JPA 可以通过 Repository接口中的方法对数据库中的数据进行增删改查也可以根据方法命名规则定义的方法、Java持久化查询语言(Java Persistence Query Language，JPOL)，以及原生 SQL进行操作。

1、项目目录

2、环境配置

JDK：17

IDEA：2024.3.3

Spring Boot：3.4.3

一、创建项目

在IDEA中创建Spring Boot项目chapter05，可以根据自己当前情况选择使用 Spring Initializr 方式或者Maven方式进行创建，这里使用 Maven方式创建项目。

二、配置依赖

在项目 chapter05 的pom.xml 文件中配置Spring Boot 整合 Spring Data JPA的依赖,包括Spring Boot 父工程的依赖、MySQL驱动依赖和 Spring Data JPA的启动器依赖，具体内容如文件1-1所示。

文件1-1丨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>3.4.3</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>org.example</groupId>
    <artifactId>chapter05-SDJPA</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>chapter05</name>
    <description>chapter05</description>
    <url/>
    <licenses>
        <license/>
    </licenses>
    <developers>
        <developer/>
    </developers>
    <scm>
        <connection/>
        <developerConnection/>
        <tag/>
        <url/>
    </scm>
    <properties>
        <java.version>17</java.version>
    </properties>

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

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.33</version>
        </dependency>

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

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

        <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>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

三、设置配置信息

在项目的resources目录下创建application.yml文件，在该文件中指定数据库连接信息和JPA的配置信息，具体如文件 1-2所示。

文件1-2丨application.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/springbootdata（数据库名）?characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: XXXXX   #用户名
    password: XXXXX   #数据库连接密码
  jpa:
    show-sql: true

！注：上述代码中，数据库名(eg:springbootdata)、用户名、数据库连接密码等，大家根据自己的实际情况进行填写。

四、创建实体类

通过JPA可以简单高效地管理Java实体类和关系数据库的映射，通常每个实体类与数据库中的单个关系表相关联，每个实体的实例表示数据库表格中的某一行记录。在项目的java目录下创建包entity(org.example.chapter05.entity)，并在该包下创建实体类Book，具体如文件1-3所示。

文件1-3丨Book.java

package org.example.chapter05.entity;

import jakarta.persistence.*;

@Entity
@Table(name="book")
public class Book {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Integer id;        //图书编号

    @Column(length = 32)
    private String name;

    @Column(length = 32)
    private String author;

    @Column(length = 32)
    private String press;

    @Column(length = 1)
    private String status;

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPress() {
        return press;
    }

    public void setPress(String press) {
        this.press = press;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }

    public Book() {
    }

    public Book(Integer id, String name, String author, String press, String status) {
        this.id = id;
        this.name = name;
        this.author = author;
        this.press = press;
        this.status = status;
    }

    @Override
    public String toString() {
        return "Book{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", author='" + author + '\'' +
                ", press='" + press + '\'' +
                ", status='" + status + '\'' +
                '}';
    }
}

在上述代码中，第2行代码使用@Entity 注解表示定义该类为一个实体类；第3行代码使用@Table注解指定当前实体类对应的数据表名称，建立实体类和数据表的映射关系；第5行代码使用@Id 注解声明当前属性对应数据表的主键；第6行代码通过@GeneratedValue(strategy=Generatio nType.IDENTITY)指定主键的生成策略为数据库自动生成。

五、自定义Repository接口

在java目录下创建包dao(org.example.chapter05.dao),在该包下自定义接口BookRepositor继承JpaRepository接口，并在BookRepository接口中添加操作数据库中图书信息的方法具体如文件 1-4 所示。

文件1-4丨BookRepository.java

import org.example.chapter05.entity.Book;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.Modifying;
import org.springframework.data.jpa.repository.Query;
import org.springframework.data.repository.query.Param;
import org.springframework.stereotype.Repository;
import org.springframework.transaction.annotation.Transactional;

@Repository
public interface BookRepository extends JpaRepository<Book, Integer> {
    Book findByAuthorAndStatus(String author, String status);
    @Modifying
    @Transactional
    @Query("delete from Book b where b.id = :id")
    void deleteBookById(@Param("id") Integer id);
}

六、创建数据库

至此，实体类和操作实体的接口都已经定义好，因为没有在JPA的配置信息中设置项目启动时根据实体类自动创建数据表，此时测试对图书信息的操作需要先创建对应的数据库和数据表，并插人对应的测试数据，相关SQL如文件1-5所示。

文件1-5丨book.sql

-- 创建数据库
CREATE DATABASE springbootdata;

-- 使用数据库
USE springbootdata;

-- 创建表
CREATE TABLE book (
  id INT NOT NULL AUTO_INCREMENT,
  name VARCHAR(32),
  author VARCHAR(32),
  press VARCHAR(32),
  status VARCHAR(1),
  PRIMARY KEY (id) USING BTREE
);

-- 插入数据
INSERT INTO book VALUES (1, '楚辞', '屈原', '中国文联出版社', '0');
INSERT INTO book VALUES (2, '纳兰词', '纳兰性德', '中国文联出版社', '1');
INSERT INTO book VALUES (3, '西游记', '吴承恩', '中国文联出版社', '2');

运行结果如图1-2所示：

七、创建项目启动类和测试类

src\main\java目录的org.example.chapter05包下的启动类Chapter05Application,具体如文件 1-6 所示。

文件1-6丨Chapter05Application.java

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Chapter05Application {

    public static void main(String[] args) {
        SpringApplication.run(Chapter05Application.class, args);
    }

}

在 src\test\java目录下的Chapter05ApplicationTests测试类中定义操作图书信息的测试方法，具体如文件1-7所示。

文件1-7丨Chapter05ApplicationTests.java

import org.example.chapter05.dao.BookRepository;
import org.example.chapter05.entity.Book;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
import java.util.Optional;

@SpringBootTest
class Chapter05ApplicationTests {
    @Autowired
    private BookRepository bookRepository;
    private  void booksInfo(){
        List<Book> books = bookRepository.findAll();
        for (Book book : books) {
            System.out.println(book);
        }
    }
    //增
    @Test
    void saveBook() {
        Book book=new Book(null,"离骚","屈原","清华大学出版社","1");
        //新增图书
        bookRepository.save(book);
        booksInfo();
    }
    //改
    @Test
    void editBook() {
        Optional<Book> op = bookRepository.findById(1);
        Book book = op.get();
        book.setName("天问");
        //修改图书
        bookRepository.save(book);
        booksInfo();
    }
    //查
    @Test
    void findBook() {
        //根据图书作者和图书状态查找对应的图书
        Book b = bookRepository.findByAuthorAndStatus("屈原", "1");
        System.out.println(b);
    }
    //删
    @Test
    void delBook() {
        bookRepository.deleteBookById(1);
        booksInfo();
    }
}

上述代码中，saveBook()方法用于测试新增图书信息，editBook()方法用于测试修改图书信息，findBook()方法用于根据图书作者和图书状态查找对应的图书，delBook()方法用于根据图书编号删除对应的图书信息。