JDBCAgent (ctp-core 6.1-SP1-SNAPSHOT API)

java.lang.Object
- com.seeyon.ctp.util.JDBCAgent

所有已实现的接口:

Closeable, AutoCloseable
```
public final class JDBCAgent
extends Object
implements Closeable
```
Title: T1开发框架

Description: 基于JDBC的数据库操作工具类。

Copyright: Copyright (c) 2012

Company: seeyon.com

从以下版本开始:

CTP2.0

构造器概要

构造器
构造器和说明
`JDBCAgent()` 使用Spring管理的数据库连接构造JDBCAgent
`JDBCAgent(boolean raw)` 传入true时将使用原始的数据库连接构造JDBCAgent，false则使用Spring管理的数据库连接
`JDBCAgent(Connection conn)` 使用传入的数据库连接构造JDBCAgent，close方法将不会关闭该连接
`JDBCAgent(String dsName)` 使用Spring管理的指定数据源的数据库连接构造JDBCAgent

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`void`	`batch1Prepare(String sql)` 准备需要批量执行更新的Prepared SQL，使用例子如下： JDBCAgent dba = new JDBCAgent(); dba.batch1Prepare("insert into xxx value(?
`void`	`batch2Add(List params)` 添加要执行Prepared SQL的数据参数列表，使用例子如下： JDBCAgent dba = new JDBCAgent(); dba.batch1Prepare("insert into xxx value(?
`int`	`batch3Execute()` 执行批量的Prepared SQL，使用例子如下： JDBCAgent dba = new JDBCAgent(); dba.batch1Prepare("insert into xxx value(?
`static String`	`clobToString(Clob clob)`
`void`	`close()` 释放数据库资源
`int`	`count(String namedSql, Map<String,Object> nameParams)` JDBC count方法
`int`	`execute(String sqlString)` 执行SQL脚本
`int`	`execute(String sqlString, List params)` 执行SQL脚本
`int`	`execute(String sqlString, Object param)` 执行SQL脚本
`int`	`executeBatch(List batchedSql)` 批量执行SQL
`void`	`executeNamedSql(String namedSql, Map<String,Object> params)` 与execut函数执行sql类似，只是sql参数形式类似Hibernate的named query
`static Object`	`executePreparedStatement(String preparedString, org.springframework.jdbc.core.PreparedStatementCallback action)` 使用默认的数据源执行预处理SQL的工具方法
`static Object`	`executePreparedStatement(String dsName, String preparedString, org.springframework.jdbc.core.PreparedStatementCallback action)` 执行预处理SQL的工具方法
`static Object`	`executeProcedure(String callString, org.springframework.jdbc.core.CallableStatementCallback action)` 使用默认的数据源执行存储过程的工具方法
`static Object`	`executeProcedure(String dsName, String callString, org.springframework.jdbc.core.CallableStatementCallback action)` 执行存储过程的工具方法
`void`	`executeSqlFile(String sqlKey)` 无需参数执行自定义SQL
`void`	`executeSqlFile(String sqlKey, List params)` 执行自定义SQL，指定sqlKey的SQL脚本，SQL文件需要存放于cfgHome/sql目录下，且以数据库类型名称开头，或者文件名以ALL开头作为各数据库通用sql配置文件数据库类型名称如（注意区分大小写）：DB2、MySQL、Oracle、PostgreSQL、SQLServer
`void`	`executeSqlFile(String sqlKey, Map<String,Object> params)` 执行自定义SQL，指定sqlKey的SQL脚本，SQL文件需要存放于cfgHome/sql目录下，且以数据库类型名称开头，或者文件名以ALL开头作为各数据库通用sql配置文件数据库类型名称如（注意区分大小写）：DB2、MySQL、Oracle、PostgreSQL、SQLServer 与executeSqlFile(String sqlKey, List params)类似，只是参数形式类似Hibernate的named query
`FlipInfo`	`findByPaging(String sql, FlipInfo fpi)` SQL翻页查询方法
`FlipInfo`	`findByPaging(String sql, List params, FlipInfo fpi)` SQL翻页查询方法
`FlipInfo`	`findNameByPaging(String namedSql, Map<String,Object> nameParams, FlipInfo fpi)` SQL翻页命名查询方法
`static Connection`	`getConnection()` 获取默认受Spring事务管理控制的数据库连接（spring中配置的名称为dataSource的数据源连接）
`static DataSource`	`getDataSource()` 获取在Spring中配置的默认数据源
`static DataSource`	`getDataSource(String dsName)` 获取在Spring中配置的指定数据源
`static String`	`getDBType()` 获取当前连接的数据库类型标识，oracle、sqlserver、mysql、postgresql
`String`	`getDBUserName()` 数据库相关信息开始 *************************
`org.hibernate.dialect.Dialect`	`getDialect()` 获取当前Hibernate中的Dialect实例
`ResultSet`	`getQueryResult()` 获得查询结果集
`static Connection`	`getRawConnection()` 获取默认原始数据库连接（spring中配置的名称为dataSource的数据源连接）
`static Connection`	`getRawConnection(String dsName)` 获取在Spring中配置的指定数据源名称的原始数据库连接
`static String`	`getSqlInFile(String sqlKey)` 获取自定义SQL，指定sqlKey的SQL脚本，SQL配置文件需要存放于cfgHome/sql目录下，且以数据库类型名称开头，或者文件名以ALL开头作为各数据库通用sql配置文件数据库类型名称如（注意区分大小写）：DB2、MySQL、Oracle、PostgreSQL、SQLServer
`protected void`	`init()`
`static void`	`loadSqlInFile()`
`static void`	`main(String[] args)` 特定数据库SQL文件执行结束 ******************
`static void`	`release()` 无论是否原生的连接，强制关闭连接，释放资源。
`List`	`resultSetToList()` 把查询结果集数据封装为Map的list，同时释放当前查询结果集的数据库游标。
`List`	`resultSetToList(boolean lowercaseKey)` 把查询结果集数据封装为Map的list，同时释放当前查询结果集的数据库游标。
`Map`	`resultSetToMap()` 把当前查询结果集合结果数据取出第一条封装到Map，如果无数据则返回空的Map实例（不是null）
`Map`	`resultSetToMap(ResultSet rs)` 把指定查询结果集合结果数据取出第一条封装到Map，如果无数据则返回空的Map实例（不是null）
`void`	`setMaxSeconds(int maxSeconds)`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - JDBCAgent
```
public JDBCAgent(Connection conn)
```
    使用传入的数据库连接构造JDBCAgent，close方法将不会关闭该连接
  - JDBCAgent
```
public JDBCAgent()
```
    使用Spring管理的数据库连接构造JDBCAgent
  - JDBCAgent
```
public JDBCAgent(boolean raw)
```
    传入true时将使用原始的数据库连接构造JDBCAgent，false则使用Spring管理的数据库连接
    
    参数:
    
    raw - 是否使用原始的数据库连接构造JDBCAgent
  - JDBCAgent
```
public JDBCAgent(String dsName)
```
    使用Spring管理的指定数据源的数据库连接构造JDBCAgent
    
    参数:
    
    dsName - Spring数据源配置名称
- 方法详细资料
  - setMaxSeconds
```
public void setMaxSeconds(int maxSeconds)
```
    参数:
    
    maxSeconds - 最大超时时间（单位：秒）设置为0或者负数时表示不做连接自动清理的检查
  - init
```
protected void init()
```
  - execute
```
public int execute(String sqlString)
            throws BusinessException,
                   SQLException
```
    执行SQL脚本
    
    参数:
    
    sqlString - 要执行的SQL脚本
    
    返回:
    
    如果是查询操作，则返回查询结果集中的记录数；如果是修改或删除操作,则返回修改或删除的记录数。
    
    抛出:
    
    BusinessException
    
    SQLException
  - execute
```
public int execute(String sqlString,
                   Object param)
            throws BusinessException,
                   SQLException
```
    执行SQL脚本
    
    参数:
    
    sqlString - 要执行的SQL脚本
    
    param - SQL中的单个参数值。当SQL脚本中只有一个'?'出现时采用。
    
    返回:
    
    如果是查询操作，则返回查询结果集中的记录数；如果是修改或删除操作,则返回修改或删除的记录数。
    
    抛出:
    
    BusinessException
    
    SQLException
  - execute
```
public int execute(String sqlString,
                   List params)
            throws BusinessException,
                   SQLException
```
    执行SQL脚本
    
    参数:
    
    sqlString - 要执行的SQL脚本
    
    params - 封装到List中的参数列表。添加参数的顺序需要和SQL脚本中的'?'出现的顺序一致。
    
    返回:
    
    如果是查询操作，则返回查询结果集中的记录数；如果是修改或删除操作,则返回修改或删除的记录数。
    
    抛出:
    
    BusinessException
    
    SQLException
  - getQueryResult
```
public ResultSet getQueryResult()
```
    获得查询结果集
    
    返回:
    
    查询结果集
  - executeBatch
```
public int executeBatch(List batchedSql)
                 throws BusinessException,
                        SQLException
```
    批量执行SQL
    
    返回:
    
    返回发生影响的记录数.
    
    抛出:
    
    BusinessException
    
    SQLException
  - batch1Prepare
```
public void batch1Prepare(String sql)
                   throws BusinessException,
                          SQLException
```
    准备需要批量执行更新的Prepared SQL，使用例子如下： JDBCAgent dba = new JDBCAgent(); dba.batch1Prepare("insert into xxx value(?,?)"); List dataList; for(int i=0;i<100;i++) { dataList = new ArrayList(); dataList.add("f1"); dataList.add("f2"); dba.batch2Add(dataList); } dba.batch3Execute();
    
    参数:
    
    sql - Prepared SQL
    
    抛出:
    
    BusinessException
    
    SQLException
  - batch2Add
```
public void batch2Add(List params)
               throws SQLException
```
    添加要执行Prepared SQL的数据参数列表，使用例子如下： JDBCAgent dba = new JDBCAgent(); dba.batch1Prepare("insert into xxx value(?,?)"); List dataList; for(int i=0;i<100;i++) { dataList = new ArrayList(); dataList.add("f1"); dataList.add("f2"); dba.batch2Add(dataList); } dba.batch3Execute();
    
    参数:
    
    params - 添加要执行Prepared SQL的数据参数列表
    
    抛出:
    
    BusinessException
    
    SQLException
  - batch3Execute
```
public int batch3Execute()
                  throws SQLException
```
    执行批量的Prepared SQL，使用例子如下： JDBCAgent dba = new JDBCAgent(); dba.batch1Prepare("insert into xxx value(?,?)"); List dataList; for(int i=0;i<100;i++) { dataList = new ArrayList(); dataList.add("f1"); dataList.add("f2"); dba.batch2Add(dataList); } dba.batch3Execute();
    
    返回:
    
    返回发生影响的记录数.
    
    抛出:
    
    BusinessException
    
    SQLException
  - findByPaging
```
public FlipInfo findByPaging(String sql,
                             FlipInfo fpi)
                      throws BusinessException,
                             SQLException
```
    SQL翻页查询方法
    
    参数:
    
    sql - 要进行翻页查询的SQL脚本
    
    fpi - 翻页信息对象(size为-1的时候取全部数据)
    
    返回:
    
    翻页信息对象，同传入参数fpi
    
    抛出:
    
    BusinessException
    
    SQLException
  - findByPaging
```
public FlipInfo findByPaging(String sql,
                             List params,
                             FlipInfo fpi)
                      throws BusinessException,
                             SQLException
```
    SQL翻页查询方法
    
    参数:
    
    sql - 要进行翻页查询的SQL脚本
    
    params - 封装到List中的参数列表。添加参数的顺序需要和SQL脚本中的'?'出现的顺序一致。
    
    fpi - 翻页信息对象(size为-1的时候取全部数据)
    
    返回:
    
    翻页信息对象，同传入参数fpi
    
    抛出:
    
    BusinessException
    
    SQLException
  - findNameByPaging
```
public FlipInfo findNameByPaging(String namedSql,
                                 Map<String,Object> nameParams,
                                 FlipInfo fpi)
                          throws BusinessException,
                                 SQLException
```
    SQL翻页命名查询方法
    
    参数:
    
    sql - 要进行翻页查询的SQL脚本
    
    params - 查询参数
    
    fpi - 翻页信息对象(size为-1的时候取全部数据)
    
    返回:
    
    翻页信息对象，同传入参数fpi
    
    抛出:
    
    BusinessException
    
    SQLException
  - count
```
public int count(String namedSql,
                 Map<String,Object> nameParams)
          throws BusinessException,
                 SQLException
```
    JDBC count方法
    
    参数:
    
    sql -
    
    返回:
    
    抛出:
    
    SQLException
    
    BusinessException
  - resultSetToList
```
public List resultSetToList()
                     throws SQLException
```
    把查询结果集数据封装为Map的list，同时释放当前查询结果集的数据库游标。
    
    返回:
    
    结果数据封装到Map的List
    
    抛出:
    
    SQLException
  - resultSetToList
```
public List resultSetToList(boolean lowercaseKey)
                     throws SQLException
```
    把查询结果集数据封装为Map的list，同时释放当前查询结果集的数据库游标。
    
    参数:
    
    lowercaseKey - 是否对列名进行lowercase转换
    
    返回:
    
    结果数据封装到Map的List
    
    抛出:
    
    SQLException
  - resultSetToMap
```
public Map resultSetToMap()
                   throws BusinessException,
                          SQLException
```
    把当前查询结果集合结果数据取出第一条封装到Map，如果无数据则返回空的Map实例（不是null）
    
    返回:
    
    查询结果集第一条数据的Map
    
    抛出:
    
    BusinessException - 如果一条数据都没有，将抛出此异常
    
    SQLException
  - resultSetToMap
```
public Map resultSetToMap(ResultSet rs)
                   throws BusinessException,
                          SQLException
```
    把指定查询结果集合结果数据取出第一条封装到Map，如果无数据则返回空的Map实例（不是null）
    
    参数:
    
    rs - 要封装到Map的结果集对象
    
    返回:
    
    数据封装Map
    
    抛出:
    
    BusinessException - 如果一条数据都没有，将抛出此异常
    
    SQLException
  - close
```
public void close()
```
    释放数据库资源
    
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
  - release
```
public static void release()
```
    无论是否原生的连接，强制关闭连接，释放资源。
  - getDBUserName
```
public String getDBUserName()
                     throws SQLException
```
    数据库相关信息开始 *************************
    
    抛出:
    
    SQLException
  - getDialect
```
public org.hibernate.dialect.Dialect getDialect()
```
    获取当前Hibernate中的Dialect实例
    
    返回:
    
    当前Hibernate的Dialect实例
  - executeProcedure
```
public static Object executeProcedure(String callString,
                                      org.springframework.jdbc.core.CallableStatementCallback action)
```
    使用默认的数据源执行存储过程的工具方法
    
    参数:
    
    callString - 存储过程调用语句
    
    action - 存储过程调用回调函数实现
    
    返回:
    
    回调函数返回的对象
  - executeProcedure
```
public static Object executeProcedure(String dsName,
                                      String callString,
                                      org.springframework.jdbc.core.CallableStatementCallback action)
```
    执行存储过程的工具方法
    
    参数:
    
    dsName - 执行存储过程的数据源名称
    
    callString - 存储过程调用语句
    
    action - 存储过程调用回调函数实现
    
    返回:
    
    回调函数返回的对象
  - executePreparedStatement
```
public static Object executePreparedStatement(String preparedString,
                                              org.springframework.jdbc.core.PreparedStatementCallback action)
```
    使用默认的数据源执行预处理SQL的工具方法
    
    参数:
    
    callString - 预处理SQL调用语句
    
    action - 预处理SQL调用回调函数实现
    
    返回:
    
    回调函数返回的对象
  - executePreparedStatement
```
public static Object executePreparedStatement(String dsName,
                                              String preparedString,
                                              org.springframework.jdbc.core.PreparedStatementCallback action)
```
    执行预处理SQL的工具方法
    
    参数:
    
    dsName - 执行预处理SQL的数据源名称
    
    callString - 预处理SQL调用语句
    
    action - 预处理SQL调用回调函数实现
    
    返回:
    
    回调函数返回的对象
  - getConnection
```
public static Connection getConnection()
```
    获取默认受Spring事务管理控制的数据库连接（spring中配置的名称为dataSource的数据源连接）
    
    返回:
    
    数据库连接
  - getRawConnection
```
public static Connection getRawConnection()
                                   throws SQLException
```
    获取默认原始数据库连接（spring中配置的名称为dataSource的数据源连接）
    
    返回:
    
    数据库连接
    
    抛出:
    
    SQLException
  - getRawConnection
```
public static Connection getRawConnection(String dsName)
                                   throws SQLException
```
    获取在Spring中配置的指定数据源名称的原始数据库连接
    
    返回:
    
    数据库连接
    
    抛出:
    
    SQLException
  - getDataSource
```
public static DataSource getDataSource()
```
    获取在Spring中配置的默认数据源
    
    返回:
    
    数据源
  - getDataSource
```
public static DataSource getDataSource(String dsName)
```
    获取在Spring中配置的指定数据源
    
    返回:
    
    数据源
  - getDBType
```
public static String getDBType()
```
    获取当前连接的数据库类型标识，oracle、sqlserver、mysql、postgresql
    
    返回:
    
    当前数据库类型标识
  - loadSqlInFile
```
public static void loadSqlInFile()
```
  - getSqlInFile
```
public static String getSqlInFile(String sqlKey)
                           throws BusinessException
```
    获取自定义SQL，指定sqlKey的SQL脚本，SQL配置文件需要存放于cfgHome/sql目录下，且以数据库类型名称开头，或者文件名以ALL开头作为各数据库通用sql配置文件数据库类型名称如（注意区分大小写）：DB2、MySQL、Oracle、PostgreSQL、SQLServer
    
    参数:
    
    sqlKey - SQL配置key
    
    返回:
    
    SQL语句
    
    抛出:
    
    BusinessException
  - executeSqlFile
```
public void executeSqlFile(String sqlKey,
                           List params)
                    throws BusinessException,
                           IOException,
                           SQLException
```
    执行自定义SQL，指定sqlKey的SQL脚本，SQL文件需要存放于cfgHome/sql目录下，且以数据库类型名称开头，或者文件名以ALL开头作为各数据库通用sql配置文件数据库类型名称如（注意区分大小写）：DB2、MySQL、Oracle、PostgreSQL、SQLServer
    
    参数:
    
    sqlKey - SQL配置key
    
    params - 自定义SQL执行所需参数List
    
    抛出:
    
    BusinessException
    
    IOException
    
    SQLException
  - executeSqlFile
```
public void executeSqlFile(String sqlKey,
                           Map<String,Object> params)
                    throws BusinessException,
                           IOException,
                           SQLException
```
    执行自定义SQL，指定sqlKey的SQL脚本，SQL文件需要存放于cfgHome/sql目录下，且以数据库类型名称开头，或者文件名以ALL开头作为各数据库通用sql配置文件数据库类型名称如（注意区分大小写）：DB2、MySQL、Oracle、PostgreSQL、SQLServer 与executeSqlFile(String sqlKey, List params)类似，只是参数形式类似Hibernate的named query
    
    参数:
    
    sqlKey - SQL配置key
    
    params - 自定义SQL执行所需参数Map，类似Hibernate的named query
    
    抛出:
    
    BusinessException
    
    IOException
    
    SQLException
  - executeNamedSql
```
public void executeNamedSql(String namedSql,
                            Map<String,Object> params)
                     throws BusinessException,
                            IOException,
                            SQLException
```
    与execut函数执行sql类似，只是sql参数形式类似Hibernate的named query
    
    参数:
    
    namedSql - 类似Hibernate的named query的sql
    
    params - 自定义SQL执行所需参数Map，类似Hibernate的named query
    
    抛出:
    
    BusinessException
    
    IOException
    
    SQLException
  - executeSqlFile
```
public void executeSqlFile(String sqlKey)
                    throws BusinessException,
                           IOException,
                           SQLException
```
    无需参数执行自定义SQL
    
    参数:
    
    sqlKey - SQL配置key
    
    抛出:
    
    BusinessException
    
    IOException
    
    SQLException
  - clobToString
```
public static String clobToString(Clob clob)
                           throws SQLException
```
    抛出:
    
    SQLException
  - main
```
public static void main(String[] args)
```
    特定数据库SQL文件执行结束 ******************

类 JDBCAgent

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

JDBCAgent

JDBCAgent

JDBCAgent

JDBCAgent

方法详细资料

setMaxSeconds

init

execute

execute

execute

getQueryResult

executeBatch

batch1Prepare

batch2Add

batch3Execute

findByPaging

findByPaging

findNameByPaging

count

resultSetToList

resultSetToList

resultSetToMap

resultSetToMap

close

release

getDBUserName

getDialect

executeProcedure

executeProcedure

executePreparedStatement

executePreparedStatement

getConnection

getRawConnection

getRawConnection

getDataSource

getDataSource

getDBType

loadSqlInFile

getSqlInFile

executeSqlFile

executeSqlFile

executeNamedSql

executeSqlFile

clobToString

main