org.dromara.hutool.db.sql

Class StatementUtil

java.lang.Object

org.dromara.hutool.db.sql.StatementUtil

public class StatementUtil
extends Object

Statement和PreparedStatement工具类

Since:

4.0.10

Author:

looly

Constructor Summary

Constructors

Constructor and Description
StatementUtil()

Method Summary

Modifier and Type	Method and Description
static <T> T	executeQuery(PreparedStatement ps, RsHandler<T> rsh) 执行查询
static int	executeUpdate(PreparedStatement ps, Object... params) 用于执行 INSERT、UPDATE 或 DELETE 语句以及 SQL DDL（数据定义语言）语句，例如 CREATE TABLE 和 DROP TABLE。
static PreparedStatement	fillArrayParam(PreparedStatement ps, Object... params) 填充SQL的参数。
static PreparedStatement	fillParams(PreparedStatement ps, Iterable<?> params) 填充SQL的参数。
static PreparedStatement	fillParams(PreparedStatement ps, Iterable<?> params, Map<Integer,Integer> nullTypeCache) 填充SQL的参数。
static Long	getGeneratedKeyOfLong(Statement ps) 获得自增键的值 此方法对于Oracle无效（返回null）
static List<Object>	getGeneratedKeys(Statement ps) 获得所有主键
static <T> T	getGeneratedKeys(Statement statement, RsHandler<T> rsHandler) 获取主键，并使用RsHandler 处理后返回
static int	getTypeOfNull(PreparedStatement ps, int paramIndex) 获取null字段对应位置的数据类型 有些数据库对于null字段必须指定类型，否则会插入报错，此方法用于获取其类型，如果获取失败，使用默认的Types.VARCHAR
static CallableStatement	prepareCall(DbConfig config, Connection conn, String sql, Object... params) 创建CallableStatement
static PreparedStatement	prepareStatement(boolean returnGeneratedKey, DbConfig config, Connection conn, String sql, Object... params) 创建PreparedStatement
static PreparedStatement	prepareStatementForBatch(DbConfig config, Connection conn, String sql, Iterable<Object[]> paramsBatch) 创建批量操作的PreparedStatement
static PreparedStatement	prepareStatementForBatch(DbConfig config, Connection conn, String sql, Object[]... paramsBatch) 创建批量操作的PreparedStatement
static void	setParam(PreparedStatement ps, int paramIndex, Object param) 为PreparedStatement 设置单个参数

Methods inherited from class java.lang.Object

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

Constructor Detail

StatementUtil

public StatementUtil()

Method Detail

prepareStatement

public static PreparedStatement prepareStatement(boolean returnGeneratedKey,
                                                 DbConfig config,
                                                 Connection conn,
                                                 String sql,
                                                 Object... params)

创建PreparedStatement

Parameters:

returnGeneratedKey - 当为insert语句时，是否返回主键

config - 数据库配置

conn - 数据库连接

sql - SQL语句，使用"?"做为占位符

params - "?"对应参数列表或者Map表示命名参数

Returns:

PreparedStatement

Since:

5.8.19

prepareStatementForBatch

public static PreparedStatement prepareStatementForBatch(DbConfig config,
                                                         Connection conn,
                                                         String sql,
                                                         Object[]... paramsBatch)

创建批量操作的PreparedStatement

Parameters:

config - 数据库配置

conn - 数据库连接

sql - SQL语句，使用"?"做为占位符

paramsBatch - "?"对应参数批次列表

Returns:

PreparedStatement

Since:

4.1.13

prepareStatementForBatch

public static PreparedStatement prepareStatementForBatch(DbConfig config,
                                                         Connection conn,
                                                         String sql,
                                                         Iterable<Object[]> paramsBatch)

创建批量操作的PreparedStatement

Parameters:

config - 数据库配置

conn - 数据库连接

sql - SQL语句，使用"?"做为占位符

paramsBatch - "?"对应参数批次列表

Returns:

PreparedStatement

Since:

4.1.13

prepareCall

public static CallableStatement prepareCall(DbConfig config,
                                            Connection conn,
                                            String sql,
                                            Object... params)
                                     throws SQLException

创建CallableStatement

Parameters:

config - 数据库配置

conn - 数据库连接

sql - SQL语句，使用"?"做为占位符

params - "?"对应参数列表

Returns:

CallableStatement

Throws:

SQLException - SQL异常

Since:

4.1.13

getGeneratedKeyOfLong

public static Long getGeneratedKeyOfLong(Statement ps)
                                  throws SQLException

获得自增键的值
此方法对于Oracle无效（返回null）

Parameters:

ps - PreparedStatement

Returns:

自增键的值，不存在返回null

Throws:

SQLException - SQL执行异常

getGeneratedKeys

public static List<Object> getGeneratedKeys(Statement ps)
                                     throws SQLException

获得所有主键

Parameters:

ps - PreparedStatement

Returns:

所有主键

Throws:

SQLException - SQL执行异常

getGeneratedKeys

public static <T> T getGeneratedKeys(Statement statement,
                                     RsHandler<T> rsHandler)
                              throws SQLException

获取主键，并使用RsHandler 处理后返回

Type Parameters:

T - 自定义主键类型

Parameters:

statement - Statement

rsHandler - 主键结果集处理器

Returns:

主键

Throws:

SQLException - SQL执行异常

Since:

5.5.3

getTypeOfNull

public static int getTypeOfNull(PreparedStatement ps,
                                int paramIndex)

获取null字段对应位置的数据类型
有些数据库对于null字段必须指定类型，否则会插入报错，此方法用于获取其类型，如果获取失败，使用默认的Types.VARCHAR

Parameters:

ps - Statement

paramIndex - 参数位置，第一位从1开始

Returns:

数据类型，默认Types.VARCHAR

Since:

4.6.7

fillArrayParam

public static PreparedStatement fillArrayParam(PreparedStatement ps,
                                               Object... params)
                                        throws SQLException

填充SQL的参数。

Parameters:

ps - PreparedStatement

params - SQL参数

Returns:

PreparedStatement

Throws:

SQLException - SQL执行异常

fillParams

public static PreparedStatement fillParams(PreparedStatement ps,
                                           Iterable<?> params)
                                    throws SQLException

填充SQL的参数。
对于日期对象特殊处理：传入java.util.Date默认按照Timestamp处理

Parameters:

ps - PreparedStatement

params - SQL参数

Returns:

PreparedStatement

Throws:

SQLException - SQL执行异常

fillParams

public static PreparedStatement fillParams(PreparedStatement ps,
                                           Iterable<?> params,
                                           Map<Integer,Integer> nullTypeCache)
                                    throws SQLException

填充SQL的参数。
对于日期对象特殊处理：传入java.util.Date默认按照Timestamp处理

Parameters:

ps - PreparedStatement

params - SQL参数

nullTypeCache - null参数的类型缓存，避免循环中重复获取类型

Returns:

PreparedStatement

Throws:

SQLException - SQL执行异常

Since:

4.6.7

setParam

public static void setParam(PreparedStatement ps,
                            int paramIndex,
                            Object param)
                     throws SQLException

为PreparedStatement 设置单个参数

Parameters:

ps - PreparedStatement

paramIndex - 参数位置，从1开始

param - 参数

Throws:

SQLException - SQL异常

Since:

4.6.7

executeQuery

public static <T> T executeQuery(PreparedStatement ps,
                                 RsHandler<T> rsh)
                          throws DbException

执行查询

Type Parameters:

T - 结果类型

Parameters:

ps - PreparedStatement

rsh - 结果集处理对象

Returns:

结果对象

Throws:

DbException - SQL执行异常

Since:

4.1.13

executeUpdate

public static int executeUpdate(PreparedStatement ps,
                                Object... params)
                         throws DbException

用于执行 INSERT、UPDATE 或 DELETE 语句以及 SQL DDL（数据定义语言）语句，例如 CREATE TABLE 和 DROP TABLE。
INSERT、UPDATE 或 DELETE 语句的效果是修改表中零行或多行中的一列或多列。
executeUpdate 的返回值是一个整数（int），指示受影响的行数（即更新计数）。
对于 CREATE TABLE 或 DROP TABLE 等不操作行的语句，executeUpdate 的返回值总为零。
此方法不会关闭PreparedStatement

Parameters:

ps - PreparedStatement对象

params - 参数

Returns:

影响的行数

Throws:

DbException - SQL执行异常