Spring?Boot中自動執(zhí)行sql腳本的方法實例

更新時間：2022年01月10日 10:38:46 作者：大哥你先走

在SpringBoot的架構中,DataSourceInitializer類可以在項目啟動后初始化數(shù)據(jù),我們可以通過自動執(zhí)行自定義sql腳本初始化數(shù)據(jù),下面這篇文章主要給大家介紹了關于Spring?Boot中自動執(zhí)行sql腳本的相關資料,需要的朋友可以參考下

背景

在應用程序啟動后，可以自動執(zhí)行建庫、建表等SQL腳本.下文中以要自動化執(zhí)行people.sql腳本為例說明，腳本在SpringBoot工程中的路徑為：classpath:people.sql，腳本的具體內容如下：

CREATE TABLE IF NOT EXISTS people(
    persion_id BIGINT NOT NULL AUTO_INCREMENT,
    first_name VARCHAR(20),
    last_name VARCHAR(20),
    PRIMARY KEY (persion_id)
);

實現(xiàn)核心

在SpringBoot的架構中，DataSourceInitializer類可以實現(xiàn)自動執(zhí)行腳本的功能。通過自定義DataSourceInitializer Bean就可以實現(xiàn)按照業(yè)務要求執(zhí)行特定的腳本。

實現(xiàn)方法

前提
已經構建了DataSource Bean。
方法
通過@Configuration、@Bean和@Value三個注解實現(xiàn)自定義DataSourceInitializer Bean，現(xiàn)在Bean的定義中實現(xiàn)自動化執(zhí)行腳本的業(yè)務邏輯。
代碼

import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
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;
@Configuration
public class BatchTaskDataSourceInitializer {
    /**
     * 構建Resource對象
     */
    @Value("classpath:schema-all.sql")
    private Resource businessScript;

    /**
     * 自定義Bean實現(xiàn)業(yè)務的特殊需求
     * @param dataSource
     * @return
     */
    @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(businessScript);
        return populator;
    }
}

注意

有兩點需要說明下：

db文件夾下的腳本可能有多個，所以，這里要使用PathMatchingResourcePatternResolver，讀取多個.sql的文件；
獲取文件的路徑是classpath*:script/db/*.sql，classpath后加個星號，意思是連jar包中的符合該規(guī)則的文件，都可以獲取到，因為該項目最終會打成jar包來運行，如果不使用這個星號，就會出現(xiàn)在開發(fā)的時，沒有問題，等到了測試或生產環(huán)境，就會出現(xiàn)找不到sql文件問題。當然，這里的文件規(guī)則，需要自己定義好，不要掃到了本不應加載的其他包中的文件了。