Redis (ymate-platform-v2-码云(gitee.com))

java.lang.Object
- net.ymate.platform.persistence.redis.Redis

All Implemented Interfaces:

AutoCloseable, IModule, IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>, IDestroyable, IInitialization<IApplication>, IRedis
```
public final class Redis
extends Object
implements IModule, IRedis
```
Author:

刘镇 (suninformation@163.com) on 15/11/30 上午3:14

Nested Class Summary
- Nested classes/interfaces inherited from interface net.ymate.platform.persistence.redis.IRedis
  IRedis.ConnectionType

Field Summary
- Fields inherited from interface net.ymate.platform.persistence.redis.IRedis
  MODULE_NAME

Constructor Summary

Constructors
Constructor and Description

Redis()

Redis(IRedisConfig config)

Constructors
Constructor and Description
`Redis()`
`Redis(IRedisConfig config)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`static IRedis`	`get()`
`IRedisConfig`	`getConfig()` 获取持久化配置对象
`IRedisCommandHolder`	`getConnectionHolder(String dataSourceName)` 获取由dataSourceName指定的数据源连接持有者对象
`IRedisDataSourceAdapter`	`getDataSourceAdapter(String dataSourceName)` 获取指定源数据源适配器
`IRedisCommandHolder`	`getDefaultConnectionHolder()` 获取默认数据源连接持有者对象
`IRedisDataSourceAdapter`	`getDefaultDataSourceAdapter()` 获取默认数据源适配器
`String`	`getName()` 获取模块名称
`IApplication`	`getOwner()` 获取所属应用容器
`void`	`initialize(IApplication owner)` 初始化
`boolean`	`isInitialized()` 是否已初始化
`IRedisSession`	`openSession()` 开启数据库连接会话(注意一定记得关闭会话)
`IRedisSession`	`openSession(IDataSourceRouter dataSourceRouter)` 开启数据库连接会话(注意一定记得关闭会话)
`<T> T`	`openSession(IDataSourceRouter dataSourceRouter, IRedisSessionExecutor<T> executor)` 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
`IRedisSession`	`openSession(IRedisCommandHolder commandsHolder)` 开启数据库连接会话(注意一定记得关闭会话)
`<T> T`	`openSession(IRedisCommandHolder commandsHolder, IRedisSessionExecutor<T> executor)` 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
`<T> T`	`openSession(IRedisSessionExecutor<T> executor)` 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
`IRedisSession`	`openSession(String dsName)` 开启数据库连接会话(注意一定记得关闭会话)
`<T> T`	`openSession(String dsName, IRedisSessionExecutor<T> executor)` 开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
`void`	`releaseConnectionHolder(IRedisCommandHolder connectionHolder)` 安全关闭数据源的连接持有者(确保非事务状态下执行关闭)
`void`	`subscribe(JedisPubSub jedisPubSub, String... channels)` 订阅
`void`	`subscribe(String dsName, JedisPubSub jedisPubSub, String... channels)` 订阅

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

- Constructor Detail
  - Redis
```
public Redis()
```
  - Redis
```
public Redis(IRedisConfig config)
```
- Method Detail
  - get
```
public static IRedis get()
```
  - getName
```
public String getName()
```
    Description copied from interface: IModule
    
    获取模块名称
    
    Specified by:
    
    getName in interface IModule
    
    Returns:
    
    返回模块名称
  - initialize
```
public void initialize(IApplication owner)
                throws Exception
```
    Description copied from interface: IInitialization
    
    初始化
    
    Specified by:
    
    initialize in interface IInitialization<IApplication>
    
    Parameters:
    
    owner - 指定所属容器参数对象
    
    Throws:
    
    Exception - 初始过程中产生的任何异常
  - isInitialized
```
public boolean isInitialized()
```
    Description copied from interface: IInitialization
    
    是否已初始化
    
    Specified by:
    
    isInitialized in interface IInitialization<IApplication>
    
    Returns:
    
    返回true表示已初始化
  - getOwner
```
public IApplication getOwner()
```
    Description copied from interface: IPersistence
    
    获取所属应用容器
    
    Specified by:
    
    getOwner in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Returns:
    
    返回所属应用容器实例
  - getConfig
```
public IRedisConfig getConfig()
```
    Description copied from interface: IPersistence
    
    获取持久化配置对象
    
    Specified by:
    
    getConfig in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Returns:
    
    返回持久化配置对象
  - getDefaultConnectionHolder
```
public IRedisCommandHolder getDefaultConnectionHolder()
```
    Description copied from interface: IPersistence
    
    获取默认数据源连接持有者对象
    
    Specified by:
    
    getDefaultConnectionHolder in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Returns:
    
    返回默认数据源连接持有者对象
  - getConnectionHolder
```
public IRedisCommandHolder getConnectionHolder(String dataSourceName)
```
    Description copied from interface: IPersistence
    
    获取由dataSourceName指定的数据源连接持有者对象
    
    Specified by:
    
    getConnectionHolder in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Parameters:
    
    dataSourceName - 数据源名称
    
    Returns:
    
    获取由指定的数据源连接持有者对象
  - releaseConnectionHolder
```
public void releaseConnectionHolder(IRedisCommandHolder connectionHolder)
                             throws Exception
```
    Description copied from interface: IPersistence
    
    安全关闭数据源的连接持有者(确保非事务状态下执行关闭)
    
    Specified by:
    
    releaseConnectionHolder in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Parameters:
    
    connectionHolder - 数据源的连接持有者对象
    
    Throws:
    
    Exception - 可能产生的异常
  - getDefaultDataSourceAdapter
```
public IRedisDataSourceAdapter getDefaultDataSourceAdapter()
```
    Description copied from interface: IRedis
    
    获取默认数据源适配器
    
    Specified by:
    
    getDefaultDataSourceAdapter in interface IRedis
    
    Returns:
    
    返回数据源适配器对象
  - getDataSourceAdapter
```
public IRedisDataSourceAdapter getDataSourceAdapter(String dataSourceName)
```
    Description copied from interface: IRedis
    
    获取指定源数据源适配器
    
    Specified by:
    
    getDataSourceAdapter in interface IRedis
    
    Parameters:
    
    dataSourceName - 数据源名称
    
    Returns:
    
    返回数据源适配器对象
  - openSession
```
public <T> T openSession(IRedisSessionExecutor<T> executor)
                  throws Exception
```
    Description copied from interface: IRedis
    
    开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
    
    Specified by:
    
    openSession in interface IRedis
    
    Type Parameters:
    
    T - 执行结果对象类型
    
    Parameters:
    
    executor - 会话执行器
    
    Returns:
    
    返回执行结果
    
    Throws:
    
    Exception - 可能产生的任何异常
  - openSession
```
public <T> T openSession(String dsName,
                         IRedisSessionExecutor<T> executor)
                  throws Exception
```
    Description copied from interface: IRedis
    
    开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
    
    Specified by:
    
    openSession in interface IRedis
    
    Type Parameters:
    
    T - 执行结果对象类型
    
    Parameters:
    
    dsName - 数据源名称
    
    executor - 会话执行器
    
    Returns:
    
    返回执行结果
    
    Throws:
    
    Exception - 可能产生的任何异常
  - openSession
```
public <T> T openSession(IRedisCommandHolder commandsHolder,
                         IRedisSessionExecutor<T> executor)
                  throws Exception
```
    Description copied from interface: IRedis
    
    开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
    
    Specified by:
    
    openSession in interface IRedis
    
    Type Parameters:
    
    T - 执行结果对象类型
    
    Parameters:
    
    commandsHolder - 数据源连接持有者对象
    
    executor - 会话执行器
    
    Returns:
    
    返回执行结果
    
    Throws:
    
    Exception - 可能产生的任何异常
  - openSession
```
public <T> T openSession(IDataSourceRouter dataSourceRouter,
                         IRedisSessionExecutor<T> executor)
                  throws Exception
```
    Description copied from interface: IRedis
    
    开启会话并执行会话执行器接口逻辑(执行完毕会话将自动关闭)
    
    Specified by:
    
    openSession in interface IRedis
    
    Type Parameters:
    
    T - 执行结果对象类型
    
    Parameters:
    
    dataSourceRouter - 数据源路由对象
    
    executor - 会话执行器
    
    Returns:
    
    返回执行结果
    
    Throws:
    
    Exception - 可能产生的任何异常
  - openSession
```
public IRedisSession openSession()
```
    Description copied from interface: IPersistence
    
    开启数据库连接会话(注意一定记得关闭会话)
    
    Specified by:
    
    openSession in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Returns:
    
    返回会话对象
  - openSession
```
public IRedisSession openSession(String dsName)
```
    Description copied from interface: IPersistence
    
    开启数据库连接会话(注意一定记得关闭会话)
    
    Specified by:
    
    openSession in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Parameters:
    
    dsName - 数据源名称
    
    Returns:
    
    返回会话对象
  - openSession
```
public IRedisSession openSession(IRedisCommandHolder commandsHolder)
```
    Description copied from interface: IPersistence
    
    开启数据库连接会话(注意一定记得关闭会话)
    
    Specified by:
    
    openSession in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Parameters:
    
    commandsHolder - 数据源连接持有者对象
    
    Returns:
    
    返回会话对象
  - openSession
```
public IRedisSession openSession(IDataSourceRouter dataSourceRouter)
```
    Description copied from interface: IPersistence
    
    开启数据库连接会话(注意一定记得关闭会话)
    
    Specified by:
    
    openSession in interface IPersistence<IRedisSession,IRedisConfig,IRedisCommandHolder>
    
    Parameters:
    
    dataSourceRouter - 数据源路由对象
    
    Returns:
    
    返回会话对象
  - subscribe
```
public void subscribe(JedisPubSub jedisPubSub,
                      String... channels)
```
    Description copied from interface: IRedis
    
    订阅
    
    Specified by:
    
    subscribe in interface IRedis
    
    Parameters:
    
    jedisPubSub - 发布订阅对象
    
    channels - 频道
  - subscribe
```
public void subscribe(String dsName,
                      JedisPubSub jedisPubSub,
                      String... channels)
```
    Description copied from interface: IRedis
    
    订阅
    
    Specified by:
    
    subscribe in interface IRedis
    
    Parameters:
    
    dsName - 数据源名称
    
    jedisPubSub - 发布订阅对象
    
    channels - 频道
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class Redis

Nested Class Summary

Nested classes/interfaces inherited from interface net.ymate.platform.persistence.redis.IRedis

Field Summary

Fields inherited from interface net.ymate.platform.persistence.redis.IRedis

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Redis

Redis

Method Detail

get

getName

initialize

isInitialized

getOwner

getConfig

getDefaultConnectionHolder

getConnectionHolder

releaseConnectionHolder

getDefaultDataSourceAdapter

getDataSourceAdapter

openSession

openSession

openSession

openSession

openSession

openSession

openSession

openSession

subscribe

subscribe

close