读取配置文件动态创建对象[C++]

本文转自http://jnn.blogbus.com/logs/1879300.html

 

 

问题的由来

使用过Log4J 的朋友应该有这样酷的体会，通过修改配置文件可以很方便得实现对应用程序的日志行为进行定义，而这些都不需要修改任何的应用程序代码。也许你会说，这些在Java中是很容易实现的（使用classforname 就可以很容易实现了）。

 

 

但是对于使用C++来进行日常开发的朋友，如果要实现这样的功能又如何来做呢？因为C++语言本身并不支持这样的通过读取配置文件动态创建对象的功能。

 

 

在Log4Cplus  中，使用C++来这种动态配置生成对象的功能，它是怎么实现呢？要知道C++可没有类似于java的class loader以及 reflection 机制，看来需要自己动手来实现通过读取配置产生合适的logger appender对象了。

 

 

好在Log4Cplus是一个为C++开发的开源logger库，它实现了一个C++版的Log4J。我们可以通过分析它来探究一下C++实现读取配置文件动态创建对象实现原理。  

 

 

分析功能，通过读取配置文件后获得需要加载的信息内容，然后通过相关对象实例模块来实现对象实例化操作。

 

 

初步分析, 系统通过读取配置文件来负责加载相关的类实例, 因此分析可以从配置模块内部入手, 实现基本的初始化分析。

 

 

通过分析源代码目录发现与系统配置相关的对象有以下几部分内容

 

 

 

 

Properties

PropertyConfigurator

BasicConfigurator

 

 

重点分析 PropertyConfigurator中的相关代码模块。

下面将结合PropertyConfigurator中的实例来进行分析

—如何实现Appender的动态可配置功能

--需要分析方法实现

--- initializeLog4cplus();

 

---configureAppenders();

 

---configureLoggers();

 

---configureAdditivity();

 

 

代码部分

 

 

void log4cplus::PropertyConfigurator::replaceEnvironVariables() { std::vector<log4cplus::tstring> keys = properties.propertyNames(); // 解析属性文件中的内容, 需要定义什么是主属性,什么次属性 -- 注意 propertyName 以及 substEnvironVars std::vector<log4cplus::tstring>::iterator it = keys.begin(); for(; it!=keys.end(); ++it) { log4cplus::tstring key = *it; log4cplus::tstring val = properties.getProperty(key); log4cplus::tstring subKey = substEnvironVars(key, getLogLog()); if(subKey != key) { properties.removeProperty(key); properties.setProperty(subKey, val); } log4cplus::tstring subVal = substEnvironVars(val, getLogLog()); if(subVal != val) { properties.setProperty(subKey, subVal); } } } void log4cplus::PropertyConfigurator::configureLoggers() { // 定义属性文件的属性项 if(properties.exists( LOG4CPLUS_TEXT("rootLogger") )) { Logger root = h.getRoot(); // 加载有关根log模块的信息 configureLogger(root, properties.getProperty(LOG4CPLUS_TEXT("rootLogger"))); } // 获取子属性部件 Properties loggerProperties = properties.getPropertySubset(LOG4CPLUS_TEXT("logger.")); vector<tstring> loggers = loggerProperties.propertyNames(); // 注意ConfigureLogger部分的内容,获取有关属性值的描述 for(vector<tstring>::iterator it=loggers.begin(); it!=loggers.end(); ++it) { Logger log = getLogger(*it); configureLogger(log, loggerProperties.getProperty(*it)); } } void log4cplus::PropertyConfigurator::configureLogger(log4cplus::Logger logger, const log4cplus::tstring& config) { // Remove all spaces from config tstring configString; //如何实现trim的功能，实现一个范型的方法调用 remove_copy_if(config.begin(), config.end(), string_append_iterator<tstring>(configString), bind1st(equal_to<tchar>(), ' ')); // "Tokenize" configString // 分离字符部分的内容,按照 “,”进行分隔 vector<tstring> tokens; tokenize(configString, ',', back_insert_iterator<vector<tstring> >(tokens)); if(tokens.size() == 0) { getLogLog().error( LOG4CPLUS_TEXT("PropertyConfigurator::configureLogger()- Invalid config string(Logger = ") + logger.getName() + LOG4CPLUS_TEXT("): /"") + config + LOG4CPLUS_TEXT("/"")); return; } 

 

void log4cplus::PropertyConfigurator::configureAppenders() { Properties appenderProperties = properties.getPropertySubset(LOG4CPLUS_TEXT("appender.")); // 根据Appenders文本获取相关的数据 vector<tstring> appendersProps = appenderProperties.propertyNames(); for(vector<tstring>::iterator it=appendersProps.begin(); it!=appendersProps.end(); ++it) { if( (*it).find( LOG4CPLUS_TEXT('.') ) == tstring::npos ) { //实现基本的数据采集获取功能 tstring factoryName = appenderProperties.getProperty(*it); //解析获得创建实例所需使用的有关Factory的方法 AppenderFactory* factory = getAppenderFactoryRegistry().get(factoryName); // 通过工厂名称来获得相关的工厂方法 if(factory == 0) { tstring err = LOG4CPLUS_TEXT("PropertyConfigurator::configureAppenders()- Cannot find AppenderFactory: "); getLogLog().error(err + factoryName); continue; } Properties properties = appenderProperties.getPropertySubset((*it) + LOG4CPLUS_TEXT(".")); try { //创建相关的对象链接 SharedAppenderPtr appender = factory->createObject(properties); if(appender.get() == 0) { tstring err = LOG4CPLUS_TEXT("PropertyConfigurator::configureAppenders()- Failed to create appender: "); getLogLog().error(err + *it); } //实现对属性值的处理 else { appender->setName(*it); appenders[*it] = appender; } } catch(std::exception& e) { tstring err = LOG4CPLUS_TEXT("PropertyConfigurator::configureAppenders()- Error while creating Appender: "); getLogLog().error(err + LOG4CPLUS_C_STR_TO_TSTRING(e.what())); } } } // end for loop } void log4cplus::PropertyConfigurator::configureAdditivity() { Properties additivityProperties = properties.getPropertySubset(LOG4CPLUS_TEXT("additivity.")); vector<tstring> additivitysProps = additivityProperties.propertyNames(); for(vector<tstring>::iterator it=additivitysProps.begin(); it!=additivitysProps.end(); ++it) { Logger logger = getLogger(*it); tstring actualValue = additivityProperties.getProperty(*it); tstring value = toLower(actualValue); if(value == LOG4CPLUS_TEXT("true")) { logger.setAdditivity(true); } else if(value == LOG4CPLUS_TEXT("false")) { logger.setAdditivity(false); } else { getLogLog().warn( LOG4CPLUS_TEXT("Invalid Additivity value: /"") + actualValue + LOG4CPLUS_TEXT("/"")); } } } 

 

在全局函数中完成LoggerAppender的初始化工作 initializeFactoryRegistry(); void initializeFactoryRegistry() { AppenderFactoryRegistry& reg = getAppenderFactoryRegistry(); auto_ptr<AppenderFactory> ptr1(new ConsoleAppenderFactory()); reg.put(ptr1); auto_ptr<AppenderFactory> ptr2(new NullAppenderFactory()); reg.put(ptr2); auto_ptr<AppenderFactory> ptr3(new FileAppenderFactory()); reg.put(ptr3); auto_ptr<AppenderFactory> ptr4(new RollingFileAppenderFactory()); reg.put(ptr4); auto_ptr<AppenderFactory> ptr5(new DailyRollingFileAppenderFactory()); reg.put(ptr5); auto_ptr<AppenderFactory> ptr6(new SocketAppenderFactory()); reg.put(ptr6); #if defined(_WIN32) auto_ptr<AppenderFactory> ptr7(new NTEventLogAppenderFactory()); reg.put(ptr7); #elif defined(HAVE_SYSLOG_H) auto_ptr<AppenderFactory> ptr8(new SysLogAppenderFactory()); reg.put(ptr8); #endif LayoutFactoryRegistry& reg2 = getLayoutFactoryRegistry(); auto_ptr<LayoutFactory> ptr21(new SimpleLayoutFactory()); reg2.put(ptr21); auto_ptr<LayoutFactory> ptr22(new TTCCLayoutFactory()); reg2.put(ptr22); auto_ptr<LayoutFactory> ptr23(new PatternLayoutFactory()); reg2.put(ptr23); FilterFactoryRegistry& reg3 = getFilterFactoryRegistry(); auto_ptr<FilterFactory> ptr31(new DenyAllFilterFactory()); reg3.put(ptr31); auto_ptr<FilterFactory> ptr32(new LogLevelMatchFilterFactory()); reg3.put(ptr32); auto_ptr<FilterFactory> ptr33(new LogLevelRangeFilterFactory()); reg3.put(ptr33); auto_ptr<FilterFactory> ptr34(new StringMatchFilterFactory()); reg3.put(ptr34); } 

 

 

通过这种方式来实现 

              AppenderFactoryRegistry

 

              LayoutFactoryRegistry

 

              FilterFactoryRegistry

 

的初始化工作 – 如果要加入新的类型的数据的支持,需要将这部分的内容也要实现

 

       

 

 如何利用Registry中的内容来实现对象数据的创建?

 

注意

 

得到的指针内容都是Factory中定义的内容,

 

通过调用Factory方法来获取具体的能够使用的对象的实例

 

AppenderFactory返回的指针是SharedAppenderPtr

class NullAppenderFactory : public AppenderFactory { public: SharedAppenderPtr createObject(const Properties& props) { return SharedAppenderPtr(new log4cplus::NullAppender(props)); } tstring getTypeName() { return LOG4CPLUS_TEXT("log4cplus::NullAppender"); } }; LayoutFactory中返回的是std::auto_ptr指针 class TTCCLayoutFactory : public LayoutFactory { public: std::auto_ptr<Layout> createObject(const Properties& props) { std::auto_ptr<Layout> tmp(new log4cplus::TTCCLayout(props)); return tmp; } tstring getTypeName() { return LOG4CPLUS_TEXT("log4cplus::TTCCLayout"); } }; 

 

这两者之间有什么样的区别联系?

通过auto_ptr可以知道对象实例在返回之后,需要将对象的生命周期交给外部的使用者,由使用者负责堆对象实例的析构工作.

 

 

分析成果

配置文件的定义实现,包含的基本类,以及这些类的实现.

对于实现的动态配置的考虑:

1.  通过生成RegistryFactory完成所有需要加载的对象的工厂方法的初始化,

2.  分析配置文件来实现不同方法的调用的实现

3.  加载完成Configure文件之后,既实现的基本的数据的获取和采集功能.