web-dev-qa-db-ja.com

System.Text.Json：自動キャストでJSONをデシリアライズする

.Net Core 3の新しいSystem.Text.Json JsonSerializerを使用して、型を自動的にキャストするにはどうすればよいですか（たとえば、intからstringへ、stringからintへ）。たとえば、C＃のProduct.Idが文字列を期待している間、JSONのidは数値であるため、これは例外をスローします。

public class HomeController : Controller
{
    public IActionResult Index()
    {
        var json = @"{""id"":1,""name"":""Foo""}";
        var o = JsonSerializer.Deserialize<Product>(json, new JsonSerializerOptions
        {
            PropertyNameCaseInsensitive = true,
        });

        return View();
    }
}

public class Product
{
    public string Id { get; set; }
    public string Name { get; set; }
}

NewtonsoftのJson.Netはこれを美しく処理しました。 C＃が文字列を期待しているときに数値を渡すかどうかは関係ありません（またはその逆）、すべてが期待どおりに逆シリアル化されました。 JSONとして渡される型の形式を制御できない場合、System.Text.Jsonを使用してこれをどのように処理しますか？

c#asp.net-core.net-corejson.netsystem.text.json
2
Johnny Oshika

  1. 新しい System.Text.Json apiはJsonConverter apiを公開し、好きなように型を変換できます。

    たとえば、汎用のnumberからstringへのコンバーターを作成できます。

    public class AutoNumberToStringConverter : JsonConverter<object>
{
    public override bool CanConvert(Type typeToConvert)
    {
        return typeof(string) == typeToConvert;
    }
    public override object Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        if(reader.TokenType == JsonTokenType.Number) {
            return reader.TryGetInt64(out long l) ?
                l.ToString():
                reader.GetDouble().ToString();
        }
        if(reader.TokenType == JsonTokenType.String) {
            return reader.GetString();
        }
        using(JsonDocument document = JsonDocument.ParseValue(ref reader)){
            return document.RootElement.Clone().ToString();
        }
    }

    public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options)
    {
        writer.WriteStringValue( value.ToString());
    }
}

  2. MVC/Razor Pageを使用する場合、起動時にこのコンバーターを登録できます。

    services.AddControllersWithViews().AddJsonOptions(opts => {
    opts.JsonSerializerOptions.PropertyNameCaseInsensitive= true;
    opts.JsonSerializerOptions.Converters.Insert(0, new AutoNumberToStringConverter());
});

    そして、MVC/Razorはタイプ変換を自動的に処理します。

  3. または、シリアライゼーション/デシリアライゼーションを手動で制御する場合：

    var opts = new JsonSerializerOptions {
    PropertyNameCaseInsensitive = true,
};
opts.Converters.Add(new AutoNumberToStringConverter());
var o = JsonSerializer.Deserialize<Product>(json,opts) ;

  4. 同様に、次のように文字列から数値型への変換を有効にできます。

    public class AutoStringToNumberConverter : JsonConverter<object>
{
    public override bool CanConvert(Type typeToConvert)
    {
        // see https://stackoverflow.com/questions/1749966/c-sharp-how-to-determine-whether-a-type-is-a-number
        switch (Type.GetTypeCode(typeToConvert))
        {
            case TypeCode.Byte:
            case TypeCode.SByte:
            case TypeCode.UInt16:
            case TypeCode.UInt32:
            case TypeCode.UInt64:
            case TypeCode.Int16:
            case TypeCode.Int32:
            case TypeCode.Int64:
            case TypeCode.Decimal:
            case TypeCode.Double:
            case TypeCode.Single:
            return true;
            default:
            return false;
        }
    }
    public override object Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options)
    {
        if(reader.TokenType == JsonTokenType.String) {
            var s = reader.GetString() ;
            return int.TryParse(s,out var i) ? 
                i :
                (double.TryParse(s, out var d) ?
                    d :
                    throw new Exception($"unable to parse {s} to number")
                );
        }
        if(reader.TokenType == JsonTokenType.Number) {
            return reader.TryGetInt64(out long l) ?
                l:
                reader.GetDouble();
        }
        using(JsonDocument document = JsonDocument.ParseValue(ref reader)){
            throw new Exception($"unable to parse {document.RootElement.ToString()} to number");
        }
    }


    public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options)
    {
        var str = value.ToString();             // I don't want to write int/decimal/double/...  for each case, so I just convert it to string . You might want to replace it with strong type version.
        if(int.TryParse(str, out var i)){
            writer.WriteNumberValue(i);
        }
        else if(double.TryParse(str, out var d)){
            writer.WriteNumberValue(d);
        }
        else{
            throw new Exception($"unable to parse {str} to number");
        }
    }
}
0
itminus

心配しないでください。必要なタイプで必要な項目を返すプロパティをクラスに追加するだけです。

public class Product
{
    public int Id { get; set; }

    public string IdString 
    {
        get
        {
            return Id.ToString();
        }
    }

    public string Name { get; set; }
}
0
robbpriestley