NewtonSoft JsonConverter - 访问其他属性

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了NewtonSoft JsonConverter - 访问其他属性相关的知识,希望对你有一定的参考价值。

我需要将十进制的输出json格式化为一种货币,文化指定了我正在序列化的对象,该对象可以嵌套,因此我无法在序列化程序中预设选项。我这样做的当前方式是使用格式化输出的额外字符串属性。

[JsonIgnore]
public decimal Cost {get;set;}

[JsonIgnore]
public CultureInfo Culture {get;set;}

public string AsCurrency(decimal value) {
  return string.Format(this.Culture, "{0:c}", value);
}

[JsonProperty("FormattedCost")]
public string FormatedCost {
  get { return this.AsCurrency(this.Cost); }
}

我有很多要处理的属性,我不打算反序列化,JsonObject被不同的语言用来填充PDF,所以我想要字符串值。

理想情况下,我想要一个JsonConverter,所以我可以做

[JsonProperty("FormattedCost")]
[JsonConverter(typeof(MyCurrencyConverter))]
public decimal Cost {get;set;}

我遇到的问题是如何访问转换器中包含对象的Culture属性。

public class MyCurrencyConverter : JsonConverter
{
    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
       var culture = // How do I get the Culture from the parent object?
       writer.WriteValue(string.format(culture, "{0:c}", (decimal)value);

    }

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

    public override bool CanConvert(Type objectType)
    {
        return typeof(decimal) == objectType;
    }
}

如请求的样本JSON。

对于一系列Contract类,每个类都有成本和文化。

[{ FormattedCost : "£5000.00"}, { FormattedCost : "$8000.00"}, { FormattedCost : "€599.00"}]

实际的对象要复杂得多,嵌套的Assets的多个字段都有自己的数字。此外,并非所有小数都是货币。

我真的不想为契约本身编写自定义序列化程序,因为每次属性更改时我都必须对其进行修改。

理想的解决方案是能够使用转换器属性标记某些小数属性,以便它可以处理它。

我想要的另一种方法是使用十进制的隐式转换为小数属性创建一个自定义类,但是由于某些属性是基于先前结果的计算属性,因此会变得更复杂。

替代方法

我有一个解决我的用例的方法,但它使用反射来获取序列化程序中的私有变量。

var binding = BindingFlags.NonPublic | BindingFlags.Instance;
var writer = serializer.GetType()
                       .GetMethod("GetInternalSerializer", binding)
                       ?.Invoke(serializer, null);
var parent = writer?.GetType()
                   .GetField("_serializeStack", binding)
                   ?.GetValue(writer) is List<object> stack 
                        && stack.Count > 1 ? stack[stack.Count - 2] as MyType: null;

在我测试的用例中,这给了我父对象,但它没有使用公共API。

答案

您要做的是在对象进行序列化时拦截和修改对象的特定属性的值,同时对所有其他属性使用默认序列化。这可以使用custom ContractResolver来完成,当应用特定属性时,ValueProvider将替换相关属性的[System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field, AllowMultiple = false)] public class JsonFormatAttribute : System.Attribute { public JsonFormatAttribute(string formattingString) { this.FormattingString = formattingString; } /// <summary> /// The format string to pass to string.Format() /// </summary> public string FormattingString { get; set; } /// <summary> /// The name of the underlying property that returns the object's culture, or NULL if not applicable. /// </summary> public string CulturePropertyName { get; set; } } public class FormattedPropertyContractResolver : DefaultContractResolver { protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization) { return base.CreateProperties(type, memberSerialization) .AddFormatting(); } } public static class JsonContractExtensions { class FormattedValueProvider : IValueProvider { readonly IValueProvider baseProvider; readonly string formatString; readonly IValueProvider cultureValueProvider; public FormattedValueProvider(IValueProvider baseProvider, string formatString, IValueProvider cultureValueProvider) { this.baseProvider = baseProvider; this.formatString = formatString; this.cultureValueProvider = cultureValueProvider; } #region IValueProvider Members public object GetValue(object target) { var value = baseProvider.GetValue(target); var culture = cultureValueProvider == null ? null : (CultureInfo)cultureValueProvider.GetValue(target); return string.Format(culture ?? CultureInfo.InvariantCulture, formatString, value); } public void SetValue(object target, object value) { // This contract resolver should only be used for serialization, not deserialization, so throw an exception. throw new NotImplementedException(); } #endregion } public static IList<JsonProperty> AddFormatting(this IList<JsonProperty> properties) { ILookup<string, JsonProperty> lookup = null; foreach (var jsonProperty in properties) { var attr = (JsonFormatAttribute)jsonProperty.AttributeProvider.GetAttributes(typeof(JsonFormatAttribute), false).SingleOrDefault(); if (attr != null) { IValueProvider cultureValueProvider = null; if (attr.CulturePropertyName != null) { if (lookup == null) lookup = properties.ToLookup(p => p.UnderlyingName); var cultureProperty = lookup[attr.CulturePropertyName].FirstOrDefault(); if (cultureProperty != null) cultureValueProvider = cultureProperty.ValueProvider; } jsonProperty.ValueProvider = new FormattedValueProvider(jsonProperty.ValueProvider, attr.FormattingString, cultureValueProvider); jsonProperty.PropertyType = typeof(string); } } return properties; } }

首先,定义以下属性和合同解析程序:

public class RootObject
{
    [JsonFormat("{0:c}", CulturePropertyName = nameof(Culture))]
    public decimal Cost { get; set; }

    [JsonIgnore]
    public CultureInfo Culture { get; set; }

    public string SomeValue { get; set; }

    public string SomeOtherValue { get; set; }
}

接下来,按如下方式定义对象:

var settings = new JsonSerializerSettings
{
    ContractResolver = new FormattedPropertyContractResolver
    {
        NamingStrategy = new CamelCaseNamingStrategy(),
    },
};
var json = JsonConvert.SerializeObject(root, Formatting.Indented, settings);

最后,序列化如下:

Cost

笔记:

  1. 由于您没有序列化文化名称,我看不到任何方法来反序列化SetValue属性。因此,我从standard方法中抛出一个例外。 (而且,即使您正在序列化文化名称,因为根据ConfigurableContractResolver,JSON对象是一组无序的名称/值对,所以无法保证在反序列化JSON中的成本之前出现文化名称。这可能是与为什么Newtonsoft不提供对父堆栈的访问有关。在反序列化期间,不能保证已经读取了父层次结构中的必需属性 - 或者甚至已经构造了父级。)
  2. 如果您必须对合同应用几种不同的自定义规则,请考虑使用How to add metadata to describe which properties are dates in JSON.Net中的cache the contract resolver
  3. 你可能想要JObject以获得最佳性能。
  4. 另一种方法是向父对象添加转换器,通过暂时禁用自身来生成对JObject的默认序列化,调整返回的JSON.Net throws StackOverflowException when using [JsonConvert()],然后将其写出来。有关此方法的示例,请参阅Can I serialize nested properties to my class in one operation with Json.net?IValueProvider
  5. 在你写的评论中,在WriteJson内部,我无法弄清楚如何访问父对象及其属性。应该可以使用自定义Tuple来执行此操作,该自定义JsonConverter返回包含父级和值的.Net fiddle或类似类,它将与期望此类输入的特定qazxswpoi一起使用。不确定我会推荐这个,因为它非常棘手。

工作样本qazxswpoi。

以上是关于NewtonSoft JsonConverter - 访问其他属性的主要内容,如果未能解决你的问题,请参考以下文章

如何在 .net core 3.1 中的 Newtonsoft JsonConverter 中注入依赖项

JsonConverter 等效于使用 System.Text.Json

Newtonsoft.Json 序列化器的重写

Newtonsoft.Json 转换DateTime类型为字符串时,串内部会有一个T。解决方案

如何调用 JsonConvert.DeserializeObject 并禁用通过 [JsonConverter] 应用于基本类型的 JsonConverter?

Web API - JsonConverter - 自定义属性