NewtonSoft JsonConverter - 访问其他属性

Question

我需要将十进制的输出 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 类的数组，每个类都有一个 Cost 和一个 Culture。

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

实际的对象要复杂得多，具有嵌套资产的多个字段，这些字段将有自己的数字。此外，并非所有小数都是货币。

我真的不想为合约本身编写自定义序列化程序，因为每次属性更改时我都必须修改它。

理想的解决方案是能够使用转换器属性标记某些十进制属性，以便它可以处理它。

我正在考虑的另一种方法是为十进制属性创建一个自定义类，并从十进制进行隐式转换，但是由于某些属性是基于先前结果计算的属性，因此变得更加复杂。

解决方法

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

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。

Answer 1

您要做的是在对象的特定属性被序列化时拦截和修改它的值，同时对所有其他属性使用默认序列化。这可以通过 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);

注意事项：

1. 由于您没有序列化区域性名称，因此我看不到任何反序列化 Cost 属性的方法。因此我从SetValue 方法中抛出了一个异常。

   （而且，即使您正在序列化文化名称，由于 JSON 对象是无序一组名称/值对，根据standard，没有确保文化名称出现在被反序列化的 JSON 中的成本之前的方法。这可能与 Newtonsoft 不提供对父堆栈的访问权限有关。在反序列化期间，不能保证父层次结构中的所需属性已被读取 - 甚至父母已经被构建了。）

2. 如果您必须对合同应用多个不同的自定义规则，请考虑使用 ConfigurableContractResolver 和 How to add metadata to describe which properties are dates in JSON.Net。

3. 您可能需要cache the contract resolver 以获得最佳性能。

4. 另一种方法是向父对象添加一个转换器，该转换器通过暂时禁用自身来生成JObject 的默认序列化，调整返回的JObject，然后将其写出。有关此方法的示例，请参阅 JSON.Net throws StackOverflowException when using [JsonConvert()] 或 Can I serialize nested properties to my class in one operation with Json.net?。

5. 在您编写的 cmets 中，在 WriteJson 内部，我无法弄清楚如何访问父对象及其属性。 应该可以使用返回 a 的自定义 IValueProvider Tuple 或包含父级和值的类似类，将与期望此类输入的特定 JsonConverter 一起使用。我不确定我会推荐这个，因为它非常棘手。

工作样本.Net fiddle。