Как загрузить файл конфигурации программно

Question

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

Файл конфигурации выглядит следующим образом

<?xml version="1.0" encoding="utf-8" ?>
<Schoool Name="RT">
  <Student></Student>
</Schoool>

Как программно загрузить и использовать этот файл конфигурации из кода?

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

Answer 1

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

var fileMap = new ConfigurationFileMap("pathtoconfigfile");
var configuration = ConfigurationManager.OpenMappedMachineConfiguration(fileMap);
var sectionGroup = configuration.GetSectionGroup("applicationSettings"); // This is the section group name, change to your needs
var section = (ClientSettingsSection)sectionGroup.Sections.Get("MyTarget.Namespace.Properties.Settings"); // This is the section name, change to your needs
var setting = section.Settings.Get("SettingName"); // This is the setting name, change to your needs
return setting.Value.ValueXml.InnerText;

Обратите внимание, что я читаю действительный файл конфигурации .net. Я использую этот код для чтения файла конфигурации EXE из DLL. Я не уверен, что это работает с примером файла конфигурации, который вы дали в своем вопросе, но это должно быть хорошим началом.

Answer 2

Ознакомьтесь с серией из трех статей Джона Риста о настройке .NET 2.0 в CodeProject.

• Раскрытие тайны конфигурации .NET 2.0
• Расшифровка загадок конфигурации .NET 2.0
• Раскрытие загадок конфигурации .NET 2.0

Настоятельно рекомендуется, хорошо написано и чрезвычайно полезно!

Вы не можете загрузить любой фрагмент XML - то, что вы можете загрузить , представляет собой полный, отдельный файл конфигурации, который выглядит и выглядит как app.config.

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

Answer 3

Следующий код позволит вам загружать контент из XML в объекты. В зависимости от источника, app.config или другого файла, используйте соответствующий загрузчик.

using System.Collections.Generic;
using System.Xml.Serialization;
using System.Configuration;
using System.IO;
using System.Xml;

class Program
{
    static void Main(string[] args)
    {
        var section = SectionSchool.Load();
        var file = FileSchool.Load("School.xml");
    }
}

Загрузчик файлов:

public class FileSchool
{
    public static School Load(string path)
    {
        var encoding = System.Text.Encoding.UTF8;
        var serializer = new XmlSerializer(typeof(School));

        using (var stream = new StreamReader(path, encoding, false))
        {
            using (var reader = new XmlTextReader(stream))
            {
                return serializer.Deserialize(reader) as School;
            }
        }
    }
}

Загрузчик секций:

public class SectionSchool : ConfigurationSection
{
    public School Content { get; set; }

    protected override void DeserializeElement(XmlReader reader, bool serializeCollectionKey)
    {
        var serializer = new XmlSerializer(typeof(School)); // works in     4.0
        // var serializer = new XmlSerializer(type, null, null, null, null); // works in 4.5.1
        Content = (Schoool)serializer.Deserialize(reader);
    }
    public static School Load()
    {
        // refresh section to make sure that it will load
        ConfigurationManager.RefreshSection("School");
        // will work only first time if not refreshed
        var section = ConfigurationManager.GetSection("School") as SectionSchool;

        if (section == null)
            return null;

        return section.Content;
    }
}

Определение данных:

[XmlRoot("School")]
public class School
{
    [XmlAttribute("Name")]
    public string Name { get; set; }

    [XmlElement("Student")]
    public List<Student> Students { get; set; }
}

[XmlRoot("Student")]
public class Student
{
    [XmlAttribute("Index")]
    public int Index { get; set; }
}

Содержимое файла app.config

<?xml version="1.0"?>
<configuration>

  <configSections>
    <section name="School" type="SectionSchool, ConsoleApplication1"/>
  </configSections>

  <startup> 
      <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.0"/>
  </startup>

  <School Name="RT">
    <Student Index="1"></Student>
    <Student />
    <Student />
    <Student />
    <Student Index="2"/>
    <Student />
    <Student />
    <Student Index="3"/>
    <Student Index="4"/>
  </School>

</configuration>

Содержимое файла XML:

<?xml version="1.0" encoding="utf-8" ?>
<School Name="RT">
  <Student Index="1"></Student>
  <Student />
  <Student />
  <Student />
  <Student Index="2"/>
  <Student />
  <Student />
  <Student Index="3"/>
  <Student Index="4"/>
</School>

опубликованный код был проверен в Visual Studio 2010 (.Net 4.0). Он будет работать в .Net 4.5.1, если вы измените конструкцию seriliazer с

new XmlSerializer(typeof(School))

до

new XmlSerializer(typeof(School), null, null, null, null);

Если предоставленный пример запускается вне отладчика, он будет работать с простейшим конструктором, однако, если он запускается из IDE VS2013 с отладкой, тогда потребуется изменение в конструкторе, иначе возникнет исключение FileNotFoundException (по крайней мере, в моем случае).

Answer 4

Атрибут configSource позволяет вам переместить любой элемент конфигурации в отдельный файл. В вашем главном app.config вы должны сделать что-то вроде этого:

<configuration>
  <configSections>
    <add name="schools" type="..." />
  </configSections>

  <schools configSource="schools.config />
</configuration>