springboot启动时初始化sql脚本

  • 基于spring2.x

1.初始化mysql数据库脚本

1.使用springboot jdbc初始化数据库

# 在application.properties中配置mysql
spring.datasource.url=jdbc:mysql://192.168.1.1:3306/example?useSSL=false&useUnicode=true&characterEncoding=utf-8&autoReconnect=true&serverTimezone=Asia/Shanghai
spring.datasource.username=root
spring.datasource.password=1234
# 配置需要执行的脚本,schema是用于创建表的语句,源码中是先执行schema,在执行data,并且schema中不能为空文件,所以如果不建表,可以在schema.sql文件中随便写一行sql,不产生沉余数据就行,如:show tables;
spring.datasource.schema=classpath*:database/schema.sql
# data中主要存放插入数据及更新操作
spring.datasource.data=classpath*:database/data.sql
# always为始终执行初始化,embedded只初始化内存数据库(默认值),如h2等,never为不执行初始化
spring.datasource.initialization-mode=always

:

  • 1.启动类中的 DataSourceAutoConfiguration.class注解会让配置失效,或者druid的防火墙也会让此方法失效。
  • 2.它还会加载schema- p l a t f o r m . s q l 文 件 , 或 者 d a t a − {platform}.sql文件,或者data- platform.sqldata{platform}.sql文件,其中platform就是spring.datasource.platform的值
  • 其它相关的参数

这四个值为执行schema.sql或者data.sql时,用的用户
spring.datasouce.data-passwork:
spring.datasouce.data-username:
spring.datasouce.schema-password:
spring.datasouce.schema-username:

spring.datasource.sql-script-encoding: utf-8 为文件的编码
spring.datasource.separator: ; 为sql脚本中语句分隔符
spring.datasource.continue-on-error: false 遇到语句错误时是否继续,若已经执行过某些语句,再执行可能会报错,可以忽略,不会影响程序启动

这种方式初始化数据库时,需要先创建数据库,不过是建议实行的方式。

2.使用原生mybatis执行sql脚本

  • 通过调用脚本的方式直接创建数据库,表以及导入初始数据
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.io.Resources;
import org.apache.ibatis.jdbc.ScriptRunner;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.sql.*;

/**
 * 初始化java数据库
 *
 * @author mind
 * @date 2020/8/3 13:45
 */
@Component
@Slf4j
public class InitDataBase {

    @Value(value = "${initDatabase.username}")
    private String userName;
    @Value(value = "${initDatabase.password}")
    private String password;
    

    @PostConstruct
    public void init() throws SQLException{
            // 创建ScriptRunner,用于执行SQL脚本,如果想要初始化后创建数据库,那么一开始在此处初始化的时候需要连接一个已经存在的数据。
        try(Connection conn = DriverManager.getConnection("jdbc:mysql://192.168.1.1:3306/information_schema?useSSL=false&useUnicode=true&characterEncoding=utf-8&autoReconnect=true&serverTimezone=Asia/Shanghai", userName, password);){
            log.info("正在初始化sql脚本........");
            conn.prepareStatement("");
            ScriptRunner runner = new ScriptRunner(conn);
            runner.setErrorLogWriter(null);
            runner.setLogWriter(null);
            // 执行SQL脚本
            runner.runScript(Resources.getResourceAsReader("database/schema-mysql.sql"));
            log.info("初始化完成!");
        }catch (Exception e){
            log.error("init sql failed!",e);
        }
    }

}

注意:但是使用该方式时,sql脚本中的注释不能有英文的分号即;,本人遇到的坑就是,创建表的时候,表中的字段的注释中包含有英文的分号;,结果该表就被跳过而不被创建。

3.改良springboot jdbc初始化数据库

由于直接使用mybatis运行脚本,存在未知的坑,因此决定稍微修改下springboot jdbc初始化数据库,该方式,直接配置的时候,可以创建表和数据只是不能创建数据库,因此直接添加一个创建数据库的功能即可。

  • 添加创建数据库的功能
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import java.sql.*;

/**
 * 初始化java数据库
 *
 * @author mind
 * @date 2020/8/3 13:45
 */
@Component
@Slf4j
public class InitDataBase {

    @Value(value = "${initDatabase.username}")
    private String userName;
    @Value(value = "${initDatabase.password}")
    private String password;
    @Value(value = "${initDatabase.databaseName}")
    private String databaseName;
    @Value(value = "${initDatabase.databaseIpAndPort}")
    private String databaseIpAndPort;
    @Value(value = "${initDatabase.creatDatabase}")
    private boolean creatDatabase;

    @PostConstruct
    public void init() throws SQLException{
            // 如果想要初始化后创建数据库,那么一开始在此处初始化的时候需要连接一个已经存在的数据,这儿设置了默认的肯定存在的数据库。
        if(creatDatabase){
            try(Connection conn = DriverManager.getConnection("jdbc:mysql://"+databaseIpAndPort+"/information_schema?useSSL=false&useUnicode=true&characterEncoding=utf-8&autoReconnect=true&serverTimezone=Asia/Shanghai", userName, password);){
                log.info("创建数据库........");
                conn.prepareStatement("create database if not exists "+databaseName+";").execute();
                log.info("数据库创建完成!");
            }catch (Exception e){
                log.error("init sql failed!",e);
            }
        }
        log.info("数据库已经创建,无需创建。");
    }
}

参考地址

1.Springboot启动初始化数据,执行sql脚本
2.Spring Boot2.x 执行schema.sql初始化数据库
3.Springboot(二十)启动时数据库初始化spring.datasource/spring.jpa
4.Java web mybatis 实现项目初始化自动初始化数据库(执行SQL文件)
5.Java原生操作数据库(不使用框架)

### Spring Boot 启动时初始化使用场景 Spring Boot 的启动过程提供了多种机制来支持初始化阶段的任务处理。这些任务可以涉及环境配置、数据预加载以及资源分配等方面。 #### 1. **通过 `ApplicationContextInitializer` 进行上下文初始化** 在 Spring Boot 应用程序初始化期间,可以从 `META-INF/spring.factories` 文件中加载实现 `ApplicationContextInitializer` 接口的类实例[^1]。此类接口允许开发者在容器刷新前对 `ConfigurableApplicationContext` 执行自定义逻辑。例如: ```java public class MyApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> { @Override public void initialize(ConfigurableApplicationContext applicationContext) { System.out.println("Initializing application context..."); // 自定义逻辑,比如修改环境变量或注册监听器 ConfigurableEnvironment environment = applicationContext.getEnvironment(); environment.getPropertySources().addFirst(new MapPropertySource("customProperties", Collections.singletonMap("my.custom.property", "value"))); } } ``` 上述代码展示了如何向环境中注入新的属性源[^2]。 --- #### 2. **利用 `CommandLineRunner` 或 `ApplicationRunner` 实现业务逻辑初始化** 对于需要在应用完全启动后立即执行某些特定业务逻辑的情况,可以使用 `CommandLineRunner` 或 `ApplicationRunner` 接口。它们会在 Spring 容器完成初始化之后运行指定方法中的代码。 以下是基于 `CommandLineRunner` 的简单例子: ```java @Component public class DataLoader implements CommandLineRunner { private final UserRepository userRepository; public DataLoader(UserRepository userRepository) { this.userRepository = userRepository; } @Override public void run(String... args) throws Exception { if (userRepository.count() == 0) { // 如果数据库为空,则插入初始数据 User user = new User("admin", "password"); userRepository.save(user); } } } ``` 此片段说明了如何在启动过程中检查并填充必要的基础数据[^3]。 --- #### 3. **借助 SQL 脚本自动创建表结构和种子数据** 为了简化开发体验,Spring Boot 支持通过内置功能读取位于 `/src/main/resources/db/` 下的 `.sql` 文件,在服务首次部署时构建所需的数据库模式或者导入测试用途的数据集。然而需要注意的是,这种方式仅适用于非生产环境下,因为它可能会包含删除现有记录或其他破坏性的命令[^4]。 示例脚本如下所示: ```sql -- schema.sql CREATE TABLE IF NOT EXISTS users ( id BIGINT AUTO_INCREMENT PRIMARY KEY, username VARCHAR(50), password VARCHAR(100) ); -- data.sql INSERT INTO users(username, password) VALUES('john', 'doe'); ``` 以上两步分别完成了表格定义与默认条目录入工作。 --- #### 总结 综上所述,Spring Boot 提供了灵活多样的手段帮助用户在其生命周期的不同节点实施定制化需求。无论是调整全局参数还是针对具体模块做精细化控制都有相应的解决方案可供选用。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值