JSON serialization – DataContractJsonSerializer vs JavaScriptSerializer

Yan Cui

I help clients go faster for less using serverless technologies.

This article is brought to you by

Is your CI build step taking too long? Try Depot for free today and experience up to 40x faster build speed!

Unlock faster CI for FREE

In C#, when you have to work with JSON data you’re usually represented with two choices – DataContractJsonSerializer or JavaScriptSerializer. There are other popular third-party libraries out there, such as the popular Json.Net project, but for the rest of this blog let’s just focus on the two built-in JSON serializers and see how they differ.

DataContracts

Without doubt the biggest difference between the two is that DataContractJsonSerializer only works with types decorated with the DataContract attribute, but JavaScriptSerializer can work with any object.

This makes perfect sense as the primary purpose of the DataContractJsonSerializer is to be used with WCF, and just as its name suggests, it’s a JSON serializer for DataContract types.

Anonymous Types

One interesting side effect of the above is that you can’t use DataContractJsonSerializer with anonymous types.

On the other hand, with the JavaScriptSerializer at least you can easily serialize an instance of an anonymous type:

   1: var jsSerializer = new JavaScriptSerializer();

   2:

   3: // define an anonymous type

   4: var anonymous = new { Id = Guid.NewGuid(), Name = "Yan", Age = 29 };

   5:

   6: // this writes:

   7: // {"Id":"2edebefb-2585-438c-bbc3-939e7688f630","Name":"Yan","Age":29}

   8: Console.WriteLine(jsSerializer.Serialize(anonymous));

Unfortunately you won’t be able to deserialize the JSON string back into an anonymous type as all the available deserialize methods requires a type which has a parameterless constructor.

Dictionaries

Another main functional difference between these two serializers is how they deal with dictionaries.

Take this simple dictionary for instance:

   1: var dictionary = new Dictionary<string, object>();

   2: dictionary.Add("Id", Guid.NewGuid());

   3: dictionary.Add("Name", "Yan");

   4: dictionary.Add("Age", 29);

The DataContractJsonSerializer serializes dictionaries as an array of KeyValuePair objects:

[{“Key”:”Id”,”Value”:”35285943-32d0-45d9-ada6-eb570f757d85″},{“Key”:”Name”,”Value”:”Yan”},{“Key”:”Age”,”Value”:29}]

whereas the JavaScriptSerializer serializes dictionaries in a much more ‘JSON’ way:

{“Id”:”35285943-32d0-45d9-ada6-eb570f757d85″,”Name”:”Yan”,”Age”:29}

This subtle different might seem trivial at first, but it can make a huge difference when you’re dealing with data that are originated from a non-.Net language. A perfect example came couple of days ago when we were testing out the Facebook graph API and one of the JSON responses we came across was a dictionary whose keys were numeric IDs like this:

{“1652438520054”:{“id”:”1652438520054″, …}}

In cases like this, you simply won’t be able to deserialize this JSON using the DataContractJsonSerializer!

Whenever you’re ready, here are 4 ways I can help you:

  1. Production-Ready Serverless: Join 20+ AWS Heroes & Community Builders and 1000+ other students in levelling up your serverless game. This is your one-stop shop for quickly levelling up your serverless skills.
  2. Do you want to know how to test serverless architectures with a fast dev & test loop? Check out my latest course, Testing Serverless Architectures and learn the smart way to test serverless.
  3. I help clients launch product ideas, improve their development processes and upskill their teams. If you’d like to work together, then let’s get in touch.
  4. Join my community on Discord, ask questions, and join the discussion on all things AWS and Serverless.

5 thoughts on “JSON serialization – DataContractJsonSerializer vs JavaScriptSerializer”

  1. Pingback: Performance Test – JSON serializers | theburningmonk.com

  2. theburningmonk

    @v. – I’ve just posted an answer to that SO question with some thoughts, hope it helps you solve the problem!

  3. Pingback: [ASP.NET MVC]JsonResult?DataMember.Name ???????????????????? » netplanetes log

Leave a Comment

Your email address will not be published. Required fields are marked *