cn.stylefeng.roses.kernel.config.api

接口 ConfigApi

public interface ConfigApi

系统配置表相关的api

系统配置表的实现可以用内存，数据库或redis

作者:

fengshuonan

方法概要

限定符和类型	方法和说明
void	deleteConfig(String key) 删除一个配置项
Set<String>	getAllConfigKeys() 获取所有配置的名称集合
Map<String,Object>	getAllConfigs() 获取配置表中所有配置
<T> T	getConfigValue(String configCode, Class<T> clazz) 获取config表中的配置，如果为空，抛出异常
<T> T	getConfigValueNullable(String configCode, Class<T> clazz) 获取config表中的配置，如果为空，返回null
<T> T	getSysConfigValueWithDefault(String configCode, Class<T> clazz, T defaultValue) 获取config表中的配置，如果为空返回默认值
void	initConfig(Map<String,Object> configs) 初始化配置表中的所有配置
void	putConfig(String key, Object value) 往配置表中添加一个配置 如果有某个配置，则会覆盖某个配置

方法详细资料

initConfig

void initConfig(Map<String,Object> configs)

初始化配置表中的所有配置

参数:

configs - 配置表的所有配置

getAllConfigs

Map<String,Object> getAllConfigs()

获取配置表中所有配置

返回:

系统配置表中所有的配置

getAllConfigKeys

Set<String> getAllConfigKeys()

获取所有配置的名称集合

返回:

所有配置的名称

putConfig

void putConfig(String key,
               Object value)

往配置表中添加一个配置

如果有某个配置，则会覆盖某个配置

参数:

key - 配置标识

value - 配置具体值

deleteConfig

void deleteConfig(String key)

删除一个配置项

参数:

key - 配置名称

getConfigValue

<T> T getConfigValue(String configCode,
                     Class<T> clazz)
              throws ConfigException

获取config表中的配置，如果为空，抛出异常

参数:

configCode - 变量名称，对应sys_config表中的code

clazz - 返回变量值的类型

返回:

配置的值

抛出:

ConfigException - 如果值为空抛出异常会

getConfigValueNullable

<T> T getConfigValueNullable(String configCode,
                             Class<T> clazz)

获取config表中的配置，如果为空，返回null

参数:

configCode - 变量名称，对应sys_config表中的code

clazz - 返回变量值的类型

返回:

配置的值

getSysConfigValueWithDefault

<T> T getSysConfigValueWithDefault(String configCode,
                                   Class<T> clazz,
                                   T defaultValue)

获取config表中的配置，如果为空返回默认值

参数:

configCode - 变量名称，对应sys_config表中的code

clazz - 返回变量值的类型

defaultValue - 如果结果为空返回此默认值

返回:

配置的值