Was ist C# JSON?

In diesem Artikel erkläre ich dir, was JSON ist und wie es in C# verwendet wird. Wir werden uns auf die Verwendung von JSON in C# mit dem Newtonsoft.Json-Paket konzentrieren, da es eines der am häufigsten verwendeten Pakete für die Arbeit mit JSON ist.

JSON (JavaScript Object Notation) ist ein einfaches Format zur Übertragung von Daten. Es wird häufig verwendet, um Daten zwischen einer Web-Anwendung und einem Server auszutauschen. JSON ist leicht zu lesen und zu schreiben und wird von vielen Programmiersprachen unterstützt, einschließlich C#.

Ein JSON Objekt im Beispiel

JSON ist ein einfaches Format zur Übertragung von Daten, das auf JavaScript basiert. Es besteht aus Schlüssel-Wert-Paaren, die durch Kommas voneinander getrennt sind. Hier ist ein einfaches Beispiel für ein JSON-Objekt:

{
    "name": "John Doe",
    "age": 30,
    "address": {
        "street": "123 Main St",
        "city": "Anytown",
        "state": "CA",
        "zip": "12345"
    },
    "phoneNumbers": [
        {
            "type": "home",
            "number": "555-555-5555"
        },
        {
            "type": "work",
            "number": "555-555-5556"
        }
    ]
}

Wie du sehen kannst, besteht das JSON-Objekt aus Schlüssel-Wert-Paaren. Schlüssel sind Zeichenfolgen, die in doppelten Anführungszeichen stehen, während Werte alles sein können, von einfachen Datentypen wie Zeichenfolgen und Ganzzahlen bis hin zu komplexeren Datenstrukturen wie Objekten und Arrays.

Verwenden von JSON in C#

Um JSON in C# zu verwenden, musst du das Newtonsoft.Json-Paket installieren. Du kannst es installieren, indem du es zu deinem Projekt hinzufügst. Dafür klickst du auf “Projekt” -> “NuGet-Pakete verwalten” und suchst dann nach “Newtonsoft.Json”.

Nachdem du das Newtonsoft.Json-Paket installiert hast, kannst du es verwenden, um JSON-Daten zu serialisieren und deserialisieren.

Serialisieren von JSON-Daten

using Newtonsoft.Json;

// Beispielklasse für die Serialisierung
public class Person
{
    public string Name { get; set; }
    public int Alter { get; set; }
    public Adresse Adresse { get; set; }
}

public class Adresse
{
    public string Straße { get; set; }
    public string Stadt { get; set; }
    public string Bundesland { get; set; }
    public string PLZ { get; set; }
}

var person = new Person
{
    Name = "John Doe",
    Alter = 30,
    Adresse = new Adresse
    {
        Straße = "123 Main St",
        Stadt = "Anytown",
        Bundesland = "CA",
        PLZ = "12345"
    }
};

// Serialisieren einer Instanz der Personenklasse in eine JSON-Zeichenfolge
string json = JsonConvert.SerializeObject(person);
Console.WriteLine(json);

Deserialisieren von JSON-Daten

using Newtonsoft.Json;

// JSON-Zeichenfolge
string json = "{'Name':'John Doe','Alter':30,'Adresse':{'Straße':'123 Main St','Stadt':'Anytown','Bundesland':'CA','PLZ':'12345'}}";

// Deserialisieren der JSON-Zeichenfolge in eine Instanz der Personenklasse
Person person = JsonConvert.DeserializeObject<Person>(json);
Console.WriteLine("Name: " + person.Name);
Console.WriteLine("Alter: " + person.Alter);
Console.WriteLine("Adresse: " + person.Adresse.Straße + ", " + person.Adresse.Stadt + ", " + person.Adresse.Bundesland + " " + person.Adresse.PLZ);

Dies sind nur einige grundlegende Beispiele für die Verwendung von JSON in C# mit dem Newtonsoft.Json-Paket. Es gibt viele weitere Funktionen und Einstellungen, die genutzt werden können, um deine JSON-Serialisierungs- und Deserialisierungsanforderungen zu erfüllen.

Die wichtigsten Methoden im Überblick

Die am häufigsten verwendeten Methoden für die Verwendung von JSON mit dem Newtonsoft.Json-Paket sind:

JsonConvert.SerializeObject(object): Diese Methode wandelt ein Objekt in eine JSON-Zeichenfolge um.

JsonConvert.DeserializeObject<T>(string): Diese Methode wandelt eine JSON-Zeichenfolge in ein Objekt des angegebenen Typs T um.

JsonConvert.SerializeObject(object, Formatting, JsonSerializerSettings): Diese Methode wandelt ein Objekt in eine JSON-Zeichenfolge um und ermöglicht es dir, Formatierungsoptionen und Einstellungen für die Serialisierung festzulegen.

JsonConvert.DeserializeObject<T>(string, JsonSerializerSettings): Diese Methode wandelt eine JSON-Zeichenfolge in ein Objekt des angegebenen Typs T um und ermöglicht es dir, Einstellungen für die Deserialisierung festzulegen.

JsonConvert.PopulateObject(string, object): Diese Methode füllt die Eigenschaften eines bestehenden Objekts anhand einer JSON-Zeichenfolge auf.

JsonConvert.DeserializeXmlNode(string, string): Diese Methode wandelt eine JSON-Zeichenfolge in einen XmlNode um und ermöglicht es dir, den Root-Elementnamen des erstellten XML-Dokuments festzulegen.

Dies sind einige der am häufigsten verwendeten Methoden für die Arbeit mit JSON in C# mit dem Newtonsoft.Json-Paket