Загрузка ConfigurationSection с обязательным дочерним ConfigurationElement с помощью .NET Framework Framework - PullRequest
Новая
       63

Загрузка ConfigurationSection с обязательным дочерним ConfigurationElement с помощью .NET Framework Framework

11 голосов
/ 18 марта 2010

У меня есть консольное приложение, которое пытается загрузить CustomConfigurationSection из файла web.config.

В пользовательском разделе конфигурации есть требуемый элемент пользовательской конфигурации. Это означает, что когда я загружаю раздел конфигурации, я ожидаю увидеть исключение, если этот элемент конфигурации не присутствует в конфигурации. Проблема в том, что .NET Framework, похоже, полностью игнорирует атрибут isRequired. Поэтому, когда я загружаю раздел конфигурации, я просто создаю экземпляр пользовательского элемента конфигурации и устанавливаю его в разделе конфигурации.

Мой вопрос: почему это происходит? Я хочу, чтобы метод GetSection () вызвал исключение ConfigurationErrors, поскольку в конфигурации отсутствует обязательный элемент.

Вот как выглядит мой раздел конфигурации. 

public class MyConfigSection : ConfigurationSection
{
    [ConfigurationProperty("MyConfigElement", IsRequired = true)]
    public MyConfigElement MyElement
    {
        get { return (MyConfigElement) this["MyConfigElement"]; }
    }
}
public class MyConfigElement : ConfigurationElement
{
    [ConfigurationProperty("MyAttribute", IsRequired = true)]
    public string MyAttribute
    {
        get { return this["MyAttribute"].ToString(); }
    }
}

Вот как я загружаю раздел конфигурации. 

   class Program
    {
        public static Configuration OpenConfigFile(string configPath)
        {
            var configFile = new FileInfo(configPath);
            var vdm = new VirtualDirectoryMapping(configFile.DirectoryName, true, configFile.Name);
            var wcfm = new WebConfigurationFileMap();
            wcfm.VirtualDirectories.Add("/", vdm);
            return WebConfigurationManager.OpenMappedWebConfiguration(wcfm, "/");
        }

        static void Main(string[] args)
        {
            try{
                string path = @"C:\Users\vrybak\Desktop\Web.config";

                var configManager = OpenConfigFile(path);
                var configSection = configManager.GetSection("MyConfigSection") as MyConfigSection;

                MyConfigElement elem = configSection.MyElement;
            } catch (ConfigurationErrorsException ex){
                Console.WriteLine(ex.ToString());
            }
        }

Вот как выглядит мой конфигурационный файл. 

<?xml version="1.0"?>
<configuration>
  <configSections>
    <section name="MyConfigSection" type="configurationFrameworkTestHarness.MyConfigSection, configurationFrameworkTestHarness" />
  </configSections>

  <MyConfigSection>

  </MyConfigSection>

Самое странное то, что если я открою конфигурационный файл и загрузлю раздел 2 раза подряд, я получу исключение, которое ожидаю. 

var configManager = OpenConfigFile(path);
var configSection = configManager.GetSection("MyConfigSection") as MyConfigSection;
configManager = OpenConfigFile(path);
configSection = configManager.GetSection("MyConfigSection") as MyConfigSection;

Если я воспользуюсь приведенным выше кодом, то сработает исключение и сообщит, что требуется MyConfigElement. Вопрос в том, почему он не выбрасывает это исключение в первый раз ??

Ответы [ 3 ]

4 голосов
/ 22 марта 2010

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

Вот мой код. 

private void ProcessMissingElements(ConfigurationElement element)
{
    foreach (PropertyInformation propertyInformation in element.ElementInformation.Properties)
    {
        var complexProperty = propertyInformation.Value as ConfigurationElement;
        if (complexProperty == null) 
            continue;

        if (propertyInformation.IsRequired && !complexProperty.ElementInformation.IsPresent)
            throw new ConfigurationErrorsException("ConfigProperty: [{0}] is required but not present".FormatStr(propertyInformation.Name));
        if (!complexProperty.ElementInformation.IsPresent)
            propertyInformation.Value = null;
        else
            ProcessMissingElements(complexProperty);
    }
}
3 голосов
/ 19 марта 2010

Эрик ответил на это в форумах MS

Цитирую свой ответ:

IsRequired член ConfigurationPropertyAttribute делает не работает применительно к ребенку объект (производный от ConfigurationElement)

0 голосов
/ 22 марта 2010

Вы пытались назначить его непосредственно на правильный тип переменной, то есть MyConfigSection вместо var? Это единственное различие, которое я вижу между двумя строками кода. (то есть во второй строке, var теперь принимает определенный тип).

...