Skip to main content

Coding Stories V - Serialization with XmlArrayItem

Serialization, almost all applications need this feature. Nowadays serialization can be in different formats. The trend now is to use JSON, but there are many applications that uses XML.
Let’s look over the following code:
public class Car
{
  public string Id { get; set; }
}
public class City
{
  [XmlArray("Cs")]
  [XmlArrayItem("C")]
  public List<Car> RegisterCars { get; set; }
}
...
XmlSerializer serializer = new XmlSerializer(typeof(City));
serializer.Serialize(writer, city);
Output:
<city>
  <Cs>
    <c>
      <id>1</id>
    <c>
    <c>
      <id>2</id>
    <c>
  <Cs>
</city>
Even if the code compiles, works perfectly, there is a small thing that can affect us. Because we use XmlArrayItem attribute, each node from the list will be named “C”. If we will need to deserialize only a C node then we will have a surprise.
This cannot be done with the default XmlSerializer class.
XmlSerializer serializer = new XmlSerializer(typeof(Car));
serializer.Deserialize("<c><id>1</id></c>");
This will expect a node named “Car”, that cannot be found there.
Because of this, when we need to control the name of the nodes from a list and I recommend to not use the XmlArrayItem. A better approach is with [XmlRoot(ElementName = "c")] on the Car class. Using this approach, we will be able to deserialize a child node of the list without having to deserialize all the list.
The final code will look like this:
[XmlRoot(ElementName = "c")]
public class Car
{
  public string Id { get; set; }
}
public class City
{
  [XmlArray("Cs")]
  public List<Car> RegisterCars { get; set; }
}
Even if this is a small thing, on a big project this can affect how different components deserialize the content. Deciding how items need to be serialized is an important step that needs to be done from the beginning.

Comments

Popular posts from this blog

How to audit an Azure Cosmos DB

In this post, we will talk about how we can audit an Azure Cosmos DB database. Before jumping into the problem let us define the business requirement: As an Administrator I want to be able to audit all changes that were done to specific collection inside my Azure Cosmos DB. The requirement is simple, but can be a little tricky to implement fully. First of all when you are using Azure Cosmos DB or any other storage solution there are 99% odds that you’ll have more than one system that writes data to it. This means that you have or not have control on the systems that are doing any create/update/delete operations. Solution 1: Diagnostic Logs Cosmos DB allows us activate diagnostics logs and stream the output a storage account for achieving to other systems like Event Hub or Log Analytics. This would allow us to have information related to who, when, what, response code and how the access operation to our Cosmos DB was done. Beside this there is a field that specifies what was th...

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills)

Cloud Myths: Cloud is Cheaper (Pill 1 of 5 / Cloud Pills) The idea that moving to the cloud reduces the costs is a common misconception. The cloud infrastructure provides flexibility, scalability, and better CAPEX, but it does not guarantee lower costs without proper optimisation and management of the cloud services and infrastructure. Idle and unused resources, overprovisioning, oversize databases, and unnecessary data transfer can increase running costs. The regional pricing mode, multi-cloud complexity, and cost variety add extra complexity to the cost function. Cloud adoption without a cost governance strategy can result in unexpected expenses. Improper usage, combined with a pay-as-you-go model, can result in a nightmare for business stakeholders who cannot track and manage the monthly costs. Cloud-native services such as AI services, managed databases, and analytics platforms are powerful, provide out-of-the-shelve capabilities, and increase business agility and innovation. H...

Cloud Myths: Migrating to the cloud is quick and easy (Pill 2 of 5 / Cloud Pills)

The idea that migration to the cloud is simple, straightforward and rapid is a wrong assumption. It’s a common misconception of business stakeholders that generates delays, budget overruns and technical dept. A migration requires laborious planning, technical expertise and a rigorous process.  Migrations, especially cloud migrations, are not one-size-fits-all journeys. One of the most critical steps is under evaluation, under budget and under consideration. The evaluation phase, where existing infrastructure, applications, database, network and the end-to-end estate are evaluated and mapped to a cloud strategy, is crucial to ensure the success of cloud migration. Additional factors such as security, compliance, and system dependencies increase the complexity of cloud migration.  A misconception regarding lift-and-shits is that they are fast and cheap. Moving applications to the cloud without changes does not provide the capability to optimise costs and performance, leading to ...