SpringBoot：Mybatis + Druid 數據訪問

2019 年 10 月 3 日
筆記

西部開源-秦疆老師：基於SpringBoot 2.1.7 的部落格教程

秦老師交流Q群號： 664386224

未授權禁止轉載！編輯不易，轉發請註明出處！防君子不防小人，共勉！

簡介

對於數據訪問層，無論是 SQL(關係型資料庫) 還是 NOSQL(非關係型資料庫)，Spring Boot 底層都是採用 Spring Data 的方式進行統一處理。

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

Sping Data 官網：https://spring.io/projects/spring-data

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

JDBC

我去新建一個項目測試：springboot_demo_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>

那我們到底應該怎麼寫才可以實現資料庫的訪問呢？

1. 我們先連接上資料庫，直接使用IDEA連接即可【操作】

2. SpringBoot中，我們只需要簡單的配置就可以實現資料庫的連接了；

我們使用yml的配置文件進行操作！

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

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

@RunWith(SpringRunner.class)  @SpringBootTest  public class SpringbootDemoDataApplicationTests {        //DI注入數據源      @Autowired      DataSource dataSource;        @Test      public void contextLoads() throws SQLException {          //看一下默認數據源          System.out.println(dataSource.getClass());          //獲得連接          Connection connection =   dataSource.getConnection();          System.out.println(connection);          //關閉連接          connection.close();      }    }

輸出結果：我們可以看到他默認給我們配置的數據源為 : 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 操作資料庫了。

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方法：用於執行存儲過程、函數相關語句。

測試

@RestController  public class JdbcController {        //JdbcTemplate 是 core 包的核心類，用於簡化 JDBC操作，還能避免一些常見的錯誤，如忘記關閉資料庫連接      //Spring Boot 默認提供了數據源，默認提供了 org.springframework.jdbc.core.JdbcTemplate      //JdbcTemplate 中會自己注入數據源，使用起來也不用再自己來關閉資料庫連接      @Autowired      JdbcTemplate jdbcTemplate;        //查詢student表中所有數據      //List 中的1個 Map 對應資料庫的 1行數據      //Map 中的 key 對應資料庫的欄位名，value 對應資料庫的欄位值      @GetMapping("/userList")      public List<Map<String, Object>> userList(){          String sql = "select * from user";          List<Map<String, Object>> maps = jdbcTemplate.queryForList(sql);          return maps;      }        //新增一個用戶      @GetMapping("/addUser")      public String addUser(){          //插入語句          String sql = "insert into mybatis.user(id, name, pwd) values (4,'小明','123456')";          jdbcTemplate.update(sql);          //查詢          return "addUser-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] = "小明2";          objects[1] = "zxcvbn";          jdbcTemplate.update(sql,objects);          //查詢          return "updateUser-ok";      }        //刪除用戶      @GetMapping("/delUser/{id}")      public String delUser(@PathVariable("id") int id){          //插入語句          String sql = "delete from user where id=?";          jdbcTemplate.update(sql,id);          //查詢          return "delUser-ok";      }    }

頁面訪問測試，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();          }      }

自定義數據源 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/%E4%BD%BF%E7%94%A8ConfigFilter
driverClassName	根據url自動識別	這一項可配可不配，如果不配置druid會根據url自動識別dbType，然後選擇相應的driverClassName
initialSize	0	初始化時建立物理連接的個數。初始化發生在顯示調用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，是組合關係，並非替換關係

引入數據源

第一步需要在應用的 pom.xml 文件中添加上 Druid 數據源依賴，而這個依賴可以從 Maven 倉庫官網 Maven Repository 中獲取

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

查看項目依賴，導入成功！

現在我們去切換數據源；

之前已經說過 Spring Boot 2.0 以上默認使用 com.zaxxer.hikari.HikariDataSource 數據源，但可以通過 spring.datasource.type 指定數據源。

數據源切換之後，同理可以注入 DataSource，然後獲取到它，輸出一看便知是否成功切換；

切換成功！既然切換成功，就可以設置數據源連接初始化大小、最大連接數、等待時間、最小連接數等設置項；

我們可以配置一些參數來測試一下；

spring:    datasource:      username: root      password: 123456      #?serverTimezone=UTC解決時區的報錯      url: jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8      driver-class-name: com.mysql.jdbc.Driver      type: com.alibaba.druid.pool.DruidDataSource        #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: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500

log4j日誌依賴

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

現在需要程式設計師自己為 com.alibaba.druid.pool.DruidDataSource 綁定全局配置文件中的參數，再添加到容器中，而不再使用 Spring Boot 的自動生成了；我們需要自己添加 DruidDataSource 組件到容器中，並綁定屬性；

package com.kuang.springdata.config;    import com.alibaba.druid.pool.DruidDataSource;  import org.springframework.boot.context.properties.ConfigurationProperties;  import org.springframework.context.annotation.Bean;  import org.springframework.context.annotation.Configuration;    import javax.sql.DataSource;    @Configuration  public class DruidConfig {        /*         將自定義的 Druid數據源添加到容器中，不再讓 Spring Boot 自動創建         綁定全局配置文件中的 druid 數據源屬性到 com.alibaba.druid.pool.DruidDataSource從而讓它們生效         @ConfigurationProperties(prefix = "spring.datasource")：作用就是將 全局配置文件中         前綴為 spring.datasource的屬性值注入到 com.alibaba.druid.pool.DruidDataSource 的同名參數中       */      @ConfigurationProperties(prefix = "spring.datasource")      @Bean      public DataSource druidDataSource() {          return new DruidDataSource();      }    }

去測試類中測試一下；看是否成功！

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();      }    }

輸出結果：可見配置參數已經生效

配置 Druid 數據源監控

Druid 數據源具有監控的功能，並提供了一個 web 介面方便用戶查看，類似安裝路由器時，人家也提供了一個默認的 web 頁面。

所以第一步需要設置 Druid 的後台管理頁面，比如登錄帳號、密碼等；配置後台管理；

    //配置 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 中找到      }

配置完畢後，我們可以選擇訪問： http://localhost:8080/druid/login.html

進入之後

配置 Druid web 監控 filter

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

    //配置 Druid 監控 之  web 監控的 filter      //WebStatFilter：用於配置Web和Druid數據源之間的管理關聯監控統計      @Bean      public FilterRegistrationBean webStatFilter() {          FilterRegistrationBean bean = new FilterRegistrationBean();          bean.setFilter(new WebStatFilter());            //exclusions：設置哪些請求進行過濾排除掉，從而不進行統計          Map<String, String> initParams = new HashMap<>();          initParams.put("exclusions", "*.js,*.css,/druid/*");          bean.setInitParameters(initParams);            //"/*" 表示過濾所有請求          bean.setUrlPatterns(Arrays.asList("/*"));          return bean;      }

配置完畢後，我們可以啟動來進行測試！

我們發送一條sql語句，然後來看一下後台的消息；

測試OK！

SpringBoot 整合mybatis

1. 導入mybatis所需要的依賴

        <!-- 引入 myBatis，這是 MyBatis官方提供的適配 Spring Boot 的，而不是Spring Boot自己的-->          <dependency>              <groupId>org.mybatis.spring.boot</groupId>              <artifactId>mybatis-spring-boot-starter</artifactId>              <version>2.1.0</version>          </dependency>

2.配置資料庫連接資訊

spring.datasource.username=root  spring.datasource.password=123456  spring.datasource.url=jdbc:mysql://localhost:3306/mybatis?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8  spring.datasource.driver-class-name=com.mysql.jdbc.Driver

我們這裡就是用默認的數據源了；先去測試一下連接是否成功！

@RunWith(SpringRunner.class)  @SpringBootTest  public class SpringbootDemoMybatisApplicationTests {        @Autowired      DataSource dataSource;        @Test      public void contextLoads() throws SQLException {            System.out.println("數據源>>>>>>" + dataSource.getClass());          Connection connection = dataSource.getConnection();          System.out.println("連接>>>>>>>>>" + connection);          System.out.println("連接地址>>>>>" + connection.getMetaData().getURL());          connection.close();        }    }

查看輸出結果，資料庫配置OK！

3，創建實體類

package com.kuang.mybatis.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.kuang.mybatis.pojo.mapper;    import com.kuang.mybatis.pojo.User;  import org.apache.ibatis.annotations.Mapper;  import org.springframework.stereotype.Repository;    import java.util.List;    //@Mapper : 表示本類是一個 MyBatis 的 Mapper，等價於以前 Spring 整合 MyBatis 時的 Mapper 介面  @Mapper  @Repository  public interface UserMapper {        //選擇全部用戶      List<User> selectUser();      //根據id選擇用戶      User selectUserById(int id);      //添加一個用戶      int addUser(User user);      //修改一個用戶      int updateUser(User user);      //根據id刪除用戶      int deleteUser(int id);    }

5.Mapper映射文件

<?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="com.kuang.mybatis.pojo.mapper.UserMapper">        <select id="selectUser" resultType="User">      select * from user    </select>        <select id="selectUserById" resultType="User">      select * from user where id = #{id}  </select>        <insert id="addUser" parameterType="User">      insert into user (id,name,pwd) values (#{id},#{name},#{pwd})  </insert>        <update id="updateUser" parameterType="User">      update user set name=#{name},pwd=#{pwd} where id = #{id}  </update>        <delete id="deleteUser" parameterType="int">      delete from user where id = #{id}  </delete>  </mapper>

6.SpringBoot 整合！

以前 MyBatis 未與 spring 整合時，配置數據源、事務、連接資料庫的帳號、密碼等都是在 myBatis 核心配置文件中進行的
myBatis 與 spring 整合後，配置數據源、事務、連接資料庫的帳號、密碼等就交由 spring 管理。因此，在這裡我們即使不使用mybatis配置文件也完全ok！
既然已經提供了 myBatis 的映射配置文件，自然要告訴 spring boot 這些文件的位置

#指定myBatis的核心配置文件與Mapper映射文件  mybatis.mapper-locations=classpath:mybatis/mapper/*.xml  # 注意：對應實體類的路徑  mybatis.type-aliases-package=com.kuang.mybatis.pojo

已經說過 spring boot 官方並沒有提供 myBaits 的啟動器，是 myBatis 官方提供的開發包來適配的 spring boot，從 pom.xml 文件中的依賴包名也能看出來，並非是以 spring-boot 開頭的；

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

可以從 org.mybatis.spring.boot.autoconfigure.MybatisProperties 中查看所有配置項

@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;

也可以直接去查看官方文檔

7.編寫controller

package com.kuang.mybatis.controller;    import com.kuang.mybatis.pojo.User;  import com.kuang.mybatis.pojo.mapper.UserMapper;    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("/selectUser")      public String selectUser(){          List<User> users = userMapper.selectUser();          for (User user : users) {              System.out.println(user);          }            return "ok";      }      //根據id選擇用戶      @GetMapping("/selectUserById")      public String selectUserById(){          User user = userMapper.selectUserById(1);          System.out.println(user);          return "ok";      }      //添加一個用戶      @GetMapping("/addUser")      public String addUser(){          userMapper.addUser(new User(5,"阿毛","456789"));          return "ok";      }      //修改一個用戶      @GetMapping("/updateUser")      public String updateUser(){          userMapper.updateUser(new User(5,"阿毛","421319"));          return "ok";      }      //根據id刪除用戶      @GetMapping("/deleteUser")      public String deleteUser(){          userMapper.deleteUser(5);          return "ok";      }    }

運行測試OK！