C# JsonConverter JSONArray 到带分隔符的字符串并返回

Question

我想实现一个自定义的 JsonConverter 来使用，

    [JsonConverter(typeof(ArrayString))]
    public string ServiceCodes { get; set; }

目的是将 JSON 数组转换为带分隔符的字符串，例如， ["this", "is", "my", "json", "array"] 应该变成 "this;is;my;json;array" （或任何分隔符）。同样，反过来应该是可能的。

我很难理解覆盖JsonConverter 的WriteJson 方法。

为了提供一些上下文，我 ServiceCodes 是实体上的一个属性（我使用的是 EF6）。我认为做我要求的事情比其他一对多的实现更容易。但是，我有一个问题是何时调用 JsonConverter？

我只希望 get 在 getter 需要 json 时提供 json，即当包含此属性的对象从我的 API 作为 JSON 返回时。例如，我不希望在编写 LINQ 时调用此转换器。

任何帮助将不胜感激，谢谢。

编辑 - 添加信息

这是类和一些 moc 数据。

    [ComplexType]
    public class TerminalDuties
    {
        public string TerminalCode { get; set; }

        public string TransportationCode { get; set; }

        [JsonConverter(typeof(ArrayString))]
        public string ServiceCodes { get; set; }
    }

"Origin": { "TerminalCode": "MIA", "TransportationCode": "GT", "ServiceCodes": ["WH", "HL"] }

我尝试了@felix-b 的答案，但它不是映射。对象为空。我在 ArrayString 类中有断点，但它们没有被击中。大概它没有尝试映射，因为该属性是一个字符串。解决方法是什么？

这是它在我的 Web API 控制器中的公开方式（从 ApiController 继承）

    [HttpPost]
    public void DoStuff([FromBody]Thing t)
    {
        someMngr.Add(t);
    }

    public class Thing : ParentClass
    {
        properties...
        public TerminalDuties Origin { get; set; }
    }

Answer 1

使用 .NET Framework 4.6.1、ASP.NET Web API 2、Entity Framework 6.1.3、Newtonsoft.Json 10.0.3 测试。

更新

我的答案最初要求指定[JsonConverter(typeof(ArrayString), ';')]，而不是问题中的[JsonConverter(typeof(ArrayString))]。

我为转换器类添加了默认构造函数，因此分隔符配置是可选的，如果不指定将使用分号。现在[JsonConverter(typeof(ArrayString))] 也可以使用。

原始答案

转换器只会在通过 JSON.NET 对您的实体进行序列化和反序列化期间调用。它不影响从代码中获取或设置属性值，也不影响 LINQ 查询和 DB 操作。

这里是转换器的实现：

public class ArrayString : JsonConverter
{
    private readonly char _delimiter;

    // UPDATE -- added default constructor, so that 
    // JsonConverter attribute can be specified without the 
    // delimiter parameter, in which case semicolon will be used
    public ArrayString() : this(';')
    {
    }

    public ArrayString(char delimiter)
    {
        _delimiter = delimiter;
    }

    public override bool CanRead => true;
    public override bool CanWrite => true;

    public override bool CanConvert(Type objectType)
    {
        return true; 
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        if (reader.TokenType != JsonToken.StartArray)
        {
            return null;
        }

        var stringValue = new StringBuilder();

        while (reader.Read() && reader.TokenType == JsonToken.String)
        {
            if (stringValue.Length > 0)
            {
                stringValue.Append(_delimiter);
            }
            stringValue.Append((string)reader.Value);
        }

        return stringValue.ToString();
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        var stringValue = value?.ToString();

        if (stringValue == null)
        {
            writer.WriteNull();
            return;
        }

        var arrayValue = stringValue.Split(_delimiter);

        writer.WriteStartArray();

        foreach (var item in arrayValue)
        {
            writer.WriteValue(item);
        }

        writer.WriteEndArray();
    }
}

以下是如何指定分隔符（本例中为分号）：

[JsonConverter(typeof(ArrayString), ';')]
public string ServiceCodes { get; set; }