本教程详细介绍了如何在spring boot应用中，利用h2内存数据库自动执行自定义sql脚本进行数据初始化。文章将指导您配置`application.properties`、实体类以及sql脚本，确保`schema.sql`和`data.sql`在应用启动时正确执行，并解决常见的初始化顺序和命名冲突问题。
在Spring Boot应用开发中，尤其是在测试或开发环境中，经常需要使用H2内存数据库来快速搭建数据环境。为了确保应用启动时数据库能够自动创建表结构并填充初始数据，Spring Boot提供了强大的数据初始化机制。然而，正确配置这一过程，特别是当涉及到自定义SQL脚本时，可能会遇到一些挑战，例如脚本执行顺序、DDL冲突或命名约定问题。本教程将深入探讨如何通过精确的配置来解决这些问题，实现H2内存数据库的自动初始化。
1. 核心配置：application.properties
实现H2数据库自动初始化的关键在于application.properties文件中的一系列配置。这些设置协同工作，控制H2数据库的行为、JPA/Hibernate的DDL生成以及SQL脚本的执行时机。
# 启用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 # H2数据库驱动 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 # 允许Hibernate生成DDL spring.jpa.generate-ddl=true # Hibernate DDL策略：'update'允许Hibernate修改现有表结构 spring.jpa.hibernate.ddl-auto=update # 格式化SQL日志输出 spring.jpa.properties.hibernate.format_sql=true # 启用SQL注释，方便调试 spring.jpa.properties.hibernate.use_sql_comments=true # 数据源初始化配置（关键！） # 延迟数据源初始化，确保Hibernate DDL完成后再执行自定义SQL脚本 spring.jpa.defer-datasource-initialization=true # 总是执行SQL初始化脚本 (schema.sql, data.sql) spring.sql.init.mode=always # 允许SQL初始化脚本在遇到错误时继续执行（可选，但推荐在开发环境使用） spring.sql.init.continue-on-error=true # 如果使用Spring Session JDBC，也需要初始化其schema # spring.session.jdbc.initialize-schema=always
关键配置解析：
- spring.sql.init.mode=always: 这是告诉Spring Boot总是查找并执行classpath根目录下的schema.sql和data.sql脚本。
- spring.jpa.defer-datasource-initialization=true: 此属性至关重要。它确保了自定义的SQL初始化脚本（schema.sql和data.sql）会在JPA/Hibernate完成其数据定义语言（DDL）操作（例如，根据实体类创建表）之后再执行。这有效避免了由于脚本尝试操作尚未创建的表而导致的冲突。
- spring.jpa.hibernate.ddl-auto=update: 在开发环境中，update模式允许Hibernate根据实体类的变化自动调整数据库模式。当与自定义schema.sql结合使用时，defer-datasource-initialization会协调两者的执行顺序。
- spring.jpa.database-platform 和 spring.jpa.properties.hibernate.dialect: 明确指定H2方言，确保Hibernate生成正确的SQL。
2. 实体类定义
实体类的定义需要与数据库表结构保持一致。特别是在使用H2的自增主键时，@GeneratedValue(strategy = GenerationType.IDENTITY) 是一个推荐的策略。同时，建议使用小写字母作为表名，以避免某些数据库在引用大写表名时可能出现的兼容性或引用问题。
// Item.java
package com.example.demo.entity;
import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.GenerationType;
import javax.persistence.Id;
import javax.persistence.Table;
@Entity(name = "ITEM_ENTITY") // 可选，定义JPA实体名
@Table(name = "items") // 明确指定表名为小写"items"
public class Item {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY) // 使用IDENTITY策略支持H2自增主键
private Long id;
private String designation; // 字段名与data.sql和schema.sql中的列名一致
// Getters and Setters
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"): 明确指定表名为小写items，与SQL脚本保持一致。
- @GeneratedValue(strategy = GenerationType.IDENTITY): IDENTITY策略适用于支持自增列的数据库（如H2），它将主键生成委托给数据库。这通常比AUTO更明确，并且能更好地与自定义schema.sql中的auto_increment配合。
- 字段名（如designation）应与SQL脚本中的列名保持一致。
3. SQL 初始化脚本
schema.sql用于定义数据库表结构，而data.sql用于插入初始数据。这两个文件应放置在src/main/resources目录下，Spring Boot会自动识别并执行它们。
schema.sql (创建表结构):
-- src/main/resources/schema.sql
create table items
(
id int not null auto_increment, -- 使用小写列名和auto_increment
designation varchar(50) not null,
primary key (id)
);data.sql (插入初始数据):
-- src/main/resources/data.sql insert into items(id, designation) -- 使用小写表名和列名 values (1, 'EXAMPLE');
注意事项：
- 命名一致性： 确保schema.sql和data.sql中使用的表名和列名与实体类中的@Table注解和字段名完全一致，包括大小写。H2在默认情况下对未加引号的标识符是大小写不敏感的，但为了最佳实践和跨数据库兼容性，建议统一使用小写。
- auto_increment： schema.sql中为id列定义auto_increment，与实体类中的GenerationType.IDENTITY策略相匹配。
4. 主应用类
标准的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);
}
}5. 总结与最佳实践
通过上述配置，您的Spring Boot应用在启动时将能够自动初始化H2内存数据库。当应用启动时，H2数据库将被创建，Hibernate将根据Item实体生成或更新items表结构，随后schema.sql（如果ddl-auto为none或create时，schema.sql将负责创建表）和data.sql将依次执行，填充初始数据。
关键点回顾：
- spring.sql.init.mode=always: 启用SQL脚本自动执行。
- spring.jpa.defer-datasource-initialization=true: 确保SQL脚本在JPA/Hibernate DDL之后执行，解决初始化顺序冲突。
- GenerationType.IDENTITY: 推荐用于H2自增主键，与auto_increment配合良好。
- 命名一致性: 实体类、@Table注解、schema.sql和data.sql中的表名和列名应保持一致，推荐使用小写字母以提高兼容性。
- spring.jpa.hibernate.ddl-auto: 根据开发阶段选择合适的策略。在自定义schema.sql创建表的情况下，可以考虑将其设置为none，让schema.sql完全负责表创建，或者如本例所示，使用update并依赖defer-datasource-initialization来协调。
遵循这些指导原则，您将能够高效、稳定地在Spring Boot应用中实现H2内存数据库的自动初始化，为开发和测试流程带来极大的便利。
