Spring Boot项目配置Druid数据源(druid-spring-boot-starter)

Druid介绍

Druid是阿里巴巴的一个开源项目，号称为监控而生的数据库连接池，在功能、性能、扩展性方面都超过其他例如DBCP、C3P0、BoneCP、Proxool、JBoss DataSource等连接池,而且Druid已经在阿里巴巴部署了超过600个应用，通过了极为严格的考验，这才收获了大家的青睐！

Spring boot集成Druid

Apache Druid（Incubating） - 面向列的分布式数据存储，非常适合为交互式应用程序提供动力,开发中使用的更多。

以往我们都是直接引入Druid的依赖：

<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>       
    <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>com.alibaba<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>       
    <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>druid<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>       
    <span class="hljs-tag"><<span class="hljs-name">version</span>></span>1.1.12<span class="hljs-tag"></<span class="hljs-name">version</span>></span>   
<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>

apache中已经出了一套完美支持SpringBoot的方案所以说我们不使用上面的依赖而是使用：

<span class="hljs-tag"><<span class="hljs-name">dependency</span>></span>
    <span class="hljs-tag"><<span class="hljs-name">groupId</span>></span>com.alibaba<span class="hljs-tag"></<span class="hljs-name">groupId</span>></span>
    <span class="hljs-tag"><<span class="hljs-name">artifactId</span>></span>druid-spring-boot-starter<span class="hljs-tag"></<span class="hljs-name">artifactId</span>></span>
    <span class="hljs-tag"><<span class="hljs-name">version</span>></span>1.1.22<span class="hljs-tag"></<span class="hljs-name">version</span>></span>
<span class="hljs-tag"></<span class="hljs-name">dependency</span>></span>

两种依赖都可以，但是配置的方式有些不同，使用druid依赖项的，在配置的时候需要新建Druid的配置类文件，而druid-spring-boot-starter依赖项则不需要，这里我使用的druid-spring-boot-starter--更简单。

配置YML文件

<span class="hljs-attr">spring:</span>
  <span class="hljs-attr">datasource:</span>
    <span class="hljs-comment"># 数据源基本配置</span>
    <span class="hljs-attr">username:</span> <span class="hljs-string">root</span>
    <span class="hljs-attr">password:</span> <span class="hljs-string">XXXX</span>
    <span class="hljs-attr">url:</span> <span class="hljs-string">jdbc:mysql://XXX.XX.XX.XXX:33306/数据库名?useUnicode=true&characterEncoding=utf-8&useSSL=false&serverTimezone=Asia/Shanghai</span>
    <span class="hljs-comment"># driver-class需要注意mysql驱动的版本(com.mysql.cj.jdbc.Driver 或 com.mysql.jdbc.Driver)</span>
    <span class="hljs-attr">driver-class-name:</span> <span class="hljs-string">com.mysql.cj.jdbc.Driver</span>
    <span class="hljs-attr">type:</span> <span class="hljs-string">com.alibaba.druid.pool.DruidDataSource</span>
    <span class="hljs-comment"># Druid的其他属性配置</span>
    <span class="hljs-attr">druid:</span>
      <span class="hljs-comment"># 初始化时建立物理连接的个数</span>
      <span class="hljs-attr">initial-size:</span> <span class="hljs-number">5</span>
      <span class="hljs-comment"># 连接池的最小空闲数量</span>
      <span class="hljs-attr">min-idle:</span> <span class="hljs-number">5</span>
      <span class="hljs-comment"># 连接池最大连接数量</span>
      <span class="hljs-attr">max-active:</span> <span class="hljs-number">20</span>
      <span class="hljs-comment"># 获取连接时最大等待时间，单位毫秒</span>
      <span class="hljs-attr">max-wait:</span> <span class="hljs-number">60000</span>
      <span class="hljs-comment"># 申请连接的时候检测，如果空闲时间大于timeBetweenEvictionRunsMillis，执行validationQuery检测连接是否有效。</span>
      <span class="hljs-attr">test-while-idle:</span> <span class="hljs-literal">true</span>
      <span class="hljs-comment"># 既作为检测的间隔时间又作为testWhileIdel执行的依据</span>
      <span class="hljs-attr">time-between-eviction-runs-millis:</span> <span class="hljs-number">60000</span>
      <span class="hljs-comment"># 销毁线程时检测当前连接的最后活动时间和当前时间差大于该值时，关闭当前连接(配置连接在池中的最小生存时间)</span>
      <span class="hljs-attr">min-evictable-idle-time-millis:</span> <span class="hljs-number">30000</span>
      <span class="hljs-comment"># 用来检测数据库连接是否有效的sql 必须是一个查询语句(oracle中为 select 1 from dual)</span>
      <span class="hljs-attr">validation-query:</span> <span class="hljs-string">select</span> <span class="hljs-string">'x'</span>
      <span class="hljs-comment"># 申请连接时会执行validationQuery检测连接是否有效,开启会降低性能,默认为true</span>
      <span class="hljs-attr">test-on-borrow:</span> <span class="hljs-literal">false</span>
      <span class="hljs-comment"># 归还连接时会执行validationQuery检测连接是否有效,开启会降低性能,默认为true</span>
      <span class="hljs-attr">test-on-return:</span> <span class="hljs-literal">false</span>
      <span class="hljs-comment"># 是否缓存preparedStatement, 也就是PSCache,PSCache对支持游标的数据库性能提升巨大，比如说oracle,在mysql下建议关闭。</span>
      <span class="hljs-attr">pool-prepared-statements:</span> <span class="hljs-literal">false</span>
      <span class="hljs-comment"># 置监控统计拦截的filters，去掉后监控界面sql无法统计，stat: 监控统计、Slf4j:日志记录、waLL: 防御sqL注入</span>
      <span class="hljs-attr">filters:</span> <span class="hljs-string">stat,wall,slf4j</span>
      <span class="hljs-comment"># 要启用PSCache，必须配置大于0，当大于0时，poolPreparedStatements自动触发修改为true。在Druid中，不会存在Oracle下PSCache占用内存过多的问题，可以把这个数值配置大一些，比如说100</span>
      <span class="hljs-attr">max-pool-prepared-statement-per-connection-size:</span> <span class="hljs-number">-1</span>
      <span class="hljs-comment"># 合并多个DruidDataSource的监控数据</span>
      <span class="hljs-attr">use-global-data-source-stat:</span> <span class="hljs-literal">true</span>
      <span class="hljs-comment"># 通过connectProperties属性来打开mergeSql功能；慢SQL记录</span>
      <span class="hljs-attr">connect-properties:</span> <span class="hljs-string">druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000</span>

这里配置很重要，比如不配置filters的stat,我们在Druid的监控页面中就拿不到想要的信息。

新建配置文件

这里使用的是druid-spring-boot-starter的依赖项, 无需创建对应的Druid配置项, 但是如果使用的druid依赖项, 除了yml配置不同外, 还需要创建一个下面这样的配置文件

<span class="hljs-meta">@Configuration</span>
<span class="hljs-meta">@Slf4j</span>
<span class="hljs-keyword">public</span> <span class="hljs-class"><span class="hljs-keyword">class</span> <span class="hljs-title">DruidDatasrouceConfig</span> </span>{

    <span class="hljs-comment">/**
     * DruidDatasrouceConfig
     *
     * <span class="hljs-doctag">@return <span class="hljs-variable">DataSource</span></span>
     */</span>
    <span class="hljs-meta">@ConfigurationProperties</span>(prefix = <span class="hljs-string">"spring.datasource"</span>)
    <span class="hljs-meta">@Bean</span>
    <span class="hljs-keyword">public</span> DruidDataSource <span class="hljs-function"><span class="hljs-title">druidDataSource</span>()</span> {
        <span class="hljs-comment">//</span>
        DruidDataSource druidDataSource = <span class="hljs-keyword">new</span> DruidDataSource();

        log.info(<span class="hljs-string">"Datasource创建完成 ..."</span>);
        log.info(druidDataSource.toString());

        <span class="hljs-keyword">return</span> druidDataSource;
    }
}

配置监控

上边我们已经开启filters的stat监控统计插件，下边进行添加监控配置：

<span class="hljs-attr">spring:</span>
  <span class="hljs-attr">datasource:</span>
    <span class="hljs-attr">druid:</span>
      <span class="hljs-attr">web-stat-filter:</span>
        <span class="hljs-comment"># 是否启用StatFilter默认值true</span>
        <span class="hljs-attr">enabled:</span> <span class="hljs-literal">true</span>
        <span class="hljs-comment"># 添加过滤规则</span>
        <span class="hljs-attr">url-pattern:</span> <span class="hljs-string">/*</span>
        <span class="hljs-comment"># 忽略过滤的格式</span>
        <span class="hljs-attr">exclusions:</span> <span class="hljs-string">/druid/*,*.js,*.gif,*.jpg,*.png,*.css,*.ico</span>

StatViewServlet配置：Druid内置提供了一个StatViewServlet用于展示Druid的统计信息，StatViewServlet的用途包括：

提供监控信息展示的html页面
提供监控信息的JSON API

配置如下，需要注意的是用户名和密码：

<span class="hljs-attr">spring:</span>
  <span class="hljs-attr">datasource:</span>
    <span class="hljs-attr">druid:</span>
      <span class="hljs-attr">stat-view-servlet:</span>
        <span class="hljs-comment"># 是否启用StatViewServlet默认值true</span>
        <span class="hljs-attr">enabled:</span> <span class="hljs-literal">true</span>
        <span class="hljs-comment"># 访问路径为/druid时，跳转到StatViewServlet</span>
        <span class="hljs-attr">url-pattern:</span> <span class="hljs-string">/druid/*</span>
        <span class="hljs-comment"># 是否能够重置数据</span>
        <span class="hljs-attr">reset-enable:</span> <span class="hljs-literal">false</span>
        <span class="hljs-comment"># 需要账号密码才能访问控制台，默认为root</span>
        <span class="hljs-attr">login-username:</span> <span class="hljs-string">druid</span>
        <span class="hljs-attr">login-password:</span> <span class="hljs-string">druid</span>
        <span class="hljs-comment"># IP白名单</span>
        <span class="hljs-attr">allow:</span> <span class="hljs-number">127.0</span><span class="hljs-number">.0</span><span class="hljs-number">.1</span>
        <span class="hljs-comment"># IP黑名单（共同存在时，deny优先于allow）</span>
        <span class="hljs-attr">deny:</span>

到这里，关于Druid的配置就基本完成了, 想要了解更多的朋友，可以去查阅官方文档Druid github

验证Druid

我们直接启动项目，浏览器访问localhost:8080/druid或者127.0.0.1:8080/druid得到如下页面说明配置成功：

进入Druid的登陆页面，输入我们在配置文件中配置的用户名和密码登陆，进入下面的页面：

首页可以看到一些基本配置信息，点击菜单栏中的数据源可以查看到我们的数据源配置信息，以及连接池配置信息：

点击sql监控，查看执行sql信息：

发现此时没有任何sql执行记录，所以我们访问链接localhost:8080/user(自己整一个测试请求)，执行一次查询操作，再来查看 sql监控页面，发现已经有了一条记录：

点击该条记录可以查看更多详情，这里就不介绍了，配置成功的小伙伴们可以自己体验Druid的各种强大功能！

结语

到这里，Spring boot整合Druid的内容就介绍完了，希望对您有所帮助

https://www.cnblogs.com/no-celery/p/14381542.html