[FIXED] Why is using [DataMember(EmitDefaultValue = false)] not recommended?

Issue

In WCF you can define a contract using the [DataContract] and [DataMember] attributes, like this:

[DataContract]
public class Sample 
{
    [DataMember(EmitDefaultValue = false, IsRequired = false)]
    public string Test { get; set; }
}

This article on the MSDN states that using EmitDefaultValue = false is not recommended:

However, i like to use this, because the XML that is generated using this construction is cleaner. Not specifying this setting results in:

<Sample>
    <Test xsi:nil="true"/>
</Sample>

while using the setting the element is ommited when there is no value:

<Sample>
</Sample>

I'm curious to what the reasoning behind that statement is. Specifically since both snipptes of XML look equivalent to me (and both last part can be deserialized correctly for this contract).

What is the reasoning behind this statement?

Solution

The reason is at the bottom of the article that you link to. The short version is:

• When the EmitDefaultValue is set to false, it is represented in the schema as an annotation specific to Windows Communication Foundation (WCF). There is no interoperable way to represent this information. In particular, the "default" attribute in the schema is not used for this purpose, the minOccurs attribute is affected only by the IsRequired setting, and the nillable attribute is affected only by the type of the data member.

• The actual default value to use is not present in the schema. It is up to the receiving endpoint to appropriately interpret a missing element.

Answered By - Shiraz Bhaiji

Answer Checked By - Robin (PHPFixing Admin)