Spring Boot+Spring DataJPA如何实现数据库首次创建时自动初始化数据

以下方案完全满足要求：不使用外部SQL文件、已有数据库绝对不会触发数据写入逻辑、初始化时机在JPA自动建表完成后。 #

1. 基础配置 #

首先配置数据源和JPA参数，实现不存在库时自动建库、自动根据实体类建表：

spring:
  datasource:
    # MySQL示例，最后createDatabaseIfNotExist=true参数实现连接时自动创建不存在的库
    url: jdbc:mysql://127.0.0.1:3306/your_biz_db?useUnicode=true&characterEncoding=utf8&serverTimezone=Asia/Shanghai&createDatabaseIfNotExist=true&useSSL=false
    username: your_db_username
    password: your_db_password
    driver-class-name: com.mysql.cj.jdbc.Driver
  jpa:
    hibernate:
      # 用update不要用create/create-drop，避免已有库的表和数据被删除
      ddl-auto: update
    show-sql: true
    # 推迟JPA初始化，保证建表流程在业务逻辑执行前全部完成
    defer-datasource-initialization: true

如果用其他数据库，把JDBC URL替换成对应格式即可，只要保证驱动支持自动创建不存在的库就行。 #

2. 核心初始化逻辑实现 #

用Spring自带的ApplicationRunner实现启动后执行逻辑，这个组件的执行时机是Spring容器完全启动、所有Bean初始化完成、JPA表结构同步全部结束后，不会出现表还没建好就插数据的问题。

2.1 通用方案（兼容所有数据库，100%不重复写入） #

这个方案通过判断初始标记数据是否存在来决定是否执行初始化，只要库已经存在且跑过一次初始化，后续启动绝对不会触发写入逻辑，兼容性最好：
首先在你的Repository层加个简单的统计方法，以UserRepository为例：

public interface UserRepository extends JpaRepository<User, Long> {
    // 统计指定ID的用户数量，用来判断初始化是否已经执行过
    Long countById(Long id);
}

然后编写初始化类：

import org.springframework.boot.ApplicationArguments;
import org.springframework.boot.ApplicationRunner;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.stereotype.Component;
import java.util.List;

@Component
public class BizDataInitializer implements ApplicationRunner {

    private final UserRepository userRepository;
    private final JdbcTemplate jdbcTemplate;

    // 构造注入，Spring 4.3+单构造器不需要额外加@Autowired注解
    public BizDataInitializer(UserRepository userRepository, JdbcTemplate jdbcTemplate) {
        this.userRepository = userRepository;
        this.jdbcTemplate = jdbcTemplate;
    }

    @Override
    public void run(ApplicationArguments args) {
        boolean hasInitialized = checkIsInitialized();
        if (hasInitialized) {
            return;
        }

        // 以下是Java编码初始化逻辑，和参考实现逻辑完全一致
        User initAdmin = new User();
        initAdmin.setId(1L);
        initAdmin.setUsername("admin");
        initAdmin.setPassword("init_pass_123");
        // 补全其他实体属性赋值
        userRepository.save(initAdmin);

        // 后续其他表的初始数据写入直接往下追加即可，不需要写SQL
    }

    /**
     * 检查是否已经完成初始化，只要判断为已初始化就直接跳过所有写入操作
     */
    private boolean checkIsInitialized() {
        try {
            // 第一步先判断核心业务表是否存在，避免新库没建表时查询报错
            List<String> existedTables = jdbcTemplate.queryForList(
                    "SELECT TABLE_NAME FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = 'user' AND TABLE_SCHEMA = DATABASE()",
                    String.class
            );
            if (existedTables.isEmpty()) {
                return false;
            }
            // 表存在的情况下，检查固定ID的初始用户是否存在，存在说明已经初始化过
            return userRepository.countById(1L) > 0;
        } catch (Exception e) {
            // 任何查询异常都直接判定为已初始化，避免方言、权限问题导致误写入已有库
            return true;
        }
    }
}

2.2 严格匹配规则方案（仅本次启动新建的库才执行初始化） #

如果要严格实现「只要database已经存在，不管里面有没有数据都不触发初始化」的规则，针对MySQL可以直接判断数据库的创建时间，把上面的checkIsInitialized方法替换成下面的实现即可：

private boolean checkIsInitialized() {
    try {
        // 查询当前连接的数据库的创建时间
        java.sql.Timestamp dbCreateTime = jdbcTemplate.queryForObject(
                "SELECT CREATE_TIME FROM INFORMATION_SCHEMA.SCHEMATA WHERE SCHEMA_NAME = DATABASE()",
                java.sql.Timestamp.class
        );
        if (dbCreateTime == null) {
            return true;
        }
        // 如果数据库创建时间距离当前启动时间超过10秒，说明是之前就存在的库，直接跳过
        long diffSecond = (System.currentTimeMillis() - dbCreateTime.getTime()) / 1000;
        return diffSecond > 10;
    } catch (Exception e) {
        return true;
    }
}

这个逻辑的判定边界非常清晰：只有本次应用启动时由JDBC驱动新创建的库，才会执行后续的数据初始化方法，只要库是启动前就存在的，绝对不会执行任何写入操作。 #

方案说明 #

• 全程没有使用任何外部SQL初始化文件，所有初始数据写入都是Java编码调用Repository方法实现，完全符合要求
• 所有判断逻辑在数据写入前执行，异常分支默认判定为已初始化，不会出现误写已有库的问题
• 初始化时机在JPA表结构同步完成之后，不会出现表不存在的插入报错

内容的提问来源于stack exchange，提问作者kensuke1984