SpringBoot結合Mybatis實現創建數據庫表的方法

前言

系統環境:

  • JAVA JDK 版本:1.8
  • MySQL 版本:8.0.27
  • MyBatis 版本:3.5.9
  • SpingBoot版本: 2.6.2

為什麼要通過應用實現創建表的功能

最近接瞭項目時,由於客戶需要分庫分表,而且每次手動創建很多表,可能是自己閑麻煩,於是乎就找瞭一些通過應用自動創建表的解決方案,其中本人比較熟悉使用 MyBatis,所以通過博文的形式給大傢講解一下,如何在 SpringBoot 環境中,使用 Mybatis 動態的創建數據庫中的表的功能。

準備創建表的 SQL 語句

創建表 SQL 語句,內容如下:

CREATE TABLE IF NOT EXISTS `user`
(
    `id`       int(0)      NOT NULL AUTO_INCREMENT COMMENT '主鍵',
    `group_id` int(0)      NULL DEFAULT NULL COMMENT '組號',
    `username` varchar(20) NULL DEFAULT NULL COMMENT '用戶名',
    `password` varchar(20) NULL DEFAULT NULL COMMENT '密碼',
    PRIMARY KEY (`id`)
) ENGINE = InnoDB
  AUTO_INCREMENT = 9
  CHARACTER SET = utf8mb4 COMMENT ='用於測試的用戶表';

實現通過 MyBatis 創建數據庫表示例

目的就是解決通過 MyBatis 執行創建表的語句,從而實現創建數據庫中的表的功能,實現代碼如下:

在 Maven 中引入相關依賴

在 Maven的 pom.xml文件中,引入 SpringBoot、MySql、MyBytis 等依賴,內容如下:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.6.2</version>
    </parent>

    <groupId>club.mydlq</groupId>
    <artifactId>springboot-mybatis-create-table-example</artifactId>
    <version>1.0.0</version>
    <name>springboot-mybatis-example</name>
    <description>springboot mybatis create table example project</description>

    <properties>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <!-- Web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!-- Lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <!-- Mysql -->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>
        <!-- MyBatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.2.1</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

在 SpringBoot 配置文件中添加數據庫配置

在 SpringBoot 的 application.yml 文件中,添加數據庫連接的參數,配置內容如下:

spring:
  application:
    name: springboot-mybatis-create-table-example
  # 數據庫配置
  datasource:
    type: com.zaxxer.hikari.HikariDataSource
    driverClassName: com.mysql.cj.jdbc.Driver
    url: jdbc:mysql://127.0.0.1:3306/test?serverTimezone=Asia/Shanghai&useUnicode=true&useSSL=false&allowPublicKeyRetrieval=true
    hikari:
      pool-name: DatebookHikariCP
      minimum-idle: 5
      maximum-pool-size: 15
      max-lifetime: 1800000
      connection-timeout: 30000
      username: root
      password: 123456

# 指定 mapper 的 xml 文件位置
mybatis:
  mapper-locations: classpath:mappers/*.xml

創建測試的 Mapper 接口類

創建一個用戶建表的 MyBatis 的 Mapper 接口,代碼如下:

import org.apache.ibatis.annotations.Mapper;

@Mapper
public interface TableMapper {

    /**
     * 創建數據庫表
     *
     * @param tableName 表名稱
     */
    void createTable(String tableName);

}

創建與 Mapper 關聯的 XML 文件

創建一個用於和 Mapper 接口關聯的 xml 文件 TableMapper.xml,在裡面添加用於創建表的 SQL 語句,內容如下:

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="club.mydlq.mappers.TableMapper">

    <!--創建表的 SQL 語句-->
    <update id="createTable" parameterType="java.lang.String">
        CREATE TABLE IF NOT EXISTS `${tableName}`
        (
            `id`       int(0)      NOT NULL AUTO_INCREMENT COMMENT '主鍵',
            `group_id` int(0)      NULL DEFAULT NULL COMMENT '組號',
            `username` varchar(20) NULL DEFAULT NULL COMMENT '用戶名',
            `password` varchar(20) NULL DEFAULT NULL COMMENT '密碼',
            PRIMARY KEY (`id`)
        ) ENGINE = InnoDB
          AUTO_INCREMENT = 9
          CHARACTER SET = utf8mb4 COMMENT ='用於測試的用戶表';
    </update>

</mapper>

創建用於測試的 Controller 類

創建一個用於測試的 Controller 類,裡面提供一個創建表的接口,代碼如下:

import club.mydlq.mappers.TableMapper;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;
import javax.annotation.Resource;

@RestController
public class TestController {

    @Resource
    private TableMapper tableMapper;

    /**
     * 創建數據庫表
     *
     * @param tableName 表名稱
     * @return 是否創建成功
     */
    @PostMapping("/createTable")
    public ResponseEntity<String> createTableTest(@RequestParam String tableName) {
        try {
            // 創建數據庫表
            tableMapper.createTable(tableName);
        } catch (Exception e) {
            return ResponseEntity.status(500).body("創建數據庫表失敗");
        }
        return ResponseEntity.ok("創建數據庫表成功");
    }

}

創建 SpringBoot 啟動類

創建一個用於啟動 SpringBoot 的啟動類,代碼如下:

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class Application {

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }

}

調用創建表的接口進行測試

執行 curl 命令,使用 POST 方法調用之前示例項目 Controller 類中提供的創建表接口 /createTable,在數據庫 test 中創建一個 user 表:

$ curl -X POST http://localhost:8080/createTable?tableName=user

執行完接口後,再進入數據庫,輸入下面命令觀察庫中是否創建包成功:

mysql> use test;
Database changed

mysql> show tables;
+----------------------------------------+
| Tables_in_test                         |
+----------------------------------------+
| user                                   |
+----------------------------------------+
1 rows in set (0.00 sec)

可以看到 test 庫中已經成功創建瞭 user 表。

到此這篇關於SpringBoot結合Mybatis實現創建數據庫表的方法的文章就介紹到這瞭,更多相關SpringBoot Mybatis創建數據庫表內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: