How to serialize and deserialize objects using NewtonSoft JSON

Some instructions on how to use Newtonsoft JSON to serialize and deserialize your objects in C# Step 1: Create a new Visual Studio project Just a simple console application will do: NewtonSoft JSON Step 2: Install Newtonsoft Json using Nuget Available at the NuGet site: https://www.nuget.org/packages/newtonsoft.json/ Enter the command to install Newtonsoft Json in the Visual Studio package manager console: [code language="xml"] Install-Package Newtonsoft.Json -Version 11.0.2 [/code] Step 3. Create an example class to serialize/deserialize [code language="csharp"] public class DataStructure { public string Name { get; set; } public List<int> Identifiers { get; set; } } [/code] Step 4. Create methods to serialize and deserialize [code language="csharp"] public static void Serialize(object obj) { var serializer = new JsonSerializer(); using (var sw = new StreamWriter(filePath)) using (JsonWriter writer = new JsonTextWriter(sw)) { serializer.Serialize(writer, obj); } } public static object Deserialize(string path) { var serializer = new JsonSerializer(); using (var sw = new StreamReader(path)) using (var reader = new JsonTextReader(sw)) { return serializer.Deserialize(reader); } } [/code] Step 5: Try it Putting this all together in the main program loop: [code language="csharp"] using Newtonsoft.Json; using System; using System.Collections.Generic; using System.IO; namespace Serializer { public class DataStructure { public string Name { get; set; } public List<int> Identifiers { get; set; } public void Print() { Console.WriteLine("Name: " + Name); Console.WriteLine("Identifiers: " + string.Join<int>(",", Identifiers)); Console.WriteLine(); Console.WriteLine(); } } class Program { const string filePath = @"c:\dump\json.txt"; public static void Serialize(object obj) { var serializer = new JsonSerializer(); using (var sw = new StreamWriter(filePath)) using (JsonWriter writer = new JsonTextWriter(sw)) { serializer.Serialize(writer, obj); } } public static object Deserialize(string path) { var serializer = new JsonSerializer(); using (var sw = new StreamReader(path)) using (var reader = new JsonTextReader(sw)) { return serializer.Deserialize(reader); } } static void Main(string[] args) { var data = new DataStructure { Name = "Henry", Identifiers = new List<int> { 1, 2, 3, 4 } }; Console.WriteLine("Object before serialization:"); Console.WriteLine("----------------------------"); Console.WriteLine(); data.Print(); Serialize(data); var deserialized = Deserialize(filePath); Console.WriteLine("Deserialized (json) string:"); Console.WriteLine("---------------------------"); Console.WriteLine(); Console.WriteLine(deserialized); } } } [/code] Giving the following output showing the object details before serialization, and the json string of the deserialized DataStructure object:

Comments

Post a Comment

Popular posts from this blog

Using the Supervisor Controller Pattern to access View controls in MVVM

Image
As discussed on a StackOverflow post , this is considered bad practice, so only use this when necessary. Step 1: Create a new WPF project Step 2: Add event handling code A number of classes are needed for doing command bindings in MVVM. Create the following classes and add to your Visual Studio project: RelayCommand.cs [code language="csharp"] using System; using System.Windows.Input; namespace SupervisorControllingPattern { public class RelayCommand<T> : ICommand { private readonly Predicate<T> _canExecute; private readonly Action<T> _execute; public RelayCommand(Action<T> execute) : this(execute, null) { _execute = execute; } public RelayCommand(Action<T> execute, Predicate<T> canExecute) { if (execute == null) throw new ArgumentNullException(nameof(execute)); _execute = execute; _canExecute = canExecute; ...
Read more

Getting started with Tesseract optical character recognition (OCR) library in Visual Studio

Image
This post is a how-to guide on how to get up and running with using the tesseract optical character recognition (OCR) library in a Microsoft Visual Studio environment. The original link can be found at the following github location: https://tesseract-ocr.github.io/tessdoc/Compiling.html#windows Step 1: Build the latest library (using Software Network client) Download and extract the latest SW (Software Network https://software-network.org/) client from the following location: https://software-network.org/client/sw-master-windows-client.zip Open a DOS command prompt and run the following commands: [code language="xml"] sw setup sw build org.sw.demo.google.tesseract.tesseract-master [/code] As shown in the following screenshot: Step 2: Install git if you have not already done so You will need git to download the libraries needed for this project. Download link for obtaining the git for Windows executables etc here: https://git-scm.com/download/win...
Read more

How to send an e-mail via Google SMTP using C#

Image
First things first, some useful StackOverflow links: https://stackoverflow.com/questions/9201239/send-e-mail-via-smtp-using-c-sharp https://stackoverflow.com/questions/17462628/the-server-response-was-5-7-0-must-issue-a-starttls-command-first-i16sm1806350 To demonstrate how this is done I first create a new Visual Studio project: Some example code for sending an email via a Google email account (smtp.goolgle.com) - obviously replace this with email / credentials of your own... I put the code within a try-catch block in order to capture any errors that may occur while attempting this. [code language="csharp"] using System; using System.Net; using System.Net.Mail; namespace EmailSmtp { class Program { static void Main(string[] args) { try { // Credentials var credentials = new NetworkCredential("someEmail@gmail.com", "somePassword"); // Mail message var ...
Read more