配置Json.net使某些字段进行URL编码

Question

假设我有这样一个模型类:

public class MyModelClass
{
    [JsonProperty("first_field"]
    public string FirstField { get; set; }

    [JsonProperty("second_field"]
    public string SecondField { get; set; }

    public MyModelClass(string first, string second)
    {
        FirstField = first;
        SecondField = second;
    }
}

假设我有这种类型的实例：

var myObject = new MyModelClass("blablabla", "<>@%#^^@!%");

当我使用Json.net将此对象转换为Json字符串时，我得到类似以下的内容：

{ 'first_field': 'blablabla', 'second_field': '<>@%#^^@!%' }

有没有一种方法可以配置Json.net，使“SecondField”的内容进行URL编码？我需要编写自己的自定义转换器还是有更简单的方法？

- desautelsj

---

你不能使用属性使“真实”属性对序列化程序不可见，并仅使用替代属性进行序列化吗？ - Casey

Answer 1

如果只有一个类中的一个字段需要处理编码，你可以在该类中添加一个只读属性来处理编码，并进行注释以使其在序列化过程中替换原始属性：

    public class MyModelClass
    {
        ...

        [JsonIgnore]
        public string SecondField { get; set; }

        [JsonProperty("second_field")]
        private string UrlEncodedSecondField
        {
            get { return System.Web.HttpUtility.UrlEncode(SecondField); }
        }

        ...
    }

演示代码: https://dotnetfiddle.net/MkVBVH

---

如果您需要在多个字段和类之间使用此功能，您可以使用与选择性地在反序列化过程中转义字符串中的HTML类似的解决方案，只需进行一些小修改：

1. 创建一个自定义的UrlEncode属性，并让解析器查找具有该属性而不是缺少AllowHtml属性的属性。
2. 将HtmlEncodingValueProvider更改为UrlEncodingValueProvider，并使其在GetValue中应用编码，而不是在SetValue中（这样它就会在序列化而不是反序列化期间对编码进行处理）。

以下是最终代码：

public class UrlEncodeAttribute : Attribute { }

public class CustomResolver : DefaultContractResolver
{
    protected override IList<JsonProperty> CreateProperties(Type type, MemberSerialization memberSerialization)
    {
        IList<JsonProperty> props = base.CreateProperties(type, memberSerialization);

        // Find all string properties that have a [UrlEncode] attribute applied
        // and attach an UrlEncodingValueProvider instance to them
        foreach (JsonProperty prop in props.Where(p => p.PropertyType == typeof(string)))
        {
            PropertyInfo pi = type.GetProperty(prop.UnderlyingName);
            if (pi != null && pi.GetCustomAttribute(typeof(UrlEncodeAttribute), true) != null)
            {
                prop.ValueProvider = new UrlEncodingValueProvider(pi);
            }
        }

        return props;
    }

    protected class UrlEncodingValueProvider : IValueProvider
    {
        PropertyInfo targetProperty;

        public UrlEncodingValueProvider(PropertyInfo targetProperty)
        {
            this.targetProperty = targetProperty;
        }

        // SetValue gets called by Json.Net during deserialization.
        // The value parameter has the original value read from the JSON;
        // target is the object on which to set the value.
        public void SetValue(object target, object value)
        {
            targetProperty.SetValue(target, (string)value);
        }

        // GetValue is called by Json.Net during serialization.
        // The target parameter has the object from which to read the string;
        // the return value is the string that gets written to the JSON
        public object GetValue(object target)
        {
            string value = (string)targetProperty.GetValue(target);
            return System.Web.HttpUtility.UrlEncode(value);
        }
    }
}

要使用自定义解析器，请首先使用新的[UrlEncode]属性装饰您想要进行URL编码的任何属性：

public class MyModelClass
{
    [JsonProperty("first_field")]
    public string FirstField { get; set; }

    [UrlEncode]
    [JsonProperty("second_field")]
    public string SecondField { get; set; }

    ...
}

然后，像这样序列化您的模型：

var myObject = new MyModelClass("blablabla", "<>@%#^^@!%");

var settings = new JsonSerializerSettings
{
    ContractResolver = new CustomResolver(),
    Formatting = Formatting.Indented
};

string json = JsonConvert.SerializeObject(myObject, settings);

演示代码: https://dotnetfiddle.net/iOOzFr

- Brian Rogers

---

这看起来是一个很好的解决方案，但需要三个类来实现这个看似简单的目标，这似乎令人难以置信。 - desautelsj

Answer 2

@brian-rogers提供的答案非常好，但我想提供一个我认为更简单的替代方案：

public class UrlEncodingConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        return objectType == typeof(string);
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        if (value == null) return;
        var encodedValue = System.Web.HttpUtility.UrlEncode((string)value);
        writer.WriteValue(encodedValue);
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.Value == null) return null;
        var decodedValue = System.Web.HttpUtility.UrlDecode(reader.Value.ToString());
        return decodedValue;
    }
}

which can be used like so:

public class MyModelClass
{
    [JsonProperty("first_field")]
    public string FirstField { get; set; }

    [JsonProperty("second_field")]
    [JsonConverter(typeof(UrlEncodingConverter))]
    public string SecondField { get; set; }
}

- desautelsj

Answer 3

试试这个：

var myObject = new MyModelClass("blablabla", WebUtility.UrlEncode("<>@%#^^@!%"));

你需要将 System.Net 添加到你的 Using-directives 中

- jan.q

---

不幸的是，我需要“myObject”包含未编码的值。只有在转换为Json时才需要对该值进行编码。 - desautelsj

然后，每当您需要时，只需使用WebUtility.UrlDecode或仅在调用函数将其转换为JSON时使用UrlEncode方法。 - jan.q