springboot启动时初始化sql脚本

本是古典何须时尚 2022-11-03 04:19 340阅读 0赞

### 文章目录 ###

*   *  1.初始化mysql数据库脚本
     *   *  1.使用springboot jdbc初始化数据库
         *  2.使用原生mybatis执行sql脚本
         *  3.改良springboot jdbc初始化数据库
     *  参考地址

*  基于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.sql文件，或者data−\{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脚本][1.Springboot_sql]  
[2.Spring Boot2.x 执行schema.sql初始化数据库][2.Spring Boot2.x _schema.sql]  
[3.Springboot（二十）启动时数据库初始化spring.datasource/spring.jpa][3.Springboot_spring.datasource_spring.jpa]  
[4.Java web mybatis 实现项目初始化自动初始化数据库(执行SQL文件)][4.Java web mybatis _SQL]  
[5.Java原生操作数据库（不使用框架）][5.Java]

[1.Springboot_sql]: https://blog.csdn.net/ssss_cccc/article/details/103957030
[2.Spring Boot2.x _schema.sql]: https://blog.csdn.net/qq_19671173/article/details/83077260?depth_1-utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-2&utm_source=distribute.pc_relevant.none-task-blog-BlogCommendFromMachineLearnPai2-2
[3.Springboot_spring.datasource_spring.jpa]: https://blog.csdn.net/u012326462/article/details/82080812
[4.Java web mybatis _SQL]: https://blog.csdn.net/weixin_42191996/article/details/102992072
[5.Java]: https://www.cnblogs.com/zhouheblog/p/11044375.html