Spring Boot3.x 启动自动执行sql脚本

1 引言

某些项目在首次启动时，需要先手动创建数据库表，然后再手动写入初始数据才能正常使用。为了省去这个手动操作过程，我们可以使用Spring Boot启动时执行sql脚本的配置，全自动完成这个过程。

2 配置

• 具体配置如下：

spring:
  sql:
    init:
      encoding: utf-8
      mode: always
      platform: mysql
      schema-locations:
        - classpath:sql/start.sql

• 列出pom.xml，该版本经过测试可以正常执行sql脚本。

<?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>

    <groupId>com.zeroone</groupId>
    <artifactId>zeroone</artifactId>
    <version>1.0</version>

    <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <!--  为Spring Boot项目提供一系列默认的配置和依赖管理-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.3.2</version>
        <relativePath/>
    </parent>

    <dependencies>
        <!--  Spring Boot核心依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- Spring Boot单元测试和集成测试的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- Spring Boot构建Web应用程序的依赖-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- redis -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>
        <!-- mysql驱动-->
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
        </dependency>
        <!-- mybatis-plus核心依赖-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-spring-boot3-starter</artifactId>
            <version>3.5.7</version>
        </dependency>
        <!-- 阿里数据库连接池 -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-3-starter</artifactId>
            <version>1.2.23</version>
        </dependency>
        <!-- 阿里JSON解析库-->
        <dependency>
            <groupId>com.alibaba.fastjson2</groupId>
            <artifactId>fastjson2</artifactId>
            <version>2.0.52</version>
        </dependency>
        <!-- Jwt -->
        <dependency>
            <groupId>com.auth0</groupId>
            <artifactId>java-jwt</artifactId>
            <version>4.4.0</version>
        </dependency>

    </dependencies>

</project>

3 参数介绍

• spring.sql.init.mode：

   ALWAYS：始终初始化数据库
   EMBEDDED：仅初始化嵌入式数据库
   NEVER：从不初始化数据库
  

• spring.sql.init.enabled：初始化的开关，默认是true。

• spring.sql.init.username：初始化脚本的用户名

• spring.sql.init.password：初始化脚本的密码

• spring.sql.init.schema-locations：配置与schema变更相关的sql脚本，多个用分号割开

• spring.sql.init.data-locations：配置与数据相关的sql脚本，多个用分号割开

• spring.sql.init.encoding：配置脚本文件的编码

• spring.sql.init.separator：配置多个sql文件的分隔符，默认是;

• spring.sql.init.continue-on-error：如果执行脚本过程中碰到错误是否继续，默认是false

4 注意事项

为了避免每次启动项目都重复执行sql。可以在首次执行后将开关关闭，即enabled改为false。但是有违我们全自动的初衷，因此我们可以在sql脚本上去做一些控制。

• 使用IF NOT EXISTS关键字，如果不存在创建表
• 使用IGNORE关键字，与现有行产生唯一键冲突，该行将被忽略，不会插入到表中，同时不会产生错误

5 完整代码

Gitee代码链接