17370845950

使用 spring.sql.init.platform 指定数据库初始化脚本

本文档旨在解决 Spring Boot 项目中,使用 schema-mysql.sql 和 data-mysql.sql 等特定数据库脚本进行初始化时,spring.datasource.platform 配置失效的问题。我们将介绍如何使用 spring.sql.init.platform 属性替代旧的配置,以确保数据库脚本能够正确执行。

在 Spring Boot 项目中,根据不同的数据库平台执行不同的 SQL 脚本是一个常见的需求。在较早的 Spring Boot 版本中,可以使用 spring.datasource.platform 属性来实现。但是,在 Spring Boot 2.5 及更高版本中,该属性已被弃用,取而代之的是 spring.sql.init.platform。

问题描述

在使用 Spring Boot 2.5 或更高版本时,如果尝试使用 spring.datasource.platform=mysql 并将 SQL 脚本命名为 schema-mysql.sql 和 data-mysql.sql,可能会发现这些脚本没有被执行。

解决方案

解决方案是使用 spring.sql.init.platform 属性来指定数据库平台。

  1. 修改 application.properties 或 application.yml 文件:

    将 spring.datasource.platform=mysql 替换为 spring.sql.init.platform=mysql。

    例如,在 application.properties 中:

    spring.sql.init.platform=mysql
  2. 确保 SQL 脚本命名正确:

    SQL 脚本的文件名应遵循 schema-{platform}.sql 和 data-{platform}.sql 的命名规范,其中 {platform} 是 spring.sql.init.platform 属性的值。

    例如,对于 MySQL 数据库,脚本应命名为 schema-mysql.sql 和 data-mysql.sql。

示例

假设我们有一个 Spring Boot 项目,需要使用 MySQL 数据库,并使用 schema-mysql.sql 创建表,使用 data-mysql.sql 插入数据。

1. application.properties:

spring.datasource.url=jdbc:mysql://localhost:3306/your_database
spring.datasource.username=your_username
spring.datasource.password=your_password
spring.sql.init.platform=mysql
spring.sql.init.mode=always # 确保每次都执行初始化脚本,开发阶段推荐

2. schema-mysql.sql:

CREATE TABLE IF NOT EXISTS users (
    id INT PRIMARY KEY AUTO_INCREMENT,
    name VARCHAR(255) NOT NULL
);

3. data-mysql.sql:

INSERT INTO users (name) VALUES ('John Doe');
INSERT INTO users (name) VALUES ('Jane Smith');

注意事项:

  • spring.sql.init.mode 属性控制 SQL 初始化脚本的执行时机。always 表示每次启动应用程序时都执行脚本,embedded 表示只在嵌入式数据库(如 H2)上执行,never 表示不执行脚本。在生产环境中,应该根据实际情况选择合适的模式。
  • 确保数据库连接配置正确,包括 URL、用户名和密码。
  • SQL 脚本文件应放置在 src/main/resources 目录下。

总结

通过使用 spring.sql.init.platform 属性,可以轻松地指定 Spring Boot 项目在启动时使用的数据库初始化脚本。这使得根据不同的数据库平台执行不同的 SQL 脚本变得更加简单和灵活。 请记住,在 Spring Boot 2.5 及更高版本中,spring.datasource.platform 属性已被弃用,应使用 spring.sql.init.platform 替代。 同时,务必注意spring.sql.init.mode属性的设置,以避免在生产环境中意外执行初始化脚本。