解決Springboot項目啟動後自動創建多表關聯的數據庫與表的方案

Posted on 2021-03-162021-03-16 by WalkonNet

熬夜寫完，尚有不足，但仍在努力學習與總結中，而您的點贊與關註，是對我最大的鼓勵！

在一些本地化項目開發當中，存在這樣一種需求，即開發完成的項目，在第一次部署啟動時，需能自行構建系統需要的數據庫及其對應的數據庫表。

若要解決這類需求，其實現在已有不少開源框架都能實現自動生成數據庫表，如mybatis plus、spring JPA等，但您是否有想過，若要自行構建一套更為復雜的表結構時，這種開源框架是否也能滿足呢，若滿足不瞭話，又該如何才能實現呢？

我在前面寫過一篇 Activiti工作流學習筆記(三)——自動生成28張數據庫表的底層原理分析，裡面分析過工作流Activiti自動構建28數據庫表的底層原理。在我看來，學習開源框架的底層原理，其中一個原因是，須從中學到能為我所用的東西。故而，在分析理解完工作流自動構建28數據庫表的底層原理之後，我決定也寫一個基於Springboot框架的自行創建數據庫與表的demo。我參考瞭工作流Activiti6.0版本的底層建表實現的邏輯，基於Springboot框架，實現項目在第一次啟動時可自動構建各種復雜如多表關聯等形式的數據庫與表的。

整體實現思路並不復雜，大概是這樣：先設計一套完整創建多表關聯的數據庫sql腳本，放到resource裡，在springboot啟動過程中，自動執行sql腳本。

首先，先一次性設計一套可行的多表關聯數據庫腳本，這裡我主要參考使用Activiti自帶的表做實現案例，因為它內部設計瞭眾多表關聯，就不額外設計瞭。

sql腳本的語句就是平常的create建表語句，類似如下：

create table ACT_PROCDEF_INFO (
 ID_ varchar(64) not null,
 PROC_DEF_ID_ varchar(64) not null,
 REV_ integer,
 INFO_JSON_ID_ varchar(64),
 primary key (ID_)
 ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_bin;

增加外部主鍵、索引——

create index ACT_IDX_INFO_PROCDEF on ACT_PROCDEF_INFO(PROC_DEF_ID_);

alter table ACT_PROCDEF_INFO
 add constraint ACT_FK_INFO_JSON_BA
 foreign key (INFO_JSON_ID_)
 references ACT_GE_BYTEARRAY (ID_);

alter table ACT_PROCDEF_INFO
 add constraint ACT_FK_INFO_PROCDEF
 foreign key (PROC_DEF_ID_)
 references ACT_RE_PROCDEF (ID_);

alter table ACT_PROCDEF_INFO
 add constraint ACT_UNIQ_INFO_PROCDEF
 unique (PROC_DEF_ID_);

整體就是設計一套符合符合需求場景的sql語句，保存在.sql的腳本文件裡，最後統一存放在resource目錄下，類似如下：

接下來，就是實現CommandLineRunner的接口，重寫其run()的bean回調方法，在run方法裡開發能自動建庫與建表邏輯的功能。

目前，我已將開發的demo上傳到瞭我的github，感興趣的童鞋，可自行下載，目前能直接下下來在本地環境運行，可根據自己的實際需求針對性參考使用。

首先，在解決這類需求時，第一個先要解決的地方是，Springboot啟動後如何實現隻執行一次建表方法。

這裡需要用到一個CommandLineRunner接口，這是Springboot自帶的，實現該接口的類，其重寫的run方法，會在Springboot啟動完成後自動執行，該接口源碼如下：

@FunctionalInterface
public interface CommandLineRunner {

 /**
 *用於運行bean的回調
 */
 void run(String... args) throws Exception;

}

擴展一下，在Springboot中，可以定義多個實現CommandLineRunner接口類，並且可以對這些實現類中進行排序，隻需要增加@Order，其重寫的run方法就可以按照順序執行，代碼案例驗證：

@Component
@Order(value=1)
public class WatchStartCommandSqlRunnerImpl implements CommandLineRunner {

 @Override
 public void run(String... args) throws Exception {
 System.out.println("第一個Command執行");
 }


@Component
@Order(value = 2)
public class WatchStartCommandSqlRunnerImpl2 implements CommandLineRunner {
 @Override
 public void run(String... args) throws Exception {
 System.out.println("第二個Command執行");
 }
}

控制臺打印的信息如下：

第一個Command執行
第二個Command執行

根據以上的驗證，因此，我們可以通過實現CommandLineRunner的接口，重寫其run()的bean回調方法，用於在Springboot啟動後實現隻執行一次建表方法。實現項目啟動建表的功能，可能還需實現判斷是否已經有相應數據庫，若無，則應先新建一個數據庫，同時，得考慮還沒有對應數據庫的情況，因此，我們通過jdbc第一次連接MySQL時，應連接一個原有自帶存在的庫。每個MySql安裝成功後，都會有一個mysql庫，在第一次建立jdbc連接時，可以先連接它。

代碼如下：

Class.forName("com.mysql.jdbc.Driver");
String url="jdbc:mysql://127.0.0.1:3306/mysql?useUnicode=true&characterEncoding=UTF-8&ueSSL=false&serverTimezone=GMT%2B8";
Connection conn= DriverManager.getConnection(url,"root","root");

建立與MySql軟件連接後，先創建一個Statement對象，該對象是jdbc中可用於執行靜態 SQL 語句並返回它所生成結果的對象，這裡可以使用它來執行查找庫與創建庫的作用。

//創建Statement對象
 Statement statment=conn.createStatement();
 /**
 使用statment的查詢方法executeQuery("show databases like \"fte\"")
 檢查MySql是否有fte這個數據庫
 **/
 ResultSet resultSet=statment.executeQuery("show databases like \"fte\"");
 //若resultSet.next()為true，證明已存在；
 //若false，證明還沒有該庫,則執行statment.executeUpdate("create database fte")創建庫
 if(resultSet.next()){
 log.info("數據庫已經存在");
 }else {
 log.info("數據庫未存在，先創建fte數據庫");
 if(statment.executeUpdate("create database fte")==1){
 log.info("新建數據庫成功");
 }
 }

在數據庫fte自動創建完成後，就可以在該fte庫裡去做建表的操作瞭。

我將建表的相關方法都封裝到SqlSessionFactory類裡，相關建表方法同樣需要用到jdbc的Connection連接到數據庫，因此，需要把已連接的Connection引用變量當做參數傳給SqlSessionFactory的初始構造函數：

public void createTable(Connection conn,Statement stat) throws SQLException {
 try {

  String url="jdbc:mysql://127.0.0.1:3306/fte?useUnicode=true&characterEncoding=UTF-8&ueSSL=false&serverTimezone=GMT%2B8";
  conn=DriverManager.getConnection(url,"root","root");
  SqlSessionFactory sqlSessionFactory=new SqlSessionFactory(conn);
  sqlSessionFactory.schemaOperationsBuild("create");
 } catch (SQLException e) {
  e.printStackTrace();
 }finally {
  stat.close();
  conn.close();
 }
 }

初始化new SqlSessionFactory(conn)後，就可以在該對象裡使用已進行連接操作的Connection對象瞭。

public class SqlSessionFactory{
 private Connection connection ;
 public SqlSessionFactory(Connection connection) {
 this.connection = connection;
 }
......
}

這裡傳參可以有兩種情況，即“create”代表創建表結構的功能，“drop”代表刪除表結構的功能：

 sqlSessionFactory.schemaOperationsBuild("create");

進入到這個方法裡，會先做一個判斷——

public void schemaOperationsBuild(String type) {
 switch (type){
 case "drop":
  this.dbSchemaDrop();break;
 case "create":
  this.dbSchemaCreate();break;
 }
}

若是this.dbSchemaCreate()，執行建表操作：

/**
 * 新增數據庫表
 */
public void dbSchemaCreate() {

 if (!this.isTablePresent()) {
 log.info("開始執行create操作");
 this.executeResource("create", "act");
 log.info("執行create完成");
 }
}

this.executeResource(“create”, “act”)代表創建表名為act的數據庫表——

public void executeResource(String operation, String component) {
 this.executeSchemaResource(operation, component, this.getDbResource(operation, operation, component), false);
 }

其中 this.getDbResource(operation, operation, component)是獲取sql腳本的路徑，進入到方法裡，可見——

public String getDbResource(String directory, String operation, String component) {
 return "static/db/" + directory + "/mysql." + operation + "." + component + ".sql";
 }

接下來，讀取路徑下的sql腳本，生成輸入流字節流：

public void executeSchemaResource(String operation, String component, String resourceName, boolean isOptional) {
 InputStream inputStream = null;

 try {
 //讀取sql腳本數據
 inputStream = IoUtil.getResourceAsStream(resourceName);
 if (inputStream == null) {
  if (!isOptional) {
  log.error("resource '" + resourceName + "' is not available");
  return;
  }
 } else {
  this.executeSchemaResource(operation, component, resourceName, inputStream);
 }
 } finally {
 IoUtil.closeSilently(inputStream);
 }

}

最後，整個執行sql腳本的核心實現在this.executeSchemaResource(operation, component, resourceName, inputStream)方法裡——

 /**
 * 執行sql腳本
 * @param operation
 * @param component
 * @param resourceName
 * @param inputStream
 */
 private void executeSchemaResource(String operation, String component, String resourceName, InputStream inputStream) {
 //sql語句拼接字符串
 String sqlStatement = null;
 Object exceptionSqlStatement = null;
 
 try {
  /**
  * 1.jdbc連接mysql數據庫
  */
  Connection connection = this.connection;
 
  Exception exception = null;
  /**
  * 2、分行讀取"static/db/create/mysql.create.act.sql"裡的sql腳本數據
  */
  byte[] bytes = IoUtil.readInputStream(inputStream, resourceName);
  /**
  * 3.將sql文件裡數據分行轉換成字符串，換行的地方，用轉義符“\n”來代替
  */
  String ddlStatements = new String(bytes);
  /**
  * 4.以字符流形式讀取字符串數據
  */
  BufferedReader reader = new BufferedReader(new StringReader(ddlStatements));
  /**
  * 5.根據字符串中的轉義符“\n”分行讀取
  */
  String line = IoUtil.readNextTrimmedLine(reader);
  /**
  * 6.循環讀取的每一行
  */
  for(boolean inOraclePlsqlBlock = false; line != null; line = IoUtil.readNextTrimmedLine(reader)) {
  /**
  * 7.若下一行line還有數據，證明還沒有全部讀取，仍可執行讀取
  */
  if (line.length() > 0) {
   /**
   8.在沒有拼接夠一個完整建表語句時，！line.endsWith(";")會為true，
   即一直循環進行拼接，當遇到";"就跳出該if語句
   **/
   if ((!line.endsWith(";") || inOraclePlsqlBlock) && (!line.startsWith("/") || !inOraclePlsqlBlock)) {
   sqlStatement = this.addSqlStatementPiece(sqlStatement, line);
   } else {
   /**
   9.循環拼接中若遇到符號";"，就意味著，已經拼接形成一個完整的sql建表語句，例如
   create table ACT_GE_PROPERTY (
   NAME_ varchar(64),
   VALUE_ varchar(300),
   REV_ integer,
   primary key (NAME_)
   ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_bin
   這樣，就可以先通過代碼來將該建表語句執行到數據庫中，實現如下：
   **/
   if (inOraclePlsqlBlock) {
    inOraclePlsqlBlock = false;
   } else {
   sqlStatement = this.addSqlStatementPiece(sqlStatement, line.substring(0, line.length() - 1));
   }
   /**
   * 10.將建表語句字符串包裝成Statement對象
   */
   Statement jdbcStatement = connection.createStatement();

   try {
   /**
   * 11.最後，執行建表語句到數據庫中
    */
   log.info("SQL: {}", sqlStatement);
    jdbcStatement.execute(sqlStatement);
   jdbcStatement.close();
   } catch (Exception var27) {
   log.error("problem during schema {}, statement {}", new Object[]{operation, sqlStatement, var27});
   } finally {
   /**
    * 12.到這一步，意味著上一條sql建表語句已經執行結束，
    * 若沒有出現錯誤話，這時已經證明第一個數據庫表結構已經創建完成，
    * 可以開始拼接下一條建表語句，
    */
   sqlStatement = null;
   }
  }
  }
 }

  if (exception != null) {
  throw exception;
  } 
 } catch (Exception var29) {
  log.error("couldn't " + operation + " db schema: " + exceptionSqlStatement, var29);
 }
 }

這部分代碼主要功能是，先用字節流形式讀取sql腳本裡的數據，轉換成字符串，其中有換行的地方用轉義符“/n”來代替。接著把字符串轉換成字符流BufferedReader形式讀取，按照“/n”符合來劃分每一行的讀取，循環將讀取的每行字符串進行拼接，當循環到某一行遇到“；”時，就意味著已經拼接成一個完整的create建表語句，類似這樣形式——

create table ACT_PROCDEF_INFO (
 ID_ varchar(64) not null,
 PROC_DEF_ID_ varchar(64) not null,
 REV_ integer,
 INFO_JSON_ID_ varchar(64),
 primary key (ID_)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE utf8_bin;

這時，就可以先將拼接好的create建表字符串，通過 jdbcStatement.execute(sqlStatement)語句來執行入庫瞭。當執行成功時，該ACT_PROCDEF_INFO表就意味著已經創建成功，接著以BufferedReader字符流形式繼續讀取下一行，進行下一個數據庫表結構的構建。

整個過程大概就是這個邏輯，可以在此基礎上，針對更為復雜的建表結構sql語句進行設計，在項目啟動時，自行執行相應的sql語句，來進行建表。

該demo代碼已經上傳git，可直接下載運行：https://github.com/z924931408/Springboot-AutoCreateMySqlTable.git

到此這篇關於解決Springboot項目啟動後自動創建多表關聯的數據庫與表的方案的文章就介紹到這瞭,更多相關Springboot創建多表關聯的數據庫與表內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

解決Springboot項目啟動後自動創建多表關聯的數據庫與表的方案

推薦閱讀：

發佈留言取消回覆

近期文章

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆