【问题标题】:Manipulating a Json string from within a custom Json Converter从自定义 Json 转换器中操作 Json 字符串
【发布时间】:2021-07-21 18:49:27
【问题描述】:

为了问我的问题,我将参考@Brian Rogers 的回答here。 在这个答案中,ReadJson 正在做一些相对简单的事情。但是,我如何在其中添加一个层,以便在将传入的 Json 字符串反序列化为对象然后返回之前对其进行操作?

这是我想做的事情的类型(Brian 的 WrappedObjectConvert 类的修改版本):

class WrappedObjectConverter : JsonConverter
{
    private string CustomParsing(string jsonString)
    {
         string modifiedJsonString;

         // Some renaming
         modifiedJsonString= Regex.Replace(modifiedJsonString, $@"(?<="")CarName(?="":\s)", "Myname", RegexOptions.IgnoreCase);

         modifiedJsonString= Regex.Replace(modifiedJsonString, $@"(?<="")CustName(?="":\s)", "Myname", RegexOptions.IgnoreCase);

         modifiedJsonString= Regex.Replace(modifiedJsonString, $@"(?<="")MyName(?="":\s)", "Myname", RegexOptions.IgnoreCase);

         modifiedJsonString= Regex.Replace(modifiedJsonString, $@"(?<="")SomeAddr(?="":\s)", "AddressLine1 ", RegexOptions.IgnoreCase);

         // Renaming IsPublic true/false to IsPrivate false/true
        modifiedJsonString= Regex.Replace(modifiedJsonString, "\"IsPublic\": true,", "\"IsPrivate\": false,", RegexOptions.IgnoreCase);
        modifiedJsonString = Regex.Replace(modifiedJsonString, "\"IsPublic\": false,", "\"IsPrivate\": true,", RegexOptions.IgnoreCase);
    }

    public override bool CanConvert(Type objectType)
    {
        return true;
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JToken token = JToken.Load(reader);

        string modifiedJsonString = CustomParsing(token.ToString());

        return ????;  // How to return the object

        // I could do something of the sort, but not sure it's got its place here:  
        // return JsonConvert.DeserializeObject<RootObject>(modifiedJsonString );  
    }

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

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

客户端类也稍作修改,添加了“IsPrivate”字段:

public class Client
{
    [JsonConverter(typeof(WrappedObjectConverter))]
    public List<Product> ProductList { get; set; }

    [JsonConverter(typeof(WrappedObjectConverter))]
    public string Name { get; set; }

    [JsonConverter(typeof(WrappedObjectConverter))]
    public bool IsPrivate { get; set; }

    [JsonConverter(typeof(WrappedObjectConverter))]
    public string AddressLine1 { get; set; }
}

还有修改过Json的demo(Brian的例子中有些标签已经改了,需要解析修改):

class Program
{
    static void Main(string[] args)
    {
        string json = @"
        {
            ""Result"": {
                ""Client"": {
                    ""ProductList"": {
                        ""Product"": [
                            {
                                ""MyName"": {
                                    ""CarName"": ""Car polish"",
                                    ""IsPublic"": ""True""
                                }
                            }
                        ]
                    },
                    ""MyName"": {
                        ""CustName"": ""Mr. Clouseau""
                    },
                    ""AddressLine1"": {
                        ""SomeAddr"": ""Hightstreet 13""
                    }
                }
            }
        }";

        RootObject obj = JsonConvert.DeserializeObject<RootObject>(json);

        Client client = obj.Result.Client;
        foreach (Product product in client.ProductList)
        {
            Console.WriteLine(product.Name);
        }
        Console.WriteLine(client.Name);
        Console.WriteLine(client.AddressLine1);
    }
}

如您所见,解析的方式有点老套,所以我的问题是:

  1. 我能否在不弄乱我的类的情况下将此解析合并到类本身?
  2. 如果我的方法是可行的方法,我如何重新创建对象以便 ReadJson() 可以返回它(请参阅 上面代码中的问号)
  3. 更上一层楼:如果客户端类有一个构造函数接受参数(传递给基类),你会怎么做 2。(因为我相信额外的嵌套级别会使事情复杂化)
  4. 如果这是错误的方法,我愿意接受建议

【问题讨论】:

  • 我不确定,但在我看来,您最终会尝试将一些深度嵌套的 JSON 扁平化为更简单的结构。你已经找到了一个我写的转换器,但是没有达到你想要的程度,所以你的解决方案是尝试使用正则表达式操作 JSON 以使其适合转换器(这不是一个好方法,IMO) .我认为您可能正在寻找的是Can I specify a path in an attribute to map a property in my class to a child property in my JSON?。如果我误解了,请澄清。
  • 你理解正确@BrianRogers,谢谢。我同意使用正则表达式很麻烦,我确实在寻找一种替代方法。从您的链接中,您是否必须用“[JsonProperty("...")]" 装饰每个 Json 属性?添加所有这些硬编码的名称不是维护责任吗?使用自定义 SerializationBinder 以便所有硬编码名称都集中在那里不是更好吗?如果没有,为什么不呢?
  • @BrianRogers,Activator.CreateInstance(objectType) 也失败了,因为我的对象没有无参数构造函数。
  • 使用另一个答案中的JsonPathConverter,您只需要装饰那些名称与 JSON 中的名称不同或需要映射到子对象的属性。但是根据您的限制,此转换器也不适合您。它不会处理非默认构造函数(如您所见),并且对于 IsPublic 属性示例,它没有办法将 true 转换为 false,反之亦然。您将需要一个专门针对您的情况的自定义转换器。
  • A SerializationBinder 不会将 JSON 属性映射到类属性,它会将 JSON 中的类型名称和程序集名称(在特殊的 $type 元属性中)映射到实际类型。所以这对扁平化没有帮助。

标签: c# json parsing jsonconvert


【解决方案1】:

从您的问题和 cmets 看来,您有一些复杂的 JSON,您的目标是将其扁平化为更简单的类结构。但是你有一些额外的限制:

  • 反序列化的目标类没有默认(无参数)构造函数。
  • 您希望将 JSON 中的键映射到类中名称不同的属性。
  • 对于某些属性,您还希望转换值(例如,将 true 转换为 false,反之亦然)。
  • 您希望将映射逻辑全部保存在一个位置,与类分开。

您可以使用自定义 JsonConverter 完成所有这些操作。关键是将 JSON 数据加载到转换器内部的 JObject 中。从那里您可以使用SelectToken 指定从JObject 检索特定数据的路径。然后,您可以使用这些部分通过它们的非默认构造函数来构造您的对象。同时,您可以翻译任何需要它的值。

例如,假设您从问题中的 JSON 开始,而您真正想要反序列化的类如下所示:

public class Client
{
    public Client(string name, string addressLine1, List<Product> productList)
    {
        Name = name;
        AddressLine1 = addressLine1;
        ProductList = productList;
    }

    public List<Product> ProductList { get; set; }
    public string Name { get; set; }
    public string AddressLine1 { get; set; }
}

public class Product
{
    public Product(string name, bool isPrivate)
    {
        Name = name;
        IsPrivate = isPrivate;
    }

    public string Name { get; set; }
    public bool IsPrivate { get; set; }
}

这是一个处理反序列化的自定义转换器:

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

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        JObject obj = JObject.Load(reader);

        string name = (string)obj.SelectToken("Result.Client.MyName.CustName");
        string addressLine1 = (string)obj.SelectToken("Result.Client.AddressLine1.SomeAddr");
        List<Product> productList = obj.SelectToken("Result.Client.ProductList.Product")
            .Select(jt =>
            {
                string prodName = (string)jt.SelectToken("MyName.CarName");
                bool isPublic = string.Equals((string)jt.SelectToken("MyName.IsPublic"), "True", StringComparison.OrdinalIgnoreCase);
                return new Product(prodName, !isPublic);
            })
            .ToList();

        Client client = new Client(name, addressLine1, productList);
        return client;
    }

    public override bool CanWrite => false;

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        throw new NotImplementedException();
    }
}

要使用转换器,您可以将[JsonConverter] 属性添加到Client 类,如下所示:

[JsonConverter(typeof(CustomConverter))]
public class Client
{
   ...
}

或者您可以将转换器作为参数传递给JsonConvert.DeserializeObject(),如下所示:

Client client = JsonConvert.DeserializeObject<Client>(json, new CustomConverter());

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

【讨论】:

  • 非常感谢布赖恩,这很有帮助。看起来我注定要以任何一种方式制造一些混乱。在这个例子中,它看起来确实很整洁,但我真正的 Json 是巨大的。有很多东西需要修改,很多对象我需要实例化。此外,使用“SelectToken”意味着我必须找出 Json 中每个属性的“路径”,这可能会变得很棘手。
  • 你为什么反对我建议的方法,即使用正则表达式在一个地方全局修改字符串 + 使用“return JsonConvert.DeserializeObject(modifiedJsonString);”从 ReadJson() 返回对象?有什么陷阱?
  • 好吧,一方面,您可以使用 Json.Net,这是一种用于解析和操作 JSON 的工具。为什么选择容易出错的正则表达式字符串操作而不是使用解析器? IMO 似乎不是很“干净”。其次,您说您有缺少默认构造函数的对象。这意味着必须使用参数化的构造函数。我不知道这些参数实际上是什么,但如果它们比简单的原语更复杂或涉及循环引用,那么你可能会遇到问题。 (续)
  • 从我的角度来看,首先提取参数然后调用构造函数的方法似乎更有可能成功。但最终它是你的代码,你比我更了解你的需求,所以你可以随心所欲地构建它。如果正则表达式更适合你,那就去吧。
  • 干杯,很高兴我能帮上忙!
猜你喜欢
  • 2015-01-11
  • 2011-03-16
  • 2011-04-25
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多