質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

90.98%

  • C#

    5805questions

    C#はマルチパラダイムプログラミング言語の1つで、命令形・宣言型・関数型・ジェネリック型・コンポーネント指向・オブジェクティブ指向のプログラミング開発すべてに対応しています。

[C#] 構造化データを順序保証してJSON形式で出力したいとき、元データはどう作るのがよいでしょうか

解決済

回答 2

投稿

  • 評価
  • クリップ 0
  • VIEW 263

yamaguri

score 7

前提・実現したいこと

  • 実現したいこと
    ある構造化されたエラーログを、順序が決まったJSON形式で出力したいです。
    JSON出力はJsonConvert.SerializeObject()を使えば良いのですが、元となるデータの作り方で悩んでいます。

  • 前提
    エラーログは発生エラーに応じて項目が増減する。
    項目の順序は決まっており、実装依存には出来ない。
    項目は構造化(ネスト)されている。

LogA
{
    "date" : "2017/09/22",
    "level" : "info",
    "message" : "aaaaa"
}
LogB
{
    "date" : "2017/09/22",
    "level" : "error",
    "message" : "bbbbb",
    "method" : {
        "name" : "MethodA",
        "exception" : "ArgumentException"
    }
}
  • 環境
    ASP.NET
    .NET Framework 4.6.2

試したこと

1. Dictionaryを使う

  • 利点
    項目の増減に対応しやすい。
    Dictionary<string, object>とすれば、ネストにも対応できる。
  • 欠点
    挿入順保証がされていない。(Addしかしない場合は挿入順になるという記事もありましたが...。)

2. OrderedDictionaryを使う

  • 利点
    Dictionaryクラスの利点に加え、挿入順保証もされている。
  • 欠点
    非ジェネリッククラスである。

3. 匿名型を使う

  • 利点
    挿入順は実装次第なので実現は可能。ネストも可。
  • 欠点
    項目の増減が宣言時しか出来ないため、組み方が難しい。

4. 専用のクラスを作る

  • 利点
    C#的なお作法?
    サブクラスを定義していけばネストできる。
  • 欠点
    フルスペックなクラスを作って、そのままJSON化すると不要な項目まで出力されてしまう。
    nullなプロパティはシリアライズしないなど、シリアライズ用のメソッドが大変そう。

 個人的な見解

OrderedDictionaryを使うのが一番楽かと思うのですが、非ジェネリッククラスを使うのは非推奨なのでしょうか。

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

回答 2

check解決した方法

+1

 解決方法

最終的には別クラスからもロギング処理を使う必要が出たため、出力メソッドごと専用クラス化しました。
DataMemberAttributeを使う方法を回答いただいていましたが、Json.Netの場合はNullValueHandlingプロパティを使うことでnull除外出来るようです。
c# - How to ignore a property in class if null, using json.net - Stack Overflow

 実装例

    public class SampleJsonData
    {
        [JsonProperty]
        public string date;
        [JsonProperty]
        public string level;
        [JsonProperty]
        public string message;
        [JsonProperty]
        public MethodInfo method;

        public class MethodInfo
        {
            [JsonProperty]
            public string name;
            [JsonProperty]
            public string exception;
        }

        public void Log() {
            Console.WriteLine(
                JsonConvert.SerializeObject(
                    this,
                    Newtonsoft.Json.Formatting.Indented,
                    new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore }
                )
            );
        }
    }
    class Program
    {
        static void Main( string[] args ) {
            var a = new SampleJsonData();

            a.date = "2017/09/22";
            a.level = "info";
            a.message = "aaaaa";
            a.Log();

            var b = new SampleJsonData();

            b.date = "2017/09/22";
            b.level = "error";
            b.message = "bbbbb";
            b.method = new SampleJsonData.MethodInfo {
                name = "MethodA",
                exception = "ArgumentException"
            };
            b.Log();
        }
    }

Console出力

{
  "date": "2017/09/22",
  "level": "info",
  "message": "aaaaa"
}
{
  "date": "2017/09/22",
  "level": "error",
  "message": "bbbbb",
  "method": {
    "name": "MethodA",
    "exception": "ArgumentException"
  }
}

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

+1

ちょうど先日”4. 専用のクラスを作る”をやってみました。

出力する項目はJSON データをシリアル化および逆シリアル化する及びDataMemberAttribute クラスを参考にしました。

DataMemberアトリビュートで出力項目と出力順のコントロールができます。EmitDefaultValue=falseを使うとnullは出力しないようですね。(<-ためしていない)

あとjsonは読みやすいけど、そこそこの件数を出力すると結局読みずらいので、私は、整形はほどほどにしておいた方がよい気がします。

投稿

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2017/09/24 12:43

    回答ありがとうございます。
    DataMemberAttributeは知らなかったので試してみます。

    確かに、jsonがつらつらと出力されると読みづらいですね。
    本来は1ログ1行で出力し、ログレベルが高いものがあればピックアップして見る予定なので、運用回避できるかと思います。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 90.98%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る

  • C#

    5805questions

    C#はマルチパラダイムプログラミング言語の1つで、命令形・宣言型・関数型・ジェネリック型・コンポーネント指向・オブジェクティブ指向のプログラミング開発すべてに対応しています。

  • トップ
  • C#に関する質問
  • [C#] 構造化データを順序保証してJSON形式で出力したいとき、元データはどう作るのがよいでしょうか