VB.NET-TIPS などプログラミングについて

数値データを表示するために各種の書式の文字列に変換することはよくあります。 各データ型が持つ ToString メソッドを使えば以下の様な感じでできます。

Console.WriteLine((12345).ToString("C"))            '¥12,345  と表示
Console.WriteLine((12345).ToString("D8"))           '00012345 と表示
Console.WriteLine((1234.567).ToString("00000.00"))  '01234.57 と表示

上の (12345) の部分は文字列 "12345" を Integer型 データとして変換されます。 また (1234.567) の部分は文字列 "1234.567" を Double型 データとして変換され、それぞれの ToString メソッドが呼ばれます。

ToString メソッドの引数の文字列には各種存在し、 「標準の数値書式指定文字列」と「カスタム数値書式指定文字列」の2種類があります ので、順を追って説明します。

• 「標準の数値書式指定文字列」について
• 「カスタム数値書式指定文字列」について
• 「複合書式指定文字列」について

■「標準の数値書式指定文字列」について

次の表に、標準の数値書式指定文字列の説明および書式指定子ごとのサンプル出力を示します。

書式指定子は上記の様にたくさんありますが、実際に使ったものとなると "C" と "D" ぐらいです。 指数表記は科学計算で必要になるぐらいで、私はあまり使った記憶がありません。
尚、以下のソースで簡単な例を示します。

    Private Sub btnTest_Click(sender As Object, e As EventArgs) Handles btnTest.Click
        '「Double」型データ
        Dim dbTest As Double = 0.0
        '「Long」型データ
        Dim lngTest As Long = 0

        '標準の数値書式指定文字列「C,c」
        Console.WriteLine("標準の数値書式指定文字列「C,c」")
        dbTest = 123
        Console.WriteLine(dbTest.ToString("C"))
        dbTest = 123.56
        Console.WriteLine(dbTest.ToString("C"))
        dbTest = 123.456
        Console.WriteLine(dbTest.ToString("C2"))
        dbTest = -123.56
        Console.WriteLine(dbTest.ToString("C"))

        '標準の数値書式指定文字列「D,d」
        Console.WriteLine("標準の数値書式指定文字列「D,d」")
        lngTest = 123
        Console.WriteLine(lngTest.ToString("D"))
        Console.WriteLine(lngTest.ToString("D5"))
        lngTest = -123
        Console.WriteLine(lngTest.ToString("D6"))
    End Sub

実行結果がコンソールには以下様に表示されます。

標準の数値書式指定文字列「C,c」
\123
\124
\123.46
-\124
標準の数値書式指定文字列「D,d」
123
00123
-000123

■「カスタム数値書式指定文字列」について

次の表に、カスタム数値書式指定文字列の説明および書式指定子ごとのサンプル出力を示します。 （よく使うものをピックアップしてあります）

尚、上記の例を以下のソースで示します。

    Private Sub btnTest_Click(sender As Object, e As EventArgs) Handles btnTest.Click
        '「Double」型データ
        Dim dbTest As Double

        'カスタム数値書式指定文字列["0"]
        Console.WriteLine("カスタム数値書式指定文字列[""0""]")
        dbTest = 123
        Console.WriteLine(dbTest.ToString("00000"))
        dbTest = 123.456
        Console.WriteLine(dbTest.ToString("00000.00"))
        dbTest = -123.56
        Console.WriteLine(dbTest.ToString("00000.00"))

        'カスタム数値書式指定文字列["#"]
        Console.WriteLine("カスタム数値書式指定文字列[""#""]")
        dbTest = 123
        Console.WriteLine(dbTest.ToString("#####"))
        dbTest = 123.456
        Console.WriteLine(dbTest.ToString("#####.##"))
        dbTest = -123.56
        Console.WriteLine(dbTest.ToString("#####.##"))

        'カスタム数値書式指定文字列[";"]
        Console.WriteLine("カスタム数値書式指定文字列["";""]")
        dbTest = 123
        Console.WriteLine(dbTest.ToString("#####;[#####];'ZERO'"))
        dbTest = 0
        Console.WriteLine(dbTest.ToString("#####;[#####];'ZERO'"))
        dbTest = -123.56
        Console.WriteLine(dbTest.ToString("#####.##;[#####.##];'ZERO'"))

        '最後に複合的な使い方
        Console.WriteLine("最後に複合的な使い方")
        dbTest = 12345678.123
        Console.WriteLine(dbTest.ToString("'テストデータ：'#,0.00"))
    End Sub

実行結果がコンソールには以下様に表示されます。

カスタム数値書式指定文字列["0"]
00123
00123.46
-00123.56
カスタム数値書式指定文字列["#"]
123
123.46
-123.56
カスタム数値書式指定文字列[";"]
123
ZERO
[123.56]
最後に複合的な使い方
テストデータ：12,345,678.12

■「複合書式指定文字列」について

複合書式指定文字列とは、出力される固定文字列の中に挿入されるべきデータ用のプレースホルダーを記入したものです。 このプレースホルダーはインデックス化されていて、「0」から順に番号が振られます。
この複合書式指定文字列を引数として使えるメソッドに String.Format や Console.WriteLine などがあります。 複合書式指定文字列の引数の後ろに、プレースホルダーに対応する出力したいデータを記述します。

この説明ではよく分からないので、以下の例を見てください。
{ } で囲まれた数字がインデックスで、対応するデータの引数の位置を示しているのが分かります。

    Private Sub btnTest_Click(sender As Object, e As EventArgs) Handles btnTest.Click
        Dim intData As Integer = 10
        Dim lngData As Long = 1000
        Dim dblData As Double = 123.45
        Console.WriteLine("Integer:{0}, Long:{1}, Double:{2}", intData, lngData, dblData)
    End Sub

実行結果がコンソールには以下様に表示されます。

Integer:10, Long:1000, Double:123.45

尚、プレースホルダーの書式は以下の様になっています。

<プレースホルダー書式>
{ index [,alignment] [:formatString] }

・index：パラメーター指定子とも呼ばれ、
         オブジェクトのリスト内で対応する項目を識別するための 0 から始まる数値です。 
・[,alignment]：書式設定フィールドの幅を指定する符号付き整数です。
         フィールド内の書式設定されたデータは、alignment が正の場合は右揃え、
         alignment が負の場合は左揃えされます。 埋め込みが必要な場合は、空白が使用されます。

・[:formatString]：書式設定されるオブジェクトの種類に適した書式指定文字列です。
        「標準の数値書式指定文字列」「カスタム数値形式文字列」が指定できます。

プレースホルダーの書式にいろいろ付け加えて、上記のソースを以下の様にしました。

    Private Sub btnTest_Click(sender As Object, e As EventArgs) Handles btnTest.Click
        Dim intData As Integer = 10
        Dim lngData As Long = 1000
        Dim dblData As Double = 123.45
        Console.WriteLine("Integer:{0,7:0.00}, Long:{1,-6:#,0}, Double:{2,10:###0.000}", _
                          intData, lngData, dblData)
    End Sub

実行結果がコンソールには以下様に表示されます。

Integer:  10.00, Long:1,000 , Double:   123.450

関連する記事

前回の TCP の記事では、クライアント側で1回の通信毎に TCP の接続を切断していたので、 複数回の文字列送信ができませんでした。
それで今回は、クライアント側で TCP の接続のタイミングと、文字列送信のタイミングを別々で行う様にすることで 複数回の文字列送信を可能にしています。

これを行う為に、以下のクライアント側の処理手順の中で、(1)(2)を1個の処理として、また(5)の処理も別のタイミングに追い出します。 具体的にはそれぞれフォームにボタンを設置（「Start」「Stop」の名前で）し、それぞれのクリック処理内でそれらを行います。

• (1)IP アドレスとポート番号で TcpClient クラスの生成によりTCPソケット作成・接続
• (2)TcpClient クラスの GetStream メソッドで NetworkStream を取得
• (3)NetworkStream の Write メソッドでテキストボックスの内容をバイト配列化して送信
• (4)NetworkStream の Read メソッドでサーバからの応答を受信しテキストボックスに表示
• (5)最後にネットワークストリーム、ソケットをクローズ

それでは以下にクライアント側のソースを示します。 TcpClient と NetworkStream クラスのオブジェクトを関数の外に出し、静的変数としています。

■TCP クライアント側のプログラム

Imports System.Net
Imports System.Text

Public Class frmTcpClient

    'サーバーのIPアドレス（または、ホスト名）とポート番号
    Dim strIpAddr As String = "localhost"
    Dim intPort As Integer = 60000

    'ソケット
    Dim mTcpClient As Sockets.TcpClient
    'ソケットストリーム
    Dim mNetStream As Sockets.NetworkStream

    '[Start]リック時イベント
    Private Sub btnStart_Click(sender As Object, e As EventArgs) Handles btnStart.Click
        'ソケット生成
        mTcpClient = New Sockets.TcpClient
        'ソケット接続
        mTcpClient.Connect(strIpAddr, intPort)
        'ソケットストリーム取得
        mNetStream = mTcpClient.GetStream()
    End Sub

    '[Stop]リック時イベント
    Private Sub btnStop_Click(sender As Object, e As EventArgs) Handles btnStop.Click
        'ソケットクローズ
        mNetStream.Close()
        mTcpClient.Close()
    End Sub

    '[Send]リック時イベント
    Private Sub btnSend_Click(sender As Object, e As EventArgs) Handles btnSend.Click
        Try
            '送信文字列をバイト配列変換
            Dim enc As Encoding = Encoding.GetEncoding("SHIFT-JIS")
            '最後尾にCR
            Dim data As Byte() = enc.GetBytes(Me.TextBox1.Text.Trim & ControlChars.Cr)
            Me.TextBox1.Text = ""

            'ソケット送信
            mNetStream.Write(data, 0, data.Count)

            'サーバからの応答を受信
            Dim bytRead As Byte() = New Byte(255) {}
            Dim intBytes As Integer = mNetStream.Read(bytRead, 0, bytRead.Length)

            '受信したデータを文字列に変換
            Dim resMsg As String = enc.GetString(bytRead, 0, intBytes)
            '末尾の\rを削除し表示
            Me.TextBox2.Text = resMsg.TrimEnd(ControlChars.Cr)

        Catch ex As Exception
            MsgBox(ex.Message)
        End Try
    End Sub

End Class

サーバ側のプログラムに変更は無いのですが、一応ソースを載せておきます。

■TCP サーバ側のプログラム

Imports System.Net
Imports System.Threading
Imports System.Text

Public Class frmTcpServer

    'リッチテキストボックスにメッセージを表示する
    Public Sub DispMsg(ByVal message As String)
        RichTextBox1.AppendText(message & vbNewLine)
        RichTextBox1.SelectionStart = RichTextBox1.TextLength
        RichTextBox1.Refresh()
    End Sub

    '[Start]ボタンクリック
    Private Sub btnStart_Click(sender As Object, e As EventArgs) Handles btnStart.Click
        'ボタン制御
        Me.btnStart.Enabled = False

        'ポート番号
        Dim pintPort As Integer = 60000
        'IPアドレス＆ポート番号設定
        Dim pEndPoint As New IPEndPoint(IPAddress.Any, pintPort)
        'ソケット・リスナー作成
        Dim pListener As New Sockets.TcpListener(pEndPoint)
        'リスナー開始
        pListener.Start()
        Call DispMsg("リスナー開始...")

        'クライアントから接続有りでこの処理を抜ける
        Dim pTcpClient As Sockets.TcpClient = pListener.AcceptTcpClient()
        Call DispMsg("クライアントから接続有り...")

        '送受信用ソケットストリーム取得
        Dim pNetStream As Sockets.NetworkStream = pTcpClient.GetStream()

        'バイト配列(取敢えず受信バッファとして256バイト)
        Dim bytRead As Byte() = New Byte(255) {}

        'ソケット受送信ループ
        While True
            'TCP受信(バッファ領域まで)
            Dim intBytes As Integer = pNetStream.Read(bytRead, 0, bytRead.Count)
            If intBytes = 0 Then
                Exit While
            End If

            '受信したデータを文字列に変換
            Dim enc As Encoding = Encoding.GetEncoding("SHIFT-JIS")
            Dim resMsg As String = enc.GetString(bytRead, 0, intBytes)
            '末尾の\rを削除
            resMsg = resMsg.TrimEnd(ControlChars.Cr)
            '表示
            Call DispMsg(resMsg)

            '正常受信の場合、送信データ作成
            Dim bytSend() As Byte = enc.GetBytes(resMsg & "...ACK" & ControlChars.Cr)
            'ソケット送信
            pNetStream.Write(bytSend, 0, bytSend.Length)
        End While

        'ソケットストリームクローズ
        pNetStream.Close()
        'クライアントクローズ
        pTcpClient.Close()
        'リスナー停止
        pListener.Stop()
        Call DispMsg("リスナー停止...")

        'ボタン制御
        Me.btnStart.Enabled = True
    End Sub

End Class

実際の実行は以下の様になります。

サーバ側の「Start」押下後、クライアント側の「Start」を押下し”abcdef”,”123456”,”ABCDEFGHI”の順に文字列を「Send」し、 更に「Stop」を押下したところまでを表しています。

ここまでのPGはサーバとクライアントが1対1のみでしか動作しません。 しかし、これでは面白くありませんので、次回は複数のクライアントからの接続を受け付けるものを紹介したいと思います。

関連する記事

このページでは TCP を使ったプロセス（EXE）間で通信について説明します。 （いわゆる TCP クライアント・サーバプログラム を作ることになります。）

TCP クライアントは TcpClient クラスを、 TCP サーバは TcpListener クラスを使います。
そこで先ずは TCP サーバのプログラムの例を示します。 今回の処理は TCP での受信待ち状態にし、クライアントからの1回のメッセージを受信し、 そのメッセージをクライアント側に返し、処理が終わるという簡単なものです。 以下にその手順を示します。

• IP アドレスとポート番号でネットワークエンドポイントを作成し TcpListener クラスの生成
• TcpListener クラスの Start メソッドで受信接続要求の待機を開始
• TcpListener クラスの AcceptTcpClient メソッドでクライアントからの接続要求を待機
• 接続要求待機を抜けた後で送受信用ソケットストリーム取得
• ソケットストリームからデータ受信し、さらにデータを送信
• 最後にソケットストリーム等をクローズし、リスナーを停止

以下にそのソースを示します。 フォーム上にはサーバ開始用の「start」ボタンと、送受信文字列等を表示する為に RichTextBox を設置しています。

■TCP サーバープログラム

Imports System.Net
Imports System.Threading
Imports System.Text

Public Class frmTcpServer

    'リッチテキストボックスにメッセージを表示する
    Public Sub DispMsg(ByVal message As String)
        RichTextBox1.AppendText(message & vbNewLine)
        RichTextBox1.SelectionStart = RichTextBox1.TextLength
        RichTextBox1.Refresh()
    End Sub

    '[Start]ボタンクリック
    Private Sub btnStart_Click(sender As Object, e As EventArgs) Handles btnStart.Click
        'ボタン制御
        Me.btnStart.Enabled = False

        'ポート番号
        Dim pintPort As Integer = 60000
        'IPアドレス＆ポート番号設定
        Dim pEndPoint As New IPEndPoint(IPAddress.Any, pintPort)
        'ソケット・リスナー作成
        Dim pListener As New Sockets.TcpListener(pEndPoint)
        'リスナー開始
        pListener.Start()
        Call DispMsg("リスナー開始...")

        'クライアントから接続有りでこの処理を抜ける
        Dim pTcpClient As Sockets.TcpClient = pListener.AcceptTcpClient()
        Call DispMsg("クライアントから接続有り...")

        '送受信用ソケットストリーム取得
        Dim pNetStream As Sockets.NetworkStream = pTcpClient.GetStream()

        'バイト配列(取敢えず受信バッファとして256バイト)
        Dim bytRead As Byte() = New Byte(255) {}

        'ソケット受送信ループ
        While True
            'TCP受信(バッファ領域まで)
            Dim intBytes As Integer = pNetStream.Read(bytRead, 0, bytRead.Count)
            If intBytes = 0 Then
                Exit While
            End If

            '受信したデータを文字列に変換
            Dim enc As Encoding = Encoding.GetEncoding("SHIFT-JIS")
            Dim resMsg As String = enc.GetString(bytRead, 0, intBytes)
            '末尾の\rを削除
            resMsg = resMsg.TrimEnd(ControlChars.Cr)
            '表示
            Call DispMsg(resMsg)

            '正常受信の場合、送信データ作成
            Dim bytSend() As Byte = enc.GetBytes(resMsg & "...ACK" & ControlChars.Cr)
            'ソケット送信
            pNetStream.Write(bytSend, 0, bytSend.Length)
        End While

        'ソケットストリームクローズ
        pNetStream.Close()
        'クライアントクローズ
        pTcpClient.Close()
        'リスナー停止
        pListener.Stop()
        Call DispMsg("リスナー停止...")

        'ボタン制御
        Me.btnStart.Enabled = True
    End Sub

End Class

以下に TCP クライアントのプログラムの例を示します。 この処理は、TCPソケットを作成・接続した後で、NetworkStream によりサーバへデータを送信し、 その後サーバからの応答を受信します。

• IP アドレスとポート番号で TcpClient クラスの生成によりTCPソケット作成・接続
• TcpClient クラスの GetStream メソッドで NetworkStream を取得
• NetworkStream の Write メソッドでテキストボックスの内容をバイト配列化して送信
• NetworkStream の Read メソッドでサーバからの応答を受信しテキストボックスに表示
• 最後にネットワークストリーム、ソケットをクローズ

以下にそのソースを示します。 フォーム上には送信文字列用と受信文字列用のテキストボックス、送信開始用の「Send」ボタンを設置しています。

■TCP クライアントプログラム

Imports System.Net
Imports System.Text

Public Class frmTcpClient

    '[Send]リック時イベント
    Private Sub btnSend_Click(sender As Object, e As EventArgs) Handles btnSend.Click
        Me.btnSend.Enabled = False
        Try
            'サーバーのIPアドレス（または、ホスト名）とポート番号
            Dim strIpAddr As String = "localhost"
            Dim intPort As Integer = 60000

            'ソケット生成・指定したホストの指定したポートに接続
            Dim pTcpClient = New Sockets.TcpClient(strIpAddr, intPort)
            'ソケットストリーム取得
            Dim pNetStream As Sockets.NetworkStream = pTcpClient.GetStream()

            '送信文字列をバイト配列変換
            Dim enc As Encoding = Encoding.GetEncoding("SHIFT-JIS")
            '最後尾にCR
            Dim data As Byte() = enc.GetBytes(Me.TextBox1.Text.Trim & ControlChars.Cr)
            Me.TextBox1.Text = ""

            'ソケット送信
            pNetStream.Write(data, 0, data.Count)

            'サーバからの応答を受信
            Dim bytRead As Byte() = New Byte(255) {}
            Dim intBytes As Integer = pNetStream.Read(bytRead, 0, bytRead.Length)

            '受信したデータを文字列に変換
            Dim resMsg As String = enc.GetString(bytRead, 0, intBytes)
            '末尾の\rを削除し表示
            Me.TextBox2.Text = resMsg.TrimEnd(ControlChars.Cr)

            'ソケットクローズ
            pNetStream.Close()
            pTcpClient.Close()

        Catch ex As Exception
            MsgBox(ex.Message)
        End Try

        Me.btnSend.Enabled = True
    End Sub

End Class

実際の実行は以下の様になります。

今回のPGはクライアント側で文字列送信後すぐに接続を切っていますので、 1回の送受信毎にサーバ側で「start」をクリックしないといけないので実用には供しないですが、ご参考になればと思います。

次回はこれを踏まえて、サーバ側で開始したらそのまま連続でクライアントからの受信と送信を出来る様にしたいと思います。

関連する記事