Tomcat 連接池介紹

Tomcat 連接池是從 Tomcat 7 開始重新編寫的高並發連接池，用以取代以前 Tomcat 中使用的 DBCP 1 連接池，它可以配置在 Tomcat 中使用，也可以單獨使用。本文主要介紹 Tomcat 連接池的基本使用，文中使用到的軟件版本：Java 1.8.0_191、Tomcat 8.5.72、Spring Boot 2.3.12.RELEASE。

1、配置參數

1.1、基礎配置

參數	默認值	描述
factory		必須，需要是 org.apache.tomcat.jdbc.pool.DataSourceFactory
type		應該是 javax.sql.DataSource 或 javax.sql.XADataSource

1.2、系統屬性

參數	默認值	描述
org.apache.tomcat.jdbc.pool.onlyAttemptCurrentClassLoader	false	是否只使用當前的類加載器(加載該連接池的類加載器)來加載動態類

1.3、一般參數

這些參數和 DBCP 一致，但有些默認值不一樣。

參數	默認值	描述
defaultAutoCommit	驅動的默認值	是否自動提交
defaultReadOnly	驅動的默認值	是否只讀
defaultTransactionIsolation	驅動的默認值	默認的事務隔離級別 NONE、READ_COMMITTED、READ_UNCOMMITTED、 REPEATABLE_READ、SERIALIZABLE
defaultCatalog		默認的 catalog。(目錄，類似於模式名，但比模式名更加抽象； Oracle，MySQL 不支持，MS SQL Server = 數據庫名)
driverClassName		驅動名稱
url		連接 url
username		用戶名
password		密碼
maxActive	100	最大活動連接數
maxIdle	100	最大空閑連接數
minIdle	10	最小空閑連接數
initialSize	10	初始連接數
maxWait	3000	從連接池獲取連接，最大等待時間(秒)
testOnBorrow	false	從連接池獲取連接時，是否驗證有效性；如果驗證失敗，則丟棄該連接。
testOnConnect	true	連接創建時，是否驗證有效性
testOnReturn	false	連接返回連接池時，是否驗證有效性
testWhileIdle	false	連接空閑時，是否驗證有效性
validationQuery	null	連接校驗的查詢sql 如果指定，該 SQL 不需要返回結果，只要不拋 SQLException；如果沒有指定，則通過調用 isValid() 方法進行校驗。
validationQueryTimeout	-1	校驗查詢的超時時間(秒)；非正數表示不啟用該特性。
validatorClassName	null	校驗的類名，需實現 org.apache.tomcat.jdbc.pool.Validator 接口並包含一個無參構造函數。
timeBetweenEvictionRunsMillis	5000	校驗空閑連接的時間周期(毫秒)，不能設為小於 1 秒，非正表示不驗證
minEvictableIdleTimeMillis	60000	空閑連接至少多長時間(毫秒)后，才會被校驗
removeAbandoned	false	是否刪除泄露的連接
removeAbandonedTimeout	60	連接泄露的超時時間(秒)
logAbandoned	false	連接刪除時是否打印堆棧信息
connectionProperties	null	連接屬性，格式為： [propertyName=property;]* "user" and "password" 將被除外，所以在此不需要包含這兩個屬性。

1.4、增強參數

參數	默認值	描述
initSQL	null	連接創建時，執行的初始化 SQL
jdbcInterceptors	null	jdbc 攔截器，需要繼承 org.apache.tomcat.jdbc.pool.JdbcInterceptor；已存在的攔截器： org.apache.tomcat.jdbc.pool.interceptor.ConnectionState 自動提交、只讀、目錄和事務隔離級別的跟蹤 org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer statement的跟蹤，在連接返回連接池時關閉它們
validationInterval	3000	連接校驗的最短間隔(毫秒)
jmxEnabled	true	是否注冊連接池到 JMX
fairQueue	true	是否使用公平隊列，如果為 true，獲取連接時將按照 "先進先出" 的原則
abandonWhenPercentageFull	0	泄露連接達到 abandonWhenPercentageFull 比例才關閉這些連接，0 表示有泄露連接立馬關閉
maxAge	0	連接最大存活時間；在從連接池獲取連接和連接返回連接池時進行該項檢測，如果 now - time-when-connected > maxAge，則關閉該連接；0 表示不進行該項檢測。
useEquals	true	是否使用 String.equals 來判斷 ProxyConnection 是否相等
suspectTimeout	0	和 removeAbandonedTimeout 類似，但該設置只是打印日志並不刪除連接；大於 0 才生效。
rollbackOnReturn	false	連接在返回連接池時是否自動回滾事務。
commitOnReturn	false	連接在返回連接池時是否自動提交事務；如果 rollbackOnReturn==true 則忽略該參數。
alternateUsernameAllowed	false	從連接池獲取連接時是否允許設置新的憑證。默認情況下，連接池會忽略 DataSource.getConnection(username,password) 的調用，直接返回一個已創建的連接；如果要使用不同的憑證來獲取連接，即 DataSource.getConnection(username,password) 生效，可把該參數設為 true。
dataSource	null	設置數據源，連接池將從該數據源獲取連接
dataSourceJNDI	null	數據源的 jndi
useDisposableConnectionFacade	true	是否使用連接外觀；設置為 true 可以防止連接關閉后的重復使用。
logValidationErrors	false	是否記錄校驗的錯誤
propagateInterruptState	false	是否傳播線程中斷狀態
ignoreExceptionOnPreLoad	false	是否忽略創建連接時的錯誤
useStatementFacade	true	如果希望使用包裝 statement，以便在設置了 statement 代理時，在已關閉的 statement 上調用 equals() and hashCode() 方法，需將此設置為 true。

詳細的說明可以參考官網文檔：https://tomcat.apache.org/tomcat-8.5-doc/jdbc-pool.html

 

tomcat連接池配置詳解

一、連接池配置

　　

<bean class="org.apache.tomcat.jdbc.pool.PoolProperties">  
    <property name="url" value="${jdbcUrl}"/> 
        <!--數據庫驅動--> 
        <property name="driverClassName" value="com.mysql.jdbc.Driver"/> 
        <!--用戶名-->
        <property name="username" value="mysql"/>  
        <!--密碼-->
        <property name="password" value="123456"/>
        <!--注冊池JMX,默認：true-->  
        <property name="jmxEnabled" value="false"/>  
        <!--檢查連接死活的時間間隔，單位：毫秒-->        
        <property name="validationInterval" value="30000"/>
        <!--指定連接進入空閑狀態時是否經過空閑對象驅逐進程的校驗，如果校驗未通過，則該連接被連接池斷掉
         值為true,則validationQuery參數必須為一個非空字串---->
        <property name="testWhileIdle" value="false"/>   
        <!--指定連接返回到池中是時是否經過校驗
         值為true,則validationQuery參數必須為一個非空字串---->
        <property name="testOnReturn" value="false"/>  
        <!--指定連接被調用時是否經過校驗，如果校驗未通過，則該連接被連接池斷掉，並由連接池嘗試調用另一個連接
         值為true,則validationQuery參數必須為一個非空字串-->
        <property name="testOnBorrow" value="true"/> 
        <!--在連接返回給調用者前用於校驗連接是否有效的SQL語句，如果指定了SQL語句，則必須為一個SELECT語句，且至少有一行結果-->
        <property name="validationQuery" value="select 1"/> 
        <!--連接池處於活動狀態的數據庫連接的最大數目，0表示不限制,表示最大並發-->  
        <property name="maxActive" value="1000"/>  
        <!--初始化連接數-->
        <property name="initialSize" value="10"/> 
        <!--連接池中連接用完時，新的請求的等待時間（即等待別的連接空閑），超時返回異常，毫秒--> 
        <property name="maxWait" value="100000"/>  
        <!--以毫秒表示空閑對象驅逐進程由休眠狀態進入運行狀態的數值，值為非正整時表示不運行任何空閑對象驅逐進程
         運行判斷連接超時任務的時間間隔-->
        <property name="timeBetweenEvictionRunsMillis" value="30000"/> 
        <!--以毫秒表示連接被空閑對象驅逐進程驅逐前在池中保持空閑狀態的最小時間，連接的超時時間，默認為半小時-->
        <property name="minEvictableIdleTimeMillis" value="30000"/> 
        <!--連接池檢查每個空閑對象驅逐進程的對象數量
            <property name="numTestPerEvictionRun" value="3"/>
        -->        
        <!--連接池處於空閑狀態的數據庫連接的最小數目，低於此數值將會創建所欠缺的連接，設0無限制--> 
        <property name="minIdle" value="10"/>
        <!--連接池處於空閑狀態的數據庫連接的最大數目，取非正整數表示不受限制，超過此數值時多余的空閑連接將會被釋放-->   
        <property name="maxIdle" value="200"/>
        <!--當清除無效連接時是否在日志中記錄清除信息的標志-->
         <property name="logAbandoned" value="false"/> 
         <!--是否清除已經超過 removeAbandonedTimeout 設置的無效連接，自動回收超時連接
          啟動機制：getNumActive() > getMaxActive() - 3 和 getNumIdle() < 2 
          假設maxActive=20,而當前18個活動連接，1個空閑連接，機制將會啟動
          但是只有在活動連接沒有使用的時長超過“removeAbandonedTimeout”（默認300秒），的連接將被清除-->
        <property name="removeAbandoned" value="true"/> 
        <!--以秒表示清除無效連接的時限，自我中斷時間，單位秒-->         
        <property name="removeAbandonedTimeout" value="60"/>
        <!--設置攔截器，默認為空
         ConnectionState：跟蹤自動提交，只讀目錄和事務隔離級別
         StatementFinalizer：跟蹤打開的語句，並關閉連接時的返回到池中
         --> 
        <property name="jdbcInterceptors" value="org.apache.tomcat.jdbc.pool.interceptor.ConnectionState;org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer"/>  
</bean> 

 

2、使用

2.1、直接使用

2.1.1、引入依賴

<dependency>
    <groupId>org.apache.tomcat</groupId>
    <artifactId>tomcat-jdbc</artifactId>
    <version>8.5.72</version>
</dependency>

2.1.2、使用例子

package com.abc.demo.general.dbpool;

import org.apache.tomcat.jdbc.pool.DataSource;
import org.apache.tomcat.jdbc.pool.PoolProperties;

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

public class TomcatPoolCase {
    public static void main(String[] args) {
        PoolProperties poolProperties = new PoolProperties();
        poolProperties.setName("Tomcat連接池");
        poolProperties.setUrl("jdbc:mysql://10.40.9.11:3306/mydb?useUnicode=true&characterEncoding=UTF-8");
        poolProperties.setDriverClassName("com.mysql.cj.jdbc.Driver");
        poolProperties.setUsername("root");
        poolProperties.setPassword("123456");
        poolProperties.setJmxEnabled(true);
        poolProperties.setTestWhileIdle(false);
        poolProperties.setTestOnBorrow(true);
        poolProperties.setValidationQuery("SELECT 1");
        poolProperties.setTestOnReturn(false);
        poolProperties.setValidationInterval(30000);
        poolProperties.setTimeBetweenEvictionRunsMillis(30000);
        poolProperties.setMaxActive(100);
        poolProperties.setInitialSize(10);
        poolProperties.setMaxWait(10000);
        poolProperties.setRemoveAbandonedTimeout(60);
        poolProperties.setMinEvictableIdleTimeMillis(30000);
        poolProperties.setMinIdle(10);
        poolProperties.setLogAbandoned(true);
        poolProperties.setRemoveAbandoned(true);
        poolProperties.setJdbcInterceptors(
                "org.apache.tomcat.jdbc.pool.interceptor.ConnectionState;" +
                "org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer");
        DataSource datasource = new DataSource();
        datasource.setPoolProperties(poolProperties);

        Connection connection = null;
        try {
            connection = datasource.getConnection();
            Statement st = connection.createStatement();
            ResultSet rs = st.executeQuery("select version()");
            if (rs.next()) {
                System.out.println(rs.getString(1));
            }
        } catch (SQLException e) {
            e.printStackTrace();
        } finally {
            close(connection);
        }

        //實際使用中一般是在應用啟動時初始化數據源，應用從數據源中獲取連接；並不會關閉數據源。
        datasource.close();
    }

    private static void close(Connection connection) {
        if (connection != null) {
            try {
                connection.close();
            } catch (SQLException e) {
                e.printStackTrace();
            }
        }
    }
}

2.2、作為資源配置在 Tomcat 中

先把對應數據庫的驅動包拷貝到 Tomcat 或應用的 lib 目錄下，然后在 content.xml 中配置資源，content.xml 可以在如下位置：

conf/context.xml：針對所有的應用
conf/Catalina/localhost：針對單個應用，適合在 Tomcat 外部部署應用
{應用}/META-INFcontext.xml：針對單個應用

配置資源的例子如下：

<Resource name="jdbc/testDb"
    auth="Container"
    type="javax.sql.DataSource"
    factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"
    testWhileIdle="true"
    testOnBorrow="true"
    testOnReturn="false"
    validationQuery="SELECT 1"
    validationInterval="30000"
    timeBetweenEvictionRunsMillis="30000"
    maxActive="20"
    maxIdle="20"
    minIdle="5"
    maxWait="10000"
    initialSize="5"
    removeAbandonedTimeout="60"
    removeAbandoned="true"
    logAbandoned="true"
    minEvictableIdleTimeMillis="30000"
    jmxEnabled="true"
    jdbcInterceptors="org.apache.tomcat.jdbc.pool.interceptor.ConnectionState;
    org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer"
    username="root"
    password="123456"
    driverClassName="com.mysql.cj.jdbc.Driver"
    url="jdbc:mysql://10.40.9.11:3306/mydb?useUnicode=true&amp;characterEncoding=UTF-8" />

可以通過 jndi 來查找該資源，這里通過 jsp 來演示查找方法：

<%@ page language="java" contentType="text/html; charset=utf-8" pageEncoding="UTF-8"%>

<%@ page import="javax.naming.Context,
                javax.naming.InitialContext,
                javax.sql.DataSource,
                java.sql.*"%>
<%
    Connection connection = null;
    try {
        InitialContext initialContext = new InitialContext();
        Context context = (Context) initialContext.lookup("java:comp/env");
        DataSource dataSource = (DataSource)context.lookup("jdbc/testDb");
        connection = dataSource.getConnection();
        Statement st = connection.createStatement();
        ResultSet rs = st.executeQuery("select version()");
        if (rs.next()) {
            System.out.println(rs.getString(1));
        }
    } catch (Exception e) {
        e.printStackTrace();
    } finally {
        if (connection != null) {
            try {
                connection.close();
            } catch (SQLException e) {
                e.printStackTrace();
            }
        }
    }
%>

<html>
    <body>
        <h3>通過 jndi 查找數據源並獲取數據庫的版本信息</h3>
    </body>
</html>

3.2、在 SpringBoot 中使用

3.1.1、引入依賴

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.12.RELEASE</version>
    <relativePath />
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-jdbc</artifactId>
    </dependency>

    <dependency>
        <groupId>org.apache.tomcat</groupId>
        <artifactId>tomcat-jdbc</artifactId>
        <version>8.5.72</version>
    </dependency>

    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

3.1.2、單數據源

application.yml 配置：

spring:
  datasource:
    tomcat-pool:
      name: Tomcat連接池
      url: jdbc:mysql://10.40.9.11:3306/mydb?useUnicode=true&characterEncoding=UTF-8
      driver-class-name: com.mysql.cj.jdbc.Driver
      username: root
      password: 123456
      test-while-idle: true
      test-on-borrow: true
      validation-query: select 1
      test-on-return: false
      validation-interval: 30000
      time-between-eviction-runs-millis: 30000
      max-active: 100
      initial-size: 10
      max-wait: 10000
      remove-abandoned-timeout: 60
      min-evictable-idle-time-millis: 30000
      min-idle: 10
      log-abandoned: true
      remove-abandoned: true
      jdbc-interceptors: org.apache.tomcat.jdbc.pool.interceptor.ConnectionState;org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer

數據源配置類：

package com.abc.demo.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {
    @Bean("dataSource")
    @ConfigurationProperties(prefix = "spring.datasource.tomcat-pool")
    public DataSource dataSource() {
        return DataSourceBuilder.create().type(org.apache.tomcat.jdbc.pool.DataSource.class).build();
    }
}

使用：

@Autowired
private DataSource dataSource;

3.1.3、多數據源

application.yml 配置：

spring:
  datasource:
    tomcat-pool:
      db1:
        name: Tomcat連接池
        url: jdbc:mysql://10.40.9.11:3306/mydb?useUnicode=true&characterEncoding=UTF-8
        driver-class-name: com.mysql.cj.jdbc.Driver
        username: root
        password: 123456
        test-while-idle: true
        test-on-borrow: true
        validation-query: select 1
        test-on-return: false
        validation-interval: 30000
        time-between-eviction-runs-millis: 30000
        max-active: 100
        initial-size: 10
        max-wait: 10000
        remove-abandoned-timeout: 60
        min-evictable-idle-time-millis: 30000
        min-idle: 10
        log-abandoned: true
        remove-abandoned: true
        jdbc-interceptors: org.apache.tomcat.jdbc.pool.interceptor.ConnectionState;org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer
      db2:
        name: Tomcat連接池
        url: jdbc:mysql://10.110.74.187:3306/egmp?useUnicode=true&characterEncoding=UTF-8
        driver-class-name: com.mysql.cj.jdbc.Driver
        username: root
        password: InsYR0ot187!
        test-while-idle: true
        test-on-borrow: true
        validation-query: select 1
        test-on-return: false
        validation-interval: 30000
        time-between-eviction-runs-millis: 30000
        max-active: 100
        initial-size: 10
        max-wait: 10000
        remove-abandoned-timeout: 60
        min-evictable-idle-time-millis: 30000
        min-idle: 10
        log-abandoned: true
        remove-abandoned: true
        jdbc-interceptors: org.apache.tomcat.jdbc.pool.interceptor.ConnectionState;org.apache.tomcat.jdbc.pool.interceptor.StatementFinalizer

數據源配置類：

package com.abc.demo.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.jdbc.DataSourceBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;

@Configuration
public class DataSourceConfig {

    @Bean("dataSource1")
    @ConfigurationProperties(prefix = "spring.datasource.tomcat-pool.db1")
    public DataSource dataSource1() {
        return DataSourceBuilder.create().type(org.apache.tomcat.jdbc.pool.DataSource.class).build();
    }

    @Bean("dataSource2")
    @ConfigurationProperties(prefix = "spring.datasource.tomcat-pool.db2")
    public DataSource dataSource2() {
        return DataSourceBuilder.create().type(org.apache.tomcat.jdbc.pool.DataSource.class).build();
    }
}

使用：

@Autowired
@Qualifier("dataSource1")
private DataSource dataSource1;

@Autowired
@Qualifier("dataSource2")
private DataSource dataSource2;