DaoUp (Nutz 1.r.61.r2 API)

java.lang.Object
- org.nutz.dao.util.DaoUp

```
public class DaoUp
extends Object
```
为非Mvc,Ioc环境下的程序提供辅助支持.
DaoUp不是一次性产品!! 如果新建DaoUp然后立马抛弃掉, 从中获取的NutDao/DataSource将会关闭!!
请注意使用场景!!! 在Mvc下有IocBy的情况下,不需要也不应该使用本类!!
Mvc下可以通过 Mvcs.getIoc()或Mvcs.ctx().getDefaultIoc()获取Ioc容器,从而获取其中的Dao实例!!
Mvc应尽量使用注入,而非主动取Dao实例,更不应该主动new NutDao!!!
最基本的用法
DaoUp.me().init(new File("db.properties")); Dao dao = DaoUp.me().dao(); dao.insert(.......); // 注意,不是每次用完Dao就关,是整个程序关闭的时候才关!! // 程序结束前关闭相关资源. DaoUp.me().close();
请参阅test源码中的DaoUpTest获取Dao的入门技巧.

作者:

wendal(wendal1985@gmail.com)

字段概要

字段
限定符和类型	字段和说明
`protected boolean`	`autoCloseWhenFinalize` 如果本对象被GC,是否触发自动关闭
`protected Dao`	`dao` Dao对象
`protected DataSource`	`dataSource` 连接池
`protected static Class<?>`	`druidFactoryClass` Druid数据源的工厂方法类
`protected static DaoUp`	`me` 内置单例
`protected String`	`name` 当前DaoUp的名称

构造器概要

构造器
限定符构造器和说明

protected DaoUp(String name)
需要新建多个DaoUp,请继承DaoUp,从而暴露构造方法或使用工厂方法!!

构造器
限定符	构造器和说明
`protected`	`DaoUp(String name)` 需要新建多个DaoUp,请继承DaoUp,从而暴露构造方法或使用工厂方法!!

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`protected DataSource`	`buildDataSource(Properties props)` 构建DataSource,子类可覆盖.
`void`	`close()` 关闭本DaoUp,将关闭DataSource并将dao和dataSource置为null!!!
`Dao`	`dao()` 返回所持有的Dao实例,如果DaoUp还没初始化或已经关闭,这里会返回null
`protected void`	`finalize()` 如果被GC,主动触发关闭,除非autoCloseWhenFinalize为false
`DataSource`	`getDataSource()` 获取数据源, 如果DaoUp还没初始化或已经关闭,这里会返回null
`void`	`init(File f)` 从一个文件读取数据库配置
`void`	`init(InputStream in)` 从一个流读取数据库配置
`void`	`init(Properties props)` 给定一个Properties配置,不能为null!!!!
`void`	`init(String name)` 从classpath或当前目录下查找配置文件来进行初始化
`static DaoUp`	`me()` 获取内置的DaoUp单例
`void`	`setAutoCloseWhenFinalize(boolean autoCloseWhenFinalize)` 设置是否在本对象被GC时自动关闭相关资源.
`void`	`setDao(Dao dao)` 主动设置Dao实例
`void`	`setDataSource(DataSource dataSource)` 主动设置数据源(连接池)

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

- 字段详细资料
  - me
```
protected static DaoUp me
```
    内置单例
  - druidFactoryClass
```
protected static Class<?> druidFactoryClass
```
    Druid数据源的工厂方法类
  - autoCloseWhenFinalize
```
protected boolean autoCloseWhenFinalize
```
    如果本对象被GC,是否触发自动关闭
  - dao
```
protected Dao dao
```
    Dao对象
  - dataSource
```
protected DataSource dataSource
```
    连接池
  - name
```
protected String name
```
    当前DaoUp的名称
- 构造器详细资料
  - DaoUp
```
protected DaoUp(String name)
```
    需要新建多个DaoUp,请继承DaoUp,从而暴露构造方法或使用工厂方法!!
- 方法详细资料
  - me
```
public static DaoUp me()
```
    获取内置的DaoUp单例
    
    返回:
    
    DaoUp实例
  - dao
```
public Dao dao()
```
    返回所持有的Dao实例,如果DaoUp还没初始化或已经关闭,这里会返回null
    
    返回:
    
    Dao实例
  - getDataSource
```
public DataSource getDataSource()
```
    获取数据源, 如果DaoUp还没初始化或已经关闭,这里会返回null
    
    返回:
    
    数据源(连接池)
  - setDataSource
```
public void setDataSource(DataSource dataSource)
```
    主动设置数据源(连接池)
    
    参数:
    
    dataSource - 数据源(连接池)
  - setDao
```
public void setDao(Dao dao)
```
    主动设置Dao实例
    
    参数:
    
    dao - Dao实例
  - init
```
public void init(String name)
          throws IOException
```
    从classpath或当前目录下查找配置文件来进行初始化
    
    参数:
    
    name -
    
    抛出:
    
    IOException
  - init
```
public void init(File f)
          throws IOException
```
    从一个文件读取数据库配置
    
    参数:
    
    f - 配置文件
    
    抛出:
    
    IOException - 文件不可读取时抛出异常
  - init
```
public void init(InputStream in)
          throws IOException
```
    从一个流读取数据库配置
    
    参数:
    
    in - 输入流,包含配置信息
    
    抛出:
    
    IOException - 读取失败是抛出异常
  - init
```
public void init(Properties props)
```
    给定一个Properties配置,不能为null!!!! 最起码要包含一个叫url的参数!!!
    
    参数:
    
    props - 配置信息
  - buildDataSource
```
protected DataSource buildDataSource(Properties props)
```
    构建DataSource,子类可覆盖. 如果存在Druid,则使用之,否则使用内置的SimpleDataSource
    
    参数:
    
    props - 配置信息
    
    返回:
    
    目标DataSource
  - close
```
public void close()
```
    关闭本DaoUp,将关闭DataSource并将dao和dataSource置为null!!!
    只能在程序关闭时调用,严禁在每次Dao操作后调用!!
  - setAutoCloseWhenFinalize
```
public void setAutoCloseWhenFinalize(boolean autoCloseWhenFinalize)
```
    设置是否在本对象被GC时自动关闭相关资源.
    若要设置为false, 请慎重考虑,因为绝大部分情况下设置为true并不能解决您当前遇到的问题!!
    DaoUp类不是设计为即用即抛的!!!而是设计为单例模式的!!!!!!!
    如果是遇到DataSource is closed之类的异常, 在考虑使用本配置前请先检讨代码!!!
    
    参数:
    
    autoCloseWhenFinalize - 是否自动关闭资源
  - finalize
```
protected void finalize()
                 throws Throwable
```
    如果被GC,主动触发关闭,除非autoCloseWhenFinalize为false
    
    覆盖:
    
    finalize 在类中 Object
    
    抛出:
    
    Throwable

类 DaoUp

字段概要

构造器概要

方法概要

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

字段详细资料

me

druidFactoryClass

autoCloseWhenFinalize

dao

dataSource

name

构造器详细资料

DaoUp

方法详细资料

me

dao

getDataSource

setDataSource

setDao

init

init

init

init

buildDataSource

close

setAutoCloseWhenFinalize

finalize