Springboot中如何自动初始化数据库(一)?

部分Springboot项目需要整体打包部署，包括数据库也需要启动时初始化。此时，可以参考本篇内容进行操作，演练、学习。

思路

编写一个配置类（注解@PostConstruct）实现启动时执行。

判断数据库是否存在，存在则返回，不存在则创建。程序只执行一次。

环境

• Springboot 2.4
• Mybatis-plus 3.3.0
• Mysql 8.0.22

代码

spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    type: com.alibaba.druid.pool.DruidDataSource
    url: jdbc:mysql://localhost:3306/demo2024?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8&autoReconnect=true&allowMultiQueries=true&rewriteBatchedStatements=true&nullCatalogMeansCurrent=true
    username: root
    password: 123456

注意：由于届时需要用到这个username用户去创建数据库，所以需要有相应的操作权限。

@Slf4j
@Configuration
public class DatabaseInitialize {
    @Value("${spring.datasource.url}")
    private String url;
    @Value("${spring.datasource.username}")
    private String username;
    @Value("${spring.datasource.password}")
    private String password;    
    /**
     * 该方法用于检测数据库是否需要初始化
     * 如果是则执行SQL脚本进行初始化操作
     */
    @PostConstruct
    private void initDatabase() {
        log.info("开始检查数据库是否需要初始化...");
        // 检测当前连接数据库是否存在
        if (currentDatabaseExists()) {
            log.info("数据库存在，不需要初始化！");
            return;
        }
        log.warn("数据库不存在！准备执行初始化步骤...");
        // 先创建数据库
        createDatabase();
        // 然后再次连接，执行脚本初始化库中的表格
        try (Connection connection = DriverManager.getConnection(url, username, password)) {
          // 相对路径的写法 前边不要加  /
            runSQLScript("db/create-table.sql", connection);
            log.info("初始化表格完成！");
        } catch (Exception e) {
            log.error("初始化表格时，连接数据库失败！");
            e.printStackTrace();
        }
    }    
    /**
     * 检测当前连接的库是否存在
     * @return
     */
    private boolean currentDatabaseExists() {
        try {
            Connection connection = DriverManager.getConnection(url, username, password);
            connection.close();
        } catch (SQLException e) {
            return false;
        }
        return true;
    }    
    /**
     * 执行SQL脚本
     *
     * @param path  resources下的文件
     * @param connection
     */
    private void runSQLScript(String path, Connection connection) {
      // 这个地方注意，Springboot发布的是jar时，需要这样读取 resources下的文件
        try (InputStream sqlFileStream = this.getClass().getClassLoader().getResourceAsStream(path)) {
            BufferedReader sqlFileStreamReader = new BufferedReader(new InputStreamReader(sqlFileStream, StandardCharsets.UTF_8));
            // 创建SQL脚本执行器对象
            ScriptRunner scriptRunner = new ScriptRunner(connection);
            // 使用SQL脚本执行器对象执行脚本
            scriptRunner.runScript(sqlFileStreamReader);
            // 最后关闭文件读取器
            sqlFileStreamReader.close();
        } catch (Exception e) {
            log.error("读取文件或者执行脚本失败！");
            e.printStackTrace();
        }
    }    
    /**
     * 执行SQL脚本以创建数据库
     */
    private void createDatabase() {
        try {
            // 修改连接语句，重新建立连接
            // 重新建立的连接不再连接到指定库，而是直接连接到整个MySQL
            // 使用URI类解析并拆解连接地址，重新组装
            URI databaseURI = new URI(url.replace("jdbc:", ""));
            // 得到连接地址中的数据库平台名（例如mysql）
            String databasePlatform = databaseURI.getScheme();
            // 得到连接地址和端口
            String hostAndPort = databaseURI.getAuthority();
            // 得到连接地址中的库名
            String databaseName = databaseURI.getPath().substring(1);
            // 组装新的连接URL，不连接至指定库
            // 特别注意：serverTimezone=GMT%2B8 很重要
            String newURL = "jdbc:" + databasePlatform + "://" + hostAndPort + "/?serverTimezone=GMT%2B8";
            // 重新建立连接
            Connection connection = DriverManager.getConnection(newURL, username, password);
            Statement statement = connection.createStatement();
            // 执行SQL语句创建数据库
            statement.execute("create database if not exists `" + databaseName + "`");
            // 关闭会话和连接
            statement.close();
            connection.close();
            log.info("创建数据库完成！");
        } catch (URISyntaxException e) {
            log.error("数据库连接URL格式错误！");
            throw new RuntimeException(e);
        } catch (SQLException e) {
            log.error("连接失败！");
            throw new RuntimeException(e);
        }
    }
}

注意：

1、脚本路径是放到jar包里边的resources下的，所以读取时，使用

this.getClass().getClassLoader().getResourceAsStream(path)

并且，路径前边不要加 /

2、连接数据库时，时区必须添加

?serverTimezone=GMT%2B8

# db/create-table.sql，放resources下
CREATE TABLE `demo_log` (
  `id` bigint(20) NOT NULL AUTO_INCREMENT,
  `description` varchar(255) DEFAULT NULL,
  `create_time` datetime DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;

效果

第一次启动项目：

第二次启动项目：

至此，数据库已初始化完成。这里涉及到数据库创建（程序自动执行）、表创建、数据插入（create-table.sql写对应SQL即可）。

另外，有项目需要根据数据库初始化缓存，需要提前加载数据，下一篇写一个demo示例。