javacommon.easytools.db

类 AbstractSqlRunner

java.lang.Object

javacommon.easytools.db.AbstractSqlRunner

直接已知子类:

Session, SqlRunner, SqlRunnerExt

public abstract class AbstractSqlRunner
extends Object

抽象SQL执行类
通过给定的数据源执行给定SQL或者给定数据源和方言，执行相应的CRUD操作
提供抽象方法getConnection和closeConnection，用于自定义数据库连接的打开和关闭

字段概要

字段

限定符和类型	字段和说明
protected SqlConnRunner	runner

构造器概要

构造器

构造器和说明
AbstractSqlRunner()

方法概要

限定符和类型	方法和说明
abstract void	closeConnection(Connection conn) 关闭连接 自定义关闭连接有利于自定义回收连接机制，或者不关闭
int	count(Entity where) 结果的条目数
int	del(Entity where) 删除数据
int	del(String tableName, String field, Object value) 删除数据
int	execute(String sql, Object... params) 执行非查询语句 语句包括 插入、更新、删除
int[]	executeBatch(String sql, Object[]... paramsBatch) 批量执行非查询语句
Long	executeForGeneratedKey(String sql, Object... params) 执行非查询语句 语句包括 插入、更新、删除
<T> T	find(Collection<String> fields, Entity where, RsHandler<T> rsh) 查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
List<Entity>	find(Entity where) 查询数据列表，返回字段由where参数指定 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> List<T>	find(Entity where, Class<T> beanClass) 查询数据列表，返回字段由where参数指定 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> T	find(Entity where, RsHandler<T> rsh, String... fields) 查询，返回所有字段 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> T	find(Query query, RsHandler<T> rsh) 查询 Query为查询所需数据的一个实体类，此对象中可以定义返回字段、查询条件，查询的表、分页等信息
List<Entity>	findAll(Entity where) 查询数据列表，返回所有字段 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> List<T>	findAll(Entity where, Class<T> beanClass) 查询数据列表，返回所有字段 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
List<Entity>	findAll(String tableName) 查询数据列表，返回所有字段
List<Entity>	findBy(String tableName, Condition... wheres) 根据某个字段名条件查询数据列表，返回所有字段
List<Entity>	findBy(String tableName, String field, Object value) 根据某个字段名条件查询数据列表，返回所有字段
List<Entity>	findLike(String tableName, String field, String value, Condition.LikeType likeType) 根据某个字段名条件查询数据列表，返回所有字段
Entity	get(Entity where) 根据条件实体查询单个记录，当有多条返回时，只显示查询到的第一条
<T> Entity	get(String tableName, String field, T value) 根据某个字段（最好是唯一字段）查询单个记录 当有多条返回时，只显示查询到的第一条
abstract Connection	getConnection() 获得链接。
SqlConnRunner	getRunner() 获取SqlConnRunner
int[]	insert(Collection<Entity> records) 批量插入数据 需要注意的是，批量插入每一条数据结构必须一致。
int	insert(Entity record) 插入数据
Long	insertForGeneratedKey(Entity record) 插入数据
List<Object>	insertForGeneratedKeys(Entity record) 插入数据
PageResult<Entity>	page(Collection<String> fields, Entity where, int page, int numPerPage) 分页查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> T	page(Collection<String> fields, Entity where, int page, int numPerPage, RsHandler<T> rsh) 分页查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
PageResult<Entity>	page(Collection<String> fields, Entity where, Page page) 分页查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> T	page(Collection<String> fields, Entity where, Page page, RsHandler<T> rsh) 分页查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
PageResult<Entity>	page(Entity where, int page, int numPerPage) 分页查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> T	page(Entity where, int page, int numPerPage, RsHandler<T> rsh) 分页查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
PageResult<Entity>	page(Entity where, Page page) 分页查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> T	page(Entity where, Page page, RsHandler<T> rsh) 分页查询 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
List<Entity>	pageForEntityList(Entity where, int page, int numPerPage) 分页查询，结果为Entity列表，不计算总数 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
List<Entity>	pageForEntityList(Entity where, Page page) 分页查询，结果为Entity列表，不计算总数 查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略
<T> List<T>	query(String sql, Class<T> beanClass, Object... params) 查询
List<Entity>	query(String sql, Object... params) 查询
<T> T	query(String sql, RsHandler<T> rsh, Object... params) 查询
Number	queryNumber(String sql, Object... params) 查询单条单个字段记录,并将其转换为Number
Entity	queryOne(String sql, Object... params) 查询单条记录
String	queryString(String sql, Object... params) 查询单条单个字段记录,并将其转换为String
void	setRunner(SqlConnRunner runner) 设置 SqlConnRunner
AbstractSqlRunner	setWrapper(Character wrapperChar) 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
AbstractSqlRunner	setWrapper(Wrapper wrapper) 设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突
int	update(Entity record, Entity where) 更新数据 更新条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

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

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

字段详细资料

runner

protected SqlConnRunner runner

构造器详细资料

AbstractSqlRunner

public AbstractSqlRunner()

方法详细资料

getConnection

public abstract Connection getConnection()
                                  throws SQLException

获得链接。根据实现不同，可以自定义获取连接的方式

返回:

Connection

抛出:

SQLException - 连接获取异常

closeConnection

public abstract void closeConnection(Connection conn)

关闭连接
自定义关闭连接有利于自定义回收连接机制，或者不关闭

参数:

conn - 连接 Connection

query

public List<Entity> query(String sql,
                          Object... params)
                   throws SQLException

查询

参数:

sql - 查询语句

params - 参数

返回:

结果对象

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.1.1

query

public <T> List<T> query(String sql,
                         Class<T> beanClass,
                         Object... params)
                  throws SQLException

查询

类型参数:

T - 结果集需要处理的对象类型

参数:

sql - 查询语句

beanClass - 元素Bean类型

params - 参数

返回:

结果对象

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.2

queryOne

public Entity queryOne(String sql,
                       Object... params)
                throws SQLException

查询单条记录

参数:

sql - 查询语句

params - 参数

返回:

结果对象

抛出:

SQLException - SQL执行异常

queryNumber

public Number queryNumber(String sql,
                          Object... params)
                   throws SQLException

查询单条单个字段记录,并将其转换为Number

参数:

sql - 查询语句

params - 参数

返回:

结果对象

抛出:

SQLException - SQL执行异常

queryString

public String queryString(String sql,
                          Object... params)
                   throws SQLException

查询单条单个字段记录,并将其转换为String

参数:

sql - 查询语句

params - 参数

返回:

结果对象

抛出:

SQLException - SQL执行异常

query

public <T> T query(String sql,
                   RsHandler<T> rsh,
                   Object... params)
            throws SQLException

查询

类型参数:

T - 结果集需要处理的对象类型

参数:

sql - 查询语句

rsh - 结果集处理对象

params - 参数

返回:

结果对象

抛出:

SQLException - SQL执行异常

execute

public int execute(String sql,
                   Object... params)
            throws SQLException

执行非查询语句
语句包括 插入、更新、删除

参数:

sql - SQL

params - 参数

返回:

影响行数

抛出:

SQLException - SQL执行异常

executeForGeneratedKey

public Long executeForGeneratedKey(String sql,
                                   Object... params)
                            throws SQLException

执行非查询语句
语句包括 插入、更新、删除

参数:

sql - SQL

params - 参数

返回:

主键

抛出:

SQLException - SQL执行异常

executeBatch

public int[] executeBatch(String sql,
                          Object[]... paramsBatch)
                   throws SQLException

批量执行非查询语句

参数:

sql - SQL

paramsBatch - 批量的参数

返回:

每个SQL执行影响的行数

抛出:

SQLException - SQL执行异常

insert

public int insert(Entity record)
           throws SQLException

插入数据

参数:

record - 记录

返回:

插入行数

抛出:

SQLException - SQL执行异常

insert

public int[] insert(Collection<Entity> records)
             throws SQLException

批量插入数据
需要注意的是，批量插入每一条数据结构必须一致。批量插入数据时会获取第一条数据的字段结构，之后的数据会按照这个格式插入。
也就是说假如第一条数据只有2个字段，后边数据多于这两个字段的部分将被抛弃。

参数:

records - 记录列表

返回:

插入行数

抛出:

SQLException - SQL执行异常

insertForGeneratedKeys

public List<Object> insertForGeneratedKeys(Entity record)
                                    throws SQLException

插入数据

参数:

record - 记录

返回:

主键列表

抛出:

SQLException - SQL执行异常

insertForGeneratedKey

public Long insertForGeneratedKey(Entity record)
                           throws SQLException

插入数据

参数:

record - 记录

返回:

主键

抛出:

SQLException - SQL执行异常

del

public int del(String tableName,
               String field,
               Object value)
        throws SQLException

删除数据

参数:

tableName - 表名

field - 字段名，最好是主键

value - 值，值可以是列表或数组，被当作IN查询处理

返回:

删除行数

抛出:

SQLException - SQL执行异常

del

public int del(Entity where)
        throws SQLException

删除数据

参数:

where - 条件

返回:

影响行数

抛出:

SQLException - SQL执行异常

update

public int update(Entity record,
                  Entity where)
           throws SQLException

更新数据
更新条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

record - 记录

where - 条件

返回:

影响行数

抛出:

SQLException - SQL执行异常

get

public <T> Entity get(String tableName,
                      String field,
                      T value)
               throws SQLException

根据某个字段（最好是唯一字段）查询单个记录
当有多条返回时，只显示查询到的第一条

类型参数:

T - 字段值类型

参数:

tableName - 表名

field - 字段名

value - 字段值

返回:

记录

抛出:

SQLException - SQL执行异常

get

public Entity get(Entity where)
           throws SQLException

根据条件实体查询单个记录，当有多条返回时，只显示查询到的第一条

参数:

where - 条件

返回:

记录

抛出:

SQLException - SQL执行异常

find

public <T> T find(Collection<String> fields,
                  Entity where,
                  RsHandler<T> rsh)
           throws SQLException

查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

类型参数:

T - 需要处理成的结果对象类型

参数:

fields - 返回的字段列表，null则返回所有字段

where - 条件实体类（包含表名）

rsh - 结果集处理对象

返回:

结果对象

抛出:

SQLException - SQL执行异常

find

public <T> T find(Query query,
                  RsHandler<T> rsh)
           throws SQLException

查询
Query为查询所需数据的一个实体类，此对象中可以定义返回字段、查询条件，查询的表、分页等信息

类型参数:

T - 需要处理成的结果对象类型

参数:

query - Query对象，此对象中可以定义返回字段、查询条件，查询的表、分页等信息

rsh - 结果集处理对象

返回:

结果对象

抛出:

SQLException - SQL执行异常

从以下版本开始:

4.0.0

find

public <T> T find(Entity where,
                  RsHandler<T> rsh,
                  String... fields)
           throws SQLException

查询，返回所有字段
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

类型参数:

T - 需要处理成的结果对象类型

参数:

where - 条件实体类（包含表名）

rsh - 结果集处理对象

fields - 字段列表，可变长参数如果无值表示查询全部字段

返回:

结果对象

抛出:

SQLException - SQL执行异常

find

public List<Entity> find(Entity where)
                  throws SQLException

查询数据列表，返回字段由where参数指定
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

where - 条件实体类（包含表名）

返回:

数据对象列表

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.1

find

public <T> List<T> find(Entity where,
                        Class<T> beanClass)
                 throws SQLException

查询数据列表，返回字段由where参数指定
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

类型参数:

T - Bean类型

参数:

where - 条件实体类（包含表名）

返回:

数据对象列表

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.2

findAll

public List<Entity> findAll(Entity where)
                     throws SQLException

查询数据列表，返回所有字段
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

where - 条件实体类（包含表名）

返回:

数据对象列表

抛出:

SQLException - SQL执行异常

findAll

public <T> List<T> findAll(Entity where,
                           Class<T> beanClass)
                    throws SQLException

查询数据列表，返回所有字段
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

类型参数:

T - Bean类型

参数:

where - 条件实体类（包含表名）

返回:

数据对象列表

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.2

findAll

public List<Entity> findAll(String tableName)
                     throws SQLException

查询数据列表，返回所有字段

参数:

tableName - 表名

返回:

数据对象列表

抛出:

SQLException - SQL执行异常

findBy

public List<Entity> findBy(String tableName,
                           String field,
                           Object value)
                    throws SQLException

根据某个字段名条件查询数据列表，返回所有字段

参数:

tableName - 表名

field - 字段名

value - 字段值

返回:

数据对象列表

抛出:

SQLException - SQL执行异常

findBy

public List<Entity> findBy(String tableName,
                           Condition... wheres)
                    throws SQLException

根据某个字段名条件查询数据列表，返回所有字段

参数:

tableName - 表名

wheres - 字段名

返回:

数据对象列表

抛出:

SQLException - SQL执行异常

从以下版本开始:

4.0.0

findLike

public List<Entity> findLike(String tableName,
                             String field,
                             String value,
                             Condition.LikeType likeType)
                      throws SQLException

根据某个字段名条件查询数据列表，返回所有字段

参数:

tableName - 表名

field - 字段名

value - 字段值

likeType - Condition.LikeType

返回:

数据对象列表

抛出:

SQLException - SQL执行异常

count

public int count(Entity where)
          throws SQLException

结果的条目数

参数:

where - 查询条件

返回:

复合条件的结果数

抛出:

SQLException - SQL执行异常

page

public <T> T page(Collection<String> fields,
                  Entity where,
                  int page,
                  int numPerPage,
                  RsHandler<T> rsh)
           throws SQLException

分页查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

类型参数:

T - 结果对象类型

参数:

fields - 返回的字段列表，null则返回所有字段

where - 条件实体类（包含表名）

page - 页码

numPerPage - 每页条目数

rsh - 结果集处理对象

返回:

结果对象

抛出:

SQLException - SQL执行异常

page

public <T> T page(Entity where,
                  int page,
                  int numPerPage,
                  RsHandler<T> rsh)
           throws SQLException

分页查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

类型参数:

T - 结果对象类型

参数:

where - 条件实体类（包含表名）

page - 页码

numPerPage - 每页条目数

rsh - 结果集处理对象

返回:

结果对象

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.2

pageForEntityList

public List<Entity> pageForEntityList(Entity where,
                                      int page,
                                      int numPerPage)
                               throws SQLException

分页查询，结果为Entity列表，不计算总数
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

where - 条件实体类（包含表名）

page - 页码

numPerPage - 每页条目数

返回:

结果对象

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.2

pageForEntityList

public List<Entity> pageForEntityList(Entity where,
                                      Page page)
                               throws SQLException

分页查询，结果为Entity列表，不计算总数
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

where - 条件实体类（包含表名）

page - 分页对象

返回:

结果对象

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.2

page

public <T> T page(Entity where,
                  Page page,
                  RsHandler<T> rsh)
           throws SQLException

分页查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

类型参数:

T - 结果对象类型

参数:

where - 条件实体类（包含表名）

page - 分页对象

rsh - 结果集处理对象

返回:

结果对象

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.2

page

public <T> T page(Collection<String> fields,
                  Entity where,
                  Page page,
                  RsHandler<T> rsh)
           throws SQLException

分页查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

类型参数:

T - 结果对象类型

参数:

fields - 返回的字段列表，null则返回所有字段

where - 条件实体类（包含表名）

page - 分页对象

rsh - 结果集处理对象

返回:

结果对象

抛出:

SQLException - SQL执行异常

page

public PageResult<Entity> page(Collection<String> fields,
                               Entity where,
                               int page,
                               int numPerPage)
                        throws SQLException

分页查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

fields - 返回的字段列表，null则返回所有字段

where - 条件实体类（包含表名）

page - 分页对象

numPerPage - 每页条目数

返回:

结果对象

抛出:

SQLException - SQL执行异常

page

public PageResult<Entity> page(Collection<String> fields,
                               Entity where,
                               Page page)
                        throws SQLException

分页查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

fields - 返回的字段列表，null则返回所有字段

where - 条件实体类（包含表名）

page - 分页对象

返回:

结果对象

抛出:

SQLException - SQL执行异常

page

public PageResult<Entity> page(Entity where,
                               int page,
                               int numPerPage)
                        throws SQLException

分页查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

where - 条件实体类（包含表名）

page - 页码

numPerPage - 每页条目数

返回:

分页结果集

抛出:

SQLException - SQL执行异常

从以下版本开始:

3.2.2

page

public PageResult<Entity> page(Entity where,
                               Page page)
                        throws SQLException

分页查询
查询条件为多个key value对表示，默认key = value，如果使用其它条件可以使用：where.put("key", " > 1")，value也可以传Condition对象，key被忽略

参数:

where - 条件实体类（包含表名）

page - 分页对象

返回:

分页结果集

抛出:

SQLException - SQL执行异常

getRunner

public SqlConnRunner getRunner()

获取SqlConnRunner

返回:

SqlConnRunner

setRunner

public void setRunner(SqlConnRunner runner)

设置 SqlConnRunner

参数:

runner - SqlConnRunner

setWrapper

public AbstractSqlRunner setWrapper(Character wrapperChar)

设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突

参数:

wrapperChar - 包装字符，字符会在SQL生成时位于表名和字段名两边，null时表示取消包装

返回:

this

从以下版本开始:

4.0.0

setWrapper

public AbstractSqlRunner setWrapper(Wrapper wrapper)

设置包装器，包装器用于对表名、字段名进行符号包装（例如双引号），防止关键字与这些表名或字段冲突

参数:

wrapper - 包装器，null表示取消包装

返回:

this

从以下版本开始:

4.0.0