Serializacja danych w języku C#

W pewnych momentach pisania aplikacji jesteśmy zmuszeni do przechowania danych w sposób shierarchizowany na dysku w pewien sposób - na przykład list typów strukturalnych. Aby przechować duże porcje tego typu danych, świetną metodą mogą okazać się bazy danych, jednak do małych rozwiązań są one przerostem formy nad treścią. Jak zaradzić temu problemowi? Zapraszam do wpisu!

Pliki, pliki, pliki

Oczywistą metodą w tym momencie jest po prostu zapis plików na dysku. Tutaj zaczyna się kolejny problem: Ilu programistów - tyle jest metod zapisu plików, a to rodzi konsekwencje problemów z przenośnością naszych danych i ich obsługi przez inne programy. Temu problemowi może zaradzić format XML, do którego możemy ładnie zapisać obiekty i struktury, elegancko zachowując hierarchię poszczególnych pól, a przy okazji robić to w sposób ustandaryzowany :)

Więc dlaczego XML jest taki fajny?

Odpowiedź na powyższe pytanie jest proste. Poddajmy analizie poniższy kod żywcem ukradziony z Wikipedii:

[code=XML] <ksiazka-telefoniczna kategoria="bohaterowie książek"> <osoba charakter="dobry"> <imie>Ambroży</imie> <nazwisko>Kleks</nazwisko> <telefon>123-456-789</telefon> </osoba> <osoba charakter="zły"> <imie>Alojzy</imie> <nazwisko>Bąbel</nazwisko> <telefon/> </osoba> </ksiazka-telefoniczna>[/code]

Powyższy kod nie wymaga wielkiego komentarza. Dzięki niemu jesteśmy w stanie w pliku zapisać w przejrzysty sposób informacje na temat interesujących nas obiektów. W tym wypadku są to osoby. C# udostępnia nam ciekawe klasy i metody, które pozwolą nam osiągnąć ten cel.

Zaczynamy kodowanie

Skoro plik XML jest tak naprawdę czystym tekstem o rozszerzeniu XML, to użyjemy standardowego dla C# StreamWritera z przestrzeni System.IO do zapisu strumienia do pliku.

Zarówno do odczytu jak i zapisu służy obiekt klasy XmlSerializer z przestrzeni nazw System.Xml.Serialization. Jak go użyć? Zobaczmy:

[code=C#]/* Tutaj inicjalizujemy strukturę z osobą i nadajemy jej polom jakieś wartości do zapisu */ osoba o = new osoba(); o.imie = "Ala"; o.nazwisko = "Kowalska"; o.wiek = 20; o.email = "ala.kowalska@domain.com"; /*Tutaj następują ciekawe sprawy */ StreamWriter wr = new StreamWriter("dane.xml"); //To służy do zapisu danych XmlSerializer serializer = new XmlSerializer(typeof(osoba)); //To będzie je formatowało :) serializer.Serialize(wr, o); //Serializujemy wr.Flush(); wr.Close(); //Sprzątamy[/code]

O ile czynności wykonywane na obiekcie wr są dość oczywiste, to my przyjrzymy się z bliska obiektowi serializer.

Do konstruktora podajemy słówko kluczowe typeof(typ_danej), który wskazuje jaki typ ta instancja klasy XmlSerializer będzie przetwarzała, niezależnie od tego czy jest to operacja odczytu czy też zapisu.

Metoda serialize przyjmuje jako pierwszy argument strumień do zapisu (u nas jest to plik), a jako drugi obiekt, który ma być serializowany . Po tych prostych operacjach otrzymujemy wynikowy XML:

[code=XML] <osoba xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <imie>Ala</imie> <nazwisko>Kowalska</nazwisko> <wiek>20</wiek> <email>ala.kowalska@domain.com</email> </osoba>[/code]

Obsługa zapisu i odczytu danych - Odczyt

Skoro potrafimy już odczytywać nasze dane, to przychodzi pora na odczyt.

Przyjrzymy się temu listingowi:

[code=C#] StreamReader r = new StreamReader("dane.xml"); XmlSerializer serializer = new XmlSerializer(typeof(osoba)); osoba p = (osoba)serializer.Deserialize(r);[/code]

Odczyt danych jest analogiczny do zapisu z kilkoma drobnymi różnicami: Do odczytu stosujemy obiekt typu StreamReader. Do deserializacji nadal używamy obiektu typu XmlSerializer, ale wywołując metodę deserialize i rzutując to co zwraca na typ naszej struktury - w tym wypadku osoby.

Nasze dane zostały odczytane.

Podsumowanie

Mam nadzieję, że mój przydługi wywód na temat serializacji danych w C# okaże się dla kogoś przydatny. Warto w ten sposób serializować typ List<>, jeżeli mamy pewne porcje danych tego samego typu.

Na koniec zamieszczam kompletny kod krótkiego programu, który zapisuje nasze dane:

[code=C#] using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Xml.Serialization; using System.IO; namespace Serializacja1 { public struct osoba { public string imie; public string nazwisko; public int wiek; public string email; } class Program { static void Main(string[] args) { /* Tutaj inicjalizujemy strukturę z osobą i nadajemy jej polom jakieś wartości do zapisu */ osoba o = new osoba(); o.imie = "Ala"; o.nazwisko = "Kowalska"; o.wiek = 20; o.email = "ala.kowalska@domain.com"; /*Tutaj następują ciekawe sprawy */ StreamWriter wr = new StreamWriter("dane.xml"); //To służy do zapisu danych XmlSerializer serializer = new XmlSerializer(typeof(osoba)); //To będzie je formatowało :) serializer.Serialize(wr, o); //Serializujemy wr.Flush(); wr.Close(); //Sprzątamy } } }[/code]