Spring Boot H2数据库初始化与数据填充技巧

本文详细介绍了如何在Spring Boot应用中，通过合理配置H2内存数据库的初始化属性、JPA DDL策略以及自定义SQL脚本，实现数据库结构的自动创建和初始数据的填充。核心在于协调`application.properties`中的`defer-datasource-initialization`、`sql.init.mode`和`jpa.hibernate.ddl-auto`等关键参数，并确保实体定义与SQL脚本之间命名的一致性，从而避免常见的表找不到或数据插入失败等问题。

在开发和测试阶段，使用H2内存数据库配合Spring Boot进行数据库的自动初始化和数据填充是常见的实践。它能够确保每次应用启动时都拥有一个干净且预填充好数据的环境。然而，要正确地实现这一过程，需要对Spring Boot的数据源初始化机制、JPA的DDL生成策略以及SQL脚本的执行时机有清晰的理解。本文将提供一套经过验证的配置方案，帮助开发者高效地完成H2内存数据库的自动初始化。

核心配置解析

要使Spring Boot自动执行位于src/main/resources目录下的schema.sql（用于创建表结构）和data.sql（用于填充初始数据）文件，并与JPA实体映射协同工作，我们需要在application.properties中进行一系列关键配置。

# H2 控制台配置，方便调试
spring.h2.console.enabled=true

# H2 内存数据库URL，DB_CLOSE_DELAY=-1 确保数据库在JVM关闭前一直存在
spring.datasource.url=jdbc:h2:mem:testdb;DB_CLOSE_DELAY=-1
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driverClassName=org.h2.Driver

# JPA/Hibernate 配置
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.H2Dialect
spring.jpa.generate-ddl=true
# 将ddl-auto设置为update，允许Hibernate在表存在时进行更新，避免与schema.sql冲突
spring.jpa.hibernate.ddl-auto=update
# 启用SQL格式化和注释，便于调试
spring.jpa.properties.hibernate.format_sql=true
spring.jpa.properties.hibernate.use_sql_comments=true

# Spring SQL 初始化配置
# 延迟数据源初始化，确保在JPA尝试生成DDL之前，SQL脚本有机会执行
spring.jpa.defer-datasource-initialization=true
# 总是执行schema.sql和data.sql脚本
spring.sql.init.mode=always
# 脚本执行遇到错误时继续，在开发阶段可提高容错性
spring.sql.init.continue-on-error=true

# 其他可能的配置，例如会话管理
spring.session.jdbc.initialize-schema=always

关键配置项说明：

• spring.jpa.defer-datasource-initialization=true: 这是至关重要的一步。它告诉Spring Boot延迟数据源的初始化，直到所有JPA实体都加载完毕。这确保了schema.sql和data.sql脚本有机会在Hibernate尝试根据实体生成或更新DDL之前执行。
• spring.sql.init.mode=always: 明确指示Spring Boot在每次应用启动时都执行schema.sql和data.sql文件。
• spring.jpa.hibernate.ddl-auto=update: 将Hibernate的DDL自动生成策略设置为update。当schema.sql负责创建表时，update模式允许Hibernate在表已存在时进行调整，而不是尝试重新创建，这可以避免冲突。如果设置为create，可能会导致Hibernate在schema.sql执行前尝试创建表，从而引发问题。
• spring.jpa.generate-ddl=true: 启用JPA的DDL生成功能，与ddl-auto协同工作。
• spring.jpa.database-platform和spring.jpa.properties.hibernate.dialect: 指定H2数据库方言，确保Hibernate生成正确的SQL。
• spring.sql.init.continue-on-error=true: 在脚本执行过程中遇到错误时，允许初始化过程继续。这在开发阶段处理一些非关键错误时非常有用。

实体定义

实体类需要与SQL脚本中定义的表结构保持一致，尤其是在表名、列名和主键生成策略上。

// Item.java
package com.example.demo.entity;

import javax.persistence.*;

@Entity(name = "ITEM_ENTITY") // 可选，定义JPA实体名称
@Table(name = "items") // 映射到数据库中的表名，建议使用小写
public class Item {

    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY) // 针对H2的auto_increment列，使用IDENTITY策略
    private Long id;

    private String designation; // 列名，建议使用小写

    // 构造函数、Getter和Setter（此处省略）
    public Item() {}

    public Long getId() {
        return id;
    }

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

    public String getDesignation() {
        return designation;
    }

    public void setDesignation(String designation) {
        this.designation = designation;
    }
}

注意事项：

• @Table(name = "items"): 确保这里的表名与schema.sql中定义的表名完全一致，推荐使用小写以避免跨数据库的潜在问题。
• @GeneratedValue(strategy = GenerationType.IDENTITY): 对于H2数据库中的auto_increment列，IDENTITY策略是最佳选择。AUTO策略可能会根据JPA提供商的默认行为或数据库方言选择其他生成器（如序列），可能与auto_increment不兼容。
• 列名：实体中的字段名（如designation）通常会通过Hibernate映射到数据库列名，建议也保持小写或与SQL脚本中的列名一致。

SQL 脚本

schema.sql和data.sql文件应放置在src/main/resources目录下。

schema.sql

用于创建表结构。

-- schema.sql
create table items
(
    id                    int not null auto_increment,
    designation           varchar(50) not null,
    primary key (id)
);

注意事项：

• 表名和列名：确保与实体类中的@Table注解和字段名保持一致，特别是大小写。在H2中，通常默认不区分大小写，但为了最佳兼容性，建议统一使用小写。
• 主键定义：id int not null auto_increment与实体中的@Id和GenerationType.IDENTITY相匹配。

data.sql

用于向已创建的表中插入初始数据。

-- data.sql
insert into items(id, designation)
values (1, 'EXAMPLE');

注意事项：

• 表名和列名：同样需要与schema.sql和实体保持一致。
• 数据值：提供符合表结构和数据类型要求的值。

主应用类

标准的Spring Boot应用启动类。

// MainApplication.java
package com.example.demo;

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

@SpringBootApplication
public class MainApplication {

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

总结

通过上述配置和代码示例，Spring Boot应用在启动时将：

1. 根据application.properties中的spring.datasource.url配置连接到H2内存数据库。
2. 由于spring.jpa.defer-datasource-initialization=true和spring.sql.init.mode=always，Spring Boot会优先执行schema.sql来创建items表。
3. 接着执行data.sql向items表中插入初始数据。
4. 随后，JPA/Hibernate会根据Item实体和spring.jpa.hibernate.ddl-auto=update策略，检查并更新数据库结构（如果需要），但由于表已由schema.sql创建，通常不会有冲突。

这种方法确保了在每次应用启动时，H2内存数据库都能被正确初始化，并包含预设的测试数据，极大地简化了开发和测试流程。在遇到类似“表找不到”或“数据插入失败”的问题时，请仔细检查application.properties中的初始化相关配置、实体类的主键生成策略以及SQL脚本中表名和列名的大小写一致性。