org.pinus4j.cluster.impl

Class AbstractDBCluster

java.lang.Object

org.pinus4j.cluster.impl.AbstractDBCluster

All Implemented Interfaces:

IDBCluster

Direct Known Subclasses:

AppDBClusterImpl, EnvDBClusterImpl

public abstract class AbstractDBCluster
extends Object
implements IDBCluster

抽象数据库集群. 主要负责初始化数据库集群的数据源对象、分表信息.
need to invoke startup method before use it, invoke shutdown method at last.

Author:

duanbn

Field Summary

Fields

Modifier and Type	Field and Description
private IClusterConfig	config 集群配置.
private org.apache.curator.framework.CuratorFramework	curatorClient curator client.
private IContainer<DBClusterInfo>	dbClusterInfoC cluster info.
private IDBGenerator	dbGenerator 数据库表生成器.
private IContainer<IClusterRouter>	dbRouterC cluster router.
protected EnumDB	enumDb 数据库类型.
private IIdGenerator	idGenerator 主键生成器.
private boolean	isShardInfoFromZk 数据分片信息是否从zookeeper中获取.
private static org.slf4j.Logger	LOG 日志
private IPrimaryCache	primaryCache 一级缓存.
private String	scanPackage 扫描数据对象包.
private ISecondCache	secondCache 二级缓存.
private EnumSyncAction	syncAction 同步数据表操作.
private ITableCluster	tableCluster 集群中的表集合.

Constructor Summary

Constructors

Constructor and Description
AbstractDBCluster(EnumDB enumDb) 构造方法.

Method Summary

Modifier and Type	Method and Description
private void	_createTable(List<DBTable> tables) 创建数据库表.
private IClusterConfig	_getConfig(String xmlFilePath) 读取配置.
private void	_initDatabaseName(DBInfo dbInfo)
private void	_initDBCluster(Collection<DBClusterInfo> dbClusterInfos)
private Map<String,Integer>	_loadTableInfo(String clusterName, List<DBTable> tables) build table info by table meta.
private void	_syncToZookeeper(List<DBTable> tables) 将表分片信息同步到zookeeper.
abstract void	buildDataSource(DBInfo dbInfo) 创建数据源连接.
abstract void	closeDataSource(DBInfo dbConnInfo) 关闭数据源连接
Lock	createLock(String lockName) create a destribute lock by give name.
List<DB>	getAllMasterShardingDB(Class<?> clazz) 获取此实体对象对应的所有的分库分表引用.
List<DB>	getAllMasterShardingDB(int tableNum, String clusterName, String tableName) get all master sharding info.
List<DB>	getAllSlaveShardingDB(Class<?> clazz, EnumDBMasterSlave slave) 获取集群从库列表.
IClusterConfig	getClusterConfig() 获取集群配置.
IDataLayerBuilder	getDataLayerBuilder() get data layer component builder.
Collection<DBClusterInfo>	getDBClusterInfo() Get all info about this cluster.
DBClusterInfo	getDBClusterInfo(String clusterName) 获取集群信息.
IDBGenerator	getDBGenerator() 获取db生成器.
IClusterRouter	getDBRouter(String clusterName) get cluster router.
List<DBTable>	getDBTableFromJvm() 从Jvm中获取分片信息.
List<DBTable>	getDBTableFromZk() 从Zookeeper中获取分片信息.
IIdGenerator	getIdGenerator() 获取id生成器.
DBInfo	getMasterGlobalConn(String clusterName) 获取主全局库连接.
DBInfo	getSlaveGlobalDbConn(String clusterName, EnumDBMasterSlave slave) 获取从库的全局库连接
EnumSyncAction	getSyncAction()
ITableCluster	getTableCluster() 获取集群表集合.
DB	selectDbFromMaster(String tableName, IShardingKey<?> value) 从主库集群中获取被操作的库表.
DB	selectDbFromSlave(String tableName, IShardingKey<?> value, EnumDBMasterSlave slaveNum) 从从库集群中获取被操作的库表.
void	setScanPackage(String scanPackage) 设置需要扫描的实体对象包.
void	setShardInfoFromZk(boolean value) 设置此集群是否从zookeeper中加载分片信息.
void	setSyncAction(EnumSyncAction syncAction) 设置数据表同步动作.
void	shutdown() relase resource.
void	startup() 启动集群.
void	startup(String xmlFilePath) 启动集群.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static final org.slf4j.Logger LOG

日志

syncAction

private EnumSyncAction syncAction

同步数据表操作.

scanPackage

private String scanPackage

扫描数据对象包.

isShardInfoFromZk

private boolean isShardInfoFromZk

数据分片信息是否从zookeeper中获取.

enumDb

protected EnumDB enumDb

数据库类型.

dbGenerator

private IDBGenerator dbGenerator

数据库表生成器.

idGenerator

private IIdGenerator idGenerator

主键生成器. 默认使用SimpleIdGeneratorImpl生成器.

primaryCache

private IPrimaryCache primaryCache

一级缓存.

secondCache

private ISecondCache secondCache

二级缓存.

dbRouterC

private IContainer<IClusterRouter> dbRouterC

cluster router.

dbClusterInfoC

private IContainer<DBClusterInfo> dbClusterInfoC

cluster info. {clusterName, clusterInfo}

tableCluster

private ITableCluster tableCluster

集群中的表集合. {集群名称, {分库下标, {表名, 分表数}}}

config

private IClusterConfig config

集群配置.

curatorClient

private org.apache.curator.framework.CuratorFramework curatorClient

curator client.

Constructor Detail

AbstractDBCluster

public AbstractDBCluster(EnumDB enumDb)

构造方法.

Parameters:

enumDb - 数据库类型.

Method Detail

getDBClusterInfo

public Collection<DBClusterInfo> getDBClusterInfo()

Description copied from interface: IDBCluster

Get all info about this cluster.

Specified by:

getDBClusterInfo in interface IDBCluster

Returns:

all cluster info.

getDBClusterInfo

public DBClusterInfo getDBClusterInfo(String clusterName)

Description copied from interface: IDBCluster

获取集群信息.

Specified by:

getDBClusterInfo in interface IDBCluster

Parameters:

clusterName - 集群名

Returns:

集群信息

startup

public void startup()
             throws DBClusterException

Description copied from interface: IDBCluster

启动集群. 调用数据库集群前需要调用此方法，为了初始化集群连接.

Specified by:

startup in interface IDBCluster

Throws:

DBClusterException - 初始化失败

startup

public void startup(String xmlFilePath)
             throws DBClusterException

Description copied from interface: IDBCluster

启动集群. 调用数据库集群前需要调用此方法，为了初始化集群连接.

Specified by:

startup in interface IDBCluster

Parameters:

xmlFilePath - 配置文件绝对路径

Throws:

DBClusterException - 初始化失败

shutdown

public void shutdown()
              throws DBClusterException

relase resource. include database connection,zookeeper connection and cache connection.

Specified by:

shutdown in interface IDBCluster

Throws:

DBClusterException - 关闭失败

getMasterGlobalConn

public DBInfo getMasterGlobalConn(String clusterName)
                           throws DBClusterException

Description copied from interface: IDBCluster

获取主全局库连接.

Specified by:

getMasterGlobalConn in interface IDBCluster

Returns:

Throws:

DBClusterException

getSlaveGlobalDbConn

public DBInfo getSlaveGlobalDbConn(String clusterName,
                                   EnumDBMasterSlave slave)
                            throws DBClusterException

Description copied from interface: IDBCluster

获取从库的全局库连接

Specified by:

getSlaveGlobalDbConn in interface IDBCluster

Returns:

Throws:

DBClusterException

selectDbFromMaster

public DB selectDbFromMaster(String tableName,
                             IShardingKey<?> value)
                      throws DBClusterException

Description copied from interface: IDBCluster

从主库集群中获取被操作的库表.

Specified by:

selectDbFromMaster in interface IDBCluster

Parameters:

tableName - 数据表名

value - 分库分表因子.

Returns:

被操作的库表

Throws:

DBClusterException

selectDbFromSlave

public DB selectDbFromSlave(String tableName,
                            IShardingKey<?> value,
                            EnumDBMasterSlave slaveNum)
                     throws DBClusterException

Description copied from interface: IDBCluster

从从库集群中获取被操作的库表.

Specified by:

selectDbFromSlave in interface IDBCluster

Parameters:

tableName - 数据库表名

value - 分库分表因子

slaveNum - 从库

Returns:

被操作的库表

Throws:

DBClusterException

getAllMasterShardingDB

public List<DB> getAllMasterShardingDB(Class<?> clazz)

Description copied from interface: IDBCluster

获取此实体对象对应的所有的分库分表引用.

Specified by:

getAllMasterShardingDB in interface IDBCluster

Parameters:

clazz - 数据对象

Returns:

getAllMasterShardingDB

public List<DB> getAllMasterShardingDB(int tableNum,
                                       String clusterName,
                                       String tableName)

get all master sharding info.

Specified by:

getAllMasterShardingDB in interface IDBCluster

Parameters:

tableNum -

clusterName -

tableName -

Returns:

getAllSlaveShardingDB

public List<DB> getAllSlaveShardingDB(Class<?> clazz,
                                      EnumDBMasterSlave slave)

Description copied from interface: IDBCluster

获取集群从库列表.

Specified by:

getAllSlaveShardingDB in interface IDBCluster

Parameters:

clazz - 数据对象

slave - 从库号

createLock

public Lock createLock(String lockName)

Description copied from interface: IDBCluster

create a destribute lock by give name.

Specified by:

createLock in interface IDBCluster

Returns:

destirbute lock.

getDataLayerBuilder

public IDataLayerBuilder getDataLayerBuilder()

Description copied from interface: IDBCluster

get data layer component builder.

Specified by:

getDataLayerBuilder in interface IDBCluster

See Also:

IDataLayerBuilder

setShardInfoFromZk

public void setShardInfoFromZk(boolean value)

Description copied from interface: IDBCluster

设置此集群是否从zookeeper中加载分片信息.

Specified by:

setShardInfoFromZk in interface IDBCluster

Parameters:

value - true:是， false:否.

getDBTableFromZk

public List<DBTable> getDBTableFromZk()

Description copied from interface: IDBCluster

从Zookeeper中获取分片信息.

Specified by:

getDBTableFromZk in interface IDBCluster

Returns:

分片信息.

getDBTableFromJvm

public List<DBTable> getDBTableFromJvm()

Description copied from interface: IDBCluster

从Jvm中获取分片信息.

Specified by:

getDBTableFromJvm in interface IDBCluster

Returns:

分片信息.

_syncToZookeeper

private void _syncToZookeeper(List<DBTable> tables)
                       throws Exception

将表分片信息同步到zookeeper.

Throws:

Exception

_createTable

private void _createTable(List<DBTable> tables)
                   throws Exception

创建数据库表.

Throws:

IOException

Exception

_initDBCluster

private void _initDBCluster(Collection<DBClusterInfo> dbClusterInfos)
                     throws LoadConfigException

Throws:

LoadConfigException

_initDatabaseName

private void _initDatabaseName(DBInfo dbInfo)

_loadTableInfo

private Map<String,Integer> _loadTableInfo(String clusterName,
                                           List<DBTable> tables)
                                    throws DBClusterException

build table info by table meta.

Throws:

DBClusterException

getDBRouter

public IClusterRouter getDBRouter(String clusterName)

Description copied from interface: IDBCluster

get cluster router.

Specified by:

getDBRouter in interface IDBCluster

_getConfig

private IClusterConfig _getConfig(String xmlFilePath)
                           throws LoadConfigException

读取配置.

Returns:

配置信息.

Throws:

LoadConfigException

buildDataSource

public abstract void buildDataSource(DBInfo dbInfo)
                              throws LoadConfigException

创建数据源连接.

Throws:

LoadConfigException

closeDataSource

public abstract void closeDataSource(DBInfo dbConnInfo)

关闭数据源连接

Parameters:

dbConnInfo -

getSyncAction

public EnumSyncAction getSyncAction()

setSyncAction

public void setSyncAction(EnumSyncAction syncAction)

Description copied from interface: IDBCluster

设置数据表同步动作.

Specified by:

setSyncAction in interface IDBCluster

getDBGenerator

public IDBGenerator getDBGenerator()

Description copied from interface: IDBCluster

获取db生成器.

Specified by:

getDBGenerator in interface IDBCluster

getIdGenerator

public IIdGenerator getIdGenerator()

Description copied from interface: IDBCluster

获取id生成器.

Specified by:

getIdGenerator in interface IDBCluster

Returns:

setScanPackage

public void setScanPackage(String scanPackage)

Description copied from interface: IDBCluster

设置需要扫描的实体对象包.

Specified by:

setScanPackage in interface IDBCluster

Parameters:

scanPackage - 包名

getTableCluster

public ITableCluster getTableCluster()

Description copied from interface: IDBCluster

获取集群表集合.

Specified by:

getTableCluster in interface IDBCluster

Returns:

集群表集合

getClusterConfig

public IClusterConfig getClusterConfig()

Description copied from interface: IDBCluster

获取集群配置.

Specified by:

getClusterConfig in interface IDBCluster

Returns: