000160. Сериализация и десериализация XML в c#
Previous000151. Запуск другой формы из основной, ListBox, MenuStripNext000163. Консоль. Основные команды
Last updated
Last updated
Сериализация и десериализация XML в c#||wmysterio|wmysterio|wmysterio@yandex.ru|||Доброго времени суток всем пользователям нашего сайта! Сегодня мы изучим одну важную тему как сериализация и обратный её процесс - десириализация. Под этим странным словом "сериализация" скрывается процесс перевода некой информации в поток битов с целью сохранить где-то или восстановить из чего-то. Иными словами - изъять из файла объект или сохранить объект в файл. Для примера мы будем использовать XML-файл для хранения нашего субъекта. Сам объект будет представлен следующим классом, например:
Кодpublic class Car {
public float Speed;
public string EngineType;
public int SeatCount;
public Car() { }
}Чтобы удобно работать с таким средством, как сериализация, Нам лучше создать ещё один класс, который будет выполнять поставленную задачу. К примеру, назовём его "XMLFile". Чтобы он умел работать со всеми типами данных, ему нужно указать приставку с типом данных на вход:
Кодpublic class XMLFile**<T>** {
}Как правило неизвестный тип(или ожидаемый) принято называть как T, хотя это никак не влияет общую картину. Так как этот тип нам нужно использовать в методах, которые я запланировал, нам нужно создать поле со стандартным типом Type, переменная которой будет заполнятся из конструктора с помощью инструкции typeof, которая как раз и возвращает тип переданного в неё объекта. Что Нам ещё нужно? Естественно - это путь к файлу, иначе куда/откуда будет записывать/читать класс. Наш конструктор будет иметь следующий вид:
Кодpublic class XMLFile**<T>** {
Type dataType;
string filePath;
public XMLFile( string filePath ) {
this.filePath = filePath + ".xml";
dataType = typeof( T );
}
}Дальше нам нужно написать две процедуры, которые сериализуют и десириализуют объект соответственно. Первый метод назовём - Load(), который десериализует данные из файла и вернёт объект указанного в конструкторе типа.
Стандартный класс XmlSerializer может получать данные только с потоковыми типами данных, например TextReader или TextWriter, по-этому мы должны создать объект потоковых типов а затем сам десериалайзер:
КодTextReader tr = new StreamReader( filePath ); // открываем поток
XmlSerializer reader = new XmlSerializer( dataType ); // передаём тип T в качестве параметра
Следующим щагом будет создания объекта типа T и возврат его из метода. Делается это следующим образом:
Кодreader.Deserialize( tr );
Как только данные изъяты нам нужно преобразовать его к типу T, чтобы наш c# умел с ним обращаться. Наш метод будет таков:
Кодpublic T Load() {
TextReader tr = new StreamReader( filePath );
XmlSerializer reader = new XmlSerializer( dataType );
T instance = ( T ) reader.Deserialize( tr );
tr.Close(); // обязательно нужно закрывать файловый поток!
return instance;
}
Сохранение происходит несколько иным образом, но за похожим принципом. Во-первых: нужно знать объект, который нужно сохранить, по-этому передаём его в качестве параметра процедуры через ключевое слово object. Во-вторых: в качестве файлового потока используем TextWriter, так как мы должны записывать данные. Для сериализации используем следующий код:
Кодpublic void Save( object Obj ) {
TextWriter tw = new StreamWriter( filePath );
XmlSerializer writer = new XmlSerializer( dataType );
writer.Serialize( tw, Obj );
tw.Close();
}
Важно! Как уже было сказано, сериализация происходит только с публичными полями. Это значит, что все методы и приватные поля не будут входить в сохраняемый объект.
Наш класс XMLFile иметь такое содержание:
Кодpublic class XMLFile<T> {
Type dataType;
string filePath;
public XMLFile( string filePath ) {
this.filePath = filePath + ".xml";
dataType = typeof( T );
}
public T Load() {
TextReader tr = new StreamReader( filePath );
XmlSerializer reader = new XmlSerializer( dataType );
T instance = (T) reader.Deserialize( tr );
tr.Close();
return instance;
}
public void Save( object Obj ) {
TextWriter tw = new StreamWriter( filePath );
XmlSerializer writer = new XmlSerializer( dataType );
writer.Serialize( tw, Obj );
tw.Close();
}
}
Давайте проверим рабоспособность нашего класса. Для этого создадим объект класса Car, который мы написали выше и сохраним его. Наш код будет следующим:
Код static void Main( string[] args ) {
XMLFile<Car> file = new XMLFile<Car>( "save" ); // создаём объект.
Car c = new Car(); // создаём авто и заполняем поля объекта
c.EngineType = "auto";
c.SeatCount = 4;
c.Speed = 25.0f;
file.Save( c ); // сохраняем транспорт
}
Проверяем результат:
Как мы видим - наш файл преобразовал некое дерево (как обычный xml-документ). Атрибуты "xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"" можно удалить. Они никак не будут влиять на чтение объекта. Это чтение мы сейчас сделаем, используя следующий код:
Код static void Main( string[] args ) {
XMLFile<Car> file = new XMLFile<Car>( "save" );
Car c = file.Load(); // получаем объект из файла
// и выводим информацию об объекте
Console.WriteLine( "Engine: {0}\nSeat count: {1}\nMax. speed: {2}", c.EngineType, c.SeatCount, c.Speed );
Console.ReadKey();
}
Результат:
Дальше в уроке пойдёт речь о некоторых особенностях заполнения xml-документа. В первую очередь это касается списков и массивов. Если наш класс Car будет иметь поле
Кодpublic List<string> Author;
то в таком формате нужно указывать тип, который указан в скобках:
Код<Car>
<Author>
<string>Joe MC Dolls</string>
<string>El Bolder</string>
<string>Mac Todds</string>
<string>Jeck Petterson</string>
<string>Yang Jedd</string>
<string>Poly Ennson</string>
</Author>
<Speed>25</Speed>
<EngineType>auto</EngineType>
<SeatCount>4</SeatCount>
</Car>
Второй случай будет касаться массивов. Заполнение не отличаются от списков, но в качестве примера возьмём класс Car. Содержимое xml-файла с полем
Кодpublic Car[] Cars;
в классе, например Test,будет таковым:
Код<Test>
<Cars>
<Car>
<Speed>25</Speed>
<EngineType>auto</EngineType>
<SeatCount>4</SeatCount>
</Car>
<Car>
<Speed>120</Speed>
<EngineType>auto</EngineType>
<SeatCount>2</SeatCount>
</Car>
<Car>
<Speed>400</Speed>
<EngineType>auto</EngineType>
<SeatCount>1</SeatCount>
</Car>
</Cars>
</Test>
Некоторые типы данный нельзя сохранить. Кроме этого, сложные двухмерные массивы или списки имеют другие конструкции. Например: поле
Кодpublic List<List<string>> Autors;как правило заполняется следующим образом:
Код<Autors>
<ArrayOfString>
<string>test 0 1</string>
<string>test 0 2</string>
<string>test 0 3</string>
</ArrayOfString>
<ArrayOfString />
<string>test 1 1</string>
<string>test 1 2</string>
<string>test 1 3</string>
<ArrayOfString />
</Autors>
По-этому, если Вы решились заполнить XML-файл вручную, то лучше сохранить заранее объект а выходной документ использовать в качестве примера для Вашего файла.
Ещё несколько слов о требованию игнорировать некие поля. Как правило игнорируются приватные поля а также те, которые не указаны в XML-файле. Вот простой пример:
Код[XmlIgnore]
public Car Preview;
[XmlIgnore]
string Pattern;
Нужно немного потренироваться, ничего сложного здесь нет. С Вами был wmysterio. До встречи в новых уроках.
|3685|1|0|06072255png90014640064\|32790903png158123||serializacija_i_deserializacija_xml_v_c|1400678655
