com.mybatisflex.core

类 FlexGlobalConfig

java.lang.Object

com.mybatisflex.core.FlexGlobalConfig

public class FlexGlobalConfig
extends Object

全局配置文件

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	FlexGlobalConfig.KeyConfig 对应的是 注解 Id 的配置

字段概要

字段

限定符和类型	字段和说明
private org.apache.ibatis.session.Configuration	configuration Mybatis 配置
private DbType	dbType 默认使用 Mysql 数据库类型
private static FlexGlobalConfig	defaultConfig
private int	defaultPageSize 分页查询时，默认每页显示的数据数量。
private int	defaultRelationQueryDepth 默认的 Relation 注解查询深度
private Object	deletedValueOfLogicDelete
private Map<Class<?>,List<InsertListener>>	entityInsertListeners
private Map<Class<?>,List<SetListener>>	entitySetListeners entity 的监听器
private Map<Class<?>,List<UpdateListener>>	entityUpdateListeners
private static ConcurrentHashMap<String,FlexGlobalConfig>	globalConfigs
private FlexGlobalConfig.KeyConfig	keyConfig 全局的 ID 生成策略配置，当 @Id 未配置 或者 配置 KeyType 为 None 时 使用当前全局配置
private String	logicDeleteColumn 默认的逻辑删除字段，允许设置 null 忽略匹配。
private Object	normalValueOfLogicDelete 逻辑删除的相关配置
private boolean	printBanner 启动是否打印 banner 和 版本号
private org.apache.ibatis.session.SqlSessionFactory	sqlSessionFactory 创建好的 sqlSessionFactory
private String	tenantColumn 默认的多租户字段，允许设置 null 忽略匹配。
private String	versionColumn 默认的乐观锁字段，允许设置 null 忽略匹配。

构造器概要

构造器

构造器和说明
FlexGlobalConfig()

方法概要

限定符和类型	方法和说明
<T extends Listener> List<T>	findSupportedListeners(Class<?> entityClass, Map<Class<?>,List<T>> listenerMap) 查找支持该 entityClass 的监听器
static FlexGlobalConfig	getConfig(org.apache.ibatis.session.Configuration configuration)
static FlexGlobalConfig	getConfig(String environmentId)
org.apache.ibatis.session.Configuration	getConfiguration()
FlexDataSource	getDataSource()
DbType	getDbType()
static FlexGlobalConfig	getDefaultConfig()
int	getDefaultPageSize()
int	getDefaultRelationQueryDepth()
Object	getDeletedValueOfLogicDelete()
Map<Class<?>,List<InsertListener>>	getEntityInsertListeners()
Map<Class<?>,List<SetListener>>	getEntitySetListeners()
Map<Class<?>,List<UpdateListener>>	getEntityUpdateListeners()
static ConcurrentHashMap<String,FlexGlobalConfig>	getGlobalConfigs()
List<InsertListener>	getInsertListener(Class<?> entityClass)
FlexGlobalConfig.KeyConfig	getKeyConfig()
String	getLogicDeleteColumn()
Object	getNormalValueOfLogicDelete()
List<SetListener>	getSetListener(Class<?> entityClass)
org.apache.ibatis.session.SqlSessionFactory	getSqlSessionFactory()
List<InsertListener>	getSupportedInsertListener(Class<?> entityClass) 获取支持该 entityClass 的insert监听器 当registerClass是entityClass的本身或其超类时，则视为支持
List<SetListener>	getSupportedSetListener(Class<?> entityClass) 获取支持该 entityClass 的set监听器 当registerClass是entityClass的本身或其超类时，则视为支持
List<UpdateListener>	getSupportedUpdateListener(Class<?> entityClass) 获取支持该 entityClass 的update监听器 当registerClass是entityClass的本身或其超类时，则视为支持
String	getTenantColumn()
List<UpdateListener>	getUpdateListener(Class<?> entityClass)
String	getVersionColumn()
boolean	isPrintBanner()
void	registerInsertListener(InsertListener listener, Class<?>... classes)
void	registerSetListener(SetListener listener, Class<?>... classes)
void	registerUpdateListener(UpdateListener listener, Class<?>... classes)
static void	setConfig(String id, FlexGlobalConfig config, boolean isDefault) 设置全局配置
void	setConfiguration(org.apache.ibatis.session.Configuration configuration)
void	setDbType(DbType dbType)
static void	setDefaultConfig(FlexGlobalConfig config)
void	setDefaultPageSize(int defaultPageSize)
void	setDefaultRelationQueryDepth(int defaultRelationQueryDepth)
void	setDeletedValueOfLogicDelete(Object deletedValueOfLogicDelete)
void	setEntityInsertListeners(Map<Class<?>,List<InsertListener>> entityInsertListeners)
void	setEntitySetListeners(Map<Class<?>,List<SetListener>> entitySetListeners)
void	setEntityUpdateListeners(Map<Class<?>,List<UpdateListener>> entityUpdateListeners)
static void	setGlobalConfigs(ConcurrentHashMap<String,FlexGlobalConfig> globalConfigs)
void	setKeyConfig(FlexGlobalConfig.KeyConfig keyConfig)
void	setLogicDeleteColumn(String logicDeleteColumn)
void	setNormalValueOfLogicDelete(Object normalValueOfLogicDelete)
void	setPrintBanner(boolean printBanner)
void	setSqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)
void	setTenantColumn(String tenantColumn)
void	setVersionColumn(String versionColumn)

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

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

字段详细资料

printBanner

private boolean printBanner

启动是否打印 banner 和 版本号

dbType

private DbType dbType

默认使用 Mysql 数据库类型

configuration

private org.apache.ibatis.session.Configuration configuration

Mybatis 配置

sqlSessionFactory

private org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory

创建好的 sqlSessionFactory

keyConfig

private FlexGlobalConfig.KeyConfig keyConfig

全局的 ID 生成策略配置，当 @Id 未配置 或者 配置 KeyType 为 None 时 使用当前全局配置

entitySetListeners

private Map<Class<?>,List<SetListener>> entitySetListeners

entity 的监听器

entityUpdateListeners

private Map<Class<?>,List<UpdateListener>> entityUpdateListeners

entityInsertListeners

private Map<Class<?>,List<InsertListener>> entityInsertListeners

normalValueOfLogicDelete

private Object normalValueOfLogicDelete

逻辑删除的相关配置

deletedValueOfLogicDelete

private Object deletedValueOfLogicDelete

defaultPageSize

private int defaultPageSize

分页查询时，默认每页显示的数据数量。

defaultRelationQueryDepth

private int defaultRelationQueryDepth

默认的 Relation 注解查询深度

logicDeleteColumn

private String logicDeleteColumn

默认的逻辑删除字段，允许设置 null 忽略匹配。

tenantColumn

private String tenantColumn

默认的多租户字段，允许设置 null 忽略匹配。

versionColumn

private String versionColumn

默认的乐观锁字段，允许设置 null 忽略匹配。

globalConfigs

private static ConcurrentHashMap<String,FlexGlobalConfig> globalConfigs

defaultConfig

private static FlexGlobalConfig defaultConfig

构造器详细资料

FlexGlobalConfig

public FlexGlobalConfig()

方法详细资料

isPrintBanner

public boolean isPrintBanner()

setPrintBanner

public void setPrintBanner(boolean printBanner)

getDbType

public DbType getDbType()

setDbType

public void setDbType(DbType dbType)

getConfiguration

public org.apache.ibatis.session.Configuration getConfiguration()

setConfiguration

public void setConfiguration(org.apache.ibatis.session.Configuration configuration)

getSqlSessionFactory

public org.apache.ibatis.session.SqlSessionFactory getSqlSessionFactory()

setSqlSessionFactory

public void setSqlSessionFactory(org.apache.ibatis.session.SqlSessionFactory sqlSessionFactory)

getKeyConfig

public FlexGlobalConfig.KeyConfig getKeyConfig()

setKeyConfig

public void setKeyConfig(FlexGlobalConfig.KeyConfig keyConfig)

getEntitySetListeners

public Map<Class<?>,List<SetListener>> getEntitySetListeners()

setEntitySetListeners

public void setEntitySetListeners(Map<Class<?>,List<SetListener>> entitySetListeners)

getEntityUpdateListeners

public Map<Class<?>,List<UpdateListener>> getEntityUpdateListeners()

setEntityUpdateListeners

public void setEntityUpdateListeners(Map<Class<?>,List<UpdateListener>> entityUpdateListeners)

getEntityInsertListeners

public Map<Class<?>,List<InsertListener>> getEntityInsertListeners()

setEntityInsertListeners

public void setEntityInsertListeners(Map<Class<?>,List<InsertListener>> entityInsertListeners)

registerSetListener

public void registerSetListener(SetListener listener,
                                Class<?>... classes)

registerUpdateListener

public void registerUpdateListener(UpdateListener listener,
                                   Class<?>... classes)

registerInsertListener

public void registerInsertListener(InsertListener listener,
                                   Class<?>... classes)

getSetListener

public List<SetListener> getSetListener(Class<?> entityClass)

getSupportedSetListener

public List<SetListener> getSupportedSetListener(Class<?> entityClass)

获取支持该 entityClass 的set监听器

当registerClass是entityClass的本身或其超类时，则视为支持

参数:

entityClass - 实体class

返回:

UpdateListener

getUpdateListener

public List<UpdateListener> getUpdateListener(Class<?> entityClass)

findSupportedListeners

public <T extends Listener> List<T> findSupportedListeners(Class<?> entityClass,
                                                           Map<Class<?>,List<T>> listenerMap)

查找支持该 entityClass 的监听器

类型参数:

T - 监听器类型

参数:

entityClass - 实体class

listenerMap - 监听器map

返回:

符合条件的监听器

getSupportedUpdateListener

public List<UpdateListener> getSupportedUpdateListener(Class<?> entityClass)

获取支持该 entityClass 的update监听器

当registerClass是entityClass的本身或其超类时，则视为支持

参数:

entityClass - 实体class

返回:

UpdateListener

getInsertListener

public List<InsertListener> getInsertListener(Class<?> entityClass)

getSupportedInsertListener

public List<InsertListener> getSupportedInsertListener(Class<?> entityClass)

获取支持该 entityClass 的insert监听器

当registerClass是entityClass的本身或其超类时，则视为支持

参数:

entityClass - 实体class

返回:

InsertListener

getNormalValueOfLogicDelete

public Object getNormalValueOfLogicDelete()

setNormalValueOfLogicDelete

public void setNormalValueOfLogicDelete(Object normalValueOfLogicDelete)

getDeletedValueOfLogicDelete

public Object getDeletedValueOfLogicDelete()

setDeletedValueOfLogicDelete

public void setDeletedValueOfLogicDelete(Object deletedValueOfLogicDelete)

getDefaultPageSize

public int getDefaultPageSize()

setDefaultPageSize

public void setDefaultPageSize(int defaultPageSize)

getDefaultRelationQueryDepth

public int getDefaultRelationQueryDepth()

setDefaultRelationQueryDepth

public void setDefaultRelationQueryDepth(int defaultRelationQueryDepth)

getLogicDeleteColumn

public String getLogicDeleteColumn()

setLogicDeleteColumn

public void setLogicDeleteColumn(String logicDeleteColumn)

getTenantColumn

public String getTenantColumn()

setTenantColumn

public void setTenantColumn(String tenantColumn)

getVersionColumn

public String getVersionColumn()

setVersionColumn

public void setVersionColumn(String versionColumn)

getDataSource

public FlexDataSource getDataSource()

getGlobalConfigs

public static ConcurrentHashMap<String,FlexGlobalConfig> getGlobalConfigs()

setGlobalConfigs

public static void setGlobalConfigs(ConcurrentHashMap<String,FlexGlobalConfig> globalConfigs)

getDefaultConfig

public static FlexGlobalConfig getDefaultConfig()

setDefaultConfig

public static void setDefaultConfig(FlexGlobalConfig config)

getConfig

public static FlexGlobalConfig getConfig(org.apache.ibatis.session.Configuration configuration)

getConfig

public static FlexGlobalConfig getConfig(String environmentId)

setConfig

public static void setConfig(String id,
                             FlexGlobalConfig config,
                             boolean isDefault)

设置全局配置

参数:

id - 环境id

config - 全局配置

isDefault - 自动指定默认全局配置（在多源时，方便由注解指定默认源）