c++对properties配置文件操作工具类

Posted 2020-10-29

源代码GitHub路径：源代码地址下载

最近要使用c++对windows api相关接口的封装，有2个接口要求读写properties文件。
原以为网上应该有一大堆资料的，结果拜BAI度的大恩大德，一点相关的资料都没有。那就只能自己动手丰衣足食。再次感谢十分强大只是找不到相关资料的BAI度。

头文件

#pragma once

#ifndef CProperties_H
#define CProperties_H

#include <iostream>
#include <fstream>
#include <sstream>
#include <string>
#include <vector>
#include <map>
#include <windows.h>
using namespace std;

#define  IS_OK 1
#define  IS_ERROR 0
typedef  bool PSTATUS;
class CProperties{
private:
    string path;
protected:
public:
    CProperties();
    virtual ~CProperties();
    //打开文件
    PSTATUS open(const char* path);
    //实现文件加载到map中
    PSTATUS load();
    void print();
    void close();
    vector<string> read(const char *k);
    PSTATUS write(const char *k,const char* v);
    void trim_first(string &s);
    void trim_end(string &s);
    void trim(string &s);
};

#endif

# 源文件

#include "stdafx.h"
#include "properties.h"
/************************************************************************************************/
///*
//*作者：王邵华
//*email：[email protected]
//*时间：20180404
//*版本历程：
//*版本号    参与人      事项    
//*V1.0.0.1  王邵华      创建  
//***************************************************************************************************
//***************************************************************************************************
//*本工具类实现c++对properties文件的读写操作，
//*1.支持单行注释如：行首除去空格后以 //、#、<!--内容--> 开始的
//* //这是单行注释
//* #这是单行注释
//* <!--这是单行注释-->
//*2.支持节点 但节点并没有意义 [section]
//*[section0]
//*key=value
//*[section1]
//*key=value
//*用到multimap所以存在key键有2个值而已，节点并没有起到区分的作用，这一点也符合properties配置文件要求规范的
//*3.支持多行注释 /*第一行，第二行.....*/
//*案例（1）同行有/*..*/ 如：key=123/*oooooo*/b=890  结果保留key=123
//*案例（2）多行有/*..*/ 如：key=123/*ooo
//*0000000000000000000
//*ooo*/b=890  结果保留key=123
//*案例（3）行头行尾有/*..*/如：/*ooooo*/key=123 结果不保留
//*
//*/
/************************************************************************************************/
static vector<string> vLine;
static multimap<string,string> msKV;
static bool mulremark = false;//多行注释开关

CProperties::CProperties(){};
CProperties::~CProperties(){};

PSTATUS CProperties::open(const char* path){
    /**************************************************************/
    //判断是否是文本文档 而不是文件夹 此代码存在问题一直hFind = 0xFFFFFFFF
    //暂留 以便日后优化
    //author：王邵华
    //time：  20180404
    /*WIN32_FIND_DATA fd; 
    bool ret = true;
    HANDLE hFind = FindFirstFile(LPCWSTR(path), &fd); 
    if ((hFind != INVALID_HANDLE_VALUE) && !(fd.dwFileAttributes & FILE_ATTRIBUTE_DIRECTORY)) 
    { 
        ret = false;
    }
    FindClose(hFind); 
    if (ret)
    {
        //文件属性不对
        return IS_ERROR;
    }*/
    /**************************************************************/
    if (nullptr == path)
    {
        return IS_ERROR;
    }
    this->path = path;
    ifstream ifs;
    ifs.open(path,ios::in);
    if (!ifs)
    {
        return IS_ERROR;//打开文件失败
    }
    string sLine;
    while(!ifs.eof()){
        sLine = "";
        getline(ifs,sLine);
        if (mulremark)//已打开多行注释开关 需判断该行有没有关闭开关
        {
            if(sLine.find("*/") != string::npos){
                mulremark = false;
            }
            continue;//无论开关是否关闭 继续读下一行数据
        }else
        {
            string::size_type pos =sLine.find("/*");string sSubLine;
            if (pos != string::npos)//改行有多行注释开关  需打开
            {
                string::size_type epos = sLine.rfind("*/");
                mulremark = epos==string::npos || epos<pos?true:false;
                sSubLine = sLine.substr(0,pos);
            }else{
                sSubLine = sLine;
            }
            trim(sSubLine);
            if (sSubLine.length()<= 0) continue;
            if (sSubLine[0] == ‘#‘)continue;
            if (sSubLine[0] == ‘[‘)continue;
            if (sSubLine.length()>2 && sSubLine[0] == ‘/‘ && sSubLine[1] == ‘/‘)continue;
            if (sSubLine.length()>4 && sSubLine[0] == ‘<‘ && sSubLine[1] == ‘!‘)continue;
            vLine.push_back(sSubLine);
        }
    }
    if (ifs.is_open())
    {
        ifs.close();
    }
    return IS_OK;
}
//实现文件加载到map中
PSTATUS CProperties::load(){
    string key,value;string sSubStr;
    for (int i = 0;i<vLine.size();i++)
    {
        string::size_type pos = vLine.at(i).find_first_of("=");
        if (pos == string::npos)
        {
            continue;
        }
        key = vLine.at(i).substr(0,pos);
        value = vLine.at(i).substr(pos+1,vLine.at(i).size()-pos);
        msKV.insert(make_pair(key,value));
    }
    return IS_OK;
}

void CProperties::print(){
    multimap<string,string>::iterator  itr = msKV.begin();
    cout<<"################################################################################"<<endl;
    for (;itr!=msKV.end();itr++)
    {
        cout<<"key:"<< itr->first.c_str()<<";value:"<<itr->second.c_str()<<endl;
    }
    cout<<"$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$$"<<endl;
}

vector<string> CProperties::read(const char *k){
    vector<string> vVauleCol;
    if (msKV.size()>0)
    {
        multimap<string, string>::size_type  cnt = msKV.count(k);
        multimap<string, string>::iterator  iter = msKV.find(k);
        for(;cnt > 0; cnt--, iter++)
        {
            vVauleCol.push_back(iter->second);
        }
    }
    return vVauleCol;
}

/*
*aim:将key=value追加到文本末尾，更新multimap映射插入
*/
PSTATUS CProperties::write(const char *k,const char* v){
    if (nullptr == k || nullptr == v)
    {
        return IS_ERROR; //校验入参
    }
    ofstream ofs;
    ofs.open(this->path.c_str(),ios::app);
    if(!ofs)
    {
        return IS_ERROR;//打开文件失败
    }
    char sStr[1024] = {};
    sprintf(sStr,"%s=%s",k,v);
    ofs<<endl<<sStr;
    msKV.insert(make_pair(k,v));
    if(ofs.is_open())
    {
        ofs.close();
    }
    return IS_OK;
}

/*
*aim:防止多次造作脏数据干扰
*/
void CProperties::close(){
    vLine.erase(vLine.begin(),vLine.end());
    msKV.erase(msKV.begin(),msKV.end());
}

void CProperties::trim_first(string &s){
    if( !s.empty() )
        s.erase(0,s.find_first_not_of(" "));
}
void CProperties::trim_end(string &s){
    if( !s.empty() )
        s.erase(s.find_last_not_of(" ") + 1);
}
void CProperties::trim(string &s)
{
    int index = 0;
    if( !s.empty())
    {
        while( (index = s.find(‘ ‘,index)) != string::npos)
        {
            s.erase(index,1);
        }
    }
}

调用实例

int _tmain1(int argc, _TCHAR* argv[])
{

//########################################################//
//read
//1.创建对象open()文件
//2.load()加载到内存中
//3.read()读取相关key值的value
//4.close()释放资源

CProperties cprop;
PSTATUS ret = cprop.open("D:\\job\\greatwall\\test\\bank.properties");
if (ret != IS_OK)
{
    cout<<"打开配置文件失败"<<endl;
    getchar();
    return 0;
}
cprop.load();
vector<string> vec = cprop.read("key3");
for (int i=0; i<vec.size();i++)
{
    cout<<vec[i].c_str()<<endl;
}
cprop.close();

//########################################################//

//########################################################//
//write
//1.创建对象
//2.load()加载到内存中
//3.write()读取相关key值的value
//4.close()释放资源

CProperties cprop_write;
ret = cprop_write.open("D:\\job\\greatwall\\test\\bank2.properties");
cprop_write.write("aaa","bbb");
cprop_write.write("aaa","bbb");
vec = cprop_write.read("aaa");
for (int i=0; i<vec.size();i++)
{
    cout<<vec[i].c_str()<<endl;
}
cprop_write.close();

//########################################################//

getchar();
return 0;
}