コメント
コメントの投稿
※名前とタイトルが入力されていないコメントでは他のコメントとの区別ができません。
入力されていないコメントには返信しませんのであらかじめご了承くださいませ。
クラスをJSON形式の文字列データに変換する方法 -シリアライズ- | VB.NET
- 2019/09/01
- 11:52
以前の記事で VB.NETで JSON 文字列をクラスに変換するデシリアライズの方法を覚え書きしましたが、今回はその逆でクラスのインスタンスを JSON 文字列に変換する方法について覚え書きします。
JSON は NuGet パッケージをインストールして簡単に実現可能なソースコードが公開されていますが、不要な DLL を参照することになりますし、何かあった時の為にできるだけ外部 DLL には頼らないほうが良いと考えていますので、今回のコードは全て .Net のマネージコードなので、汎用性が高いものと考えています。
前提条件
Windows 7 professional 以降 / Windows Server 2008 R2 以降
Visual Studio 2010 professional 以降
VB.net
.Net FrameWork 4.0 以降
１．ViewModelクラス
json 形式のデータを保持するためのクラスを作成します。ポイントとしては、変換するオブジェクトのクラス名に DataContract の属性を設定し、プロパティには DataMember 属性を設定します。プロパティの名称はjsonの文字列と全く同じにします。（大文字小文字記号など区別されます）
※プロジェクトの参照設定に System.Runtime.Serialization.dll を追加することが前提です。
Customer.vb
Imports System.Runtime.Serialization
<DataContract()>
Public Class Customer
<DataMember()>
Public Property Id As Integer = 0
<DataMember()>
Public Property Name As String = String.Empty
<DataMember()>
Public Property Age As Integer = 0
<DataMember()>
Public Property Gender As Integer = 0
End Class
２．JSON 文字列に変換する方法
System.IO.MemoryStream と StreamReader でインスタンスを読み込み、DataContractJsonSerializer （シリアライザー）でシリアライズした文字列を取得します。※プロジェクトの参照設定に System.Runtime.Serialization.dll を追加することが前提です。
JsonUtility.vb
Imports System.Runtime.Serialization.Json
Public Class JsonUtility
''' <summary>
''' オブジェクトをJSON文字列に変換する
''' </summary>
''' <param name="obj">変換するオブジェクト型</param>
''' <returns>変換後のJSON文字列</returns>
''' <remarks></remarks>
Public Shared Function GetJson(ByVal obj As Object) As String
'JSON文字列にシリアライズ
Dim tp As Type = obj.GetType
Dim result As String = String.Empty
Dim serializer As New DataContractJsonSerializer(tp)
Using stream As New IO.MemoryStream()
Using sr As New IO.StreamReader(stream)
serializer.WriteObject(stream, obj)
stream.Position = 0
result = sr.ReadToEnd
End Using
End Using
Return result
End Function
End Class
３．使用方法
先ほど作成した JsonUtility を以下のように呼び出し、引数にクラスのインスタンスを渡した結果を変数に格納します。TestForm.vb
Private Sub btnReadInstance_Click(sender As Object, e As EventArgs) Handles btnReadXml.Click
Dim entity As New Customer()
entity.Id = 1
entity.Name = "名前１"
entity.Age = 10
entity.Gender = 1
Dim json As String = JsonUtility.GetJson(entity)
Console.WriteLine(json)
End Sub
以上で クラスのインスタンスを JSON 文字列に変換することができます。
最後までお読みいただき、ありがとうございます。
他にも VB.net に関する記事 をご紹介しておりますのでご参考頂ければ幸いです。
- 関連記事
-
- クラスをJSON形式の文字列データに変換する方法 -シリアライズ- | VB.NET
- 令和元号に対応する動的な元号の取得方法 | VB.NET
- データセットに複数列のリレーションを追加する方法 | VB.NET
- JSON形式の文字列データをクラスに変換する方法 -デシリアライズ- | VB.NET
- XMLデータから配列を含むクラスに変換する方法 -デシリアライズ- | VB.NET
