从自定义 Json 转换器中操作 Json 字符串
Manipulating a Json string from within a custom Json Converter
为了提出我的问题,我将参考@Brian Rogers 的回答here。
在这个答案中,ReadJson 做的事情相对简单。但是,我怎么能在其中添加一个层,以便在将传入的 Json 字符串反序列化为对象然后 return 对其进行操作之前对其进行操作?
这是我想做的事情类型(Brian 的 WrappedObjectConvert class 的修改版本):
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();
}
}
客户端 class 也通过添加字段“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; }
}
以及修改后的demoJson(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);
}
}
如您所见,解析的方式有点老套,所以我的问题是:
- 我可以将此解析合并到 classes 本身而不弄乱我的 classes 吗?
- 如果我的方法可行,我该如何重新创建对象以便 ReadJson() 可以 return 它(请参阅
上面代码中的问号)
- 更上一层楼:如果客户端 class 有一个接受参数的构造函数(传递给基 class),你会怎么做 2.(作为额外的级别我认为嵌套会使事情复杂化)
- 如果这是错误的方法,我愿意接受建议
从您的问题和评论来看,您似乎有一些复杂的 JSON,您的目标是将其扁平化为更简单的 class 结构。但是你有一些额外的限制:
- 用于反序列化的目标 classes 没有默认(无参数)构造函数。
- 您想将 JSON 中的键映射到 class 中不同名称的属性。
- 对于某些属性,您还希望转换值(例如,将 true 转换为 false,反之亦然)。
- 您想将映射逻辑全部放在一个地方,与 classes 分开。
您可以使用自定义 JsonConverter
. The key is to load the JSON data into a JObject
inside the converter. From there you can use SelectToken
来指定从 JObject
检索特定数据片段的路径。然后,您可以使用这些片段通过它们的非默认构造函数来构造您的对象。同时您可以翻译任何需要它的值。
例如,假设您从问题中的 JSON 开始,而您真正想要反序列化的 classes 看起来像这样:
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
class,如下所示:
[JsonConverter(typeof(CustomConverter))]
public class Client
{
...
}
或者您可以像这样将转换器作为参数传递给 JsonConvert.DeserializeObject()
:
Client client = JsonConvert.DeserializeObject<Client>(json, new CustomConverter());
这是一个工作演示:https://dotnetfiddle.net/EwtQHh
为了提出我的问题,我将参考@Brian Rogers 的回答here。 在这个答案中,ReadJson 做的事情相对简单。但是,我怎么能在其中添加一个层,以便在将传入的 Json 字符串反序列化为对象然后 return 对其进行操作之前对其进行操作?
这是我想做的事情类型(Brian 的 WrappedObjectConvert class 的修改版本):
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();
}
}
客户端 class 也通过添加字段“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; }
}
以及修改后的demoJson(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);
}
}
如您所见,解析的方式有点老套,所以我的问题是:
- 我可以将此解析合并到 classes 本身而不弄乱我的 classes 吗?
- 如果我的方法可行,我该如何重新创建对象以便 ReadJson() 可以 return 它(请参阅 上面代码中的问号)
- 更上一层楼:如果客户端 class 有一个接受参数的构造函数(传递给基 class),你会怎么做 2.(作为额外的级别我认为嵌套会使事情复杂化)
- 如果这是错误的方法,我愿意接受建议
从您的问题和评论来看,您似乎有一些复杂的 JSON,您的目标是将其扁平化为更简单的 class 结构。但是你有一些额外的限制:
- 用于反序列化的目标 classes 没有默认(无参数)构造函数。
- 您想将 JSON 中的键映射到 class 中不同名称的属性。
- 对于某些属性,您还希望转换值(例如,将 true 转换为 false,反之亦然)。
- 您想将映射逻辑全部放在一个地方,与 classes 分开。
您可以使用自定义 JsonConverter
. The key is to load the JSON data into a JObject
inside the converter. From there you can use SelectToken
来指定从 JObject
检索特定数据片段的路径。然后,您可以使用这些片段通过它们的非默认构造函数来构造您的对象。同时您可以翻译任何需要它的值。
例如,假设您从问题中的 JSON 开始,而您真正想要反序列化的 classes 看起来像这样:
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
class,如下所示:
[JsonConverter(typeof(CustomConverter))]
public class Client
{
...
}
或者您可以像这样将转换器作为参数传递给 JsonConvert.DeserializeObject()
:
Client client = JsonConvert.DeserializeObject<Client>(json, new CustomConverter());
这是一个工作演示:https://dotnetfiddle.net/EwtQHh