从自定义 Json 转换器中操作 Json 字符串

问题描述

为了提出我的问题,我将参考@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(?="":\s)",$@"(?<="")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 中的键映射到类中不同命名的属性。
  • 对于某些属性,您还想转换这些值(例如,将 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

相关问答

错误1:Request method ‘DELETE‘ not supported 错误还原:...
错误1:启动docker镜像时报错:Error response from daemon:...
错误1:private field ‘xxx‘ is never assigned 按Alt...
报错如下,通过源不能下载,最后警告pip需升级版本 Requirem...