web-dev-qa-db-ja.com

クラスのカスタムJSONシリアル化

以下のような構造のコードがあります。

public class Stats
{
        public string URL { get; set; }
        public string Status { get; set; }
        public string Title { get; set; }
        public string Description { get; set; }
        public int Length { get; set; }
}

そして

 public class UrlStats
 {
        public string URL { get; set; }
        public int TotalPagesFound { get; set; }
        public List<Stats> TotalPages { get; set; }
        public int TotalTitleTags { get; set; }
        public List<Stats> TotalTitles { get; set; }
        public int NoDuplicateTitleTags { get; set; }
        public List<Stats> DuplicateTitles { get; set; }
        public int NoOverlengthTitleTags { get; set; }
        public List<Stats> OverlengthTitles { get; set; }
 }

基本的に私はタイトルタグ、重複タイトルなどの統計のためにウェブサイトをスキャンしています。

私はJQueryを使用してAJAX呼び出しを実行し、大きなWebサイトのスキャンにかなりの時間がかかるため、プロセスの実行中にユーザーのURL統計を表示するためにURL統計を取得しています。 5秒ごとにサーバーから統計情報を取得します。問題は、更新中ではなく、スキャン処理が完了したときに最後に送信する必要があるすべてのList変数データです。今何が起こっているのかList<Stats>変数データも更新中に送信されますが、これはデータの大きなチャンクであり、プロセスの更新を表示するために必要なintタイプの変数のみを送信したいです。

インターネットで検索したところ、問題を解決するのに役立つものは見つからず、Json.NETは非常に優れたライブラリであることがわかりましたが、適切に使用して必要なものを取得する方法がわかりません。

可能であれば、基本的に、実行時にデータ型に応じてプロパティをシリアル化することを探しています。

23
Dinesh Ahuja

問題には2つの異なるアプローチがあります。

クラスを頻繁に変更する場合は、最初の方法を選択する必要があります。最初の方法では、新しく追加されたプロパティをシリアル化することを忘れないためです。さらに、同じ方法でシリアル化したい別のクラスを追加したい場合は、はるかに再利用可能です。

これらの2つのクラスのみがあり、それらが変更されない可能性が最も高い場合は、2番目のアプローチを選択して、ソリューションをシンプルに保つことができます。

1.カスタムコンバーターを使用して、すべてのintプロパティを選択します

最初のアプローチは、JsonConverter型のプロパティのみを含めることでクラスまたは構造体をシリアル化するカスタムintを使用することです。コードは次のようになります。

class IntPropertyConverter : JsonConverter
{
    public override bool CanConvert(Type objectType)
    {
        // this converter can be applied to any type
        return true;
    }

    public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer)
    {
        // we currently support only writing of JSON
        throw new NotImplementedException();
    }

    public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer)
    {
        if (value == null)
        {
            serializer.Serialize(writer, null);
            return;
        }

        // find all properties with type 'int'
        var properties = value.GetType().GetProperties().Where(p => p.PropertyType == typeof(int));

        writer.WriteStartObject();

        foreach (var property in properties)
        {
            // write property name
            writer.WritePropertyName(property.Name);
            // let the serializer serialize the value itself
            // (so this converter will work with any other type, not just int)
            serializer.Serialize(writer, property.GetValue(value, null));
        }

        writer.WriteEndObject();
    }
}

次に、JsonConverterAttributeを使用してクラスを装飾する必要があります。

[JsonConverter(typeof(IntPropertyConverter))]
public class UrlStats
{
    // ...
}

免責事項:このコードは非常に大まかにのみテストされています。


2.プロパティを個別に選択します

2番目のソリューションは少し単純に見えます。JsonIgnoreAttributeを使用して、シリアル化から除外する属性を装飾できます。または、シリアル化する属性を明示的に含めることで、「ブラックリスト」から「ホワイトリスト」に切り替えることができます。これがサンプルコードのビットです:

ブラックリスト:(概要をわかりやすくするためにプロパティを並べ替えました)

[JsonObject(MemberSerialization.OptOut)] // this is default and can be omitted
public class UrlStats
{
    [JsonIgnore] public string URL { get; set; }
    [JsonIgnore] public List<Stats> TotalPages { get; set; }
    [JsonIgnore] public List<Stats> TotalTitles { get; set; }
    [JsonIgnore] public List<Stats> DuplicateTitles { get; set; }
    [JsonIgnore] public List<Stats> OverlengthTitles { get; set; }

    public int TotalPagesFound { get; set; }
    public int TotalTitleTags { get; set; }
    public int NoDuplicateTitleTags { get; set; }
    public int NoOverlengthTitleTags { get; set; }
}

ホワイトリスト:(再注文も)

[JsonObject(MemberSerialization.OptIn)] // this is important!
public class UrlStats
{
    public string URL { get; set; }
    public List<Stats> TotalPages { get; set; }
    public List<Stats> TotalTitles { get; set; }
    public List<Stats> DuplicateTitles { get; set; }
    public List<Stats> OverlengthTitles { get; set; }

    [JsonProperty] public int TotalPagesFound { get; set; }
    [JsonProperty] public int TotalTitleTags { get; set; }
    [JsonProperty] public int NoDuplicateTitleTags { get; set; }
    [JsonProperty] public int NoOverlengthTitleTags { get; set; }
}
31
fero

わかりました。質問をもう一度読んでください。データの予測をシリアル化できると思います。

以下を試すことができます。

var json = JsonConvert.SerializeObject(new { u.TotalPagesFound, u.TotalTitleTags, u.NoDuplicateTitleTags, u.NoOverlengthTitleTags } );

これにより、クラスのintプロパティのみがJSONに変換されます。これは最も簡単な方法であり、クラスの構造に関連付けられています。より一般的なものが必要な場合は、カスタムコンバーターを実装する必要があります。

元の答え:

私はあなたのクラスに問題がないと思います、あなたはループ参照のような奇妙なことは何もないので、Json.NETはあなたのクラスをシリアライズするのに問題はないはずです。 Json.NETを入手して、以下を試すことができます

// create new instance of your url stat class
var u = new UrlStats() { URL = "a.com", TotalPages = new List<Stats>() { new Stats() { URL = "b.com", Status = "xxxx" } } };
// seralize!
var json = JsonConvert.SerializeObject(u);
Console.Write(json);

この方法で得られるものは次のようなものです:

{"URL":"a.com","TotalPagesFound":0,"TotalPages":[{"URL":"b.com","Status":"xxxx","Title":null,"Description":null,"Length":0}],"TotalTitleTags":0,"TotalTitles":null,"NoDuplicateTitleTags":0,"DuplicateTitles":null,"NoOverlengthTitleTags":0,"OverlengthTitles":null}

そして、それは私には良いjsonのように見えます。

2
corrego