読者です 読者をやめる 読者になる 読者になる

.NETでTCPを使って通信する(TcpClientとTcpListenerを使う)

.NETで通信するプログラムに興味が出てきたので調べたりしています。ネットワークプログラミングと言うんですかね。まずはやっぱりTCPかなと思うので、TCPを使って通信する簡単なクライアントとサーバのサンプルコードを書いてみました。

.NETでTCPを使って通信するにはTcpClientとTcpListenerを使います。

より細かく制御できるSocketを使う方法もあるようです。いい勉強になりそうだとは思うのですがなかなか難しそうなのでソケットはまた別で試したいと思います。というフラグ立て。

クライアント

クライアントもサーバもHTTPをイメージしてリクエストとレスポンスのメッセージをやりとりする動きにしました。まずはクライアントの動きです。

クライアントの動き

  1. サーバに接続
  2. サーバにリクエストを送信する
  3. サーバからレスポンスを受信する

クライアントのサンプルコード

上記の動きをするクライアントのサンプルコードです。クライアント側ではTcpClientを使います。エンドポイントとはIPアドレスとポート番号のセットのことです。

// クライアント
public class Client<TRequest, TResponse> {
    // 接続先のエンドポイント
    private readonly IPEndPoint _endpoint;

    public Client(IPEndPoint endpoint) {
        _endpoint = endpoint;
    }

    // サーバにリクエストを送信してレスポンスを受信する
    public async Task<TResponse> Send(TRequest request) {
        using (var client = new TcpClient()) {
            // 1. サーバに接続
            await client.ConnectAsync(_endpoint.Address, _endpoint.Port);

            using (var stream = client.GetStream()) {
                // 2. サーバにリクエストを送信する
                Console.WriteLine($"Client send: {request}");
                stream.WriteObject(request);

                // 3. サーバからレスポンスを受信する
                var response = stream.ReadObject<TResponse>();
                Console.WriteLine($"Client received: {response}");

                return response;
            }
        }
    }
}

Stream.WriteObject、Stream.ReadObjectは自作した拡張メソッドです。WriteObjectはオブジェクトをバイト配列に変換してストリームに書き込みます。ReadObjectはストリームから読み込んだバイト配列をオブジェクトとして取得します。

サーバ

続いてサーバです。クライアントと比べるとちょっと複雑です。

サーバの動き

  1. クライアントからの接続を待つ
  2. クライアントからの接続を受け入れる
  3. クライアントからリクエストを受信する
  4. リクエストを処理してレスポンスを作る
  5. クライアントにレスポンスを送信する

3から5は複数のクライアントからのリクエストを並列に処理できるようにしています。

サーバのサンプルコード

サーバではまずTcpListenerを使ってクライアントからの接続を待ちます。クライアントから接続されると今度はTcpClientを使ってメッセージを読み書きすると言った感じになります。

// サーバ
public class Server<TRequest, TResponse> {
    // 接続を待つエンドポイント
    private readonly IPEndPoint _endpoint;

    // リクエストからレスポンスを作成する処理
    private readonly Func<TRequest, TResponse> _processor;

    // TCPリスナー
    private readonly TcpListener _listener;

    public Server(IPEndPoint endpoint, Func<TRequest, TResponse> processor) {
        _endpoint = endpoint;
        _processor = processor;
        _listener = new TcpListener(_endpoint);
    }

    // クライアントからリクエストを受信してレスポンスを送信する
    private void Receive(TcpClient client) {
        using (client)
        using (var stream = client.GetStream()) {
            // 3. クライアントからリクエストを受信する
            var request = stream.ReadObject<TRequest>();

            // 4. リクエストを処理してレスポンスを作る
            var response = _processor(request);

            // 5. クライアントにレスポンスを送信する
            stream.WriteObject(response);
        }
    }

    // 接続を待つ
    public async Task Listen() {
        Console.WriteLine($"Server listen:");
        // 1. クライアントからの接続を待つ
        _listener.Start();

        while (true) {
            // 2. クライアントからの接続を受け入れる
            var client = await _listener.AcceptTcpClientAsync();
            Console.WriteLine($"Server accepted:");

            var task = Task.Run(() => Receive(client));

            // Taskの管理やエラー処理は省略
        }
    }

    // 終了する
    public void Close() {
        _listener.Stop();
    }
}

なるべく簡単なサンプルにするためにエラー処理やTaskの管理など省いていますが、ベースとしてはこんな感じかなと。実際作り込むには色々考えることがありそうに思ったり。

クライアントとサーバを実行してみる

サーバを動かしてクライアントも実行してみます。

class Program {
    static void Main(string[] args) {
        // サーバが接続を待つエンドポイント
        // であり
        // クライアントが接続するサーバのエンドポイント
        var endpoint = new IPEndPoint(IPAddress.Loopback, 54321);

        // サーバ
        var server = new Server<Message, Message>(
            endpoint,
            // リクエストからレスポンスを作る処理
            request => new Message {
                Id = request.Id,
                // メッセージの文字列を逆順にする
                Content = new string(request.Content.Reverse().ToArray()),
            });
        // 接続を待機
        var task = Task.Run(() => server.Listen());

        // クライアント
        Task.WaitAll(
            // リクエストを送信してレスポンスを受信
            new Client<Message, Message>(endpoint).Send(new Message { Id = 10, Content = "あいうえお" }),
            new Client<Message, Message>(endpoint).Send(new Message { Id = 20, Content = "かきくけこ" }),
            new Client<Message, Message>(endpoint).Send(new Message { Id = 30, Content = "さしすせそ" })
        );

        // サーバを終了
        server.Close();
        // サーバの終了処理、Taskの管理、エラー処理あたりが微妙
    }
}

// 実行結果(実行するたびに変わる)
/*
Server listen:
Server accepted:
Server accepted:
Client send: { Id = 10, Content = "あいうえお" }
Client send: { Id = 30, Content = "さしすせそ" }
Server accepted:
Client send: { Id = 20, Content = "かきくけこ" }
Client received: { Id = 30, Content = "そせすしさ" }
Client received: { Id = 10, Content = "おえういあ" }
Client received: { Id = 20, Content = "こけくきか" }
*/

実行結果やデバッグ実行で分かりやすくするために、同じプロセス内でクライアントもサーバも動かしています。あとサーバ(リスナー)の終了の仕方とかTaskの管理とか微妙かもです。

ソース全体はこちらに。

SQL Server - OPENROWSETでJSONファイルを読み込んでOPENJSON

前回、OPENJSONを使ってJSON文字列を結果セットに変換してみました。

ichiroku11.hatenablog.jp

そのあとにそういえば「JSONファイル」を読み込んでOPENJSONを使う方法を知らないなと思いました。検索してみると次の記事が見つかります。

Importing JSON files into SQL Server using OPENROWSET (BULK) | SQL Server Database Engine Blog

この記事の二番煎じもいいところですが、OPENROWSETもCROSS APPLYもたぶんあまり使ったことがない気がするので試してみました。

まずJSONファイルを用意します。

{
    "entries": [
        { "id": 10, "name": "" },
        { "id": 30, "name": "" },
        { "id": 20, "name": "" }
    ]
}

JSONファイルはC:\Temp\sample.jsonにあるとします。このファイルを読み込んで結果セットに変換するクエリは次のように書きます。

select Id, Name
from
    -- OPENROWSETでJSONファイルを読み込む
    -- SINGLE_NCLOBを指定して1行1列の結果セットを取得する
    -- 結果セットにJson(Text)という名前を付ける
    openrowset(bulk N'C:\Temp\sample.json', SINGLE_NCLOB) as Json(Text)
    -- 結果セットのJson.Textに対してCROSS APPLYでOPENJSONを呼び出す
    cross apply
        openjson(Json.Text, N'$.entries')
        with(
            Id int N'$.id',
            Name nvarchar(10) N'$.name'
        )
order by Id;

-- 実行結果
/*
Id          Name
----------- ----------
10          あ
20          う
30          い
*/

OPENROWSETの引数にSINGLE_NCLOBを指定すると、ファイルの内容をnvarchar(max)の1行1列の結果セットとして取得できます。CROSS APPLYは結果セットの行ごとに関数を呼び出します。今回の結果セットは1行なのでOPENJSONは1回だけ呼ばれているはずです。

参考

SQL Server - OPENJSONは役に立つ

SQL Server 2016から手軽にJSONを扱えるようになっています。

MSDNなどを読みながら勉強している最中で全体を把握しているわけではないですが、SQL ServerJSONサポートは次の2つの機能がメインなのかなと思います。

機能 概要
FOR JSON 結果セットJSON文字列に変換する
OPENJSON関数 JSON文字列結果セットに変換する

ここではSELECT文で取得できる行と列の表形式のデータを「結果セット」と言っています。たぶん言いますよね。行セットとも言うのかもしれません。

そしてOPENJSONの使い方を知っているとJSON文字列を解析したり、集計や抽出するときなどになかなか役に立つのかなと思うので、クエリを書きながら使い方を覚えていきたいと思います。

まずOPENJSONには

の2つがあります。

OPENJSON (TRANSACT-SQL)

今回は明示的なスキーマを指定する方法を試します。正直なところ既定のスキーマはあまり使わないのかな?と。

明示的なスキーマを指定してOPENJSON

明示的なスキーマを指定するとは、結果セットで取得したいスキーマをWITH句で指定することです。WITH句を使わないと既定のスキーマになります。

早速クエリを。

-- JSON文字列
declare @json nvarchar(max) = N'[
  { "id": 10, "name": "Aaa" },
  { "id": 30, "name": "Ccc" },
  { "id": 20, "name": "Bbb" },
  { "id": 99, "name": "Xxx" }
]';

-- OPENJSONを使ってJSON文字列を結果セットに
select *
from openjson(@json)
with(   -- 結果セットのスキーマ(Id, Nameカラムを持つスキーマ)を指定する
    Id int N'$.id',    -- "id"プロパティをIdカラムとする
    Name nvarchar(10) N'$.name'   -- "name"プロパティをNameカラムとする
)
order by Id;

-- 実行結果
/*
Id          Name
----------- ----------
10          Aaa
20          Bbb
30          Ccc
99          Xxx
*/

OPENJSONの引数にはJSON文字列を渡します。

WITH句では結果セットのスキーマをカラムごとにカラム名、データ型、JSONパス式の順で指定します。CREATE TABLEのカラム定義に似ていますね。指定したカラムは普通のテーブルのカラムのようにORDER BY句などで利用できます。

この中で見慣れないのはJSONパス式かなと思いますが、ざっくり言うとJavaScriptオブジェクトのプロパティアクセスのような文字列です。

JSON パス式 (SQL Server)

ドル記号($)については以下の記述がありますが、コンテキストアイテムは「JSON文字列をパースして取得できたオブジェクト」という解釈でいいのかなと思います。

ドル記号 ($) はコンテキスト アイテムを表します。

パス式を指定してOPENJSON

OPENJSONは2つ目の引数にJSONパス式を渡すこともできます。JSONパス式を渡すと取得するオブジェクト(コンテキストアイテム)を指定できます。

declare @json nvarchar(max) = N'{
  "entries": [
      { "id": 10, "name": "Aaa" },
      { "id": 30, "name": "Ccc" },
      { "id": 20, "name": "Bbb" },
      { "id": 99, "name": "Xxx" }
  ]
}';

-- "entries"プロパティが指す配列を取得したいとして
select *
-- OPENJSONの2つ目の引数に取得したいオブジェクトへのJSONパスを指定
from openjson(@json, N'$.entries')
with(
    Id int N'$.id',
    Name nvarchar(10) N'$.name'
);

-- 実行結果
/*
Id          Name
----------- ----------
10          Aaa
30          Ccc
20          Bbb
99          Xxx
*/

とりあえずこんなところで。

OPENJSONはJSONをごにょごにょしたいときに役に立つかなと思いました。

その他の参考

数値や文字列を右詰して前を「0(ゼロ)」で埋める(T-SQL)

T-SQLの小ネタです。

数値や文字列を右詰して前を「0(ゼロ)」で埋めた文字列を作ります。

前回はC#でやってみたので今回はT-SQLです。

ichiroku11.hatenablog.jp

数値の右詰と0埋め

数値の場合はSQL Server 2012から追加されているFORMAT関数を使います。C#と同じような書式を指定できます。

-- 3桁の数値を右詰と0埋めして5桁に
declare @number int = 123;
print format(@number, N'd5');
print format(@number, N'00000');  -- またはこれ

-- 実行結果
-- 00123
-- 00123

SQL Server 2012以前は省略(・・・調べていません)。

参考

文字列の右詰と0埋め

文字列の場合はRIGHT関数を使って次のようにするといいみたいです。

-- 3桁の文字列を右詰と0埋めして5桁に
declare @text varchar(3) = N'123';
print right('00000' + @text, 5);

-- 実行結果
-- 00123
参考

数値や文字列を右詰して前を「0(ゼロ)」で埋める(C#)

C#の小ネタです。まぁいつも小ネタですが。

数値や文字列を右詰(右寄せ?)して前を「0(ゼロ)」で埋めた文字列を作ります。

数値の右詰と0埋め

数値の場合はstring.FormatメソッドかToStringメソッドで標準の10進数"D"数値書式指定を使います。"0"カスタム指定子を使ってもできますが標準のほうでいいのかな?と。

// 3桁の数値を右詰と0埋めして5桁に
var number = 123;
Console.WriteLine(string.Format($"{number:d5}"));   // 標準の数値書式指定
Console.WriteLine(number.ToString("d5"));    // ToStringを使うと
Console.WriteLine(string.Format($"{number:00000}"));    // カスタム数値書式指定

// 実行結果
// 00123
// 00123
// 00123
参考

文字列の右詰と0埋め

文字列の場合はstring.PadLeftメソッドを使います。

// 3桁の文字列を右詰と0埋めして5桁に
var text = "123";
Console.WriteLine(text.PadLeft(5, '0'));

// 実行結果
// 00123
参考