WindowsFormからのWebAPIの非同期呼び出し

Question

前提・実現したいこと

既に実装されて提供されているASP.NET WebAPIで実装されたAPIを呼び出して、サーバで生成されたデータをクライアントにダウンロードしたいです。クライアントはWindowsFormです。
開発環境はVS2022、.NET6です。

用意されているAPIの概要

①データ作成要求API
条件を渡して呼び出すと、API側でデータ作成用のバッチを起動してその処理状態を管理するレコードを
DBに登録する。登録されたときの主キーを応答データでかえす。

②データ作成バッチ
DBに処理状態を「処理中」で更新して処理を開始する。処理が終わったら処理状態を「処理終了」で更新して、作成されたデータをファイルとしてサーバに出力する。

③データ取得API
データ作成用のバッチ処理が作成したデータを取得する。
データ作成バッチが実行中で、まだデータが出力されていない場合、ステータスを「処理中」、データを空で返す。データが出力されている場合、ステータスを「処理終了」、サーバに出力されたデータを返す。

解決したいこと・教えていただきたいこと

②データ作成バッチはそれなりに時間がかかることが分かっています。
（②データ取得APIを何度か呼び出さないと、データが取得できない）そのため、WindowsFormからの呼び出しは非同期処理
とすべきだと考えています。ただし、上記一連の処理はクラスライブラリに実装し、
WindowsFormからはクラスライブラリのメソッドを呼び出して処理をさせるように指示をうけています。

非同期処理についてあまりくわしくないのですが、こういった条件だと、どのように実装すべきでしょうか？
サンプルになるようなコード等教えていただけると嬉しいです。それを見ながら非同期処理も含め勉強したいと思っています。

Answer 1

質問が適切ではなかったので解決しませんでした。

Comments

[退会済みユーザー]

そんなのは自己解決ではありません。

Answer 2

質問は以下のところ、

非同期処理についてあまりくわしくないのですが、こういった条件だと、どのように実装すべきでしょうか？

・・・即ちクライアント側の WinForms アプリから Web API を非同期で要求して応答を処理するところだと理解してレスします。

ASP.NET Web API ということですから認証はトークンベースになって、クライアントは HttpClient を使い、データの受け渡しには JSON 文字列を使うということになると想像しています。

以下のその簡単なサンプルの記事を紹介しておきます。認証トークンの取得もデータの取得も HttpClient を使って非同期に行っています。

HttpClient で ASP.NET Web API にアクセス
http://surferonwww.info/BlogEngine/post/2019/09/29/call-aspnet-web-api-from-httpclien.aspx

他に、上の記事にも書いてありますが、HttpClient を使ったアプリから Web API にアクセスするには　Microsoft のドキュメント Call a Web API From a .NET Client (C#) で紹介されている Microsoft.AspNet.WebApi.Client を使う方法もあります。そのドキュメントへのリンクが張ってあるのでそちらも見てください。

もう一つのサンプルとして、IHttpClientFactory を利用して HTTP 接続プールを作り、それから HttpClient インスタンスを取得してアクセスする方法を書いた記事を紹介しておきます。

Windows Forms で IHttpClientFactory 利用 (CORE)
http://surferonwww.info/BlogEngine/post/2021/03/12/how-to-use-ihttpclientfactory-in-windows-forms-application.aspx

HttpClient のインスタンスを生成すると、そのたびにソケットも生成されます。しかし、HttpClient のインスタンスを Dispose してもソケットはすぐにはクローズされないので（デフォルトで 4 分かかるそう）、短期間で何度も生成 / Dispose を繰り返すとソケットの枯渇につながるという問題があり、それを避けるため、HttpClient のインスタンスはシングルトンにしてアプリで使いまわすということが推奨されています。ただし、長期にわたってシングルトンにした HttpClient のインスタンスを使い続けると、DNS の変更が反映されないという別の問題があるそうです。

IHttpClientFactory オブジェクトを利用することにより HTTP 接続プールが生成でき、プールから HttpClient を取得して使うことにより上記の問題（socket の枯渇と DNS の変更）を回避できるそうです。

Comments

[退会済みユーザー]

非同期API呼び出しの部分はよくわかりました。ありがとうございました。
あとよくわからないのが、何度か繰り返し呼び出して待つ部分です。
雰囲気は以下のようになるのかと考えていますが、もう少し具体的にどんな風に実装すべきなのかが
いまいちわかっていません。

// Formから呼び出すクラスライブラリのメソッド
static async Task<string> GetData(string guid)
{
while(1)
{
// 1秒間隔で
Sleep(1000)

// APIの結果を非同期で取得

// 取得結果が望む結果なら抜けて答えを返す
}
}

// WindowsForm側のイベント
private void TestButton_Click(object sender, EventArgs e)
{
// 非同期でAPIを利用してデータを取得する
awit ApiYobidashi.GetData("29F7FCB35FF54D53A68043AD28FE3A9D");

// 次の処理？
}

[退会済みユーザー]

> あとよくわからないのが、何度か繰り返し呼び出して待つ部分です。雰囲気は以下のようになるのかと考えていますが、もう少し具体的にどんな風に実装すべきなのかがいまいちわかっていません。

そこは質問者さんと顧客の間の仕様・要件、Web API の実装などによります。そのあたりが分からない第三者に聞いても答えられる話ではありません。ポーリングで要件を満たすならそれでもいいんじゃないの・・・というような無責任な返事しかできません。

質問者さん、業務の一環としてやっているようですが、であれば上司・先輩に相談することをお勧めします。

[退会済みユーザー]

> ポーリングで要件を満たすならそれでもいいんじゃないの・・・というような無責任な返事しかできません。

ポーリングで要件を満たすとして、実装サンプルなど教えていただくことは可能でしょうか？
無責任でも差支えありません。

[退会済みユーザー]

質問者さん、業務の一環としてやっているようですが、であれば上司・先輩に相談することをお勧めします。質問者さんと顧客の間の仕様・要件、Web API の実装などによります。そのあたりが分からない第三者に聞いても答えられる話ではありません。

[退会済みユーザー]

わかりました。ありがとうございます。