druid简单教程

原文：http://blog.csdn.net/yunnysunny/article/details/8657095
java程序很大一部分要操作数据库，为了提高性能操作数据库的时候，有不得不使用数据库连接池。数据库连接池有很多选择，c3p、dhcp、proxool等，druid作为一名后起之秀，凭借其出色的性能，也逐渐印入了大家的眼帘。接下来本教程就说一下druid的简单使用。

 首先从 下载最新的jar包。如果想使用最新的源码编译，可以从 下载源码，然后使用maven命令行，或者导入到eclipse中进行编译。

1 配置

和dbcp类似，druid的配置项如下

配置	缺省值	说明
name		配置这个属性的意义在于，如果存在多个数据源，监控的时候 可以通过名字来区分开来。如果没有配置，将会生成一个名字， 格式是："DataSource-" + System.identityHashCode(this)
jdbcUrl		连接数据库的url，不同数据库不一样。例如： mysql : jdbc:mysql://10.20.153.104:3306/druid2  oracle : jdbc:oracle:thin:@10.20.149.85:1521:ocnauto
username		连接数据库的用户名
password		连接数据库的密码。如果你不希望密码直接写在配置文件中， 可以使用ConfigFilter。详细看这里：
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都不会其作用。
testOnBorrow	true	申请连接时执行validationQuery检测连接是否有效， 做了这个配置会降低性能。
testOnReturn	false	归还连接时执行validationQuery检测连接是否有效， 做了这个配置会降低性能
testWhileIdle	false	建议配置为true，不影响性能，并且保证安全性。 申请连接的时候检测，如果空闲时间大于 timeBetweenEvictionRunsMillis， 执行validationQuery检测连接是否有效。
timeBetweenEvictionRunsMillis		有两个含义： 1) Destroy线程会检测连接的间隔时间  2) testWhileIdle的判断依据，详细看testWhileIdle属性的说明
numTestsPerEvictionRun		不再使用，一个DruidDataSource只支持一个EvictionRun
minEvictableIdleTimeMillis
connectionInitSqls		物理连接初始化的时候执行的sql
exceptionSorter	根据dbType自动识别	当数据库抛出一些不可恢复的异常时，抛弃连接
filters		属性类型是字符串，通过别名的方式配置扩展插件， 常用的插件有： 监控统计用的filter:stat  日志用的filter:log4j  防御sql注入的filter:wall
proxyFilters		类型是List， 如果同时配置了filters和proxyFilters， 是组合关系，并非替换关系

表1.1 配置属性

根据常用的配置属性，首先给出一个如下的配置文件，放置于src目录下。

1. url:jdbc:mysql://localhost:3306/dragoon_v25_masterdb  
2. driverClassName:com.mysql.jdbc.Driver  
3. username:root  
4. password:aaaaaaaa  
5.        
6. filters:stat  
7.    
8. maxActive:20  
9. initialSize:1  
10. maxWait:60000  
11. minIdle:10  
12. #maxIdle:15  
13.    
14. timeBetweenEvictionRunsMillis:60000  
15. minEvictableIdleTimeMillis:300000  
16.    
17. validationQuery:SELECT 'x'  
18. testWhileIdle:true  
19. testOnBorrow:false  
20. testOnReturn:false  
21. #poolPreparedStatements:true  
22. maxOpenPreparedStatements:20  
23.   
24. #对于长时间不使用的连接强制关闭  
25. removeAbandoned:true  
26. #超过30分钟开始关闭空闲连接  
27. removeAbandonedTimeout:1800  
28. #将当前关闭动作记录到日志  
29. logAbandoned:true  

配置文件1.1 

配置项中指定了各个参数后，在连接池内部是这么使用这些参数的。数据库连接池在初始化的时候会创建initialSize个连接，当有数据库操作时，会从池中取出一个连接。如果当前池中正在使用的连接数等于maxActive，则会等待一段时间，等待其他操作释放掉某一个连接，如果这个等待时间超过了maxWait，则会报错；如果当前正在使用的连接数没有达到maxActive，则判断当前是否空闲连接，如果有则直接使用空闲连接，如果没有则新建立一个连接。在连接使用完毕后，不是将其物理连接关闭，而是将其放入池中等待其他操作复用。

同时连接池内部有机制判断，如果当前的总的连接数少于miniIdle，则会建立新的空闲连接，以保证连接数得到miniIdle。如果当前连接池中某个连接在空闲了timeBetweenEvictionRunsMillis时间后任然没有使用，则被物理性的关闭掉。有些数据库连接的时候有超时限制（mysql连接在8小时后断开），或者由于网络中断等原因，连接池的连接会出现失效的情况，这时候设置一个testWhileIdle参数为true，可以保证连接池内部定时检测连接的可用性，不可用的连接会被抛弃或者重建，最大情况的保证从连接池中得到的Connection对象是可用的。当然，为了保证绝对的可用性，你也可以使用testOnBorrow为true（即在获取Connection对象时检测其可用性），不过这样会影响性能。

2 代码编写

2.1 使用spring

首先给出spring配置文件

xml version="1.0" encoding="UTF-8"?>
<beans xmlns=""
    xmlns:xsi=""
    xsi:schemaLocation="
         /spring-beans-3.0.xsd
        ">

    <bean id="propertyConfigurer"
        class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="locations">
            <list>
                <value>/WEB-INF/classes/dbconfig.propertiesvalue>
            list>
        property>
    bean>
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource"
        destroy-method="close">
        <property name="url" value="${url}" />
        <property name="username" value="${username}" />
        <property name="password" value="${password}" />
        <property name="driverClassName" value="${driverClassName}" />
        <property name="filters" value="${filters}" />

        <property name="maxActive" value="${maxActive}" />
        <property name="initialSize" value="${initialSize}" />
        <property name="maxWait" value="${maxWait}" />
        <property name="minIdle" value="${minIdle}" />

        <property name="timeBetweenEvictionRunsMillis" value="${timeBetweenEvictionRunsMillis}" />
        <property name="minEvictableIdleTimeMillis" value="${minEvictableIdleTimeMillis}" />

        <property name="validationQuery" value="${validationQuery}" />
        <property name="testWhileIdle" value="${testWhileIdle}" />
        <property name="testOnBorrow" value="${testOnBorrow}" />
        <property name="testOnReturn" value="${testOnReturn}" />
        <property name="maxOpenPreparedStatements"
            value="${maxOpenPreparedStatements}" />
        <property name="removeAbandoned" value="${removeAbandoned}" />
        <property name="removeAbandonedTimeout" value="${removeAbandonedTimeout}" />
        <property name="logAbandoned" value="${logAbandoned}" />
    bean>

    <bean id="dataSourceDbcp" class="org.apache.commons.dbcp.BasicDataSource"
        destroy-method="close">

        <property name="driverClassName" value="${driverClassName}" />
        <property name="url" value="${url}" />
        <property name="username" value="${username}" />
        <property name="password" value="${password}" />

        <property name="maxActive" value="${maxActive}" />
        <property name="minIdle" value="${minIdle}" />
        <property name="maxWait" value="${maxWait}" />
        <property name="defaultAutoCommit" value="true" />

        <property name="timeBetweenEvictionRunsMillis" value="${timeBetweenEvictionRunsMillis}" />
        <property name="minEvictableIdleTimeMillis" value="${minEvictableIdleTimeMillis}" />

        <property name="validationQuery" value="${validationQuery}" />
        <property name="testWhileIdle" value="${testWhileIdle}" />
        <property name="testOnBorrow" value="${testOnBorrow}" />
        <property name="testOnReturn" value="${testOnReturn}" />
        <property name="maxOpenPreparedStatements"
            value="${maxOpenPreparedStatements}" />
        <property name="removeAbandoned" value="${removeAbandoned}" />
        <property name="removeAbandonedTimeout" value="${removeAbandonedTimeout}" />
        <property name="logAbandoned" value="${logAbandoned}" />
    bean>



    <bean id="jdbc" class="org.springframework.jdbc.core.JdbcTemplate">
        <property name="dataSource">
            <ref bean="dataSource" />
        property>
    bean>

    <bean id="SpringTableOperatorBean" class="com.whyun.druid.model.TableOperator"
        scope="prototype">
        <property name="dataSource">
            <ref bean="dataSource" />
        property>
    bean>

beans>

配置文件2.1

其中第一个bean中给出的配置文件/WEB-INF/classes/dbconfig.properties就是第1节中给出的配置文件。我这里还特地给出dbcp的spring配置项，目的就是将两者进行对比，方便大家进行迁移。这里没有使用JdbcTemplate，所以jdbc那个bean没有使用到。下面给出com.whyun.druid.model.TableOperator类的代码。

package com.whyun.druid.model;

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.sql.Statement;

import javax.sql.DataSource;

public class TableOperator {
    private DataSource dataSource;
    public void setDataSource(DataSource dataSource) {
        this.dataSource = dataSource;
    }

    private static final int COUNT = 800;

    public TableOperator() {

    }

    public void tearDown() throws Exception {
        try {
            dropTable();
        } catch (SQLException e) {
            e.printStackTrace();
        }
    }

    public void insert() throws Exception {

        StringBuffer ddl = new StringBuffer();
        ddl.append("INSERT INTO t_big (");
        for (int i = 0; i < COUNT; ++i) {
            if (i != 0) {
                ddl.append(", ");
            }
            ddl.append("F" + i);
        }
        ddl.append(") VALUES (");
        for (int i = 0; i < COUNT; ++i) {
            if (i != 0) {
                ddl.append(", ");
            }
            ddl.append("?");
        }
        ddl.append(")");

        Connection conn = dataSource.getConnection();

//        System.out.println(ddl.toString());

        PreparedStatement stmt = conn.prepareStatement(ddl.toString());

        for (int i = 0; i < COUNT; ++i) {
            stmt.setInt(i + 1, i);
        }
        stmt.execute();
        stmt.close();

        conn.close();
    }

    private void dropTable() throws SQLException {

        Connection conn = dataSource.getConnection();

        Statement stmt = conn.createStatement();
        stmt.execute("DROP TABLE t_big");
        stmt.close();

        conn.close();
    }

    public void createTable() throws SQLException {
        StringBuffer ddl = new StringBuffer();
        ddl.append("CREATE TABLE t_big (FID INT AUTO_INCREMENT PRIMARY KEY ");
        for (int i = 0; i < COUNT; ++i) {
            ddl.append(", ");
            ddl.append("F" + i);
            ddl.append(" BIGINT NULL");
        }
        ddl.append(")");

        Connection conn = dataSource.getConnection();

        Statement stmt = conn.createStatement();
        stmt.execute(ddl.toString());
        stmt.close();

        conn.close();
    }
}

代码片段2.1

注意：在使用的时候，通过获取完Connection对象，在使用完之后，要将其close掉，这样其实是将用完的连接放入到连接池中，如果你不close的话，会造成连接泄露。

然后我们写一个servlet来测试他.

package com.whyun.druid.servelt;

import java.io.IOException;
import java.io.PrintWriter;
import java.sql.SQLException;

import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.WebApplicationContextUtils;

import com.whyun.druid.model.TableOperator;

public class TestServlet extends HttpServlet {
    private TableOperator operator;


    @Override
    public void init() throws ServletException {

        super.init();
         ServletContext servletContext = this.getServletContext();

         WebApplicationContext ctx
            = WebApplicationContextUtils.getWebApplicationContext(servletContext);
         operator = (TableOperator)ctx.getBean("SpringTableOperatorBean");
    }

    /**
     * The doGet method of the servlet.
     *
     * This method is called when a form has its tag value method equals to get.
     *
     * @param request the request send by the client to the server
     * @param response the response send by the server to the client
     * @throws ServletException if an error occurred
     * @throws IOException if an error occurred
     */
    public void doGet(HttpServletRequest request, HttpServletResponse response)
            throws ServletException, IOException {

        response.setContentType("text/html");
        PrintWriter out = response.getWriter();

        boolean createResult = false;
        boolean insertResult = false;
        boolean dropResult = false;

        try {
            operator.createTable();
            createResult = true;
        } catch (SQLException e) {
            e.printStackTrace();
        }
        if (createResult) {
            try {
                operator.insert();
                insertResult = true;
            } catch (Exception e) {
                e.printStackTrace();
            }
            try {
                operator.tearDown();
                dropResult = true;
            } catch (Exception e) {
                e.printStackTrace();
            }
        }


        out.println("{'createResult':"+createResult+",'insertResult':"
                +insertResult+",'dropResult':"+dropResult+"}");

        out.flush();
        out.close();
    }

}

代码片段2.2

这里没有用到struts2或者springmvc，虽然大部分开发者用的是这两种框架。

2.2 不使用spring

类似于dbcp，druid也提供了原生态的支持。先看下面这段代码：

package com.whyun.util.db;

import javax.sql.DataSource;

import org.apache.commons.dbcp.BasicDataSourceFactory;

import com.alibaba.druid.pool.DruidDataSourceFactory;
import com.whyun.util.config.MySqlConfigProperty;
import com.whyun.util.config.MySqlConfigProperty2;

/**
 * The Class DataSourceUtil.
 */
public class DataSourceUtil {

    /** 使用配置文件dbconfig.properties构建Druid数据源. */
    public static final int DRUID_MYSQL_SOURCE = 0;

    /** 使用配置文件dbconfig2.properties构建Druid数据源. */
    public static final int DRUID_MYSQL_SOURCE2 = 1;

    /** 使用配置文件dbconfig.properties构建Dbcp数据源. */
    public static final int DBCP_SOURCE = 4;

    /**
     * 根据类型获取数据源
     *
     * @param sourceType 数据源类型
     * @return druid或者dbcp数据源
     * @throws Exception the exception
     */
    public static final DataSource getDataSource(int sourceType)
        throws Exception {
        DataSource dataSource = null;
        switch(sourceType) {
        case DRUID_MYSQL_SOURCE:
            dataSource = DruidDataSourceFactory.createDataSource(
                    MySqlConfigProperty.getInstance().getProperties());
            break;
        case DRUID_MYSQL_SOURCE2:
            dataSource = DruidDataSourceFactory.createDataSource(
                    MySqlConfigProperty2.getInstance().getProperties());
            break;
        case DBCP_SOURCE:
            dataSource = BasicDataSourceFactory.createDataSource(
                    MySqlConfigProperty.getInstance().getProperties());
            break;
        }
        return dataSource;
    }
}

代码片段2.3 手动读取配置文件初始化连接池

第37行中调用了类com.alibaba.druid.pool.DruidDataSourceFactory中createDataSource方法来初始化一个连接池。对比dbcp的使用方法，两者很相似。

下面给出一个多线程的测试程序。运行后可以比较druid和dbcp的性能差别。

package com.whyun.druid.test;

import java.sql.SQLException;
import java.util.ArrayList;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.TimeUnit;

import com.whyun.druid.model.TableOperator;
import com.whyun.util.db.DataSourceUtil;

public class MutilThreadTest {
    public static void test(int dbType, int times)
        throws Exception {
        int numOfThreads =Runtime.getRuntime().availableProcessors()*2;
        ExecutorService executor = Executors.newFixedThreadPool(numOfThreads);
        final TableOperator test = new TableOperator();
//        int dbType = DataSourceUtil.DRUID_MYSQL_SOURCE;
//        dbType = DataSourceUtil.DBCP_SOURCE;
        test.setDataSource(DataSourceUtil.getDataSource(dbType));

        boolean createResult = false;
        try {
            test.createTable();
            createResult = true;
        } catch (SQLException e) {
            e.printStackTrace();
        }
        if (createResult) {
            List> results = new ArrayList>();
            for (int i = 0; i < times; i++) {
                results.add(executor.submit(new Callable() {
                    @Override
                    public Long call() throws Exception {
                            long begin = System.currentTimeMillis();
                                try {
                                    test.insert();
                                    //insertResult = true;
                                } catch (Exception e) {
                                    e.printStackTrace();
                                }
                            long end = System.currentTimeMillis();
                        return end - begin;
                    }
                }));
            }
            executor.shutdown();
            while(!executor.awaitTermination(Long.MAX_VALUE, TimeUnit.DAYS));

            long sum = 0;
            for (Future result : results) {
                sum += result.get();
            }


            System.out.println("---------------db type "+dbType+"------------------");
            System.out.println("number of threads :" + numOfThreads + " times:" + times);
            System.out.println("running time: " + sum + "ms");
            System.out.println("TPS: " + (double)(100000 * 1000) / (double)(sum));
            System.out.println();
            try {
                test.tearDown();
                //dropResult = true;
            } catch (Exception e) {
                e.printStackTrace();
            }
        } else {
            System.out.println("初始化数据库失败");
        }

    }

    public static void main (String argc[])
        throws Exception {
        test(DataSourceUtil.DBCP_SOURCE,50);
        test(DataSourceUtil.DRUID_MYSQL_SOURCE,50);

    }
}

代码片段2.4 连接池多线程测试程序

3 监控

3.1 web监控

druid提供了sql语句查询时间等信息的监控功能。为了让数据库查询一直运行，下面特地写了一个ajax进行轮询。同时，还要保证在web.xml中配置如下信息

<servlet>
        <servlet-name>DruidStatViewservlet-name>
        <servlet-class>com.alibaba.druid.support.http.StatViewServletservlet-class>
    servlet>
<servlet-mapping>
        <servlet-name>DruidStatViewservlet-name>
        <url-pattern>/druid/*url-pattern>
    servlet-mapping>

配置文件3.1 在web.xml中添加druid监控

同时将ajax代码提供如下

function showTime() {
    var myDate = new Date();
    var timeStr = '';
    timeStr += myDate.getFullYear()+'-'; //获取完整的年份(4位,1970-????)
    timeStr += myDate.getMonth()+'-';      //获取当前月份(0-11,0代表1月)
    timeStr += myDate.getDate() + ' ';      //获取当前日(1-31)
    timeStr += myDate.getHours()+':';      //获取当前小时数(0-23)
    timeStr += myDate.getMinutes()+':';    //获取当前分钟数(0-59)
    timeStr += myDate.getSeconds();    //获取当前秒数(0-59)
    return timeStr
}
$(document).ready(function() {
    function loadDBTestMessage() {
        $.get('servlet/MysqlTestServlet',function(data) {
            if (typeof(data) != 'object') {
                data = eval('(' + data + ')');
            }
            var html = '['+showTime()+']';
            html += '创建：' + data['createResult'];
            html +=  '插入：' + data['insertResult'];
            html += '销毁:' + data['dropResult'];
            html +=
            $('#message').html(html);
        });
    }

    setInterval(function() {
        loadDBTestMessage();
    }, 10000);
});

代码片段3.1 ajax轮询

这时打开 地址，会看到监控界面，点击其中的sql标签。

图3.1 监控界面查看sql查询时间

注意：在写配置文件1.1时，要保证filter配置项中含有stat属性，否则这个地方看不到sql语句的监控数据。

表格中各项含义如下

名称	解释	备注
ExecuteCount	当前sql已执行次数
ExecTime	当前sql已执行时间
ExecMax	当前sql最大执行时间
Txn	当前运行的事务数量
Error	当前sql执行出错的数目
Update	当前sql更新或者删除操作中已经影响的行数
FetchRow	当前sql操作中已经读取的行数
Running	当前sql正在运行的数目
Concurrent	当前sql最大并发执行数
ExecHisto	当前sql做execute操作的时间分布数组	分为0-1,1-10,10-100,100-1000，>1000，5个时间分布区域，单位为ms
ExecRsHisto	当前sql做execute操作和resultSet 打开至关闭的时间总和分布数组	同上
FetchRowHisto	当前sql查询时间分布数组	同上
UpdateHisto	当前sql更新、删除时间分布数组	同上

表3.1 监控字段含义

老版本的druid的jar包中不支持通过web界面进行远程监控，从0.2.14开始可以通过配置jmx地址来获取远程运行druid的服务器的监控信息。具体配置方法如下：

<servlet>
        <servlet-name>DruidStatViewservlet-name>
        <servlet-class>com.alibaba.druid.support.http.StatViewServletservlet-class>
        <init-param>
            <param-name>jmxUrlparam-name>
            <param-value>service:jmx:rmi:///jndi/rmi://localhost:9004/jmxrmiparam-value>
        init-param>
    servlet>
    <servlet-mapping>
        <servlet-name>DruidStatViewservlet-name>
        <url-pattern>/druid/*url-pattern>
    servlet-mapping>

配置文件3.2 远程监控web

这里连接的配置参数中多了一个jmxUrl，里面配置一个jmx连接地址。jmx连接中也可以指定用户名、密码，在上面的servlet中添加两个init-param，其param-name分别为jmxUsername和jmxPassword，分别对应连接jmx的用户名和密码。对于jmx在服务器端的配置，可以参考3.2节中的介绍。

3.2 jconsole监控

同时druid提供了jconsole监控的功能，因为界面做的不是很好，所以官方中没有对其的相关介绍。如果是纯java程序的话，上面提到的web监控就无法使用了，jconsole的作用就体现出来了。不过我在下面做教程的时候，依然使用的是刚才用的web项目。

首先在catalina.bat（或者catalina.sh）中加入java的启动选项，放置于if "%OS%" == "Windows_NT" setlocal这句之后。

set JAVA_OPTS=%JAVA_OPTS% -Dcom.sun.management.jmxremote -Dcom.sun.management.jmxremote.port="9004" -Dcom.sun.management.jmxremote.authenticate="false" -Dcom.sun.management.jmxremote.ssl="false"

保存完之后，启动startup.bat(或者startup.sh)来运行tomcat（上面设置java启动项的配置，按理来说在eclipse中也能适用，但是笔者在其下没有试验成功）。然后在远程的某台电脑的命令行中运行如下命令

jconsole -pluginpath E:\kuaipan\workspace6\druid-web\WebRoot\WEB-INF\lib\druid-0.2.11.jar

这里的最后一个参数就是你的druid的jar包的路径。

图3.2 jconsole连接界面

在远程进程的输入框里面输入ip:端口号，然后点击连接（上面的配置中没有指定用户名、密码，所以这里不用填写）。打开的界面如下：

图3.3 jconsole 连接成功界面

可以看到和web监控界面类似的数据了。

参考

本文章中的代码已上传：

oschina 问答社区：