Форум программистов, компьютерный форум, киберфорум
C# для начинающих
Войти
Регистрация
Восстановить пароль
Карта форума Темы раздела Блоги Сообщество Поиск Заказать работу  
 
Рейтинг 4.50/8: Рейтинг темы: голосов - 8, средняя оценка - 4.50
5 / 5 / 4
Регистрация: 20.01.2011
Сообщений: 350
1
.NET 4.x

Постоянная работа с xml-файлом настроек программы и возникающие ошибки

10.05.2017, 19:07. Показов 1539. Ответов 2
Метки нет (Все метки)

Author24 — интернет-сервис помощи студентам
Всем привет. У меня в моей программе реализовано хранение настроек в xml-файле. Я сделал специальную библиотеку отдельно в которой всего-то один класс. Вот весь код:
C#
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
using System;
using System.Collections.Generic;
using System.IO;
using System.Xml;
using System.Xml.Linq;
 
namespace mpSettings
{
    public class MpSettings
    {
        /// <summary>
        /// Файл настроек в виде XElement
        /// </summary>
        public static XElement XmlMpSettingsFile;
        /// <summary>
        /// Полное имя файла настроек (включая путь)
        /// </summary>
        public static string FullFileName;
        // Разделы (зоны) в файле
        private static readonly List<string> Zones = new List<string> { "User", "Config", "Settings" };
 
        /// <summary>
        /// Элементы (узлы), содержащиеся в файле настроек (for Settings)
        /// </summary>
        public enum Elements
        {
            MainSet = 1, // Основные настройки
        }
        /// <summary>
        /// Получение списка имен атрибутов в зависимости от элемента (узла)
        /// </summary>
        /// <param name="element">Элемент (узел)</param>
        /// <returns>Список имен атрибутов для указанного элемента (узла)</returns>
        private static List<string> BaseAttrNames(Elements element)
        {
            switch (element)
            {
                case Elements.MainSet:
                    return new List<string>
                {
                        "Theme", "AccentColor","ConfigTheme", "ConfigAccentColor","BordersType", "Ribbon", "FloatMenu",
                        "ChkDrwsOnMnu", "Separator",
                        "FloatMenuCollapseTo", "DrawingsAlone", "DrawingsCollapseTo"
                };
 
                default: return null;
            }
        }
        /// <summary>
        /// Получение списка значений атрибутов в зависимости от элемента (узла)
        /// </summary>
        /// <param name="element">Элемент (узел)</param>
        /// <returns>Список значений атрибутов для указанного элемента (узла)</returns>
        private static List<string> BaseAttrValues(Elements element)
        {
            switch (element)
            {
                case Elements.MainSet:
                    return new List<string>
                {
                        "BaseLight", "Blue","BaseLight", "Blue","Shadow", "True", "True",
                        "False", "0",
                        "0", "False", "0"
                };
 
                default: return null;
            }
        }
        /// <summary>
        /// Проверка файла настроек на наличие вхождений
        /// При отсутствии требуемых вхождений создает их
        /// </summary>
        private static void CheckFilesForEntries()
        {
            const string zone = "Settings";
            // Только для раздела Settings!!!!!
            foreach (Elements element in Enum.GetValues(typeof(Elements)))
            {
                var attNames = BaseAttrNames(element);
                var attValues = BaseAttrValues(element);
                if (attNames != null & attValues != null)
                {
                    for (var i = 0; i < attNames.Count; i++)
                        if (string.IsNullOrEmpty(GetValue(zone, Enum.GetName(typeof(Elements), element), attNames[i])))
                            SetValue(zone, Enum.GetName(typeof(Elements), element), attNames[i], attValues[i], true);
                }
            }
            //SaveFile();
        }
        /// <summary>
        /// Загрузка файла настроек, установка полного имени, проверка его наличия и проверка узлов
        /// </summary>
        /// <param name="file">Файл конфигурации</param>
        public static void LoadFile(string file)
        {
            try
            {
                // Полное имя (включая путь)
                FullFileName = file; //Path.Combine(directory, FileName);
                // Если файл существует, то грузим его. Иначе - создаем новый
                XmlMpSettingsFile = File.Exists(FullFileName) ? XElement.Load(FullFileName) : new XElement("ModPlus");
                // Добавляем разделы
                foreach (var zone in Zones)
                {
                    if (XmlMpSettingsFile.Element(zone) == null)
                        XmlMpSettingsFile.SetElementValue(zone, string.Empty);
                }
                SaveFile();
                // Проверяем вхождения
                CheckFilesForEntries();
            }
            catch (Exception)
            {
                // ignored
            }
        }
        /// <summary>
        /// Перезагрузка файла настроек
        /// </summary>
        private static void ReloadSettingsFile()
        {
            XmlMpSettingsFile = XElement.Load(FullFileName);
        }
        /// <summary>
        /// Сохранение файла настроек
        /// </summary>
        public static void SaveFile()
        {
            // Сохраняем
            XmlMpSettingsFile.Save(FullFileName);
            // Перезагружаем
            ReloadSettingsFile();
        }
        /// <summary>
        /// Получение значения из файла настроек для указанного элемента (узла)
        /// </summary>
        /// <param name="zone">Группа</param>
        /// <param name="element">Имя элемента (узла)</param>
        /// <param name="attrName">Имя атрибута</param>
        /// <returns>Значение атрибута. Если узла или атрибута не существует, то возвращает пустую строку</returns>
        public static string GetValue(string zone, string element, string attrName)
        {
            try
            {
                // Перезагружаем, т.к. могли исправить вручную или еще как-то
                ReloadSettingsFile();
                var xElement = XmlMpSettingsFile.Element(zone)?.Element(element);
                var attribute = xElement?.Attribute(attrName);
                if (attribute != null) return attribute.Value;
            }
            catch (Exception)
            {
                return string.Empty;
            }
            return string.Empty;
        }
        /// <summary>
        /// Получение значения из файла настроек для указанного элемента (узла)
        /// </summary>
        /// <param name="zone">Группа</param>
        /// <param name="attrName">Имя атрибута</param>
        /// <returns>Значение атрибута. Если узла или атрибута не существует, то возвращает пустую строку</returns>
        public static string GetValue(string zone, string attrName)
        {
            try
            {
                // Перезагружаем, т.к. могли исправить вручную или еще как-то
                ReloadSettingsFile();
                var xElement = XmlMpSettingsFile.Element(zone);
                var attribute = xElement?.Attribute(attrName);
                if (attribute != null) return attribute.Value;
            }
            catch (Exception)
            {
                return string.Empty;
            }
            return string.Empty;
        }
        /// <summary>
        /// Сохранение значения в файл настроек
        /// </summary>
        /// <param name="zone">Группа</param>
        /// <param name="element">Элемент (узел)</param>
        /// <param name="attrName">Имя атрибута</param>
        /// <param name="value">Значение</param>
        /// <param name="saveFile">Сохранять или нет файл. Это для тех случаев, когда много данных сохраняется подряд - 
        /// дабы не загружать систему вызываем сохранение затем отдельно</param>
        public static void SetValue(string zone, string element, string attrName, string value, bool saveFile)
        {
            /* Создание/заполнение узла
             * Так как узла может не быть, то его надо создать
             * Если узел уже есть, то в него просто добавится пустое значение */
            var xel = XmlMpSettingsFile.Element(zone);
            if (xel == null)
                XmlMpSettingsFile.SetElementValue(zone, string.Empty);
            xel?.SetElementValue(element, string.Empty);
            // Установка значения атрибута
            var xElement = XmlMpSettingsFile.Element(zone)?.Element(element);
            xElement?.SetAttributeValue(attrName, value);
            // Сохранение файла
            if (saveFile)
                SaveFile();
        }
        /// <summary>
        /// Сохранение значения в файл настроек
        /// </summary>
        /// <param name="zone">Группа</param>
        /// <param name="attrName">Имя атрибута</param>
        /// <param name="value">Значение</param>
        /// <param name="saveFile">Сохранять или нет файл. Это для тех случаев, когда много данных сохраняется подряд - 
        /// дабы не загружать систему вызываем сохранение затем отдельно</param>
        public static void SetValue(string zone, string attrName, string value, bool saveFile)
        {
            /* Создание/заполнение узла
             * Так как узла может не быть, то его надо создать
             * Если узел уже есть, то в него просто добавится пустое значение */
            var xel = XmlMpSettingsFile.Element(zone);
            if (xel == null)
                XmlMpSettingsFile.SetElementValue(zone, string.Empty);
            // Установка значения атрибута
            var xElement = XmlMpSettingsFile.Element(zone);
            xElement?.SetAttributeValue(attrName, value);
            // Сохранение файла
            if (saveFile)
                SaveFile();
        }
        /// <summary>
        /// Добавление атрибута в корневой элемент файла
        /// </summary>
        /// <param name="atrName">Имя атрибута</param>
        /// <param name="atrValue">Значение атрибута</param>
        public static void SetMainAttribute(string atrName, string atrValue)
        {
            XmlMpSettingsFile.SetAttributeValue(atrName, atrValue);
            SaveFile();
        }
        /// <summary>
        /// Получение значение атрибута из корневого элемента файла
        /// </summary>
        /// <param name="atrName">Имя атрибута</param>
        /// <returns>Значение атрибута</returns>
        public static string GetMainAttribute(string atrName)
        {
            var attribute = XmlMpSettingsFile.Attribute(atrName);
            return attribute?.Value ?? string.Empty;
        }
 
        public static bool ValidateXml(string file)
        {
            var s = new XmlReaderSettings { CloseInput = true };
            var reader = XmlReader.Create(file, s);
            using (reader)
            {
 
 
                var mSuccess = true;
                try
                {
                    while (reader.Read())
                    {
                    }
 
                    //'Close the reader.
                    reader.Close();
                }
                catch
                {
                    reader.Close();
                    mSuccess = false;
                }
                //'The validationeventhandler is the only thing that would set m_Success to false
                return mSuccess;
            }
        }
    }
}
При инициализации библиотеки вызывается метод LoadFile, который загружает файл настроек в переменную, а также XmlMpSettingsFile и записывает имя файла (полный путь) в переменную FullFileName.
Далее, при работе моей программы происходит неоднократное использование методов GetValue и SetValue. При этом происходит сохранение файла (вызов метода SaveFile) и "перезагрузка" файла в переменную XmlMpSettingsFile.
Библиотеку делал "на заре" написания программы и сейчас уже не могу ее заменить. Просто моя программа "плагинная" и все подключаемые модули используют эту библиотеку. Все методы должны остаться и единственное, что я могу править, так это работу методов.

Так вот, к сути - иногда при работе основной программы (при работе плагинов вроде не замечалось) происходит "порча" xml-файла настроек, что приводит к ошибкам типа "", шестнадцатеричное значение 0х03, является недопустимым знаком. или Присутствует незавершенная строковая константа., строка 3, позиция 41. Т.е. в файле появляются незакрытые скобки и что-то там еще подобное.
Есть ли возможности предусмотреть такие проблемы?
0
Programming
Эксперт
94731 / 64177 / 26122
Регистрация: 12.04.2006
Сообщений: 116,782
10.05.2017, 19:07
Ответы с готовыми решениями:

Xml-файл настроек программы. Как его проверять?
Всем привет. Вопрос наверно касается больше не конкретного языка, но т.к. все делаю на C#, то и...

работа с XML файлом
хочу написать анализатор XML для загрузки вопросов. &lt;Questions&gt; &lt;Question&gt; &lt;quest...

Работа с xml файлом
Здравствуйте. Помогите пожалуйста с записью в конец XML файла. Структура xml файла выглядит...

Работа с Xml файлом
Есть xml фаил как из него получить набор строк: Insert into table (Title,Numbe) values ('&quot; + Title...

2
Эксперт .NET
5534 / 4298 / 1217
Регистрация: 12.10.2013
Сообщений: 12,332
Записей в блоге: 2
10.05.2017, 19:14 2
Цитата Сообщение от Modis Посмотреть сообщение
Есть ли возможности предусмотреть такие проблемы?
Ятд, обработать ошибку и в обработчике пересоздать файл настроек со стандартными (по умолчанию) значениями.
0
5 / 5 / 4
Регистрация: 20.01.2011
Сообщений: 350
10.05.2017, 19:38  [ТС] 3
Цитата Сообщение от insite2012 Посмотреть сообщение
Ятд, обработать ошибку и в обработчике пересоздать файл настроек со стандартными (по умолчанию) значениями
Ошибка ловится при попытке чтения уже попорченного файла. Хотелось бы как-то предусмотреть решение проблемы на стадии его сохранения. Хотя, видимо это невозможно, т.к. даже понять где и когда (и почему???) происходит порча, просто невозможно
Я уже начинал издалека - при работе программы создаю копию файла настроек. В принципе, можно пробовать загрузить его, в случае ошибки, НО! Я хочу все это предусмотреть именно в этой библиотеке, чтобы похожие проблемы решить при работе различных частей программы (плагинов).
Значит остается решить - где и когда делать бэкап файла. Если в методе SaveFile, то значит нужно предусмотреть проверку файла на целосостность, прежде чем его бэкапить. В принципе, тем же try{} catch{} с попыткой чтения в вспомогательную переменную
Но есть и другая проблема. Прям сегодня столкнулся (почему и тему создал) - у одного пользователя при первом запуске программы происходил краш файла. Успевал записаться один узел и у которого уже второй атрибут не имел закрывающую кавычку. Т.е. никаких бэкапов нет и в помине. Как и рабочего файла настроек. В итоге я пользователю прислал пустой файл настроек (с основной разметкой, без значений атрибутов) и у него все заработало. Но вот отследить где и почему происходило нарушение файла возможности нет.
Вот я и подумал - может в методе SetValue моего класса при вызове метода xElement?.SetAttributeValue(attrName, value) можно как-то проверять данные, которые должны быть сохранены?
0
10.05.2017, 19:38
IT_Exp
Эксперт
87844 / 49110 / 22898
Регистрация: 17.06.2006
Сообщений: 92,604
10.05.2017, 19:38
Помогаю со студенческими работами здесь

Работа с XML - файлом
Необходимо считывать данную структуру XML-файла для дальнейшей работы с ней, а затем сохранять при...

XPath и работа с xml-файлом
Есть xml файл со структурой &lt;?xml version=&quot;1.0&quot; encoding=&quot;utf-8&quot;?&gt; &lt;root&gt; &lt;element id=&quot;&quot;&gt; ...

Cохранение настроек программы в xml
подскажите как сохранять настройки программы в xml, с ini разобрался хотелось бы и с xml. А...

Постоянная работа программы
При обучении языкам программирования, как правило предлагаются простые программы после выполнения...


Искать еще темы с ответами

Или воспользуйтесь поиском по форуму:
3
Ответ Создать тему
КиберФорум - форум программистов, компьютерный форум, программирование
Powered by vBulletin
Copyright ©2000 - 2024, CyberForum.ru