Json.Netでシリアル化するときにカスタムのDateTime形式を指定する

ASP.NET Web APIを使用して一部のデータを公開するAPIを開発しています。

APIの1つで、クライアントは日付をyyyy-MM-ddフォーマットで公開することを望んでいます。GlobalConfiguration.Configuration.Formatters.JsonFormatterこれはこのクライアントに非常に固有であるため、グローバル設定（など）を変更したくありません。そして、私はそれを複数のクライアントのためのソリューションで開発しています。

私が考えることができる解決策の1つは、カスタムを作成しJsonConverterてから、それをカスタム書式設定を行う必要があるプロパティに置くことです

例えば

class ReturnObjectA 
{
    [JsonConverter(typeof(CustomDateTimeConverter))]
    public DateTime ReturnDate { get;set;}
}

それを行う簡単な方法が他にあるかどうか疑問に思っています。

あなたは正しい軌道に乗っています。グローバル設定は変更できないとおっしゃっていたので、次にJsonConverterお勧めするのは、必要に応じて属性を適用することです。Json.NetにはIsoDateTimeConverter、日付形式を指定できるビルトインがすでに組み込まれていることがわかります。残念ながら、JsonConverter属性の唯一の引数は型であるため、属性を介して形式を設定することはできません。ただし、簡単な解決策がありIsoDateTimeConverterます。をサブクラス化し、サブクラスのコンストラクターで日付形式を指定します。JsonConverter必要な場所に属性を適用し、カスタムコンバーターを指定すると、準備が整います。必要なコード全体を次に示します。

class CustomDateTimeConverter : IsoDateTimeConverter
{
    public CustomDateTimeConverter()
    {
        base.DateTimeFormat = "yyyy-MM-dd";
    }
}

そこに時間を置いてもかまわない場合は、IsoDateTimeConverterをサブクラス化する必要すらありません。デフォルトの日付形式はyyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK（ソースコードに表示されている）です。

このアプローチを使用できます：

public class DateFormatConverter : IsoDateTimeConverter
{
    public DateFormatConverter(string format)
    {
        DateTimeFormat = format;
    }
}

次のように使用します。

class ReturnObjectA 
{
    [JsonConverter(typeof(DateFormatConverter), "yyyy-MM-dd")]
    public DateTime ReturnDate { get;set;}
}

DateTimeFormat文字列は、ここで説明されている.NET形式の文字列構文を使用します。https：//docs.microsoft.com/en-us/dotnet/standard/base-types/custom-date-and-time-format-strings

IsoDateTimeConverterグローバル書式設定を変更せずに、インスタンスを使用して行うこともできます。

string json = JsonConvert.SerializeObject(yourObject,
    new IsoDateTimeConverter() { DateTimeFormat = "yyyy-MM-dd HH:mm:ss" });

これは引数JsonConvert.SerializeObjectを取るオーバーロードを使用しparams JsonConverter[]ます。

シリアライザ設定オーバーロードの1つを使用して利用することもできます。

var json = JsonConvert.SerializeObject(someObject, new JsonSerializerSettings() { DateFormatString = "yyyy-MM-ddThh:mm:ssZ" });

または

var json = JsonConvert.SerializeObject(someObject, Formatting.Indented, new JsonSerializerSettings() { DateFormatString = "yyyy-MM-ddThh:mm:ssZ" });

Typeを取るオーバーロードも利用できます。

ヘルパークラスをビルドしてプロパティ属性に適用する

ヘルパークラス：

public class ESDateTimeConverter : IsoDateTimeConverter
{
    public ESDateTimeConverter()
    {
        base.DateTimeFormat = "yyyy-MM-ddTHH:mm:ss.fffZ";
    }
}

あなたのコードは次のように使用します：

[JsonConverter(typeof(ESDateTimeConverter))]
public DateTime timestamp { get; set; }

私が使用している別の解決策があります。文字列プロパティを作成してjsonに使用するだけです。このプロパティは、適切にフォーマットされた日付を返します。

class JSonModel {
    ...

    [JsonProperty("date")]
    public string MyDate { get; set; }

    public string CustomDate {
        get { return MyDate.ToString("DDMMYY"); }
        set { MyDate = DateTime.Parse(value); }
    }

    ...
}

これにより、追加のクラスを作成する必要がなくなります。また、さまざまなデータ形式を作成できます。たとえば、同じDateTimeを使用して、時間の別のプロパティを簡単に作成できます。

json convert属性の装飾が機能しない場合がありますが、例外的に「2010-10-01」が有効な日付であると表示されます。このタイプを回避するために、プロパティのjson変換属性を削除し、以下のようにdeserilizedObjectメソッドで言及しました。

var addresss = JsonConvert.DeserializeObject<AddressHistory>(address, new IsoDateTimeConverter { DateTimeFormat = "yyyy-MM-dd" });

コンバーター付き

public class CustomDateTimeConverter : IsoDateTimeConverter
    {
        public CustomDateTimeConverter()
        {
            DateTimeFormat = "yyyy-MM-dd";
        }

        public CustomDateTimeConverter(string format)
        {
            DateTimeFormat = format;
        }
    }

デフォルトのカスタム形式で使用できます

class ReturnObjectA 
{
    [JsonConverter(typeof(DateFormatConverter))]
    public DateTime ReturnDate { get;set;}
}

または、プロパティに指定された形式

class ReturnObjectB 
{
    [JsonConverter(typeof(DateFormatConverter), "dd MMM yy")]
    public DateTime ReturnDate { get;set;}
}