SpringBoot：Mybatis + Druid 資料通路

文章目錄

SpringBoot：Mybatis + Druid 資料通路

1、簡介
2、JDBC
3、CRUD操作
4、自定義資料源 DruidDataSource

1、配置 Druid 資料源監控
2、配置 Druid web 監控 filter

5、SpringBoot 整合mybatis

1、簡介

對于資料通路層，無論是SQL(關系型資料庫) 還是NOSQL(非關系型資料庫)，SpringBoot 底層都是采用 SpringData 的方式進行統一處理。

Spring Boot 底層都是采用 SpringData 的方式進行統一處理各種資料庫，SpringData也是Spring中與SpringBoot、SpringCloud 等齊名的知名項目。

SpingData 官網：https://spring.io/projects

資料庫相關的啟動器：可以參考官方文檔：https://docs.spring.io/springboot/docs/2.1.7.RELEASE/reference/htmlsingle/#using-boot-starter

2、JDBC

建立一個項目測試：springboot-data; 引入相應的子產品！基礎子產品

項目建好之後，發現自動幫我們導入了如下的啟動器：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <scope>runtime</scope>
</dependency>

實作資料庫的通路

先連接配接上資料庫，直接使用IDEA連接配接即可【操作】
SpringBoot中，我們隻需要簡單的配置就可以實作資料庫的連接配接了；

我們使用yaml的配置檔案進行操作！

spring:
  datasource:
    username: root
    password: 123456
    #?serverTimezone=UTC解決時區的報錯
    url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8

配置完這一些東西後，就可以直接去使用了，因為SpringBoot已經預設幫我們進行了自動配置；我們去測試類測試一下

package com.kk;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;

@SpringBootTest
class Springboot04DataApplicationTests {

    @Autowired
    DataSource dataSource;
    @Test
    void contextLoads() throws SQLException {
        //檢視預設的資料源 class com.zaxxer.hikari.HikariDataSource   dbcp
        System.out.println(dataSource.getClass());
        //獲得資料庫連接配接
        Connection connection = dataSource.getConnection();
        System.out.println(connection);
        connection.close();


    }

}

在運作的時候可能會遇到的Bug

SpringBoot 中 Invalid character found in the request target 異常

在啟動類中添加

@Bean
public ConfigurableServletWebServerFactory webServerFactory() {
    TomcatServletWebServerFactory factory = new TomcatServletWebServerFactory();
    factory.addConnectorCustomizers(new TomcatConnectorCustomizer() {
        @Override
        public void customize(Connector connector) {
            connector.setProperty("relaxedQueryChars", "|{}[]");
        }
    });
    return factory;
}

輸出結果：可以看到它預設給我們配置的資料源為 : class com.zaxxer.hikari.HikariDataSource ，我們并沒有手動配置

全局搜尋一下，找到資料源的所有自動配置都在：DataSourceProperties 檔案下；這裡自動配置的原理以及能配置哪些屬性？

Spring Boot 2.1.7 預設使用 com.zaxxer.hikari.HikariDataSource 資料源，
而以前版本，如 Spring Boot 1.5 預設使用 org.apache.tomcat.jdbc.pool.DataSource 作為資料源；

HikariDataSource 号稱 Java WEB 目前速度最快的資料源，相比于傳統的 C3P0 、DBCP、Tomcat jdbc 等連接配接池更加優秀；

有了資料庫連接配接，顯然就可以 CRUD 操作資料庫了。

3、CRUD操作

1、有了資料源(com.zaxxer.hikari.HikariDataSource)，可以拿到資料庫連接配接(java.sql.Connection)，有了連接配接，就可以使用連接配接和原生的 JDBC 語句來操作資料庫

2、即使不使用第三方第資料庫操作架構，如 MyBatis等，Spring 本身也對原生的JDBC 做了輕量級的封裝，即 org.springframework.jdbc.core.JdbcTemplate。

3、資料庫操作的所有 CRUD 方法都在 JdbcTemplate 中。

4、Spring Boot 不僅提供了預設的資料源，同時預設已經配置好了 JdbcTemplate 放在了容器中，程式員隻需自己注入即可使用

5、JdbcTemplate 的自動配置原理是依賴 org.springframework.boot.autoconfigure.jdbc 包下的 org.springframework.boot.autoconfigure.jdbc.JdbcTemplateAutoConfiguration 類

JdbcTemplate主要提供以下幾類方法：

execute方法：可以用于執行任何SQL語句，一般用于執行DDL語句；
update方法及batchUpdate方法：update方法用于執行新增、修改、删除等語句；batchUpdate方法用于執行批處理相關語句；
query方法及queryForxxx方法：用于執行查詢相關語句；
call方法：用于執行存儲過程、函數相關語句。

測試：

package com.kk.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;
import java.util.Map;

@RestController
public class JDBCController {
    
    //JdbcTemplate 是 core 包的核心類，用于簡化 JDBC操作，還能避免一些常見的錯誤，如忘記關閉資料庫連接配接
    //Spring Boot 預設提供了資料源，預設提供了 org.springframework.jdbc.core.JdbcTemplate
    //JdbcTemplate 中會自己注入資料源，使用起來也不用再自己來關閉資料庫連接配接
    @Autowired
    JdbcTemplate jdbcTemplate;
    
    //查詢資料庫的所有資訊
    //沒有實體類，資料庫中的東西怎麼擷取? Map
    //List 中的1個 Map 對應資料庫的 1行資料
    //Map 中的 key 對應資料庫的字段名，value 對應資料庫的字段值
    @GetMapping("/userList")
    public List<Map<String ,Object>> userList(){
        String sql="select * from user";
        List<Map<String, Object>> list_maps = jdbcTemplate.queryForList(sql);
        return list_maps;
    }

    @GetMapping("/addUser")
    public String addUser(){
        String sql="insert into mybatis.user(id,name,pwd) values(2,'dabai','123456')";
       jdbcTemplate.update(sql);
        return "update-ok";
    }

    @GetMapping("/updateUser/{id}")
    public String updateUser(@PathVariable("id") int id){
        String sql="update mybatis.user set name=?,pwd=? where id="+id;
        //封裝
        Object[] objects = new Object[2];
        objects[0]="xiaobai";
        objects[1]="9999999";
        jdbcTemplate.update(sql,objects);
        return "updateUser-ok";
    }

    @GetMapping("/deleteUser/{id}")
    public String deleteUser(@PathVariable("id") int id){
        String sql="delete from mybatis.user where id=?";
        jdbcTemplate.update(sql,id);
        return "deleteUser-ok";
    }
}

測試成功！

原理探究：

org.springframework.boot.autoconfigure.jdbc.DataSourceConfiguration 資料源配置類作用：根據邏輯判斷之後，添加資料源；

SpringBoot預設支援以下資料源：

com.zaxxer.hikari.HikariDataSource （Spring Boot 2.0 以上，預設使用此資料源）
org.apache.tomcat.jdbc.pool.DataSource
org.apache.commons.dbcp2.BasicDataSource

可以使用 spring.datasource.type 指定自定義的資料源類型，值為要使用的連接配接池實作的完全限定名。預設情況下，它是從類路徑自動檢測的。

@Configuration
    @ConditionalOnMissingBean({DataSource.class})
    @ConditionalOnProperty(
        name = {"spring.datasource.type"}
    )
    static class Generic {
        Generic() {
        }

        @Bean
        public DataSource dataSource(DataSourceProperties properties) {
            return properties.initializeDataSourceBuilder().build();
        }
    }

4、自定義資料源 DruidDataSource

DRUID 簡介

Druid 是阿裡巴巴開源平台上一個資料庫連接配接池實作，結合了 C3P0、DBCP、PROXOOL 等 DB 池的優點，同時加入了日志監控。
Druid 可以很好的監控 DB 池連接配接和 SQL 的執行情況，天生就是針對監控而生的 DB 連接配接池。
Spring Boot 2.0 以上預設使用 Hikari 資料源，可以說 Hikari 與 Driud 都是目前 Java Web 上最優秀的資料源，我們來重點介紹 Spring Boot 如何內建 Druid 資料源，如何實作資料庫監控。

*com.alibaba.druid.pool.DruidDataSource 基本配置參數如下：*

配置	預設值	說明
name	配置這個屬性的意義在于，如果存在多個資料源，監控的時候可以通過名字來區分開來。如果沒有配置，将會生成一個名字，格式是：“DataSource-” + System.identityHashCode(this). 另外配置此屬性至少在1.0.5版本中是不起作用的，強行設定name會出錯詳情-點此處。
url	連接配接資料庫的url，不同資料庫不一樣。例如： mysql : jdbc:mysql://10.20.153.104:3306/druid2 oracle : jdbc:oracle:thin:@10.20.149.85:1521:ocnauto
username	連接配接資料庫的使用者名
password	連接配接資料庫的密碼。如果你不希望密碼直接寫在配置檔案中，可以使用ConfigFilter。詳細看這裡：https://github.com/alibaba/druid/wiki/使用ConfigFilter
driverClassName	根據url自動識别	這一項可配可不配，如果不配置druid會根據url自動識别dbType，然後選擇相應的driverClassName
initialSize	初始化時建立實體連接配接的個數。初始化發生在顯示調用init方法，或者第一次getConnection時
maxActive	8	最大連接配接池數量
maxIdle	8	已經不再使用，配置了也沒效果
minIdle	最小連接配接池數量
maxWait	擷取連接配接時最大等待時間，機關毫秒。配置了maxWait之後，預設啟用公平鎖，并發效率會有所下降，如果需要可以通過配置useUnfairLock屬性為true使用非公平鎖。
poolPreparedStatements	false	是否緩存preparedStatement，也就是PSCache。PSCache對支援遊标的資料庫性能提升巨大，比如說oracle。在mysql下建議關閉。
maxOpenPreparedStatements	-1	要啟用PSCache，必須配置大于0，當大于0時，poolPreparedStatements自動觸發修改為true。在Druid中，不會存在Oracle下PSCache占用記憶體過多的問題，可以把這個數值配置大一些，比如說100
validationQuery	用來檢測連接配接是否有效的sql，要求是一個查詢語句。如果validationQuery為null，testOnBorrow、testOnReturn、testWhileIdle都不會其作用。
validationQueryTimeout	機關：秒，檢測連接配接是否有效的逾時時間。底層調用jdbc Statement對象的void setQueryTimeout(int seconds)方法
testOnBorrow	true	申請連接配接時執行validationQuery檢測連接配接是否有效，做了這個配置會降低性能。
testOnReturn	false	歸還連接配接時執行validationQuery檢測連接配接是否有效，做了這個配置會降低性能
testWhileIdle	false	建議配置為true，不影響性能，并且保證安全性。申請連接配接的時候檢測，如果空閑時間大于timeBetweenEvictionRunsMillis，執行validationQuery檢測連接配接是否有效。
timeBetweenEvictionRunsMillis	1分鐘（1.0.14）	有兩個含義： 1) Destroy線程會檢測連接配接的間隔時間，如果連接配接空閑時間大于等于minEvictableIdleTimeMillis則關閉實體連接配接 2) testWhileIdle的判斷依據，詳細看testWhileIdle屬性的說明
numTestsPerEvictionRun	不再使用，一個DruidDataSource隻支援一個EvictionRun
minEvictableIdleTimeMillis	30分鐘（1.0.14）	連接配接保持空閑而不被驅逐的最長時間
connectionInitSqls	實體連接配接初始化的時候執行的sql
exceptionSorter	根據dbType自動識别	當資料庫抛出一些不可恢複的異常時，抛棄連接配接
filters	屬性類型是字元串，通過别名的方式配置擴充插件，常用的插件有：監控統計用的filter:stat 日志用的filter:log4j 防禦sql注入的filter:wall
proxyFilters	類型是List<com.alibaba.druid.filter.Filter>，如果同時配置了filters和proxyFilters，是組合關系，并非替換關系

引入資料源

<!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.6</version>
</dependency>

檢視項目依賴，導入成功！

切換資料源；

之前已經說過 Spring Boot 2.0 以上預設使用 com.zaxxer.hikari.HikariDataSource 資料源，可以通過 spring.datasource.type 指定資料源。

type:

設定資料源連接配接初始化大小、最大連接配接數、等待時間、最小連接配接數等設定項；

#Spring Boot 預設是不注入這些屬性值的，需要自己綁定
#druid 資料源專有配置
initialSize: 5
minIdle: 5
maxActive: 20
maxWait: 60000
timeBetweenEvictionRunsMillis: 60000
minEvictableIdleTimeMillis: 300000
validationQuery: SELECT 1 FROM DUAL
testWhileIdle: true
testOnBorrow: false
testOnReturn: false
poolPreparedStatements: true
#配置監控統計攔截的filters，stat:監控統計、log4j：日志記錄、wall：防禦sql注入
#如果允許時報錯  java.lang.ClassNotFoundException: org.apache.log4j.Priority
#則導入 log4j 依賴即可，Maven 位址： https://mvnrepository.com/artifact/log4j/log4j
filters: stat,wall,log4j
maxPoolPreparedStatementPerConnectionSize: 20
useGlobalDataSourceStat: true
connectionProperties:

log4****日志依賴

<!-- https://mvnrepository.com/artifact/log4j/log4j -->
<dependency>
    <groupId>log4j</groupId>
    <artifactId>log4j</artifactId>
    <version>1.2.17</version>
</dependency>

測試

public class SpringbootDemoDataApplicationTests {

    //注入資料源
    @Autowired
    DataSource dataSource;

    @Test
    public void contextLoads() throws SQLException {
        //看一下預設資料源
        System.out.println(dataSource.getClass());
        //獲得連接配接
        Connection connection =   dataSource.getConnection();
        System.out.println(connection);

        DruidDataSource druidDataSource = (DruidDataSource) dataSource;
        System.out.println("druidDataSource 資料源最大連接配接數：" + druidDataSource.getMaxActive());
        System.out.println("druidDataSource 資料源初始化連接配接數：" + druidDataSource.getInitialSize());

        //關閉連接配接
        connection.close();
    }

}

測試成功！

1、配置 Druid 資料源監控

Druid 資料源具有監控的功能，并提供了一個web界面友善使用者檢視，類似安裝路由器時，它也提供了一個預設的 web 頁面。

是以第一步需要設定 Druid 的背景管理頁面，比如登入賬号、密碼等配置背景管理；

package com.kk.config;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.servlet.Filter;
import javax.sql.DataSource;
import java.util.HashMap;
import java.util.Map;

@Configuration
public class DruidConfig {

    @ConfigurationProperties(prefix = "spring.datasource")  //關聯application.yaml中的spring.datasource
    @Bean
    public DataSource druidDataSource(){
        return new DruidDataSource();
    }

    //配置 Druid 監控管理背景的Servlet；
    //内置 Servler 容器時沒有web.xml檔案，是以使用 Spring Boot 的注冊 Servlet 方式
    @Bean
    public ServletRegistrationBean statViewServlet() {
        ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");

        Map<String, String> initParams = new HashMap<>();
        initParams.put("loginUsername", "admin"); //背景管理界面的登入賬号
        initParams.put("loginPassword", "123456"); //背景管理界面的登入密碼

        //背景允許誰可以通路
        //initParams.put("allow", "localhost")：表示隻有本機可以通路
        //initParams.put("allow", "")：為空或者為null時，表示允許所有通路
        initParams.put("allow", "");
        //deny：Druid 背景拒絕誰通路
        //initParams.put("kuangshen", "192.168.1.20");表示禁止此ip通路

        //設定初始化參數
        bean.setInitParameters(initParams);
        return bean;
        //這些參數可以在 com.alibaba.druid.support.http.StatViewServlet 的父類 com.alibaba.druid.support.http.ResourceServlet 中找到
    }



    //filter
    @Bean
    public FilterRegistrationBean webStatFilter(){
        FilterRegistrationBean<Filter> bean = new FilterRegistrationBean<>();
        bean.setFilter(new WebStatFilter());

        //可以過濾哪些請求？
        HashMap<String, String> initParameters = new HashMap<>();
        //這些東西不進行統計
        initParameters.put("exclusions","*.js,*.css,/druid/*");


        bean.setInitParameters(initParameters);
        return bean;
    }
}

測試通路！ http://localhost:8080/druid/login.html

2、配置 Druid web 監控 filter

這個過濾器的作用就是統計 web 應用請求中所有的資料庫資訊，比如發出的 sql 語句，sql 執行的時間、請求次數、請求的 url 位址、以及seesion 監控、資料庫表的通路次數等等。

//filter
@Bean
public FilterRegistrationBean webStatFilter(){
    FilterRegistrationBean<Filter> bean = new FilterRegistrationBean<>();
    bean.setFilter(new WebStatFilter());

    //可以過濾哪些請求？
    HashMap<String, String> initParameters = new HashMap<>();
    //這些東西不進行統計
    initParameters.put("exclusions","*.js,*.css,/druid/*");


    bean.setInitParameters(initParameters);
    return bean;
}

執行sql

執行sql之後會有記錄

5、SpringBoot 整合mybatis

1. 導入mybatis所需要的依賴

<!-- https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter -->
<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.2.0</version>
</dependency>

2.配置資料庫連接配接資訊

# 資料庫驅動：
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
# 資料源名稱
spring.datasource.name=defaultDataSource
# 資料庫連接配接位址
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
# 資料庫使用者名&密碼：
spring.datasource.username=root
spring.datasource.password=123456

測試一下連接配接是否成功！

package com.kk;

import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import javax.sql.DataSource;
import java.sql.SQLException;

@SpringBootTest
class Springboot05MybatisApplicationTests {

    @Autowired
    DataSource dataSource;
    @Test
    void contextLoads() throws SQLException {
        System.out.println(dataSource.getClass());
        System.out.println(dataSource.getConnection());
    }

}

測試成功！

3，建立實體類

package com.kk.pojo;

public class User {
    private int id;
    private String name;
    private String pwd;

    public User() {
    }

    public User(int id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }

    public int getId() {
        return id;
    }

    public void setId(int id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pwd='" + pwd + '\'' +
                '}';
    }
}

4.配置Mapper接口類

package com.kk.mapper;

import com.kk.pojo.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import java.util.List;

//這個注解表示 這是一個mybatis 的mapper類
@Mapper  //controller層
@Repository  //spring
public interface UserMapper {



    List<User> queryUserList();

    User queryUserById(int id);

    int addUser(User user);

    int updateUser(User user);

    int deleteUser(int id);




}

5.編寫controller

package com.kk.controller;

import com.kk.mapper.UserMapper;
import com.kk.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.List;

@RestController
public class UserController {

    @Autowired
    private UserMapper userMapper;

    @GetMapping("/queryUserList")
    public List<User> queryUserList(){
        List<User> userList = userMapper.queryUserList();
        for (User user : userList) {
            System.out.println(user);
        }
        return userList;
    }

    //根據id選擇使用者
    @GetMapping("/queryUserById")
    public String selectUserById(){
        User user = userMapper.queryUserById(1);
        System.out.println(user);
        return "ok";
    }
    //添加一個使用者
    @GetMapping("/addUser")
    public String addUser(){
        userMapper.addUser(new User(1,"大黃","9999999"));
        userMapper.addUser(new User(3,"大黃","9999999"));
        userMapper.addUser(new User(4,"大黃","9999999"));

        return "ok";
    }
    //修改一個使用者
    @GetMapping("/updateUser")
    public String updateUser(){
        userMapper.updateUser(new User(5,"黃毛","999999"));
        return "ok";
    }
    //根據id删除使用者
    @GetMapping("/deleteUser")
    public String deleteUser(){
        userMapper.deleteUser(5);
        return "ok";
    }
}

6.SpringBoot 整合

以前 MyBatis 未與 spring 整合時，配置資料源、事務、連接配接資料庫的賬号、密碼等都是在 myBatis 核心配置檔案中進行的

myBatis 與 springboot 整合後，配置資料源、事務、連接配接資料庫的賬号、密碼等就交由 spring 管理。是以，在這裡我們即使不使用mybatis配置檔案也完全ok！

既然已經提供了 myBatis 的映射配置檔案，就需要告訴 spring boot 這些檔案的位置

# 整合mybatis
# 設定别名以及設定能讓spring識别
#指定myBatis的核心配置檔案與Mapper映射檔案
# 注意：對應實體類的路徑
mybatis.type-aliases-package=com.kk.pojo
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

springboot 官方并沒有提供 myBaits 的啟動器，是 myBatis 官方提供的開發包來适配的 spring boot，從 pom.xml 檔案中的依賴包名也能看出來，并非是以 spring-boot 開頭的；

同理上面全局配置檔案中的這兩行配置也是以 mybatis 開頭而非 spring 開頭也充分說明這些都是 myBatis 官方提供的

@ConfigurationProperties(
    prefix = "mybatis"
)
public class MybatisProperties {
    public static final String MYBATIS_PREFIX = "mybatis";
    private static final ResourcePatternResolver resourceResolver = new PathMatchingResourcePatternResolver();
    private String configLocation;
    private String[] mapperLocations;
    private String typeAliasesPackage;
    private Class<?> typeAliasesSuperType;
    private String typeHandlersPackage;
    private boolean checkConfigLocation = false;
    private ExecutorType executorType;
    private Class<? extends LanguageDriver> defaultScriptingLanguageDriver;
    private Properties configurationProperties;
    @NestedConfigurationProperty
    private Configuration configuration;

[官方文檔](

SpringBoot：Mybatis + Druid 資料通路