exp.libs.db.sql

类 DBUtils

java.lang.Object

exp.libs.db.sql.DBUtils

直接已知子类:

SqliteUtils

public class DBUtils
extends Object

 数据库工具.
 
 使用示例:
        DataSourceBean ds = new DataSourceBean();
        ds.setDriver(DBType.MYSQL.DRIVER);
        ds.set....
 
        Connection conn = DBUtils.getConn(ds);
        DBUtils.query(DBUtils, sql);
        DBUtils.close(conn);
 

PROJECT : exp-libs
SUPPORT : https://exp-blog.com

从以下版本开始:

JDK 1.8+

版本:

2022-03-06

作者:

EXP: exp.lqb@foxmail.com

构造器概要

构造器

限定符	构造器和说明
protected	DBUtils() 私有化构造函数

方法概要

限定符和类型	方法和说明
static List<Map<String,Object>>	callSP(Connection conn, String proSql, Object[] params) 调用存储过程，获取[结果集]返回。
static void	close(Connection conn) 关闭数据库连接
static void	commit(Connection conn) 提交数据库变更
static boolean	createBeanFromDB(Connection conn, String packageName, String outDirPath, String[] exportTables) 根据物理表生成对应的JavaBean类文件（类似Bean与Dao的复合对象）.
static boolean	createBeanFromPDM(String pdmPath, String packageName, String outDirPath, String[] exportTables) 根据物理模型生成对应的JavaBean类文件（类似Bean与Dao的复合对象）.
static String	execSP(Connection conn, String proSql, Object[] params) 执行存储过程，获得简单返回值（支持[无返回值]和 [单值]返回两种形式）。
static boolean	execute(Connection conn, String sql) 执行普通sql
static boolean	execute(Connection conn, String preSql, Object[] params) 执行预编译sql
static Connection	getConn(DataSourceBean ds) 获取数据库连接(先通过连接池获取，若连接池获取失败，则改用JDBC获取).
static Connection	getConn(DataSourceBean ds, int retry) 获取数据库连接(先通过连接池获取，若连接池获取失败，则改用JDBC获取).
static Connection	getConnByJDBC(DataSourceBean ds) 通过JDBC获取数据库连接.
static Connection	getConnByPool(DataSourceBean ds) 通过连接池获取数据库连接
static DBType	judgeDBType(Connection conn) 通过Connection判断数据库类型
static <BEAN> List<BEAN>	query(Class<BEAN> clazz, Connection conn, String sql) 查询一个JavaBean对应的物理表数据，并把对应列值转存到JavaBean对应的成员域.
static Object	queryCellObj(Connection conn, String sql) 查询[第一行][第一列]的单元格值（所得值保留其原本的数据类型）.
static String	queryCellStr(Connection conn, String sql) 查询[第一行][第一列]的单元格值（所得值强制转换为String类型）.
static List<Object>	queryColumnObj(Connection conn, String sql, int col) 查询[第col列]表数据（数据值保留其原本的数据类型）.
static List<String>	queryColumnStr(Connection conn, String sql, int col) 查询[第col列]表数据（数据值会被强制转换成String类型）.
static Map<String,Object>	queryFirstRowObj(Connection conn, String sql) 查询[第一行]表数据.
static Map<String,String>	queryFirstRowStr(Connection conn, String sql) 查询[第一行]表数据.
static int	queryInt(Connection conn, String sql) 查询一个int整数值.
static Map<String,Object>	queryKVO(Connection conn, String sql) 查询键值对(其中值会保留其原本数据类型).
static List<Map<String,Object>>	queryKVOs(Connection conn, String sql) 查询多行表数据.
static Map<String,String>	queryKVS(Connection conn, String sql) 查询键值对(其中值会被强制转换为String类型).
static List<Map<String,String>>	queryKVSs(Connection conn, String sql) 查询多行表数据.
static long	queryLong(Connection conn, String sql) 查询一个long整数值.
static void	setAutoCommit(Connection conn, boolean autoCommit) 开/关 数据库自动提交
static void	setAutoShutdownPool(boolean auto) 设置是否自动关闭线程池.
static void	shutdownPool() 马上关闭线程池
static void	shutdownPool(int delay) 延迟一段时间后关闭线程池
static boolean	testConn(DataSourceBean ds) 测试数据源连接是否可用

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

DBUtils

protected DBUtils()

私有化构造函数

方法详细资料

setAutoShutdownPool

public static void setAutoShutdownPool(boolean auto)

 设置是否自动关闭线程池.
 
        使用场景：
   通常当在进程销毁钩子中需要入库操作时, 若使用线程池, 则必定报错：
                Attempt to refer to a unregistered pool by its alias xxx
 
   这是因为proxool总是最先向JVM请求销毁自身, 导致在进程销毁钩子无法使用线程池, 只能使用常规的JDBC操作.
   
   通过此方法, 在程序使用线程池之前设置 false 可以避免这种主动销毁的行为
   但是在进程钩子的最后, 需要手动调用 shutdownPool() 方法关闭线程池
 

参数:

auto - true:自动关闭线程池(默认); false:手动关闭线程池

shutdownPool

public static void shutdownPool()

马上关闭线程池

shutdownPool

public static void shutdownPool(int delay)

延迟一段时间后关闭线程池

参数:

delay - 延迟时间, 单位:ms

testConn

public static boolean testConn(DataSourceBean ds)

测试数据源连接是否可用

参数:

ds - 数据源

返回:

true:连接可用; false:连接不可用

judgeDBType

public static DBType judgeDBType(Connection conn)

通过Connection判断数据库类型

参数:

conn - 数据库连接

返回:

数据库类型

getConn

public static Connection getConn(DataSourceBean ds)

 获取数据库连接(先通过连接池获取，若连接池获取失败，则改用JDBC获取).
        在连接成功前，重试若干次(默认10次)
 

参数:

ds - 数据库配置信息

返回:

数据库连接(若连接失败返回null)

getConn

public static Connection getConn(DataSourceBean ds,
                                 int retry)

 获取数据库连接(先通过连接池获取，若连接池获取失败，则改用JDBC获取).
        在连接成功前，重试若干次.
 

参数:

ds - 数据库配置信息

retry - 重试次数

返回:

数据库连接(若连接失败返回null)

getConnByPool

public static Connection getConnByPool(DataSourceBean ds)

通过连接池获取数据库连接

参数:

ds - 数据库配置信息

返回:

数据库连接(若连接失败返回null)

getConnByJDBC

public static Connection getConnByJDBC(DataSourceBean ds)

 通过JDBC获取数据库连接.
 （在shutdown等场景下无法通过连接池获取连接，此时需用JDBC方式）
 

参数:

ds - 数据库配置信息

返回:

数据库连接(若连接失败返回null)

setAutoCommit

public static void setAutoCommit(Connection conn,
                                 boolean autoCommit)

开/关 数据库自动提交

参数:

conn - 数据库连接

autoCommit - 是否自动提交

commit

public static void commit(Connection conn)

提交数据库变更

参数:

conn - 数据库连接

close

public static void close(Connection conn)

关闭数据库连接

参数:

conn - 数据库连接

createBeanFromDB

public static boolean createBeanFromDB(Connection conn,
                                       String packageName,
                                       String outDirPath,
                                       String[] exportTables)

 根据物理表生成对应的JavaBean类文件（类似Bean与Dao的复合对象）.
        表名和列名会自动做前缀删除和驼峰处理.
        例如：
                表名为 T_CP_USER， 类名则为 CpUser
                列名为 I_ID，类成员域名则为iId
 

参数:

conn - 数据库连接

packageName - 所生成的JavaBean类文件的包路径, 如: foo.bar.bean

outDirPath - 所生成的JavaBean类文件的存储路径, 如: ./src/main/java/foo/bar/bean

exportTables - 需要导出为JavaBean的物理表名集（若为空则全库导出）

返回:

true:成功; false:失败

createBeanFromPDM

public static boolean createBeanFromPDM(String pdmPath,
                                        String packageName,
                                        String outDirPath,
                                        String[] exportTables)

 根据物理模型生成对应的JavaBean类文件（类似Bean与Dao的复合对象）.
        表名和列名会自动做前缀删除和驼峰处理.
        例如：
                表名为 T_CP_USER， 类名则为 CpUser
                列名为 I_ID，类成员域名则为iId
 

参数:

pdmPath - 物理模型文件路径（支持PowerDesigner）

packageName - 所生成的JavaBean类文件的包路径, 如: foo.bar.bean

outDirPath - 所生成的JavaBean类文件的存储路径, 如: ./src/main/java/foo/bar/bean

exportTables - 需要导出为JavaBean的物理表名集（若为空则全库导出）

返回:

true:成功; false:失败

query

public static <BEAN> List<BEAN> query(Class<BEAN> clazz,
                                      Connection conn,
                                      String sql)

查询一个JavaBean对应的物理表数据，并把对应列值转存到JavaBean对应的成员域.

参数:

clazz - JavaBean类定义

conn - 数据库连接

sql - 查询sql

返回:

JavaBean对象列表（查询失败返回null）

queryKVS

public static Map<String,String> queryKVS(Connection conn,
                                          String sql)

 查询键值对(其中值会被强制转换为String类型).
        仅适用于形如 【select key, value from table where ...】 的sql
 

参数:

conn - 数据库连接

sql - 键值对查询SQL

返回:

Map 键值对表 （不会返回null）

queryKVO

public static Map<String,Object> queryKVO(Connection conn,
                                          String sql)

 查询键值对(其中值会保留其原本数据类型).
        仅适用于形如 【select key, value from table where ...】 的sql
 

参数:

conn - 数据库连接

sql - 键值对查询SQL

返回:

Map 键值对表 （不会返回null）

queryKVSs

public static List<Map<String,String>> queryKVSs(Connection conn,
                                                 String sql)

 查询多行表数据.
        每行数据以列名为key，以列值为val（列值会被强制转换成String类型）.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

List> (不会返回null)

queryKVOs

public static List<Map<String,Object>> queryKVOs(Connection conn,
                                                 String sql)

 查询多行表数据.
        每行数据以列名为key，以列值为val（列值会保留其原本数据类型）.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

List> (不会返回null)

queryInt

public static int queryInt(Connection conn,
                           String sql)

 查询一个int整数值.
  若返回的不是 1x1 的结果集，只取 [1][1] 作为返回值.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

查询结果（查询失败则返回-1）

queryLong

public static long queryLong(Connection conn,
                             String sql)

 查询一个long整数值.
  若返回的不是 1x1 的结果集，只取 [1][1] 作为返回值.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

查询结果（查询失败则返回-1）

queryCellStr

public static String queryCellStr(Connection conn,
                                  String sql)

 查询[第一行][第一列]的单元格值（所得值强制转换为String类型）.
  若返回的不是 1x1 的结果集，只取 [1][1] 作为返回值.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

查询结果（查询失败则返回null）

queryCellObj

public static Object queryCellObj(Connection conn,
                                  String sql)

 查询[第一行][第一列]的单元格值（所得值保留其原本的数据类型）.
  若返回的不是 1x1 的结果集，只取 [1][1] 作为返回值.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

查询结果（查询失败则返回null）

queryFirstRowStr

public static Map<String,String> queryFirstRowStr(Connection conn,
                                                  String sql)

 查询[第一行]表数据.
        行数据以列名为key，以列值为val（列值会被强制转换成String类型）.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

Map (不会返回null)

queryFirstRowObj

public static Map<String,Object> queryFirstRowObj(Connection conn,
                                                  String sql)

 查询[第一行]表数据.
        行数据以列名为key，以列值为val（列值保留其原本的数据类型）.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

Map (不会返回null)

queryColumnStr

public static List<String> queryColumnStr(Connection conn,
                                          String sql,
                                          int col)

 查询[第col列]表数据（数据值会被强制转换成String类型）.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

List (不会返回null)

queryColumnObj

public static List<Object> queryColumnObj(Connection conn,
                                          String sql,
                                          int col)

 查询[第col列]表数据（数据值保留其原本的数据类型）.
 

参数:

conn - 数据库连接

sql - 查询sql

返回:

List (不会返回null)

execute

public static boolean execute(Connection conn,
                              String preSql,
                              Object[] params)

执行预编译sql

参数:

conn - 数据库连接

preSql - 预编译sql

params - 参数表

返回:

true:执行成功; false:执行失败

execute

public static boolean execute(Connection conn,
                              String sql)

执行普通sql

参数:

conn - 数据库连接

sql - 普通sql

返回:

true:执行成功; false:执行sql

execSP

public static String execSP(Connection conn,
                            String proSql,
                            Object[] params)

 执行存储过程，获得简单返回值（支持[无返回值]和 [单值]返回两种形式）。
 根据数据库连接自动识别 mysql、sybase、oracle。
 
 注意：
 参数如果有null，则可能出错，特别是sybase数据库
 
 mysql存储过程要求：
  入参表：proSql的占位符?个数 必须与 入参表params长度相同，否则抛出SQLException异常。
        返回值：最后一个结果集（即SELECT语句）的第1行、第1列的值。
 
 sybase存储过程要求：
  入参表：proSql的占位符?个数 必须与 入参表params长度相同，否则抛出SQLException异常。
        返回值：return所指定的值。
 
 oracle存储过程要求：
  入参表：当proSql的占位符?个数 比 入参表params长度多0，为无返回值形式；
       多1，为有返回值形式。其余情况抛出SQLException异常。
        返回值：当proSql的占位符?个数比入参表params多1，则认为最后1个占位符是出参。
 

参数:

conn - 数据库连接

proSql - 存储过程SQL，占位符格式，如 SP_TEST(?,?,?)

params - 入参表

返回:

对于返回单值的存储过程，返回String类型，即兼容数字和字符、但日期类型无法保证格式。 对于无返回值的存储过程，会返回任意值，不取返回值即可。

callSP

public static List<Map<String,Object>> callSP(Connection conn,
                                              String proSql,
                                              Object[] params)

 调用存储过程，获取[结果集]返回。
 根据数据库连接自动识别 mysql、sybase、oracle。
 
 注意：
 参数如果有null，则可能出错，特别是sybase数据库
 
 mysql存储过程要求：
  入参表：proSql的占位符?个数 必须与 入参表params长度相同，否则抛出SQLException异常。
        返回值：最后一个结果集（即SELECT语句）的第1行、第1列的值。
 
 sybase存储过程要求：
  入参表：proSql的占位符?个数 必须与 入参表params长度相同，否则抛出SQLException异常。
        返回值：return所指定的值。
 
 oracle存储过程要求：
  入参表：当proSql的占位符?个数 比 入参表params长度多0，为无返回值形式；
       多1，为有返回值形式。其余情况抛出SQLException异常。
        返回值：当proSql的占位符?个数比入参表params多1，则认为最后1个占位符是出参。
 

参数:

conn - 数据库连接

proSql - 存储过程SQL，占位符格式，如 SP_TEST(?,?,?)

params - 入参表

返回:

List>结果集（不会返回null）