DB (tiny 1.1.5 API)

java.lang.Object
- cn.xnatural.app.util.DB

All Implemented Interfaces:

AutoCloseable
```
public class DB
extends Object
implements AutoCloseable
```
数据库 sql 操作工具

Field Summary

Fields
Modifier and Type	Field and Description
`protected static AtomicInteger`	`count`
`protected DataSource`	`dataSource` 数据源
`protected Map<String,Object>`	`dsAttr` dataSource 属性集
`protected Integer`	`maxRows` 最大返回条数限制
`String`	`name` 名字标识
`protected static ThreadLocal<Connection>`	`txConn` 事务连接,保存在线程上下文

Constructor Summary

Constructors
Constructor and Description
`DB(DataSource dataSource)` 创建一个 `DB`
`DB(Map<String,Object> dsAttr)` 创建一个 `DB`
`DB(String jdbcUrl)` 创建一个`DB`
`DB(String jdbcUrl, Integer minIdle, Integer maxActive)` 创建一个`DB`
`DB(String jdbcUrl, String username, String password)` 创建一个`DB`
`DB(String jdbcUrl, String username, String password, Integer minIdle, Integer maxActive)` 创建一个`DB`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`call(String sql, Object... params)` 执行一个存储过程
`void`	`close()`
`static DataSource`	`createDataSource(Map<String,Object> dsAttr)` 创建一个数据源
`DB`	`dsAttr(String attrName, Object attrValue)` 设置 `DataSource` 属性
`int`	`execute(String sql, Object... params)` 插入一条数据/更新数据
`protected void`	`fillParam(PreparedStatement pst, Object... params)`
`String`	`getJdbcUrl()` 获取 jdbc 连接地址
`protected DB`	`init()`
`Object`	`insertWithGeneratedKey(String sql, Object... params)` 插入一条数据并返回第一个数据库自生成字段
`Map<String,Object>`	`row(String sql, Object... params)` 返回一条数据
`List<Map<String,Object>>`	`rows(String sql, Object... params)` 查询多条数据
`DB`	`setMaxRows(int maxRows)` 设置限制最大返回条数
`<T> T`	`single(String sql, Class<T> retType, Object... params)` 查询单个值
`String`	`toString()`
`<T> T`	`trans(Supplier<T> fn)` 开启一个事务
`<T> T`	`withConn(Function<Connection,T> fn)` 执行连接

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

count

protected static final AtomicInteger count

name
```
public final String name
```
名字标识

dataSource

protected volatile DataSource dataSource

数据源

maxRows
```
protected Integer maxRows
```
最大返回条数限制

dsAttr

protected final Map<String,Object> dsAttr

dataSource 属性集

txConn

protected static final ThreadLocal<Connection> txConn

事务连接,保存在线程上下文

Constructor Detail

DB
```
public DB(DataSource dataSource)
```
创建一个 DB

Parameters:

dataSource - 外部数据源

DB
```
public DB(Map<String,Object> dsAttr)
```
创建一个 DB

Parameters:

dsAttr - 属性集

DB
```
public DB(String jdbcUrl)
```
创建一个DB

Parameters:

jdbcUrl - jdbc 连接地址

DB

public DB(String jdbcUrl,
          String username,
          String password)

创建一个DB

Parameters:: jdbcUrl - jdbc 连接地址; username - 连接用户名; password - 连接密码

DB

public DB(String jdbcUrl,
          Integer minIdle,
          Integer maxActive)

创建一个DB

Parameters:: jdbcUrl - jdbc 连接地址; minIdle - 最小连接; maxActive - 最大活动连接

DB

public DB(String jdbcUrl,
          String username,
          String password,
          Integer minIdle,
          Integer maxActive)

创建一个DB

Parameters:: jdbcUrl - jdbc 连接地址; username - 连接用户名; password - 连接密码; minIdle - 最小连接; maxActive - 最大活动连接

Method Detail

dsAttr

public DB dsAttr(String attrName,
                 Object attrValue)

设置 DataSource 属性

Parameters:: attrName - 属性名; attrValue - 属性值
Returns:: DB

setMaxRows
```
public DB setMaxRows(int maxRows)
```
设置限制最大返回条数

Parameters:

maxRows - > 0

Returns:

DB

withConn

public <T> T withConn(Function<Connection,T> fn)

执行连接

Parameters:: fn - 函数
Returns:: DB

trans
```
public <T> T trans(Supplier<T> fn)
```
开启一个事务

Type Parameters:

T - 返回类型

Parameters:

fn - 事务执行函数

Returns:

返回值

execute
```
public int execute(String sql,
                   Object... params)
```
插入一条数据/更新数据

Parameters:

sql - sql 语句

params - 参数

Returns:

成功条数

call
```
public int call(String sql,
                Object... params)
```
执行一个存储过程

Parameters:

sql - sql语句

params - 参数

Returns:

影响条数

insertWithGeneratedKey
```
public Object insertWithGeneratedKey(String sql,
                                     Object... params)
```
插入一条数据并返回第一个数据库自生成字段

Parameters:

sql - sql 语句

params - 参数

Returns:

自生成字段的值

rows

public List<Map<String,Object>> rows(String sql,
                                     Object... params)

查询多条数据

Parameters:: sql - sql 语句; params - 参数
Returns:: 多条数据结果

row

public Map<String,Object> row(String sql,
                              Object... params)

返回一条数据

Parameters:: sql - sql语句; params - 参数
Returns:: 一条数据

single
```
public <T> T single(String sql,
                    Class<T> retType,
                    Object... params)
```
查询单个值

Type Parameters:

T - 类型

Parameters:

sql - sql 语句

retType - 返回的类型 Integer.class, Long.class, String.class, Double.class, BigDecimal.class, Boolean.class, Date.class

params - 参数

Returns:

单个值

fillParam

protected void fillParam(PreparedStatement pst,
                         Object... params)
                  throws SQLException

Throws:: SQLException

init
```
protected DB init()
```

close
```
public void close()
           throws Exception
```
Specified by:

close in interface AutoCloseable

Throws:

Exception

getJdbcUrl
```
public String getJdbcUrl()
```
获取 jdbc 连接地址

toString
```
public String toString()
```
Overrides:

toString in class Object

createDataSource
```
public static DataSource createDataSource(Map<String,Object> dsAttr)
```
创建一个数据源

Parameters:

dsAttr - 连接池属性

Returns:

DataSource 数据源

Class DB

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

count

name

dataSource

maxRows

dsAttr

txConn

Constructor Detail

DB

DB

DB

DB

DB

DB

Method Detail

dsAttr

setMaxRows

withConn

trans

execute

call

insertWithGeneratedKey

rows

row

single

fillParam

init

close

getJdbcUrl

toString

createDataSource