WCF – Be ware of the field ordering when using DataContractSerializer

Check out my new course Learn you some Lambda best practice for great good! and learn the best practices for performance, cost, security, resilience, observability and scalability.

One of the less known aspect of the DataContractSerializer is its dependency on the order in which fields are serialized and deserialized.

As this article points out, the basic rules for ordering include:

  • If a data contract type is a part of an inheritance hierarchy, data members of its base types are always first in the order.
  • Next in order are the current type’s data members that do not have the Order property of the DataMemberAttribute attribute set, in alphabetical order.
  • Next are any data members that have the Order property of the DataMemberAttribute attribute set. These are ordered by the value of the Order property first and then alphabetically if there is more than one member of a certain Order value. Order values may be skipped.

The problem is that when the inbound data is not ordered accordingly the fields which are ‘out of order’ will not be deserialized as highlighted by this StackOverflow question. Though this is unlikely to happen as the serializer will take care of the correct ordering for you, unless like jhersh you are attempting to manually create some data for test purposes.

Parting Thoughts…

Seeing as the DataContractSerializer is also dependent on the ordering of the fields in the serialized type (albeit not transparent to you and well taken care of almost all the time) I have long been tempted to try out the Protocol Buffers wrapper for .Net which are meant to be much faster and more compact because it doesn’t serialize the names of the properties unlike the DataContractSerializer.

For those of you who aren’t aware of it, protocol buffers is the binary serialization used by Google for most of its data communications. In order to use the protobuf-net serialization you need to explicitly specify the order in which your properties should be serialized:

[DataContract]
public sealed class Test1
{
    [DataMember(Name="a", Order=1, IsRequired=true)]
    public int A { get; set; }
}

[DataContract]
public sealed class Test2
{
    [DataMember(Name = "b", Order = 2, IsRequired = true)]
    public string B { get; set; }
}

[DataContract]
public sealed class Test3
{
    [DataMember(Name = "c", Order = 3, IsRequired = true)]
    public Test1 C { get; set; }
}

And inject a new behaviour to the WCFmethod to use the new serializer:

[ServiceContract]
public interface IFoo
{
    [OperationContract, ProtoBehavior]
    Test3 Bar(Test1 value);
}

Oh, such temptation…

References:

StackOverflow question – WCF data contract, some fields do not serialize

MSDN – Data member order

protobuf-net – Is it quick?

Liked this article? Support me on Patreon and get direct help from me via a private Slack channel or 1-2-1 mentoring.
Subscribe to my newsletter


Hi, I’m Yan. I’m an AWS Serverless Hero and the author of Production-Ready Serverless.

I specialise in rapidly transitioning teams to serverless and building production-ready services on AWS.

Are you struggling with serverless or need guidance on best practices? Do you want someone to review your architecture and help you avoid costly mistakes down the line? Whatever the case, I’m here to help.

Hire me.


Check out my new podcast Real-World Serverless where I talk with engineers who are building amazing things with serverless technologies and discuss the real-world use cases and challenges they face. If you’re interested in what people are actually doing with serverless and what it’s really like to be working with serverless day-to-day, then this is the podcast for you.


Check out my new course, Learn you some Lambda best practice for great good! In this course, you will learn best practices for working with AWS Lambda in terms of performance, cost, security, scalability, resilience and observability. We will also cover latest features from re:Invent 2019 such as Provisioned Concurrency and Lambda Destinations. Enrol now and start learning!


Check out my video course, Complete Guide to AWS Step Functions. In this course, we’ll cover everything you need to know to use AWS Step Functions service effectively. There is something for everyone from beginners to more advanced users looking for design patterns and best practices. Enrol now and start learning!


Are you working with Serverless and looking for expert training to level-up your skills? Or are you looking for a solid foundation to start from? Look no further, register for my Production-Ready Serverless workshop to learn how to build production-grade Serverless applications!

Find a workshop near you