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会在应用特定属性时替换相关属性的SetValue。

首先，定义以下属性和合约解析器：

[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属性的方法。因此，我从standard方法中抛出异常。

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

工作样本method signatures。

NewtonSoft JsonConverter - 访问其他属性

1 个答案: