C# – Jak wygodnie serializować i deserializować obiekty.

Serializacja jest bardzo rozległym zagadnieniem, dowodem na to może być chociażby osobny rozdział w książkach technicznych. Jest wiele istotnych kwestii związanych z tym tematem, natomiast ja tym wpisem chciałbym Ci pokazać najwygodniejszy sposób. Jeżeli chciałbyś dowiedzieć się jeszcze więcej na temat serializacji, gorąco polecam Ci książkę: C# w pigułce.

Wielokrotnie w swoich projektach spotykamy się z potrzebą serializacji lub deserializacji obiektów. Najczęściej w celu transmisji obiektów, przez sieć lub poza aplikację, lub też po prostu przechowując dane w pliku. Na swoim przykładzie wiem, że raczej ten pierwszy wariant pojawia się częściej, więc skupimy się na transmisji danych (API).

Zakładam, że koncepcja serializacji jest Ci chociaż trochę znana. Dla przypomnienia, w skrócie chodzi o to, by na podstawie obiektu utworzyć strumień danych reprezentujący ten obiekt (strumień ten może mieć postać JSON lub XML) i odwrotne działanie – deserializacja, czyli utworzenie obiektu, na podstawie strumienia. Tyle słowem wstępu, czas na konkrety.

Naszym zadaniem będzie deserializacja odpowiedzi, którą otrzymamy od serwera, tak aby ułatwić sobie późniejszą pracę. Tak jak wspomniałem wykorzystamy API, nie jest istotne jakie, najważniejsza jest koncepcja działania i poszczególne kroki – dlatego na tym skup swoją uwagę.

Pozwolę sobie pominąć proces wysyłania żądania do serwera.

Krok 1. Wszystkie dokumentacje API udostępniają przykładowe odpowiedzi serwera. Przykładowa odpowiedź z pierwszego lepszego API wygląda następująco.

{
    "status": 200,
    "msg": "OK",
    "result": {
        "extid": "extuserid",
        "email": "jeff@openload.io",
        "signup_at": "2015-01-09 23:59:54",
        "storage_left": -1,
        "storage_used": "32922117680",
        "traffic": {
          "left": -1,
          "used_24h": 0
        },
        "balance": 0
    }
}

{

"status": 200,

"msg": "OK",

"result": {

"extid": "extuserid",

"email": "[email protected]",

"signup_at": "2015-01-09 23:59:54",

"storage_left": -1,

"storage_used": "32922117680",

"traffic": {

"left": -1,

"used_24h": 0

"balance": 0

}

Krok 2. Utwórz klasę np. AccountResponse.cs i uśuń z niej zawartość – zostaw biblioteki i namespace.

Krok 3. Skopiuj całą odpowiedź z serwera. Przejdź do Visual Studio. Ustaw kursor pomiędzy nawiasami klamrowymi w pliku powyżej. Następnie wybierz z menu Edit -> Paste special, i wybierz w naszym przypadku Paste JSON As Classes. Twoim oczom ukaże się reprezentacja odpowiedzi serwera w postaci obiektu klasy. Oczywiście to nie koniec.

Tej opcji nie ma jeszcze w Visual Studio Code (08.11.18r.)

.NET Framework

Krok 4. Zmień nazwę głównej klasy z Rootobject na AccountResponse. Będziemy teraz potrzebować klasy JavaScriptSerializer, aby móc z niej korzystać potrzebna jest odpowiednia referencja. W VS, dodaj referencję System.Web.Extensions do projektu. Możesz to zrobić poprzez kliknięcie prawym na References a następnie Add Reference. Wyszukaj i dodaj. Jak wszystko wykonasz poprawnie zaimportuj do pliku w którym będziesz używał tą klasę poniższą bibliotekę.

using System.Web.Script.Serialization;

1	using System.Web.Script.Serialization;

Krok 5. Mamy wszystko co potrzebujemy. Teraz zostało nam tylko dopełnienie formalności. Użyjmy zatem naszej nowej klasy.

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Web.Script.Serialization;

namespace wiedza_serializacja
{
    class Program
    {
        static void Main(string[] args)
        {
            //Przykładowa odpowiedz JSON z serwera
            var response =
                "{\"status\": 200,\"msg\": \"OK\",\"result\": {\"extid\": \"extuserid\",\"email\": \"jeff@openload.io\",\"signup_at\": \"2015-01-09 23:59:54\",\"storage_left\": -1,\"storage_used\": \"32922117680\",\"traffic\": {\"left\": -1,\"used_24h\": 0},\"balance\": 0}}";

            //Deserializujemy JSON na AccounResponse
            var ar = new JavaScriptSerializer().Deserialize<AccountResponse>(response);

            Console.WriteLine($"Wiadomość: {ar.msg}, Status: {ar.status}, Balance: {ar.result.balance}");

            Console.ReadKey();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using System.Web.Script.Serialization;

namespace wiedza_serializacja

{

class Program

{

static void Main(string[] args)

{

//Przykładowa odpowiedz JSON z serwera

var response =

"{\"status\": 200,\"msg\": \"OK\",\"result\": {\"extid\": \"extuserid\",\"email\": \"[email protected]\",\"signup_at\": \"2015-01-09 23:59:54\",\"storage_left\": -1,\"storage_used\": \"32922117680\",\"traffic\": {\"left\": -1,\"used_24h\": 0},\"balance\": 0}}";

//Deserializujemy JSON na AccounResponse

var ar = new JavaScriptSerializer().Deserialize<AccountResponse>(response);

Console.WriteLine($"Wiadomość: {ar.msg}, Status: {ar.status}, Balance: {ar.result.balance}");

Console.ReadKey();

}

UPDATE 08.11.18

ASP.NET Core

W ASP.NET Core taki sam efekt można uzyskać wykorzystując bibliotekę Newtonsoft.Json z pakietu Microsoft.AspNetCore.All

Wystarczy dodać do projektu pakiet poprzez komendę:

Install-Package Microsoft.AspNetCore.All -Version 2.1.4

1	Install-Package Microsoft.AspNetCore.All -Version 2.1.4

lub

dotnet add package Microsoft.AspNetCore.All --version 2.1.4

1	dotnet add package Microsoft.AspNetCore.All --version 2.1.4

a następnie w podobny sposób wywołać funkcję DeserializeObject()

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Newtonsoft.Json;

namespace wiedza_serializacja
{
    class Program
    {
        static void Main(string[] args)
        {
            //Przykładowa odpowiedz JSON z serwera
            var response =
                "{\"status\": 200,\"msg\": \"OK\",\"result\": {\"extid\": \"extuserid\",\"email\": \"jeff@openload.io\",\"signup_at\": \"2015-01-09 23:59:54\",\"storage_left\": -1,\"storage_used\": \"32922117680\",\"traffic\": {\"left\": -1,\"used_24h\": 0},\"balance\": 0}}";

            //Deserializujemy JSON na AccounResponse
            var ar = JsonConvert.DeserializeObject<AccountResponse>(response);

            Console.WriteLine($"Wiadomość: {ar.msg}, Status: {ar.status}, Balance: {ar.result.balance}");

            Console.ReadKey();
        }
    }
}

using System;

using System.Collections.Generic;

using System.Linq;

using System.Text;

using System.Threading.Tasks;

using Newtonsoft.Json;

namespace wiedza_serializacja

{

class Program

{

static void Main(string[] args)

{

//Przykładowa odpowiedz JSON z serwera

var response =

//Deserializujemy JSON na AccounResponse

var ar = JsonConvert.DeserializeObject<AccountResponse>(response);

Console.WriteLine($"Wiadomość: {ar.msg}, Status: {ar.status}, Balance: {ar.result.balance}");

Console.ReadKey();

}

Konsola:

Wiadomosc: OK, Status: 200, Balance: 0

1	Wiadomosc: OK, Status: 200, Balance: 0

Mam nadzieję, że komuś przyda się ta wiedza we własnych projektach, oczywiście ten mechanizm można zastosować również w odwrotną stronę – serializacji. Generalnie sposobów na serializowanie jest wiele, natomiast według mnie ten jest najprostszy.

Jerzy Kołakowski

Pasjonat informatyki, bloger.

Full-stack Developer

Technologie:

ASP.NET MVC
ASP.NET CORE
Angular 2+

Wiedza Informatyczna

Podziel się wiedzą z innymi!

C# – Jak wygodnie serializować i deserializować obiekty.

About the Author: Jerzy Kołakowski

1 Comment

Dodaj komentarz Anuluj pisanie odpowiedzi

You May Also Like

C# – Różnice pomiędzy typem wartościowym, a referencyjnym

C# – Współbieżność

About the Author: Jerzy Kołakowski

1 Comment

Dodaj komentarz Anuluj pisanie odpowiedzi