net.ymate.platform.core.configuration

Interface IConfig

All Superinterfaces:

AutoCloseable, IDestroyable

All Known Implementing Classes:

Cfgs

@Ignored
public interface IConfig
extends IDestroyable

配置体系管理器接口定义

Author:

刘镇 (suninformation@163.com) on 15-3-9 上午12:24

Field Summary

Fields

Modifier and Type	Field and Description
static String	MODULE_NAME
static String	MODULES_FOLDER_NAME
static String	PROJECTS_FOLDER_NAME
static String	YMP_CONFIG_HOME

Method Summary

Modifier and Type	Method and Description
<T extends IConfiguration> T	fillCfg(Class<? extends IConfigurationProvider> providerClass, T configObject, String cfgFileName, boolean search) 根据自定义配置提供者填充配置对象
<T extends IConfiguration> T	fillCfg(Class<? extends IConfigurationProvider> providerClass, T configObject, String cfgFileName, boolean search, boolean reload) 根据自定义配置提供者填充配置对象
<T extends IConfiguration> T	fillCfg(T configObject) 填充配置对象
<T extends IConfiguration> T	fillCfg(T configObject, boolean search) 装载配置，根据Configuration注解指定的配置文件进行加载，否则默认使用当前配置类对象的SimpleName作为配置文件名，即：SimpleName.CfgTagName.xml
<T extends IConfiguration> T	fillCfg(T configObject, String cfgFileName) 填充配置对象
<T extends IConfiguration> T	fillCfg(T configObject, String cfgFileName, boolean search) 填充配置对象
String	getConfigHome() 配置体系主目录路径
String	getModuleHome() 模块主目录路径
String	getModuleName() 模块名称
String	getProjectHome() 项目主目录路径
String	getProjectName() 项目名称
String	getUserDir() 系统变量 user.dir 值
String	getUserHome() 系统变量 user.home 值
void	initialize() 初始化
boolean	isInitialized() 是否已初始化
IConfiguration	loadCfg(String cfgFileName) 根据配置文件名称自动分析(xml、properties和json等)文件类型并填充配置对象, 若未找到则返回null
IConfiguration	loadCfg(String cfgFileName, boolean search) 根据配置文件名称自动分析(xml、properties和json等)文件类型并填充配置对象, 若未找到则返回null
File	searchAsFile(String cfgFile) 按照模块路径->项目路径->主路径(CONFIG_HOME)->用户路径(user.dir)->系统用户路径(user.home)的顺序寻找指定文件
String	searchAsPath(String cfgFile) 搜索配置文件真实资源路径，先在配置体系中查找，再到项目 CLASSPATH 路径中查找，若 cfgFile 以 "jar:" 开头则直接返回
InputStream	searchAsStream(String cfgFile) 按照模块路径的顺序寻找指定文件, 若文件存在则返回该文件输入流

Methods inherited from interface java.lang.AutoCloseable

close

Field Detail

MODULE_NAME

static final String MODULE_NAME

See Also:

Constant Field Values

YMP_CONFIG_HOME

static final String YMP_CONFIG_HOME

See Also:

Constant Field Values

PROJECTS_FOLDER_NAME

static final String PROJECTS_FOLDER_NAME

See Also:

Constant Field Values

MODULES_FOLDER_NAME

static final String MODULES_FOLDER_NAME

See Also:

Constant Field Values

Method Detail

initialize

void initialize()
         throws Exception

初始化

Throws:

Exception - 初始过程中产生的任何异常

isInitialized

boolean isInitialized()

是否已初始化

Returns:

返回true表示已初始化

getConfigHome

String getConfigHome()

配置体系主目录路径

Returns:

返回配置体系主目录路径

getProjectName

String getProjectName()

项目名称

Returns:

返回项目名称

getProjectHome

String getProjectHome()

项目主目录路径

Returns:

返回项目主目录路径

getModuleName

String getModuleName()

模块名称

Returns:

返回模块名称

getModuleHome

String getModuleHome()

模块主目录路径

Returns:

返回模块主目录路径

getUserHome

String getUserHome()

系统变量 user.home 值

Returns:

返回系统变量 user.home 值

getUserDir

String getUserDir()

系统变量 user.dir 值

Returns:

返回系统变量 user.dir 值

searchAsPath

String searchAsPath(String cfgFile)

搜索配置文件真实资源路径，先在配置体系中查找，再到项目 CLASSPATH 路径中查找，若 cfgFile 以 "jar:" 开头则直接返回

Parameters:

cfgFile - 配置文件相对路径及名称

Returns:

配置文件真实路径

searchAsFile

File searchAsFile(String cfgFile)

按照模块路径->项目路径->主路径(CONFIG_HOME)->用户路径(user.dir)->系统用户路径(user.home)的顺序寻找指定文件

Parameters:

cfgFile - 配置文件路径及名称

Returns:

找到的文件File对象，只要找到存在的File，立即停止寻找并返回当前File实例

searchAsStream

InputStream searchAsStream(String cfgFile)

按照模块路径的顺序寻找指定文件, 若文件存在则返回该文件输入流

Parameters:

cfgFile - 配置文件路径及名称

Returns:

返回配置文件输入流

loadCfg

IConfiguration loadCfg(String cfgFileName,
                       boolean search)

根据配置文件名称自动分析(xml、properties和json等)文件类型并填充配置对象, 若未找到则返回null

Parameters:

cfgFileName - 配置所需要的装载参数

search - 是否采用搜索

Returns:

返回配置对象

loadCfg

IConfiguration loadCfg(String cfgFileName)

根据配置文件名称自动分析(xml、properties和json等)文件类型并填充配置对象, 若未找到则返回null

Parameters:

cfgFileName - 配置所需要的装载参数

Returns:

返回配置对象

fillCfg

<T extends IConfiguration> T fillCfg(T configObject,
                                     String cfgFileName)

填充配置对象

Type Parameters:

T - 目标对象类型

Parameters:

configObject - 配置对象，不可为空

cfgFileName - 配置所需要的装载参数

Returns:

是否成功装载配置

fillCfg

<T extends IConfiguration> T fillCfg(T configObject,
                                     String cfgFileName,
                                     boolean search)

填充配置对象

Type Parameters:

T - 目标对象类型

Parameters:

configObject - 配置对象，不可为空

cfgFileName - 配置所需要的装载参数

search - 是否采用搜索

Returns:

是否成功装载配置

fillCfg

<T extends IConfiguration> T fillCfg(T configObject)

填充配置对象

Type Parameters:

T - 目标对象类型

Parameters:

configObject - 配置对象，不可为空

Returns:

是否成功装载配置

fillCfg

<T extends IConfiguration> T fillCfg(T configObject,
                                     boolean search)

装载配置，根据Configuration注解指定的配置文件进行加载，否则默认使用当前配置类对象的SimpleName作为配置文件名，即：SimpleName.CfgTagName.xml

Type Parameters:

T - 目标对象类型

Parameters:

configObject - 配置对象，不可为空

search - 是否采用搜索

Returns:

是否成功装载配置

fillCfg

<T extends IConfiguration> T fillCfg(Class<? extends IConfigurationProvider> providerClass,
                                     T configObject,
                                     String cfgFileName,
                                     boolean search)

根据自定义配置提供者填充配置对象

Type Parameters:

T - 目标对象类型

Parameters:

providerClass - 配置提供者类对象，若为空则采用框架默认

configObject - 配置对象，不可为空

cfgFileName - 配置所需要的装载参数

search - 是否采用搜索

Returns:

是否成功装载配置

fillCfg

<T extends IConfiguration> T fillCfg(Class<? extends IConfigurationProvider> providerClass,
                                     T configObject,
                                     String cfgFileName,
                                     boolean search,
                                     boolean reload)

根据自定义配置提供者填充配置对象

Type Parameters:

T - 目标对象类型

Parameters:

providerClass - 配置提供者类对象，若为空则采用框架默认

configObject - 配置对象，不可为空

cfgFileName - 配置所需要的装载参数

search - 是否采用搜索

reload - 是否自动重新加载

Returns:

是否成功装载配置