MyBatis初級實戰之三：springboot集成druid

2021 年 1 月 19 日
筆記

OpenWrite版：

歡迎訪問我的GitHub

//github.com/zq2599/blog_demos

內容：所有原創文章分類匯總及配套源碼，涉及Java、Docker、Kubernetes、DevOPS等；

本文是《MyBatis初級實戰》系列的第三篇，我們將實戰springboot、mybatis、druid的集成，並驗證；

關於druid

Druid是資料庫連接池，並且能夠提供強大的監控和擴展功能；
官方GitHub地址：//github.com/alibaba/druid
本次集成使用了durid官方的starter，名為druid-spring-boot-starter，版本1.1.17，對應druid版本是1.1.17

本篇概覽

本文由以下內容組成：

新建springboot工程，裡面有詳細的集成druid的操作；
編寫和執行單元測試程式碼，並規避一個由集成druid帶來的問題；
啟動springboot應用，通過swagger驗證基本功能正常；
通過斷點，確認使用了druid連接池；
體驗druid提供的監控頁面；

源碼下載

如果您不想編碼，可以在GitHub下載所有源碼，地址和鏈接資訊如下表所示(//github.com/zq2599/blog_demos)：

名稱	鏈接	備註
項目主頁	//github.com/zq2599/blog_demos	該項目在GitHub上的主頁
git倉庫地址(https)	//github.com/zq2599/blog_demos.git	該項目源碼的倉庫地址，https協議
git倉庫地址(ssh)	[email protected]:zq2599/blog_demos.git	該項目源碼的倉庫地址，ssh協議

這個git項目中有多個文件夾，本章的應用在mybatis文件夾下，如下圖紅框所示：

springboot+mybatis+druid+swagger集成步驟小結

將整個集成所需步驟列舉如下，避免遺漏：

創建springboot工程；
pom.xml中加入mybaits、druid、swagger依賴；
配置mybatis-config.xml；
配置application.yml，裡面有數據源、mybatis、druid；
springboot啟動類，指定MapperScan；
swagger配置類；
druid配置類；
資料庫實體類；
mybatis的mapper配置文件；
mybatis的mapper類；
業務程式碼；

後續按照上述清單進行開發即可；

開發

本文的實戰使用的資料庫和表結構與《MyBatis初級實戰之一：Spring Boot集成》一模一樣；
前文《MyBatis初級實戰之一：Spring Boot集成》創建了父工程mybatis，本文繼續在此工程中新增子工程，名為druidonesource，整個子工程文件結構如下：

3. 在父工程中添加druid的版本管理：

            <dependency>
                <groupId>com.alibaba</groupId>
                <artifactId>druid-spring-boot-starter</artifactId>
                <version>1.1.17</version>
            </dependency>

新工程druidonesource的pom.xml內容如下：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="//maven.apache.org/POM/4.0.0" xmlns:xsi="//www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="//maven.apache.org/POM/4.0.0 //maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.bolingcavalry</groupId>
        <artifactId>mybatis</artifactId>
        <version>1.0-SNAPSHOT</version>
        <relativePath>../pom.xml</relativePath>
    </parent>

    <groupId>com.bolingcavalry</groupId>
    <artifactId>druidonesource</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>druidonesource</name>
    <description>Demo project for Mybatis Druid (one datasource) in Spring Boot</description>

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

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintage</groupId>
                    <artifactId>junit-vintage-engine</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <!-- swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>com.google.code.gson</groupId>
            <artifactId>gson</artifactId>
        </dependency>
    </dependencies>

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

</project>

新建mybatis-config.xml：

<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "//mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <typeAliases>
        <!-- 映射文件中的類不用寫全路徑了-->
        <package name="com.bolingcavalry.druidonesource.entity"/>
    </typeAliases>
</configuration>

配置application.yml，請重點關注druid的配置，還請注意stat-view-servlet，這裡是druid監控頁面的登錄配置：

server:
  port: 8080

spring:
  #1.JDBC數據源
  datasource:
    username: root
    password: 123456
    url: jdbc:mysql://192.168.50.43:3306/mybatis?useUnicode=true&characterEncoding=utf-8&useSSL=true&serverTimezone=UTC
    driver-class-name: com.mysql.cj.jdbc.Driver
    #2.連接池配置
    druid:
      #初始化連接池的連接數量 大小，最小，最大
      initial-size: 5
      min-idle: 5
      max-active: 20
      #配置獲取連接等待超時的時間
      max-wait: 60000
      #配置間隔多久才進行一次檢測，檢測需要關閉的空閑連接，單位是毫秒
      time-between-eviction-runs-millis: 60000
      # 配置一個連接在池中最小生存的時間，單位是毫秒
      min-evictable-idle-time-millis: 30000
      # 配置一個連接在池中最大生存的時間，單位是毫秒
      max-evictable-idle-time-millis: 300000
      validation-query: SELECT 1 FROM user
      test-while-idle: true
      test-on-borrow: true
      test-on-return: false
      # 是否快取preparedStatement，也就是PSCache  官方建議MySQL下建議關閉   個人建議如果想用SQL防火牆 建議打開
      pool-prepared-statements: true
      max-pool-prepared-statement-per-connection-size: 20
      # 配置監控統計攔截的filters，去掉後監控介面sql無法統計，'wall'用於防火牆
      filters: stat,wall,slf4j
      filter:
        stat:
          merge-sql: true
          slow-sql-millis: 5000
      #3.基礎監控配置
      web-stat-filter:
        enabled: true
        url-pattern: /*
        #設置不統計哪些URL
        exclusions: "*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*"
        session-stat-enable: true
        session-stat-max-count: 100
      stat-view-servlet:
        enabled: true
        url-pattern: /druid/*
        reset-enable: true
        #設置監控頁面的登錄名和密碼
        login-username: admin
        login-password: admin
        allow: 127.0.0.1
        #deny: 192.168.1.100

# mybatis配置
mybatis:
  # 配置文件所在位置
  config-location: classpath:mybatis-config.xml
  # 映射文件所在位置
  mapper-locations: classpath:mappers/*Mapper.xml

# 日誌配置
logging:
  level:
    root: INFO
    com:
      bolingcavalry:
        druidonesource:
          mapper: debug

創建啟動類，要帶上MapperScan註解：

package com.bolingcavalry.druidonesource;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.bolingcavalry.druidonesource.mapper")
public class DuridOneSourceApplication {

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

創建swagger配置類：

package com.bolingcavalry.druidonesource;

import springfox.documentation.service.Contact;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Tag;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @Description: swagger配置類
 * @author: willzhao E-mail: [email protected]
 * @date: 2020/8/11 7:54
 */
@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .tags(new Tag("UserController", "用戶服務"), new Tag("LogController", "日誌服務"))
                .select()
                // 當前包路徑
                .apis(RequestHandlerSelectors.basePackage("com.bolingcavalry.druidonesource.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    //構建 api文檔的詳細資訊函數,注意這裡的註解引用的是哪個
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //頁面標題
                .title("MyBatis CURD操作")
                //創建人
                .contact(new Contact("程式設計師欣宸", "//github.com/zq2599/blog_demos", "[email protected]"))
                //版本號
                .version("1.0")
                //描述
                .description("API 描述")
                .build();
    }
}

創建druid配置類，如下，可見是通過使用application.yml中配置的參數對DruidDataSource進行配置：

package com.bolingcavalry.druidonesource;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @Description: druid配置類
 * @author: willzhao E-mail: [email protected]
 * @date: 2020/8/18 08:12
 */
@Configuration
public class DruidConfig {

    private static final Logger logger = LoggerFactory.getLogger(DruidConfig.class);

    @Value("${spring.datasource.url}")
    private String dbUrl;
    @Value("${spring.datasource.username}")
    private String username;
    @Value("${spring.datasource.password}")
    private String password;
    @Value("${spring.datasource.driver-class-name}")
    private String driverClassName;
    @Value("${spring.datasource.druid.initial-size}")
    private int initialSize;
    @Value("${spring.datasource.druid.max-active}")
    private int maxActive;
    @Value("${spring.datasource.druid.min-idle}")
    private int minIdle;
    @Value("${spring.datasource.druid.max-wait}")
    private int maxWait;
    @Value("${spring.datasource.druid.pool-prepared-statements}")
    private boolean poolPreparedStatements;
    @Value("${spring.datasource.druid.max-pool-prepared-statement-per-connection-size}")
    private int maxPoolPreparedStatementPerConnectionSize;
    @Value("${spring.datasource.druid.time-between-eviction-runs-millis}")
    private int timeBetweenEvictionRunsMillis;
    @Value("${spring.datasource.druid.min-evictable-idle-time-millis}")
    private int minEvictableIdleTimeMillis;
    @Value("${spring.datasource.druid.max-evictable-idle-time-millis}")
    private int maxEvictableIdleTimeMillis;
    @Value("${spring.datasource.druid.validation-query}")
    private String validationQuery;
    @Value("${spring.datasource.druid.test-while-idle}")
    private boolean testWhileIdle;
    @Value("${spring.datasource.druid.test-on-borrow}")
    private boolean testOnBorrow;
    @Value("${spring.datasource.druid.test-on-return}")
    private boolean testOnReturn;
    @Value("${spring.datasource.druid.filters}")
    private String filters;
    @Value("{spring.datasource.druid.connection-properties}")
    private String connectionProperties;

    /**
     * Druid 連接池配置
     */
    @Bean
    public DruidDataSource dataSource() {
        DruidDataSource datasource = new DruidDataSource();
        datasource.setUrl(dbUrl);
        datasource.setUsername(username);
        datasource.setPassword(password);
        datasource.setDriverClassName(driverClassName);
        datasource.setInitialSize(initialSize);
        datasource.setMinIdle(minIdle);
        datasource.setMaxActive(maxActive);
        datasource.setMaxWait(maxWait);
        datasource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);
        datasource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
        datasource.setMaxEvictableIdleTimeMillis(minEvictableIdleTimeMillis);
        datasource.setValidationQuery(validationQuery);
        datasource.setTestWhileIdle(testWhileIdle);
        datasource.setTestOnBorrow(testOnBorrow);
        datasource.setTestOnReturn(testOnReturn);
        datasource.setPoolPreparedStatements(poolPreparedStatements);
        datasource.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);
        try {
            datasource.setFilters(filters);
        } catch (Exception e) {
            logger.error("druid configuration initialization filter", e);
        }
        datasource.setConnectionProperties(connectionProperties);
        return datasource;
    }

}

接下來的數據實體類、mapper配置、mapper介面類、業務程式碼等，除了package不一樣，其他的與上一章《MyBatis初級實戰之二：增刪改查》一模一樣，請參考github源碼或者上一篇文章來編寫，這裡就不佔篇幅了；

單元測試（特別注意）

單元測試時有個問題要特別注意，就是關閉監控功能，否則會導致單元測試失敗；

新建名為application-test.yml的文件，內容和application.yml一樣，僅下圖紅框中的值不同：

單元測試類UserControllerTest的內容與上一章《MyBatis初級實戰之二：增刪改查》一樣，僅下圖紅框位置是新增的，用於指定使用application-test.yml配置文件:

驗證，單元測試

如下圖紅框的操作，即可完成單元測試：

驗證，swagger

運行DuridOneSourceApplication類啟動應用；
瀏覽器打開：//localhost:8080/swagger-ui.htm，操作如下：

3. 得到響應操作成功，並返回了主鍵ID：

其他介面也可以通過類似操作在swagger頁面上完成；

確認使用了druid連接池

上面的操作證明咱們的spring boot應用可以操作資料庫，但沒辦法證明用的是druid數據源（沒準用的還是spring boot的默認datasource），因此需要有種更直接的方式來檢查數據源詳情，因此採用了打斷點的手段，查看數據源實例；
給UserMapper介面insertWithFields方法的打上斷點，如下圖紅框：

3. 如下圖，在DuridOneSourceApplication類上點擊滑鼠右鍵，選擇紅框中的選項，即可以debug的方式啟動應用：