HikariCpPlugin (JFinal-码云(gitee.com))

java.lang.Object
- com.jfinal.plugin.hikaricp.HikariCpPlugin

All Implemented Interfaces:

IDataSourceProvider, IPlugin
```
public class HikariCpPlugin
extends Object
implements IPlugin, IDataSourceProvider
```
Fast, simple, reliable. HikariCP is a "zero-overhead" production ready JDBC connection pool. At roughly 130Kb, the library is very light

Constructor Summary

Constructors
Constructor and Description
`HikariCpPlugin(String jdbcUrl, String username, String password)`
`HikariCpPlugin(String jdbcUrl, String username, String password, String driverClass)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DataSource`	`getDataSource()`
`void`	`setAutoCommit(boolean autoCommit)` 是否自动提交
`void`	`setCatalog(String catalog)` 支持 catalog 概念的数据库可以设定该参数
`void`	`setConnectionInitSql(String connectionInitSql)` 新连接生成后，添加到连接池前执行的初始化sql
`void`	`setConnectionTestQuery(String connectionTestQuery)` JDBC4以下版本数据库驱动需要设定此参数
`void`	`setConnectionTimeout(long connectionTimeoutMs)`
`void`	`setDriverClass(String driverClass)` 驱动类名
`void`	`setIdleTimeout(long idleTimeoutMs)` 空闲超时时间(单位：毫秒)，默认600000 (10 分钟)
`void`	`setJdbcUrl(String jdbcUrl)` jdbc连接url
`void`	`setLeakDetectionThreshold(long leakDetectionThresholdMs)` 内存泄露侦测周期，最小为2000（2秒）
`void`	`setMaximumPoolSize(int maximumPoolSize)` 连接池最大连接数默认10
`void`	`setMaxLifetime(long maxLifetimeMs)` 最大生命周期/最大存活时间(单位：毫秒) ，默认1800000 (30 分钟)
`void`	`setPassword(String password)` 数据库密码
`void`	`setPoolName(String poolName)` 用户指定的连接池名
`void`	`setReadOnly(boolean readOnly)` 是否是只读连接，是否有效取决于相应的数据库是否支持
`void`	`setTransactionIsolation(String isolationLevel)` 事物等级
`void`	`setUsername(String username)` 数据库类型
`void`	`setValidationTimeout(long validationTimeoutMs)` 连接是否存活测试周期，默认5000（5秒）
`boolean`	`start()`
`boolean`	`stop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HikariCpPlugin
```
public HikariCpPlugin(String jdbcUrl,
                      String username,
                      String password)
```
  - HikariCpPlugin
```
public HikariCpPlugin(String jdbcUrl,
                      String username,
                      String password,
                      String driverClass)
```
- Method Detail
  - getDataSource
```
public DataSource getDataSource()
```
    Specified by:
    
    getDataSource in interface IDataSourceProvider
  - start
```
public boolean start()
```
    Specified by:
    
    start in interface IPlugin
  - stop
```
public boolean stop()
```
    Specified by:
    
    stop in interface IPlugin
  - setDriverClass
```
public final void setDriverClass(String driverClass)
```
    驱动类名
    
    Parameters:
    
    driverClass -
    
    Since:
    
    V1.0.0
  - setUsername
```
public final void setUsername(String username)
```
    数据库类型
    
    Parameters:
    
    username -
    
    Since:
    
    V1.0.0
  - setPassword
```
public final void setPassword(String password)
```
    数据库密码
    
    Parameters:
    
    password -
    
    Since:
    
    V1.0.0
  - setAutoCommit
```
public final void setAutoCommit(boolean autoCommit)
```
    是否自动提交
    
    Parameters:
    
    autoCommit -
    
    Since:
    
    V1.0.0
  - setReadOnly
```
public final void setReadOnly(boolean readOnly)
```
    是否是只读连接，是否有效取决于相应的数据库是否支持
    
    Parameters:
    
    readOnly -
    
    Since:
    
    V1.0.0
  - setConnectionTimeout
```
public final void setConnectionTimeout(long connectionTimeoutMs)
```
    Parameters:
    
    connectionTimeoutMs - 连接超时时间(单位：毫秒)
    
    Since:
    
    V1.0.0
  - setIdleTimeout
```
public final void setIdleTimeout(long idleTimeoutMs)
```
    空闲超时时间(单位：毫秒)，默认600000 (10 分钟)
    
    Parameters:
    
    idleTimeoutMs -
    
    Since:
    
    V1.0.0
  - setMaxLifetime
```
public final void setMaxLifetime(long maxLifetimeMs)
```
    最大生命周期/最大存活时间(单位：毫秒) ，默认1800000 (30 分钟)
    
    Parameters:
    
    maxLifetime -
    
    Since:
    
    V1.0.0
  - setMaximumPoolSize
```
public final void setMaximumPoolSize(int maximumPoolSize)
```
    连接池最大连接数默认10
    
    Parameters:
    
    maximumPoolSize -
    
    Since:
    
    V1.0.0
  - setPoolName
```
public final void setPoolName(String poolName)
```
    用户指定的连接池名
    
    Parameters:
    
    poolName -
    
    Since:
    
    V1.0.0
  - setConnectionInitSql
```
public final void setConnectionInitSql(String connectionInitSql)
```
    新连接生成后，添加到连接池前执行的初始化sql
    
    Parameters:
    
    connectionInitSql -
    
    Since:
    
    V1.0.0
  - setConnectionTestQuery
```
public final void setConnectionTestQuery(String connectionTestQuery)
```
    JDBC4以下版本数据库驱动需要设定此参数
    
    Parameters:
    
    connectionTestQuery - 连接时测试sql
    
    Since:
    
    V1.0.0
  - setJdbcUrl
```
public final void setJdbcUrl(String jdbcUrl)
```
    jdbc连接url
    
    Parameters:
    
    jdbcUrl -
  - setCatalog
```
public final void setCatalog(String catalog)
```
    支持 catalog 概念的数据库可以设定该参数
    
    Parameters:
    
    catalog -
  - setTransactionIsolation
```
public final void setTransactionIsolation(String isolationLevel)
```
    事物等级
    
    Parameters:
    
    isolationLevel -
  - setValidationTimeout
```
public final void setValidationTimeout(long validationTimeoutMs)
```
    连接是否存活测试周期，默认5000（5秒）
    
    Parameters:
    
    validationTimeoutMs -
  - setLeakDetectionThreshold
```
public final void setLeakDetectionThreshold(long leakDetectionThresholdMs)
```
    内存泄露侦测周期，最小为2000（2秒）
    
    Parameters:
    
    leakDetectionThresholdMs -

Class HikariCpPlugin

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

HikariCpPlugin

HikariCpPlugin

Method Detail

getDataSource

start

stop

setDriverClass

setUsername

setPassword

setAutoCommit

setReadOnly

setConnectionTimeout

setIdleTimeout

setMaxLifetime

setMaximumPoolSize

setPoolName

setConnectionInitSql

setConnectionTestQuery

setJdbcUrl

setCatalog

setTransactionIsolation

setValidationTimeout

setLeakDetectionThreshold