Visual Basic .NETでJSONデータを取り扱うのにJson .NETが便利。JSON文字列データをDeserialize時の格納クラスを円滑に定義するための備忘録である。
※Json .NET：NuGet上パッケージ名は NewtonSoft.Json
課題
Json .NET を用いると、以下コードのようにSourceのJSON文字列をMyClassの形式に格納出来る。
Dim StructuredData = JsonConvert.DeserializeObject(Of MyClass)(source)
しかしこのMyClassをどう定義するかが初心者には難しい。
もっと具体的に言えば、YouTube Data API V3のデータを取り扱おうと思っても、入れ子にされたデータに対してどうクラスを定義すればStructuredDataに格納できるかに悩む。複雑なデータをお手軽快適に取り扱うのが課題だった。
結論
直下のデータ
基本的なデータの取り扱い
配列ではない個別項目にアクセスしたい場合はそれぞれプロパティを定義する。つまり、以下例であればPublic Property kind As String と定義し Debug.Print (StructuredData.kind) という形で使える。
{
__”kind”: “youtube#playlistItemListResponse”,
__”etag”: “XXX_XXXXXXXXXXXXX_X-XXXXXXX”,
__”nextPageToken”: “XXXXXXXXXXXXXX”,
↓
Public Class MyClass
__Public Property kind As String
__Public Property etag As String
__Public Property nextPageToken As String
End Class
同じ階層の全データが同じデータ型のKey-Valueの形になっている場合
以下 pageInfo 項目内、totalResults, resultsPerPage は両方とも String – Long 構成とみなせる。
{
__”kind”: “youtube#playlistItemListResponse”,
__”etag”: “XXX_XXXXXXXXXXXXX_X-XXXXXXX”,
__”pageInfo”: {
____”totalResults”: 11,
____”resultsPerPage”: 10
__}
}
この場合はPublic Property kv As Dictionary(Of DataTypeKey, DataTypeValue) の形で定義すればDebug.Print (kv(“kind”))のように必要項目のみKEY指定して扱える。
Public Class MyClass
__Public Property pageInfo As Dictionary(Of String, Long)
End Class
更に下の階層のデータを持つ項目がある場合・データ型が異なる場合
Public Class MyClass
__Public Property kind As String
__Public Property etag As String
__Public Property pageInfo As Dictionary(Of String, Long)
End Class
個別にプロパティを設けて厳密にアクセスしたい場合は個別に項目を定義する。つまり、Public Property kind As String と定義し Debug.Print (StructuredData.kind) という形で使える。
配列データ
変数名の右に [ 記号でくくってある場合は配列データである。
.NET で規定されている型のデータが配列になっている場合
以下構成であれば Public Property name As List(Of String) で定義すれば良い。 ※YouTubeAPI出力になかったので動作未確認。
__”name”: [
____”AAA”,
____”BBB”
__],
↓
Public Class MyClass
__Public Property name As List(Of String)
End Class
.NET で規定されていない型のデータが配列になっている場合
対象の配列（下の例であればitems, snippet）それぞれをまるまるクラスとして定義し、上述の応用で配列のやり方（Public Property items As List(Of NestedClass), Public Property snippet As NestedNestedClass）で配列項目または個別項目と決めればよい。
{
__”kind”: “youtube#playlistItemListResponse”,
__”etag”: “XXX_XXXXXXXXXXXXX_X-XXXXXXX”,
__”nextPageToken”: “XXXXXXXXXXXXXX”,
__”items”: [
____{
______”kind”: “youtube#playlistItem”,
______”etag”: “XXXXXXXXXXXXXXXXXXXX_XXXXXX”,
______”id”: “XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX”,
______”snippet”: {
________”publishedAt”: “2022-02-20T17:23:00Z”,
________”resourceId”: {
__________”kind”: “youtube#video”,
__________”videoId”: “XXXXXXXXXXX”
________},
↓
Public Class MyClass
__Public Property kind As String
__Public Property etag As String
__Public Property nextPageToken As String
__Public Property items As List(Of NestedClass)
End Class
Public Class NestedClass
__Public Property kind As String
__Public Property etag As String
__Public Property id As String
__Public Property snippet As NestedNestedClass
End Class
Public Class NestedNestedClass
__Public Property publishedAt As Date
__Public Property resourceId As Dictionary(Of String, String)
End Class
調査実施環境：
- Windows 11
- Visual Studio .NET 2019
- .NET Core 3.1
- Json .NET .NET Standard 2.0 Version 13.0.1.25517
