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

###前提・実現したいこと

実現したいこと

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

前提

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

lang
1LogA
2{
3    "date" : "2017/09/22",
4    "level" : "info",
5    "message" : "aaaaa"
6}

lang
1LogB
2{
3    "date" : "2017/09/22",
4    "level" : "error",
5    "message" : "bbbbb",
6    "method" : {
7        "name" : "MethodA",
8        "exception" : "ArgumentException"
9    }
10}

環境

ASP.NET
.NET Framework 4.6.2

###試したこと

####1. Dictionaryを使う

利点

項目の増減に対応しやすい。
Dictionary<string, object>とすれば、ネストにも対応できる。

欠点

挿入順保証がされていない。（Addしかしない場合は挿入順になるという記事もありましたが...。）

####2. OrderedDictionaryを使う

利点

Dictionaryクラスの利点に加え、挿入順保証もされている。

欠点

非ジェネリッククラスである。

####3. 匿名型を使う

利点

挿入順は実装次第なので実現は可能。ネストも可。

欠点

項目の増減が宣言時しか出来ないため、組み方が難しい。

####4. 専用のクラスを作る

利点

C#的なお作法？
サブクラスを定義していけばネストできる。

欠点

フルスペックなクラスを作って、そのままJSON化すると不要な項目まで出力されてしまう。
nullなプロパティはシリアライズしないなど、シリアライズ用のメソッドが大変そう。

個人的な見解

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

行動規範の内容に同意します

回答2件

自己解決

解決方法

最終的には別クラスからもロギング処理を使う必要が出たため、出力メソッドごと専用クラス化しました。
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"
  }
}

投稿2017/10/05 05:04

yamaguri

総合スコア13