SpringBoot啟動執(zhí)行sql腳本的3種方法實例

更新時間：2022年01月10日 11:13:19 作者：AtongWood

在應用程序啟動后,可以自動執(zhí)行建庫、建表等SQL腳本,下面這篇文章主要給大家介紹了關于SpringBoot啟動執(zhí)行sql腳本的3種方法,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下

背景

項目里后端需要計算坐標距離，想用sql實現(xiàn)算法，然后通過執(zhí)行一個sql腳本，創(chuàng)建一個函數(shù)供各業(yè)務調(diào)用。我們需要在springboot項目啟動時執(zhí)行sql腳本，在網(wǎng)上一頓搜索，總結了有三種做法：

配置application.yml文件
自定義DataSourceInitializer Bean
啟動時執(zhí)行方法

第一種做法最方便簡潔，是首選方案，但是由于種種原因項目里不能用，只能選擇使用第二種做法。第三種做法不推薦，這里只當是記錄一下做過的工作。

開發(fā)調(diào)測sql腳本的時候，推薦使用這個驅(qū)動，可以讓我們看到sql執(zhí)行日志，有沒有執(zhí)行？報了什么異常？

spring
  datasource
    driver-class-name: net.sf.log4jdbc.DriverSpy

<dependency>
    <groupId>com.googlecode.log4jdbc</groupId>
    <artifactId>log4jdbc</artifactId>
    <version>1.2</version>
    <scope>runtime</scope>
</dependency>

同時，spring.datasource.url的配置應該如下起頭

spring
  datasource
    url: 'jdbc:log4jdbc:mysql://XXXXX'

配置application.yml文件

spring:
  datasource:
    username: root
    password: root
    driver-class-name: net.sf.log4jdbc.DriverSpy
    url: jdbc:log4jdbc:mysql://localhost:3306/springboot
    schema:
      - classpath:sql/function.sql
      - classpath:sql/procedure.sql
    initialization-mode: ALWAYS
    separator:\\

自定義存儲過程或者函數(shù)時，可能需要使用delimiter設置斷句分隔符，但是delimiter在springboot執(zhí)行的sql腳本里不可用。springboot提供了spring.datasource.separator配置解決這個問題，如上配置之后，不必執(zhí)行delimiter \\，我們在腳本里可以直接使用\\作為分隔符。

以下兩種情況會導致啟動時sql腳本不執(zhí)行：

1.啟動類上的注解如果配置了exclude={DataSourceAutoConfiguration.class}，sql腳本將不被執(zhí)行。

@SpringBootApplication(exclude={DataSourceAutoConfiguration.class})

2.如果開啟了druid連接池的防火墻，sql腳本將不被執(zhí)行。

spring
  datasource
    druid
      filter
        wall
          enabled: true

自定義DataSourceInitializer Bean

參考博文：Spring Boot中自動執(zhí)行sql腳本

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.core.io.Resource;
import org.springframework.jdbc.datasource.init.DataSourceInitializer;
import org.springframework.jdbc.datasource.init.DatabasePopulator;
import org.springframework.jdbc.datasource.init.ResourceDatabasePopulator;
import javax.sql.DataSource;

public class CustomizeDataSourceInitializer {

    @Value("classpath:sql/function.sql")
    private Resource functionScript;

    @Bean
    public DataSourceInitializer dataSourceInitializer(final DataSource dataSource) {
        final DataSourceInitializer initializer = new DataSourceInitializer();
        // 設置數(shù)據(jù)源
        initializer.setDataSource(dataSource);
        initializer.setDatabasePopulator(databasePopulator());
        return initializer;
    }

    private DatabasePopulator databasePopulator() {
        final ResourceDatabasePopulator populator = new ResourceDatabasePopulator();
        populator.addScripts(functionScript);
        populator.setSeparator("$$");
        return populator;
    }
}

populator.setSeparator("$$")的作用和配置spring.datasource.separator一樣。

啟動時執(zhí)行方法

參考博文：springboot啟動前執(zhí)行方法的幾種方式

三種實現(xiàn)方式：

第一種 @PostConstruct注解

第二種實現(xiàn)InitializingBean接口

第三種實現(xiàn)BeanPostProcessor接口

這種做法思路就是啟動時調(diào)用MyBatis接口，但是受限于Mybatis的用法規(guī)則，不能完美的滿足需求，比如，執(zhí)行的sql腳本只能有一條語句，這樣的話，如果我要創(chuàng)建兩個存儲過程，需要先后調(diào)用兩個MyBatis接口。我們不必這么做，前兩種做法更好。