【Spring Boot 3】【数据源】自定义JPA多数据源

背景

软件开发是一门实践性科学，对大多数人来说，学习一种新技术不是一开始就去深究其原理，而是先从做出一个可工作的DEMO入手。但在我个人学习和工作经历中，每次学习新技术总是要花费或多或少的时间、检索不止一篇资料才能得出一个可工作的DEMO，这占用了我大量的时间精力。因此本文旨在通过一篇文章即能还原出可工作的、甚至可用于生产的DEMO，期望初学者能尽快地迈过0到1的这一步骤，并在此基础上不断深化对相关知识的理解。
为达以上目的，本文会将开发环境、工程目录结构、开发步骤及源码尽量全面地展现出来，文字描述能简则简，能用代码注释的绝不在正文中再啰嗦一遍，正文仅对必要且关键的信息做重点描述。

介绍

《【Spring Boot 3】【数据源】自定义JDBC多数据源》 说明了开发Spring Boot JDBC应用时如何自定义多数据源，但在实际开发工作中，很少再使用JDBC直接进行数据库操作，取而代之的是各种ORM框架。本文介绍使用Spring Data JPA时如何自定义多数据源。

本文也基于 《【Spring Boot 3】【数据源】自定义JPA数据源》。

开发环境

分类	名称	版本
操作系统	Windows	Windows 11
JDK	Oracle JDK	21.0.1
IDE	IntelliJ IDEA	2023.2.4
构建工具	Apache Maven	3.9.3
数据库	MySQL	8.0.33

开发步骤及源码

1> 准备2个数据源（创建2个数据库）。

• 数据源一

-- 创建第一个数据源
CREATE SCHEMA IF NOT EXISTS `db1` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;

-- 创建第一个数据源中的数据表
CREATE TABLE IF NOT EXISTS `db1`.`product`
(
    `id`    BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `name`  VARCHAR(100)    NOT NULL COMMENT '产品名称',
    `price` DECIMAL         NOT NULL COMMENT '产品价格',
    PRIMARY KEY (`id`),
    UNIQUE INDEX `id_UNIQUE` (`id` ASC) VISIBLE
)
    ENGINE = InnoDB
    DEFAULT CHARACTER SET = utf8mb4
    COLLATE = utf8mb4_bin;

-- 创建用户
DROP USER IF EXISTS 'userA'@'%';
CREATE USER 'userA'@'%' IDENTIFIED BY '123123';

-- 给用户赋予访问第一个数据源的权限
GRANT ALL PRIVILEGES ON db1.* TO 'userA'@'%';

• 数据源二

-- 创建第二个数据源
CREATE SCHEMA IF NOT EXISTS `db2` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;

-- 创建第二个数据源中的数据表
CREATE TABLE IF NOT EXISTS `db2`.`customer`
(
    `id`   BIGINT UNSIGNED NOT NULL AUTO_INCREMENT COMMENT '自增主键',
    `name` VARCHAR(100)    NOT NULL COMMENT '顾客名称',
    `age`  INT             NOT NULL COMMENT '年龄',
    PRIMARY KEY (`id`),
    UNIQUE INDEX `id_UNIQUE` (`id` ASC) VISIBLE
)
    ENGINE = InnoDB
    DEFAULT CHARACTER SET = utf8mb4
    COLLATE = utf8mb4_bin;

-- 创建用户
DROP USER IF EXISTS 'userB'@'%';
CREATE USER 'userB'@'%' IDENTIFIED BY '456456';

-- 给用户赋予访问第二个数据源的权限
GRANT ALL PRIVILEGES ON db2.* TO 'userB'@'%';

2> 创建Maven工程，添加依赖。

<?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>com.jiyongliang</groupId>
        <artifactId>springboot3-datasource</artifactId>
        <version>0.0.1</version>
    </parent>
    <artifactId>springboot3-datasource-jpa-multi</artifactId>

    <properties>
        <java.version>21</java.version>
        <maven.compiler.source>21</maven.compiler.source>
        <maven.compiler.target>21</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <spring-boot.version>3.2.2</spring-boot.version>
        <mysql-connector-j.version>8.3.0</mysql-connector-j.version>
        <lombok.version>1.18.30</lombok.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies