使用 IEnumerable<> 将 Json 转换为 C# class

Question

I have a Json which looks like this...

{
  "steps": [
    {
      "stepsType": "runWizard",
      "wizardType": "cv2.0Server",
      "config": {
        "mode": "add",
        "resourceName": "cv2.0 Server",
        "activeDbPrimaryServer": {
          "serverName": "JJH3M005A",
          "serverAddress": "JJH3M005A.microsoft.info"
        },
        "activeDbCatalog": "cv2.0Database",
        "activeDBUserId": "user",
        "activeDBPassword": "password",
        "activeIntegratedSecurity": false
      }
    }
  ]
}

I have created a model like this...

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Microsoft.Database.Configuration.Model
{
    public class ClusterConfigurationModel
    {
        public IEnumerable<ClusterConfigurationModelStep> Steps { get; }
    }

    public class ClusterConfigurationModelStep : ClusterConfigurationModel
    {
        public string StepType { get;  }

        public string WizardType { get;  }

        public IEnumerable<ClusterConfigurationServerConfig> Config { get;  }     
    }

    public class ClusterConfigurationServerConfig : ClusterConfigurationModelStep
    {
        public string Mode { get; }

        public string ResourceName { get; }

        public IEnumerable<ClusterConfigurationDbPrimaryServer> ActiveDbPrimaryServer { get; }

        public string ActiveDbCatalog { get; }

        public string ActiveDbUserId { get; }

        public string ActiveDbPassword { get; }

        public string ActiveIntegratedSecurity { get; }
    }

    public class ClusterConfigurationDbPrimaryServer : ClusterConfigurationServerConfig
    {
        public string ServerName { get; }

        public string ServerAddress { get;  }
    }
}

Is this correct I am trying to create a custom json convertor using,

1. AbstractJsonConverter
2. JsonConverterFactory with an Interface
3. JsonConverter with an Interface

I am new to C#, just want to know whether the model I have created is correct or do I need some modification?

Answer 1

First of all, you need not to have inheritance for every single class. For example (after removing inheritance):

public class ClusterConfigurationModelStep : ClusterConfigurationModel
{
    public string StepType { get;  }

    public string WizardType { get;  }

    public IEnumerable<ClusterConfigurationServerConfig> Config { get;  }     
}

Second, you may want to have [JsonProperty("json_key_name")] from Newtonsoft.Json or [JsonPropertyName("json_key_name")] from System.Text.Json for mapping JSON keyfield name to class's variable. It is by default using camelCase in C#.

Answer 2

You should avoid using IEnumerable<T> for fields and properties, use a T[] array or an IList<T> instead.

The reason for this is that an enumerable is an interator that contains state, it contains a reference to the current item being pointed to. This means that it can only be consumed once, and then you can not enumerate the contents again.

Instead, you usually want to create a list instead and then enumerate that list multiple times in multiple places in your code.