Topic 13324 min readStructured Tutorial

C# JSON Handling - Complete Beginner Tutorial

Quick Answer

In C#, JSON handling involves reading and writing JSON data using libraries like System.Text.Json or Newtonsoft.Json. These libraries allow you to serialize objects to JSON and deserialize JSON back to objects, enabling easy file handling and data exchange in applications.

Learning Objectives

Explain the purpose of JSON Handling in a practical learning context.
Identify the main ideas, terms, and decisions involved in JSON Handling.
Apply JSON Handling in a simple real-world scenario or practice task.

Introduction to JSON Handling in C#

JSON (JavaScript Object Notation) is a popular data format used for exchanging information between systems. In C#, handling JSON is essential for working with APIs, configuration files, and data storage.

This tutorial covers how to read and write JSON files in C# using built-in and third-party libraries, with practical examples to help you get started quickly.

JSON is the lingua franca of data exchange.

Understanding JSON and Its Role in C#

JSON is a lightweight, text-based format that is easy for humans to read and write, and easy for machines to parse and generate. It represents data as key-value pairs and arrays.

In C#, JSON is commonly used to serialize objects into a string format for storage or transmission and to deserialize JSON strings back into objects.

JSON syntax includes objects (curly braces) and arrays (square brackets).
Data types supported include strings, numbers, booleans, arrays, and nested objects.
C# provides libraries to convert between JSON and objects seamlessly.

Using System.Text.Json for JSON Handling

System.Text.Json is a modern, high-performance JSON library included in .NET Core 3.0 and later. It supports serialization and deserialization with minimal configuration.

This library is recommended for most new projects due to its speed and integration with the .NET ecosystem.

Serialize objects to JSON strings using JsonSerializer.Serialize.
Deserialize JSON strings to objects using JsonSerializer.Deserialize.
Supports asynchronous file operations for reading and writing JSON files.

Example: Serialize and Deserialize with System.Text.Json

Here is a simple example demonstrating how to serialize a C# object to JSON and deserialize JSON back to an object.

Using Newtonsoft.Json (Json.NET) for JSON Handling

Newtonsoft.Json, also known as Json.NET, is a popular third-party JSON library for .NET. It offers extensive features and flexibility, making it widely used in many projects.

It supports advanced scenarios like LINQ to JSON, custom converters, and more.

Serialize objects using JsonConvert.SerializeObject.
Deserialize JSON using JsonConvert.DeserializeObject.
Supports formatting options and error handling.

Example: Serialize and Deserialize with Newtonsoft.Json

Below is an example showing how to use Newtonsoft.Json to serialize and deserialize JSON data.

Reading and Writing JSON Files in C#

Handling JSON files involves reading JSON content from files and writing JSON data back to files. Both System.Text.Json and Newtonsoft.Json support this through integration with file I/O operations.

Using asynchronous methods is recommended for better performance and responsiveness.

Use File.ReadAllText or File.ReadAllTextAsync to read JSON from a file.
Use File.WriteAllText or File.WriteAllTextAsync to write JSON to a file.
Combine file I/O with JSON serialization/deserialization for complete file handling.

Practical Example

This example shows how to convert a Person object to a JSON string and then back to a Person object using System.Text.Json.

This example demonstrates JSON serialization and deserialization using the Newtonsoft.Json library.

This example shows how to asynchronously write a JSON object to a file and read it back using System.Text.Json.

Examples

Serialize and Deserialize Using System.Text.Json

using System;
using System.Text.Json;

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

class Program
{
    static void Main()
    {
        var person = new Person { Name = "Alice", Age = 30 };

        // Serialize to JSON
        string jsonString = JsonSerializer.Serialize(person);
        Console.WriteLine(jsonString);

        // Deserialize from JSON
        Person deserialized = JsonSerializer.Deserialize<Person>(jsonString);
        Console.WriteLine($"Name: {deserialized.Name}, Age: {deserialized.Age}");
    }
}

This example shows how to convert a Person object to a JSON string and then back to a Person object using System.Text.Json.

Serialize and Deserialize Using Newtonsoft.Json

using System;
using Newtonsoft.Json;

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

class Program
{
    static void Main()
    {
        var person = new Person { Name = "Bob", Age = 25 };

        // Serialize to JSON
        string jsonString = JsonConvert.SerializeObject(person);
        Console.WriteLine(jsonString);

        // Deserialize from JSON
        Person deserialized = JsonConvert.DeserializeObject<Person>(jsonString);
        Console.WriteLine($"Name: {deserialized.Name}, Age: {deserialized.Age}");
    }
}

This example demonstrates JSON serialization and deserialization using the Newtonsoft.Json library.

Reading and Writing JSON Files Asynchronously

using System;
using System.IO;
using System.Text.Json;
using System.Threading.Tasks;

public class Person
{
    public string Name { get; set; }
    public int Age { get; set; }
}

class Program
{
    static async Task Main()
    {
        var person = new Person { Name = "Charlie", Age = 40 };
        string filePath = "person.json";

        // Serialize and write to file
        using (FileStream createStream = File.Create(filePath))
        {
            await JsonSerializer.SerializeAsync(createStream, person);
        }

        // Read and deserialize from file
        using (FileStream openStream = File.OpenRead(filePath))
        {
            Person deserialized = await JsonSerializer.DeserializeAsync<Person>(openStream);
            Console.WriteLine($"Name: {deserialized.Name}, Age: {deserialized.Age}");
        }
    }
}

This example shows how to asynchronously write a JSON object to a file and read it back using System.Text.Json.

Best Practices

Use System.Text.Json for new projects due to its performance and native support.
Validate JSON data before deserialization to avoid runtime errors.
Use asynchronous file operations to improve application responsiveness.
Handle exceptions during file and JSON operations gracefully.
Use data annotations or custom converters for complex serialization scenarios.

Common Mistakes

Ignoring exceptions when reading or writing JSON files.
Assuming JSON property names always match C# property names without configuration.
Using synchronous file I/O in UI or server applications causing blocking.
Not validating JSON schema or structure before deserialization.
Mixing different JSON libraries without understanding their differences.

Hands-on Exercise

Serialize and Deserialize a Custom Object

Create a C# class representing a product with properties like Id, Name, and Price. Serialize an instance to JSON and then deserialize it back to an object.

Expected output: Console output showing the JSON string and the deserialized object's property values.

Hint: Use System.Text.Json's JsonSerializer methods.

Read and Write JSON File

Write a program that saves a list of users to a JSON file and reads it back, displaying the user details.

Expected output: User details printed to the console after reading from the JSON file.

Hint: Use asynchronous file operations with JsonSerializer.SerializeAsync and DeserializeAsync.

Interview Questions

What is the difference between System.Text.Json and Newtonsoft.Json?

Interview

System.Text.Json is a high-performance, built-in JSON library in .NET Core 3.0+, while Newtonsoft.Json is a popular third-party library with more features and flexibility. System.Text.Json is faster but has fewer features compared to Newtonsoft.Json.

How do you deserialize JSON to a C# object?

Interview

You use a JSON library method like JsonSerializer.Deserialize<T>(jsonString) in System.Text.Json or JsonConvert.DeserializeObject<T>(jsonString) in Newtonsoft.Json, where T is the target object type.

Why is asynchronous file handling recommended when working with JSON files?

Interview

Asynchronous file handling prevents blocking the main thread, improving application responsiveness and scalability, especially in UI and web applications.