将具有嵌套属性的对象打印为逗号分隔的键值对字符串

Question

我有一个Person 类：

public class Person
{
    public string Name { get; set; }
    public string Surname { get; set; }
    public Address Address { get; set; }
}

public class Address
{
    public string Line1 { get; set; }
    public string Line2 { get; set; }
}

作为最终结果，我想将 Person 实例打印为 JSON，但我希望它是一个巨大的键值对字符串，例如：

"Name:John,Surname:Doe,Line1:Infinite Loop,Line2:California"

请注意，在上面的示例中，我去掉了实际的类名（即它打印出 Line1 而不是 Address.Line1） - 我只关心所有名称/值对。

所以最终结果将是Persons 的数组：

"persons":[
    "Name:John,Surname:Doe,Line1:Infinite Loop 1,Line2:California",            
    "Name:Jane,Surname:Doe,Line1:Infinite Loop 2,Line2:California"
]

作为起点，我尝试使用反射：

void Main()
{
    var persons = new List<Person>();
    persons.Add(new Person
    {
        Name = "John",
        Surname = "Doe",
        Address = new Address
        {
            Line1 = "Infinite Loop",
            Line2 = "California"                
        }
    });

    foreach(var person in persons)
    {
        var properties = new List<string>();
        foreach(var property in person.GetType().GetProperties())
        {
            properties.Add($"{property.Name}:{property.GetValue(person, null)}");
        }
        Console.WriteLine(string.Join(",", properties));
    }
}

但我在 LINQPad 中得到以下输出：

Name:John,Surname:Doe,Address:UserQuery+Address

我假设Address 没有正确迭代，因为它是Person 中的嵌套对象。即便如此，这看起来也不是最干净/最有效的方法。

Answer 1

您可以像这样使用自定义 JsonConverter 来做到这一点：

class PersonConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(Person);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var pairs = JObject.FromObject(value)
            .Descendants()
            .OfType<JProperty>()
            .Where(p => p.Value is JValue)
            .Select(p => p.Name + ":" + p.Value);
        writer.WriteValue(string.Join(",", pairs));
    }

    public override bool CanRead
    {
        get { return false; }
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

然后通过将转换器传递给JsonConvert.SerializeObject 来使用它，如下所示：

string json = JsonConvert.SerializeObject(obj, Formatting.Indented, new PersonConverter());

这是一个工作演示：https://dotnetfiddle.net/L4YDsm

Answer 2

将ToString 覆盖添加到您的类并以 JSON 形式返回字符串集合。

public class Person
{
  public string Name { get; set; }
  public string Surname { get; set; }
  public Address Address { get; set; }
  public override string ToString()
  {
    return $"Name:{Name},Surname:{Surname},Line1:{Address?.Line1},Line2:{Address?.Line2}";
  }
}

Answer 3

您必须以一种可以深入到对象结构中的方式实现反射，以便执行您想要的操作。这是对您提供的代码的简单递归和通用改编。

public static string GetRecursivePropertyValues(object obj)
{
    var properties = new List<string>();
    foreach (var property in obj.GetType().GetProperties())
    {
        object currentPropertyValue = property.GetValue(obj);
        if (property.PropertyType.IsPrimitive || property.PropertyType == typeof(string))
            properties.Add($"{property.Name}:{currentPropertyValue}");
        else
        {
            var subProperties = GetRecursivePropertyValues(currentPropertyValue);
            properties.Add(subProperties);
        }
    }
    return string.Join(";", properties);
}

此实现首先验证每个属性是否使用原始类型或string（在 C# 中不被视为原始类型）定义，如果是这种情况，则正常打印它们。否则，如果类型是复杂的（例如，如果它被声明为 Address 实例），它会递归检索复杂对象的属性，并将它们添加到结果字符串中。

你可以这样称呼它：

string propertiesStr = GetRecursivePropertyValues(person);

编辑：代码现在仅根据 OP 的要求展平对象（之前的代码示例使用了一些质朴的 JSON 格式）。

Answer 4

使用 Newtonsoft.json

https://www.newtonsoft.com/json/help/html/SerializingJSON.htm

检查上面的链接...它会告诉你如何将一个对象序列化为 json，重要的是要注意，你需要将所有项目添加到一个列表中，然后将列表序列化为 json 以获得所需的效果

Product product = new Product();

product.Name = "Apple";
product.ExpiryDate = new DateTime(2008, 12, 28);
product.Price = 3.99M;
product.Sizes = new string[] { "Small", "Medium", "Large" };

有例子：

string output = JsonConvert.SerializeObject(product);
//{
//  "Name": "Apple",
//  "ExpiryDate": "2008-12-28T00:00:00",
//  "Price": 3.99,
//  "Sizes": [
//    "Small",
//    "Medium",
//    "Large"
//  ]
//}