DaoTemplate (hutool-db 4.6.0 API)

java.lang.Object
- cn.hutool.db.DaoTemplate

```
public class DaoTemplate
extends Object
```
数据访问层模板
此模板用于简化对指定表的操作，简化的操作如下：
1、在初始化时指定了表名，CRUD操作时便不需要表名
2、在初始化时指定了主键，某些需要主键的操作便不需要指定主键类型

作者:

Looly

字段概要

字段
限定符和类型	字段和说明
`protected Db`	`db` SQL运行器
`protected String`	`primaryKeyField` 本表的主键字段，请在子类中覆盖或构造方法中指定，默认为id
`protected String`	`tableName` 表名

构造器概要

构造器
构造器和说明
`DaoTemplate(String tableName)` 构造，此构造需要自定义SqlRunner，主键默认为id
`DaoTemplate(String tableName, DataSource ds)`
`DaoTemplate(String tableName, String primaryKeyField)` 构造，使用默认的池化连接池，读取默认配置文件的空分组，适用于只有一个数据库的情况
`DaoTemplate(String tableName, String primaryKeyField, DataSource ds)` 构造
`DaoTemplate(String tableName, String primaryKeyField, Db db)` 构造

方法概要

方法
限定符和类型	方法和说明
`int`	`add(Entity entity)` 添加
`Long`	`addForGeneratedKey(Entity entity)` 添加
`List<Object>`	`addForGeneratedKeys(Entity entity)` 添加
`int`	`addOrUpdate(Entity entity)` 增加或者更新实体
`int`	`count(Entity where)` 满足条件的数据条目数量
`<T> int`	`del(Entity where)` 删除
`<T> int`	`del(String field, T value)` 删除
`<T> int`	`del(T pk)` 删除
`boolean`	`exist(Entity where)` 指定条件的数据是否存在
`List<Entity>`	`find(Entity where)` 根据某个字段值查询结果
`<T> List<Entity>`	`find(String field, T value)` 根据某个字段值查询结果
`List<Entity>`	`findAll()` 查询当前表的所有记录
`List<Entity>`	`findBySql(String sql, Object... params)` 根据SQL语句查询结果 SQL语句可以是非完整SQL语句，可以只提供查询的条件部分（例如WHERE部分）此方法会自动补全SELECT * FROM [tableName] 部分，这样就无需关心表名，直接提供条件即可
`Entity`	`get(Entity where)` 根据条件实体查询单个记录，当有多条返回时，只显示查询到的第一条
`<T> Entity`	`get(String field, T value)` 根据某个字段（最好是唯一字段）查询单个记录当有多条返回时，只显示查询到的第一条
`<T> Entity`	`get(T pk)` 根据主键获取单个记录
`PageResult<Entity>`	`page(Entity where, Page page)` 分页
`PageResult<Entity>`	`page(Entity where, Page page, String... selectFields)` 分页
`int`	`update(Entity entity)` 更新
`int`	`update(Entity record, Entity where)` 按照条件更新

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

- 字段详细资料
  - tableName
```
protected String tableName
```
    表名
  - primaryKeyField
```
protected String primaryKeyField
```
    本表的主键字段，请在子类中覆盖或构造方法中指定，默认为id
  - db
```
protected Db db
```
    SQL运行器
- 构造器详细资料
  - DaoTemplate
```
public DaoTemplate(String tableName)
```
    构造，此构造需要自定义SqlRunner，主键默认为id
    
    参数:
    tableName - 数据库表名
  - DaoTemplate
```
public DaoTemplate(String tableName,
           String primaryKeyField)
```
    构造，使用默认的池化连接池，读取默认配置文件的空分组，适用于只有一个数据库的情况
    
    参数:
    tableName - 数据库表名
    primaryKeyField - 主键字段名
  - DaoTemplate
```
public DaoTemplate(String tableName,
           DataSource ds)
```
  - DaoTemplate
```
public DaoTemplate(String tableName,
           String primaryKeyField,
           DataSource ds)
```
    构造
    
    参数:
    tableName - 表名
    primaryKeyField - 主键字段名
    ds - 数据源
  - DaoTemplate
```
public DaoTemplate(String tableName,
           String primaryKeyField,
           Db db)
```
    构造
    
    参数:
    tableName - 表名
    primaryKeyField - 主键字段名
    db - Db对象
- 方法详细资料
  - add
```
public int add(Entity entity)
        throws SQLException
```
    添加
    
    参数:
    entity - 实体对象
    
    返回:
    插入行数
    
    抛出:
    
    SQLException - SQL执行异常
  - addForGeneratedKeys
```
public List<Object> addForGeneratedKeys(Entity entity)
                                 throws SQLException
```
    添加
    
    参数:
    entity - 实体对象
    
    返回:
    主键列表
    
    抛出:
    
    SQLException - SQL执行异常
  - addForGeneratedKey
```
public Long addForGeneratedKey(Entity entity)
                        throws SQLException
```
    添加
    
    参数:
    entity - 实体对象
    
    返回:
    自增主键
    
    抛出:
    
    SQLException - SQL执行异常
  - del
```
public <T> int del(T pk)
        throws SQLException
```
    删除
    
    类型参数:
    T - 主键类型
    参数:
    pk - 主键
    
    返回:
    删除行数
    
    抛出:
    
    SQLException - SQL执行异常
  - del
```
public <T> int del(String field,
          T value)
        throws SQLException
```
    删除
    
    类型参数:
    T - 主键类型
    参数:
    field - 字段名
    value - 字段值
    
    返回:
    删除行数
    
    抛出:
    
    SQLException - SQL执行异常
  - del
```
public <T> int del(Entity where)
        throws SQLException
```
    删除
    
    类型参数:
    T - 主键类型
    参数:
    where - 删除条件，当条件为空时，返回0（防止误删全表）
    
    返回:
    删除行数
    
    抛出:
    
    SQLException - SQL执行异常
  - update
```
public int update(Entity record,
         Entity where)
           throws SQLException
```
    按照条件更新
    
    参数:
    record - 更新的内容
    where - 条件
    
    返回:
    更新条目数
    
    抛出:
    
    SQLException - SQL执行异常
  - update
```
public int update(Entity entity)
           throws SQLException
```
    更新
    
    参数:
    entity - 实体对象，必须包含主键
    
    返回:
    更新行数
    
    抛出:
    
    SQLException - SQL执行异常
  - addOrUpdate
```
public int addOrUpdate(Entity entity)
                throws SQLException
```
    增加或者更新实体
    
    参数:
    entity - 实体，当包含主键时更新，否则新增
    
    返回:
    新增或更新条数
    
    抛出:
    
    SQLException - SQL执行异常
  - get
```
public <T> Entity get(T pk)
           throws SQLException
```
    根据主键获取单个记录
    
    类型参数:
    T - 主键类型
    参数:
    pk - 主键值
    
    返回:
    记录
    
    抛出:
    
    SQLException - SQL执行异常
  - get
```
public <T> Entity get(String field,
             T value)
           throws SQLException
```
    根据某个字段（最好是唯一字段）查询单个记录
    当有多条返回时，只显示查询到的第一条
    
    类型参数:
    T - 字段值类型
    参数:
    field - 字段名
    value - 字段值
    
    返回:
    记录
    
    抛出:
    
    SQLException - SQL执行异常
  - get
```
public Entity get(Entity where)
           throws SQLException
```
    根据条件实体查询单个记录，当有多条返回时，只显示查询到的第一条
    
    参数:
    where - 条件
    
    返回:
    记录
    
    抛出:
    
    SQLException - SQL执行异常
  - find
```
public <T> List<Entity> find(String field,
                    T value)
                  throws SQLException
```
    根据某个字段值查询结果
    
    类型参数:
    T - 字段值类型
    参数:
    field - 字段名
    value - 字段值
    
    返回:
    记录
    
    抛出:
    
    SQLException - SQL执行异常
  - findAll
```
public List<Entity> findAll()
                     throws SQLException
```
    查询当前表的所有记录
    
    返回:
    记录
    
    抛出:
    
    SQLException - SQL执行异常
  - find
```
public List<Entity> find(Entity where)
                  throws SQLException
```
    根据某个字段值查询结果
    
    参数:
    where - 查询条件
    
    返回:
    记录
    
    抛出:
    
    SQLException - SQL执行异常
  - findBySql
```
public List<Entity> findBySql(String sql,
                     Object... params)
                       throws SQLException
```
    根据SQL语句查询结果
    SQL语句可以是非完整SQL语句，可以只提供查询的条件部分（例如WHERE部分）
    此方法会自动补全SELECT * FROM [tableName] 部分，这样就无需关心表名，直接提供条件即可
    
    参数:
    sql - SQL语句
    params - SQL占位符中对应的参数
    
    返回:
    记录
    
    抛出:
    
    SQLException - SQL执行异常
  - page
```
public PageResult<Entity> page(Entity where,
                      Page page,
                      String... selectFields)
                        throws SQLException
```
    分页
    
    参数:
    where - 条件
    page - 分页对象
    selectFields - 查询的字段列表
    
    返回:
    分页结果集
    
    抛出:
    
    SQLException - SQL执行异常
  - page
```
public PageResult<Entity> page(Entity where,
                      Page page)
                        throws SQLException
```
    分页
    
    参数:
    where - 条件
    page - 分页对象
    
    返回:
    分页结果集
    
    抛出:
    
    SQLException - SQL执行异常
  - count
```
public int count(Entity where)
          throws SQLException
```
    满足条件的数据条目数量
    
    参数:
    where - 条件
    
    返回:
    数量
    
    抛出:
    
    SQLException - SQL执行异常
  - exist
```
public boolean exist(Entity where)
              throws SQLException
```
    指定条件的数据是否存在
    
    参数:
    where - 条件
    
    返回:
    是否存在
    
    抛出:
    
    SQLException - SQL执行异常

类 DaoTemplate

字段概要

构造器概要

方法概要

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

字段详细资料

tableName

primaryKeyField

db

构造器详细资料

DaoTemplate

DaoTemplate

DaoTemplate

DaoTemplate

DaoTemplate

方法详细资料

add

addForGeneratedKeys

addForGeneratedKey

del

del

del

update

update

addOrUpdate

get

get

get

find

findAll

find

findBySql

page

page

count

exist