Spring Boot操作数据库学习之整合Druid

矫情吗；* 2024-03-27 08:52 81阅读 0赞

#### 文章目录 ####

*  一 Druid 简介
 *  二 配置数据源
 *   *  创建项目步骤及数据库内容
 *  三 整合操作
 *   *  3.1 添加Druid数据源依赖
     *  3.2 编写配置文件
     *  3.3 测试
     *  3.4 自定义绑定数据源设置
     *  3.5 导入Log4j的依赖&配置日志输出
     *  3.6 添加DruidDataSource组件
     *  3.7 测试
     *  3.8 配置 Druid 数据源监控
     *  3.9 配置过滤器

## 一 Druid 简介 ##

*  Java程序很大一部分要操作数据库，为了提高性能操作数据库的时候，又不得不使用数据库连接池。
 *  Druid 是阿里巴巴开源平台上一个数据库连接池实现，结合了 C3P0、DBCP 等 DB 池的优点，同时加入了日志监控。
 *  Druid 可以很好的监控 DB 池连接和 SQL 的执行情况，天生就是针对监控而生的 DB 连接池。
 *  Spring Boot 2.0 以上默认使用 Hikari 数据源，Hikari 与 Driud 都是当前 Java Web 上最优秀的数据源。
 *  [Druid GitHub地址][Druid GitHub]
 *  com.alibaba.druid.pool.DruidDataSource 基本配置参数

<table> 
 <thead> 
  <tr> 
   <th>配置</th> 
   <th>缺省值</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>name</td> 
   <td></td> 
   <td>意义：如果存在多个数据源，监控的时候可以通过名字来区分开来。 如果没有配置，将会生成一个名字，格式是：<code>"DataSource-" +System.identityHashCode(this)</code></td> 
  </tr> 
  <tr> 
   <td>url</td> 
   <td></td> 
   <td>连接数据库的url，不同数据库不一样。例如： <code>mysql :jdbc:mysql://10.20.153.104:3306/druid2</code> <code>oracle :jdbc:oracle:thin:@10.20.149.85:1521:ocnauto</code></td> 
  </tr> 
  <tr> 
   <td>username</td> 
   <td></td> 
   <td>连接数据库的用户名</td> 
  </tr> 
  <tr> 
   <td>password</td> 
   <td></td> 
   <td>连接数据库的密码。如果你不希望密码直接写在配置文件中，可以使用ConfigFilter。</td> 
  </tr> 
  <tr> 
   <td>driverClassName</td> 
   <td>根据url自动识别</td> 
   <td>非必须配置，如果不配置druid会根据url自动识别dbType，然后选择相应的driverClassName</td> 
  </tr> 
  <tr> 
   <td>initialSize</td> 
   <td>0</td> 
   <td>初始化时建立物理连接的个数。初始化发生在显示调用init方法，或者第一次getConnection时</td> 
  </tr> 
  <tr> 
   <td>maxActive</td> 
   <td>8</td> 
   <td>最大连接池数量</td> 
  </tr> 
  <tr> 
   <td>minIdle</td> 
   <td></td> 
   <td>最小连接池数量</td> 
  </tr> 
  <tr> 
   <td>maxWait</td> 
   <td></td> 
   <td>获取连接时最大等待时间，单位毫秒。配置了maxWait之后，缺省启用公平锁，并发效率会有所下降，如果需要，可以通过配置useUnfairLock属性为true使用非公平锁。</td> 
  </tr> 
  <tr> 
   <td>poolPreparedStatements</td> 
   <td>false</td> 
   <td>是否缓存preparedStatement，也就是PSCache。PSCache对支持游标的数据库性能提升巨大，比如说oracle。在mysql下建议关闭。</td> 
  </tr> 
  <tr> 
   <td>maxOpenPreparedStatements</td> 
   <td>-1</td> 
   <td>要启用PSCache，必须配置大于0，当大于0时，poolPreparedStatements自动触发修改为true。在Druid中，不会存在Oracle下PSCache占用内存过多的问题，可以把这个数值配置大一些，比如说100</td> 
  </tr> 
  <tr> 
   <td>validationQuery</td> 
   <td></td> 
   <td>用来检测连接是否有效的sql，要求是一个查询语句。如果validationQuery为null，testOnBorrow、testOnReturn、testWhileIdle都不会其作用。</td> 
  </tr> 
  <tr> 
   <td>validationQueryTimeout</td> 
   <td></td> 
   <td>单位：秒，检测连接是否有效的超时时间。底层调用jdbcStatement对象的void setQueryTimeout(int seconds)方法</td> 
  </tr> 
  <tr> 
   <td>testOnBorrow</td> 
   <td>true</td> 
   <td>申请连接时执行validationQuery检测连接是否有效，这个配置会降低性能。</td> 
  </tr> 
  <tr> 
   <td>testOnReturn</td> 
   <td>false</td> 
   <td>归还连接时执行validationQuery检测连接是否有效，这个配置会降低性能</td> 
  </tr> 
  <tr> 
   <td>testWhileIdle</td> 
   <td>false</td> 
   <td>建议配置为true，不影响性能，并且保证安全性。申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。</td> 
  </tr> 
  <tr> 
   <td>timeBetweenEvictionRunsMillis</td> 
   <td>1分钟（1.0.14）</td> 
   <td>有两个含义： 
    <hr> 1) Destroy线程会检测连接的间隔时间，如果连接空闲时间大于等于minEvictableIdleTimeMillis则关闭物理连接. 
    <hr>2) testWhileIdle的判断依据，详细看testWhileIdle属性的说明</td> 
  </tr> 
  <tr> 
   <td>numTestsPerEvictionRun</td> 
   <td></td> 
   <td>不再使用，一个DruidDataSource只支持一个EvictionRun</td> 
  </tr> 
  <tr> 
   <td>minEvictableIdleTimeMillis</td> 
   <td>30分钟（1.0.14）连接保持空闲而不被驱逐的最长时间</td> 
   <td></td> 
  </tr> 
  <tr> 
   <td>connectionInitSqls</td> 
   <td></td> 
   <td>物理连接初始化的时候执行的sql</td> 
  </tr> 
  <tr> 
   <td>exceptionSorter</td> 
   <td>根据dbType自动识别</td> 
   <td>当数据库抛出一些不可恢复的异常时，抛弃连接</td> 
  </tr> 
  <tr> 
   <td>filters</td> 
   <td></td> 
   <td>属性类型是字符串，通过别名的方式配置扩展插件，常用的插件有： 监控统计用的filter:stat 日志用的filter:log4j防御sql注入的filter:wall</td> 
  </tr> 
  <tr> 
   <td>proxyFilters</td> 
   <td></td> 
   <td>类型是List&lt;com.alibaba.druid.filter.Filter&gt;，如果同时配置了filters和proxyFilters，是组合关系，并非替换关系</td> 
  </tr> 
 </tbody> 
</table>

## 二 配置数据源 ##

### 创建项目步骤及数据库内容 ###

*  同[Spring Boot操作数据库学习之整合JDBC2.1~2.3][Spring Boot_JDBC2.1_2.3]

## 三 整合操作 ##

### 3.1 添加Druid数据源依赖 ###

<dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>druid</artifactId>
        <version>1.2.15</version>
    </dependency>

### 3.2 编写配置文件 ###

spring:
      datasource:
        username: root
        password: xxxx
        url: jdbc:mysql://localhost:3306/mybatis?useSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
        # 自定义数据源
        type: com.alibaba.druid.pool.DruidDataSource

### 3.3 测试 ###

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 SpringbootDataApplicationTests {
        
    
        @Autowired
        DataSource dataSource;
        @Test
        void contextLoads() throws SQLException {
        
            //查看一下默认的数据源
            System.out.println(dataSource.getClass());
            Connection connection = dataSource.getConnection();
            System.out.println(connection);
            connection.close();
        }
    
    }

![在这里插入图片描述][ef48b508f01740af954dc03d787822a2.png]

*  出现`class com.alibaba.druid.pool.DruidDataSource`说明测试成功了

### 3.4 自定义绑定数据源设置 ###

*  设置数据源连接初始化大小、最大连接数、等待时间、最小连接数等设置项

#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

### 3.5 导入Log4j的依赖&配置日志输出 ###

*  在pom.xml中导入Log4j依赖

<dependency>
                <groupId>log4j</groupId>
                <artifactId>log4j</artifactId>
                <version>1.2.17</version>
            </dependency>

*  在resources目录下配置log4j.properties配置文件

log4j.rootLogger=DEBUG, stdout
    log4j.appender.stdout=org.apache.log4j.ConsoleAppender
    log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
    log4j.appender.stdout.layout.ConversionPattern=%5p [%t] - %m%n

### 3.6 添加DruidDataSource组件 ###

*  现在需要手动为 DruidDataSource 绑定全局配置文件中的参数，再添加到容器中，而不再使用 Spring Boot 的自动生成；需要手动添加DruidDataSource 组件到容器中，并绑定属性。

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;
    
    /**
     * @author 缘友一世
     * date 2023/1/21-22:21
     */
    @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();
        }
    
    }

### 3.7 测试 ###

@Test
        public void contextLoads2() 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();
        }

![在这里插入图片描述][a29abdc308404ade8db7c99c64a3d538.png]

### 3.8 配置 Druid 数据源监控 ###

*  Druid数据源具有监控的功能，并提供了一个web界面方便用户查看，类似安装路由器，提供了一个默认的web页面。

1.  设置 Druid 的后台管理页面，比如登录账号、密码 等；配置后台管理

//后台监控: web.xml ServletRegistrationBean
    //因为SpringBoot 内置了 servlet容器，所以没有web.xml 替代方法：ServletRegistrationBean
    @Bean
    public ServletRegistrationBean statViewServlet() {
        
        ServletRegistrationBean<StatViewServlet> bean = new ServletRegistrationBean<>(new StatViewServlet(),"/druid/*");
        //后台需要有人登录，账号密码设置
        HashMap<String, String> initParameters = new HashMap<>();
        //增加配置 登录key 是固定的 loginUsername LoginPassword
        initParameters.put("loginUsername","admin");
        initParameters.put("loginPassword","123456");
        //允许谁都可以访问
        initParameters.put("allow","");
        //禁止访问 initParameters.put("xxx","192.168.11.23");
        bean.setInitParameters(initParameters);//设置初始化参数
        return bean;
    }

1.  配置完毕后，我们可以选择访问`http://localhost:8080/druid/login.html`进行登录访问  
    ![在这里插入图片描述][86abea4342f747ac8266e419da01582f.png]  
    ![在这里插入图片描述][147b38411ef447449141797c2f06c98d.png]

### 3.9 配置过滤器 ###

//filter 过滤
    @Bean
    public FilterRegistrationBean webStatFilter() {
        
        FilterRegistrationBean bean = new FilterRegistrationBean();
        bean.setFilter(new WebStatFilter());
        Map<String, String> initParamenters = new HashMap<>();
        //这些东西不进行统计
        initParamenters.put("exelusions","*.js,/druid/*");
        bean.setInitParameters(initParamenters);
        return bean;
    }

*  配置 Druid web 监控 filter 过滤器平时在工作中，按需求进行配置即可，主要用作监控

[Druid GitHub]: https://github.com/alibaba/druid/
[Spring Boot_JDBC2.1_2.3]: https://blog.csdn.net/yang2330648064/article/details/128746995
[ef48b508f01740af954dc03d787822a2.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/6486c178dba3423fb81f3d1261d3da95.png
[a29abdc308404ade8db7c99c64a3d538.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/f47911414e7f477588914f712f83c03c.png
[86abea4342f747ac8266e419da01582f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/c3e03d2e6d0845b4a2e7d4ebcfe9ca88.png
[147b38411ef447449141797c2f06c98d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/7d0153f761734042b93115f4cf7d432d.png