spring boot 学习 Druid连接池的使用配置

Druid介绍

Druid是一个JDBC组件，druid 是阿里开源在 github 上面的数据库连接池,它包括三部分：
* DruidDriver 代理Driver，能够提供基于Filter－Chain模式的插件体系。
* DruidDataSource 高效可管理的数据库连接池。
* SQLParser 专门解析 sql 语句

Druid 有什么优点？(来源网络)
1. 可以监控数据库访问性能，Druid内置提供了一个功能强大的StatFilter插件，能够详细统计SQL的执行性能，这对于线上分析数据库访问性能有帮助。
2. 替换DBCP和C3P0。Druid提供了一个高效、功能强大、可扩展性好的数据库连接池。
3. 数据库密码加密。直接把数据库密码写在配置文件中，这是不好的行为，容易导致安全问题。DruidDruiver和DruidDataSource都支持PasswordCallback。
4. SQL执行日志，Druid提供了不同的LogFilter，能够支持Common-Logging、Log4j和JdkLog，你可以按需要选择相应的LogFilter，监控你应用的数据库访问情况。
5. 扩展JDBC，如果你要对JDBC层有编程的需求，可以通过Druid提供的Filter-Chain机制，很方便编写JDBC层的扩展插件。
项目地址： https://github.com/alibaba/druid
Druid 问题集(中文文档)：https://github.com/alibaba/druid/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98

SpringBoot+Druid

1. 引入依赖

新建springboot项目，引入必要的依赖；再添加以下的依赖。

<!-- MySQL Driver驱动包 -->

      <dependency>

          <groupId>mysql</groupId>

          <artifactId>mysql-connector-java</artifactId>

          <version>5.1.38</version>

          <scope>runtime</scope>

      </dependency>

<!-- Spring Boot的JPA依赖包 -->

      <dependency>

          <groupId>org.springframework.boot</groupId>

          <artifactId>spring-boot-starter-data-jpa</artifactId>

      </dependency>

<!-- 阿里系的Druid依赖包 -->

      <dependency>

          <groupId>com.alibaba</groupId>

          <artifactId>druid</artifactId>

          <version>1.0.20</version>

      </dependency>

2. 添加配置文件

虽然spring boot可以不用配置xml，但是也并不是完全不需要配置文件，当然不用配置文件也能跑起来。
对于配置文件，我不太喜欢.yml，虽然它比较简洁，但使用.yml时，属性名的值和冒号中间必须有空格！如：name: rui才是正确的，name:rui将读取不出来。
于application.properties添加以下信息：

# 驱动配置信息

spring.datasource.type=com.alibaba.druid.pool.DruidDataSource

spring.datasource.url = jdbc:mysql://127.0.0.1:3306/myspringboot

spring.datasource.username = root

spring.datasource.password = 123456

spring.datasource.driverClassName = com.mysql.jdbc.Driver


# 连接池的配置信息

# 初始化大小，最小，最大

spring.datasource.initialSize=5

spring.datasource.minIdle=5

spring.datasource.maxActive=20

# 配置获取连接等待超时的时间

spring.datasource.maxWait=60000

# 配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒

spring.datasource.timeBetweenEvictionRunsMillis=60000

# 配置一个连接在池中最小生存的时间，单位是毫秒

spring.datasource.minEvictableIdleTimeMillis=300000

spring.datasource.validationQuery=SELECT 1 FROM DUAL

spring.datasource.testWhileIdle=true

spring.datasource.testOnBorrow=false

spring.datasource.testOnReturn=false

# 打开PSCache，并且指定每个连接上PSCache的大小

spring.datasource.poolPreparedStatements=true

spring.datasource.maxPoolPreparedStatementPerConnectionSize=20

# 配置监控统计拦截的filters，去掉后监控界面sql无法统计，'wall'用于防火墙

spring.datasource.filters=stat,wall,log4j

# 通过connectProperties属性来打开mergeSql功能；慢SQL记录

spring.datasource.connectionProperties=druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000

 下面就是datasource的配置，这样不写进代码有个好处，那就是如果是给客户用的程序，可以很方便的修改数据库配置，而不用重新编译。
* DataResource配置类

@Configuration

public class DruidDBConfig {

    private Logger logger = Logger.getLogger(DruidDBConfig.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.driverClassName}")

    private String driverClassName;


    @Value("${spring.datasource.initialSize}")

    private int initialSize;


    @Value("${spring.datasource.minIdle}")

    private int minIdle;


    @Value("${spring.datasource.maxActive}")

    private int maxActive;


    @Value("${spring.datasource.maxWait}")

    private int maxWait;


    @Value("${spring.datasource.timeBetweenEvictionRunsMillis}")

    private int timeBetweenEvictionRunsMillis;


    @Value("${spring.datasource.minEvictableIdleTimeMillis}")

    private int minEvictableIdleTimeMillis;


    @Value("${spring.datasource.validationQuery}")

    private String validationQuery;


    @Value("${spring.datasource.testWhileIdle}")

    private boolean testWhileIdle;


    @Value("${spring.datasource.testOnBorrow}")

    private boolean testOnBorrow;


    @Value("${spring.datasource.testOnReturn}")

    private boolean testOnReturn;


    @Value("${spring.datasource.poolPreparedStatements}")

    private boolean poolPreparedStatements;


    @Value("${spring.datasource.maxPoolPreparedStatementPerConnectionSize}")

    private int maxPoolPreparedStatementPerConnectionSize;


    @Value("${spring.datasource.filters}")

    private String filters;


    @Value("{spring.datasource.connectionProperties}")

    private String connectionProperties;


    @Bean     //声明其为Bean实例

    @Primary  //在同样的DataSource中，首先使用被标注的DataSource

    public DataSource dataSource() {

        DruidDataSource datasource = new DruidDataSource();


        datasource.setUrl(this.dbUrl);

        datasource.setUsername(username);

        datasource.setPassword(password);

        datasource.setDriverClassName(driverClassName);


        //configuration

        datasource.setInitialSize(initialSize);

        datasource.setMinIdle(minIdle);

        datasource.setMaxActive(maxActive);

        datasource.setMaxWait(maxWait);

        datasource.setTimeBetweenEvictionRunsMillis(timeBetweenEvictionRunsMillis);

        datasource.setMinEvictableIdleTimeMillis(minEvictableIdleTimeMillis);

        datasource.setValidationQuery(validationQuery);

        datasource.setTestWhileIdle(testWhileIdle);

        datasource.setTestOnBorrow(testOnBorrow);

        datasource.setTestOnReturn(testOnReturn);

        datasource.setPoolPreparedStatements(poolPreparedStatements);

        datasource.setMaxPoolPreparedStatementPerConnectionSize(maxPoolPreparedStatementPerConnectionSize);

        try {

            datasource.setFilters(filters);

        } catch (SQLException e) {

            logger.log(Level.ERROR, "druid configuration initialization filter : {0}", e);

        }

        datasource.setConnectionProperties(connectionProperties);


        return datasource;

    }

}

@Bean声明，DataSource 对象为 Spring 容器所管理;
@Primary表示这里定义的DataSource将覆盖其他来源的DataSource。

• Druid的Servlet与拦截器(用于查看Druid监控)
  (这两个类好像由开发团队提供了样例，所以直接使用网上资源，只需修改为自己想要的参数即可)

Druid的Servlet：

@WebServlet(urlPatterns="/druid/*",

        initParams={

                @WebInitParam(name="allow",value="127.0.0.1"),// IP白名单(没有配置或者为空，则允许所有访问)

                @WebInitParam(name="deny",value="192.168.1.73"),// IP黑名单 (存在共同时，deny优先于allow)

                @WebInitParam(name="loginUsername",value="admin"),// 用户名

                @WebInitParam(name="loginPassword",value="123456"),// 密码

                @WebInitParam(name="resetEnable",value="false")// 禁用HTML页面上的“Reset All”功能

})

public class DruidStatViewServlet extends StatViewServlet {

    private static final long serialVersionUID = -2688872071445249539L;


}

 Druid的拦截器：

@WebFilter(filterName="druidWebStatFilter",urlPatterns="/*",

        initParams={
               
@WebInitParam(name="exclusions",value="*.js,*.gif,*.jpg,*.bmp,*.png,*.css,*.ico,/druid/*")//忽略资源

        }

)


public class DruidStatFilter extends WebStatFilter {


}

 

3. 运行项目

启动springboot项目，访问 http://localhost:8080/druid/login.html 直接登录访问 Druid 的后台。

4. druid参数详解

配置	缺省值	说明
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自动识别
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，是组合关系，并非替换关系