MongoDS (hutool 2.0.0 API)

java.lang.Object
- com.xiaoleilu.hutool.db.ds.MongoDS

所有已实现的接口:

Closeable, AutoCloseable
```
public class MongoDS
extends Object
implements Closeable
```
MongoDB工具类

作者:

xiaoleilu

字段概要

字段
限定符和类型字段和说明

static String MONGO_CONFIG_PATH
默认配置文件

字段
限定符和类型	字段和说明
`static String`	`MONGO_CONFIG_PATH` 默认配置文件

构造器概要

构造器
构造器和说明
`MongoDS(Setting mongoSetting, String... groups)` 构造MongoDB数据源当提供多个数据源时，这些数据源将为一个副本集或者mongos 调用者必须持有MongoDS实例，否则会被垃圾回收导致写入失败！
`MongoDS(Setting mongoSetting, String host, int port)` 构造MongoDB数据源调用者必须持有MongoDS实例，否则会被垃圾回收导致写入失败！
`MongoDS(String... groups)` 构造MongoDB数据源当提供多个数据源时，这些数据源将为一个副本集或者多个mongos 调用者必须持有MongoDS实例，否则会被垃圾回收导致写入失败！
`MongoDS(String host, int port)` 构造MongoDB数据源调用者必须持有MongoDS实例，否则会被垃圾回收导致写入失败！

方法概要

方法
限定符和类型	方法和说明
`void`	`close()`
`static void`	`closeAll()` 关闭全部连接
`protected void`	`finalize()` 在垃圾回收（GC）被调用时关闭MongoDB客户端
`com.mongodb.DBCollection`	`getCollection(String dbName, String collectionName)` 获得MongoDB中指定集合对象
`com.mongodb.DB`	`getDb(String dbName)` 获得DB
`static MongoDS`	`getDS(Collection<String> groups)` 获取MongoDB数据源
`static MongoDS`	`getDS(Setting setting, Collection<String> groups)` 获取MongoDB数据源
`static MongoDS`	`getDS(Setting setting, String... groups)` 获取MongoDB数据源
`static MongoDS`	`getDS(String... groups)` 获取MongoDB数据源
`static MongoDS`	`getDS(String host, int port)` 获取MongoDB数据源
`com.mongodb.MongoClient`	`getMongo()`
`void`	`init()` 初始化，当给定分组数大于一个时使用
`void`	`initCloud()` 初始化集群集群的其它客户端设定参数使用全局设定集群中每一个实例成员用一个group表示，例如： [db0] host = 10.11.49.157:27117 [db1] host = 10.11.49.157:27118 [db2] host = 10.11.49.157:27119
`void`	`initSingle()` 初始化设定文件中的host和端口有三种形式： --------------------- host = host:port --------------------- host = host port = port --------------------- #此种形式使用MongoDB默认端口 host = host ---------------------
`void`	`setSetting(Setting setting)` 设定MongoDB配置文件

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

- 字段详细资料
  - MONGO_CONFIG_PATH
```
public static final String MONGO_CONFIG_PATH
```
    默认配置文件
    
    另请参阅:
    常量字段值
- 构造器详细资料
  - MongoDS
```
public MongoDS(String host,
       int port)
```
    构造MongoDB数据源
    调用者必须持有MongoDS实例，否则会被垃圾回收导致写入失败！
    
    参数:
    host - 主机（域名或者IP）
    port - 端口
  - MongoDS
```
public MongoDS(Setting mongoSetting,
       String host,
       int port)
```
    构造MongoDB数据源
    调用者必须持有MongoDS实例，否则会被垃圾回收导致写入失败！
    
    参数:
    mongoSetting - MongoDB的配置文件，如果是null则读取默认配置文件或者使用MongoDB默认客户端配置
    host - 主机（域名或者IP）
    port - 端口
  - MongoDS
```
public MongoDS(String... groups)
```
    构造MongoDB数据源
    当提供多个数据源时，这些数据源将为一个副本集或者多个mongos
    调用者必须持有MongoDS实例，否则会被垃圾回收导致写入失败！官方文档： http://docs.mongodb.org/manual/administration/replica-sets/
    
    参数:
    groups - 分组列表，当为null或空时使用无分组配置，一个分组使用单一模式，否则使用副本集模式
  - MongoDS
```
public MongoDS(Setting mongoSetting,
       String... groups)
```
    构造MongoDB数据源
    当提供多个数据源时，这些数据源将为一个副本集或者mongos
    调用者必须持有MongoDS实例，否则会被垃圾回收导致写入失败！
    官方文档： http://docs.mongodb.org/manual/administration/replica-sets/
    
    参数:
    mongoSetting - MongoDB的配置文件，必须有
    groups - 分组列表，当为null或空时使用无分组配置，一个分组使用单一模式，否则使用副本集模式
- 方法详细资料
  - getDS
```
public static MongoDS getDS(String host,
            int port)
```
    获取MongoDB数据源
    
    参数:
    host - 主机
    port - 端口
    
    返回:
    MongoDB连接
  - getDS
```
public static MongoDS getDS(String... groups)
```
    获取MongoDB数据源
    
    参数:
    groups - 分组列表
    
    返回:
    MongoDB连接
  - getDS
```
public static MongoDS getDS(Collection<String> groups)
```
    获取MongoDB数据源
    
    参数:
    groups - 分组列表
    
    返回:
    MongoDB连接
  - getDS
```
public static MongoDS getDS(Setting setting,
            String... groups)
```
    获取MongoDB数据源
    
    参数:
    setting - 设定文件
    groups - 分组列表
    
    返回:
    MongoDB连接
  - getDS
```
public static MongoDS getDS(Setting setting,
            Collection<String> groups)
```
    获取MongoDB数据源
    
    参数:
    groups - 分组列表
    
    返回:
    MongoDB连接
  - closeAll
```
public static void closeAll()
```
    关闭全部连接
  - init
```
public void init()
```
    初始化，当给定分组数大于一个时使用
  - initSingle
```
public void initSingle()
```
    初始化
    设定文件中的host和端口有三种形式： --------------------- host = host:port --------------------- host = host port = port --------------------- #此种形式使用MongoDB默认端口 host = host ---------------------
  - initCloud
```
public void initCloud()
```
    初始化集群
    集群的其它客户端设定参数使用全局设定
    集群中每一个实例成员用一个group表示，例如：
    [db0] host = 10.11.49.157:27117 [db1] host = 10.11.49.157:27118 [db2] host = 10.11.49.157:27119
  - setSetting
```
public void setSetting(Setting setting)
```
    设定MongoDB配置文件
  - getMongo
```
public com.mongodb.MongoClient getMongo()
```
    返回:
    获得MongoDB客户端对象
  - getDb
```
public com.mongodb.DB getDb(String dbName)
```
    获得DB
    
    参数:
    dbName - DB
    
    返回:
    DB
  - getCollection
```
public com.mongodb.DBCollection getCollection(String dbName,
                                     String collectionName)
```
    获得MongoDB中指定集合对象
    
    参数:
    dbName - 库名
    collectionName - 集合名
    
    返回:
    DBCollection
  - close
```
public void close()
```
    指定者:
    
    close 在接口中 Closeable
    
    指定者:
    
    close 在接口中 AutoCloseable
  - finalize
```
protected void finalize()
                 throws Throwable
```
    在垃圾回收（GC）被调用时关闭MongoDB客户端
    
    覆盖:
    
    finalize 在类中 Object
    
    抛出:
    
    Throwable

类 MongoDS

字段概要

构造器概要

方法概要

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

字段详细资料

MONGO_CONFIG_PATH

构造器详细资料

MongoDS

MongoDS

MongoDS

MongoDS

方法详细资料

getDS

getDS

getDS

getDS

getDS

closeAll

init

initSingle

initCloud

setSetting

getMongo

getDb

getCollection

close

finalize