Личный опыт разработки ПО

Мне часто приходится писать гибко конфигурируемые программы. Конфигурационные файлы часто получаются довольно сложными, с развитой иерархией. Для хранения настроек я использовал XML файлы, а разбор конфигурации делал вручную.

Недавно (с версии 1.41.0) в Boost появилась библиотека Property Tree, предназначенная для решения данной задачи. Помимо поддержки XML, также поддерживаются форматы INI, JSON и свой формат INFO.

В данной заметке я рассмотрю указанные форматы и приведу код для разбора файла.

Форматы файлов

Обойду стороной вопрос об удобстве синтаксиса, так как вопрос этот достаточно субъективный, просто приведу примеры файлов описывающих одну и ту же конфигурацию:

INI

; Комментарий
[server]
name	=	"alpha server"
port	=	9010
 
[channels]
; Иерархии в INI-файлах не поддерживаются
 
[channel]
; Не работает
name	=	first
id	=	1
comment	=	"Необязательный комментарий"
enabled	=	true
 
[channel]
; Не работает
name	=	second
id	=	2
enabled	=	false

XML

<?xml version="1.0" encoding="utf-8"?>
<!-- Комментарий -->
<server>
	<name>alpha server</name>
	<port>9010</port>
	<channels>
		<channel>
			<name>first</name>
			<id>1</id>
			<comment>Необязательный комментарий</comment>
			<enabled>true</enabled>
		</channel>
		<channel>
			<name>second</name>
			<id>2</id>
			<enabled>false</enabled>
		</channel>
	</channels>
</server>

JSON

{
	/* Комментарий */
	"server":
	{
		"name":	"alpha server",
		"port":	9010,
		"channels":
		[
			{
				"name":		"first",
				"id":		1,
				"comment":	"Необязательный комментарий",
				"enabled":	true
			},
			{
				"name":		"second",
				"id":		2,
				"enabled":	false
			}
		]
	}
}

INFO

; Комментарий
server
{
	name	"alpha server"
	port	9010
	channels
	{
		channel
		{
			name	"first"
			id	1
			comment	"Необязательный комментарий"
			enabled	true
		}
		channel
		{
			name	"second"
			id	2
			enabled	false
		}
	}
}

Теперь по существу:

1. Формат INI не поддерживает иерархическое представление данных
2. C документами сохраненными в UTF-8, проблем при чтении у Boost Property Tree не обнаружено
3. JSON очень строго регламентирует синтаксис и структуру файла, поэтому при ошибках в файле, например из-за пропущенной запятой, файл разобран не будет
4. JSON проверяет правильность написания булевых значений – написав "fals" вместо "false", вы получите ошибку на этапе разбора файла. Внимание, в случае XML и INFO ошибки на будет, а код get<bool>("…") вернет true (как и ожидается, если "false" написан верно, возвращаемое значение будет false).
5. Во всех форматах корректно идет работа как с целыми числами, так и с числами с плавающей точкой. Возможна запись в виде: 1560, 1560.5, 1.5605e3

Разбор файла

Первым делом необходимо подключить один из указанных заголовочных файлов, в зависимости от того, с файлами какого формата вы будете работать:

#include <boost/property_tree/ini_parser.hpp>
#include <boost/property_tree/xml_parser.hpp>
#include <boost/property_tree/json_parser.hpp>
#include <boost/property_tree/info_parser.hpp>

После этого создается объект типа boost::property_tree::ptree, в котором при удачном разборе файла будет сохранена структура файла со значениями. Далее собственно вызывается функция для разбора файла. Об ошибке во время разбора файла можно вывести подробное сообщение:

1
2
3
4
5
6
7
8
9
10
11
12

boost::property_tree::ptree config;
try
{
	Parser("fileName", config);
}
catch (Exception& error)
{
	std::cout 
		<< error.message() << ": " 
		<< error.filename() << ", line " 
		<< error.line() << std::endl;
}

Parser в четвертой строке и Exception в шестой в зависимости от типа файла принимают следующие значения:

Разбор конфигурации

После успешно выполненного разбора документ будет представлен узлами содержащими элементы (узел из одного значения) или другие узлы.

Доступ к нужному узлу осуществляется методом:

Для доступа к элементу узла используются три метода:

Пример кода:

try
{
	const boost::property_tree::ptree& server = config.get_child("server");
	std::cout 
		<< "\nServer ===================================\n"
		<< "Name:\t" << server.get<std::string>("name") << '\n'
		<< "Port:\t" << server.get("port", 9000) << '\n';
	BOOST_FOREACH (const boost::property_tree::ptree::value_type& channel, 
		config.get_child("server.channels"))
	{
		const boost::property_tree::ptree& values = channel.second;
		std::cout 
			<< "\tChannel --------------------------\n"
			<< "\tName:\t" << values.get<std::string>("name") << '\n'
			<< "\tId:\t" << values.get<unsigned>("id") << '\n'
			<< "\tEnabled:" << values.get<bool>("enabled", true) << '\n';
		if (const boost::optional<std::string> optionalComment = 
				values.get_optional<std::string>("comment"))
		{
			std::cout << "\t" << optionalComment.get() << '\n';
		}
	}
}
catch (const boost::property_tree::ptree_bad_data& error)
{
	std::cout << error.what() << std::endl;
}
catch (const boost::property_tree::ptree_bad_path& error)
{
	std::cout << error.what() << std::endl;
}

Запись конфигурации

Теоретически можно создавать и редактировать конфигурационные файлы, для этого есть соответствующие методы:

config.put("enabled", false);
write_xml("test.xml", config);

К сожалению практически в этом смысла мало:

1. Файлы XML и JSON становятся трудночитаемыми человеком, так как полностью пропадает форматирование
2. UTF-8 фрагменты в JSON сохраняются с полной потерей информации
3. На этом фоне INFO смотрится прилично, но комментарии не сохраняются

Заключение

У меня, как правило не стоит задача сохранения конфигураций из программы. Система конфигурируется человеком в текстовом редакторе, а программа данную конфигурацию читает и настраивает себя. Для этих целей библиотека очень удобна и действительно упрощает разбор конфигураций. В качестве формата файлов я выбрал JSON из-за его легкого синтаксиса и строгих проверок.

Для сохранений конфигураций библиотека, на мой взгляд пока не годится, разве что только файлы будут в формате INFO и вас устроит отсутствие комментариев.

Библиотека тяжеловата и поскольку представлена в виде заголовочных файлов, то компиляция замедлится.

Файлы к заметке

Архив с тестовой программой и конфигурацией в формате INI, XML, JSON, INFO