HttpClientでPostでhttpサーバーに文字を送信して、結果のJsonを取得したい

Question

こんにちは。

前提・実現したいこと

Windows10を使ってVisual Studo 2017でUWPアプリケーションのプロジェクトを作っています。
Postでhttpサーバーに文字を送信して、結果のJsonを取得したいです。

UWPにはWebClientがないので、もともとWebClientとHttpUtilityを使っていたのをHttpClientに変更したいです。

argsはキーのペアで、
name, "白鷺",
language, "japanese",
kind, "bird"
のようなものです。

urlはhttpサーバーのurlです。

resultはjsonです。

発生している問題・エラーメッセージ

            client.DefaultRequestHeaders.Add("user-agent", "Mozilla/5.5");
　          client.DefaultRequestHeaders.Add("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");

あたりで、接続に失敗します。
HttpClientを使うのが初めてで、なにを渡したらよいかわからずにおります。

該当のソースコード

もとのコードです。

public static string GetJsonResult(Dictionary<string, string> args, string url)
{
    string data = CreateQuerystring(args);
    string result = GetHttpResponse(url, data);
}

public static string CreateQuerystring(Dictionary<string, string> args)
{
    StringBuilder sb = new StringBuilder();
    foreach (string name in args.Keys)
    {
        sb.Append(HttpUtility.UrlEncode(name));
        sb.Append("=");

        sb.Append(HttpUtility.UrlEncode(args[name]));
        sb.Append("&");
    }            
    return sb.ToString(0, Math.Max(sb.Length - 1, 0));
}

public static string GetHttpResponse(string url, string data)
{
    byte[] rawData = client.UploadData(url, Encoding.UTF8.GetBytes(data));
    return Encoding.UTF8.GetString(rawData);
}

試したこと

public static string GetHttpResponse(string url, string data)
        {
            HttpClient client = new HttpClient();
            client.DefaultRequestHeaders.Add("user-agent", "Mozilla/5.5");
　          client.DefaultRequestHeaders.Add("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");

            var stringContent = new StringContent(data, System.Text.Encoding.UTF8);
            var message = client.PostAsync(url, stringContent);
            return message.Result.Content.ToString();
        }
                
        public static string CreateQuerystring(Dictionary<string, string> args)
        {
            StringBuilder sb = new StringBuilder();
            foreach (string name in args.Keys)
            {
                sb.Append(Uri.EscapeDataString(name));
                sb.Append("=");

                sb.Append(Uri.EscapeDataString(args[name]));
                sb.Append("&");
            }            
            return sb.ToString(0, Math.Max(sb.Length - 1, 0));
        }

求める回答

Q1)HttpClientのPostのコード。GetHttpResponse(string url, string data)のMethod
Q2)client.DefaultRequestHeadersを全部コメントアウトするとつながるが、そのとき結果はmessageのどこに入っているか。
Q3)そもそもはいっていないのか？

補足情報（FW/ツールのバージョンなど）

Intel Pentium(R) CPU 4415 Y 1.60GHz
RAM 8GB
Windows10Pro 64bit 1803 17134.345 
Microsoft Visual Studio Community 2017 
Version 15.8.5
VisualStudio.15.Release/15.8.5+28010.2036
Microsoft .NET Framework
Version 4.7.03056 
インストールされているバージョン:Community 

Answer 1

Q1)HttpClientのPostのコード。GetHttpResponse(string url, string data)のMethod

以下の記事のコードが参考になりませんか？　WCF と書いてありますが Web サーバーに HttpClient を使って POST 要求をかけ、JSON 文字列を応答として受け取るところは質問者さんのケースと同じです。

HttpClient で WCF サービスを呼出
http://surferonwww.info/BlogEngine/post/2018/02/24/request-wcf-service-using-httpclient.aspx

応答として受け取った JSON 文字列を C# のオブジェクトにデシリアライズしないと処置できないと思いますが、そのあたりのコードも書いてあります。

質問者さんのケースでは、POST するのは JSON 文字列ではなくて application/x-www-form-urlencoded 形式のようで、その文字列を CreateQuerystring メソッドで取得するのだろうと思いますが、そうであれば紹介した記事のコードを以下のように変更すればよさそうです。

string postData = CreateQuerystring(args);

request.Content = new StringContent(postData, 
                                    Encoding.UTF8, 
                                    "application/x-www-form-urlencoded");

Q2)client.DefaultRequestHeadersを全部コメントアウトするとつながるが、そのとき結果はmessageのどこに入っているか。

Fiddler を使って要求・応答をキャプチャして調べてください。その中にヒントが含まれているはずです。今の情報で言えるのはそれぐらいしかないです。

【追伸】

下の 2018/12/03 13:19 の私のコメントで Fiddler で「どういう情報が得られるかは、後で回答欄に書いておきます」と書きましたが、それを以下に書きます。

以下の画像は上の回答で紹介した記事「HttpClient で WCF サービスを呼出」のコードを実行した際の要求・応答を Fiddler でキャプチャしたものです。期待通り要求がサーバーに送信され、サーバーから応答が返ってきていることが分かります。Fiddler 無しでは要求が出ているか否かさえも分かりません。まして、応答が返ってきているか、それは期待通りかなんてことは分かりません。

質問者さんの Q2, Q3 の疑問「結果はmessageのどこに入っているか」「そもそもはいっていないのか？」も Text を見るなどすればすぐに分かります。

なので、Fiddler なしで HTTP 通信を行うアプリの開発は無理と言っても過言ではないと思います。

（注）クライアントにブラウザを使う場合と違って、デスクトップアプリなどからですと localhost はキャプチャできないので注意してください。

Comments

[TrainRain]

丁寧にありがとうございます。
Fiddlerというのはなんですか？
ふだんはVisual Studioのデバッグで、変数の中を見ています。
messageには見当たらなかったのです。Fiddlerをつかうともっと情報を得られるのでしょうか。

[退会済みユーザー]

HTTP 通信を行うアプリの開発には必須と言ってもいいツールです。詳しくは以下の記事を見てください。

Fiddler のお勧め
http://surferonwww.info/BlogEngine/post/2011/05/25/Recommendation-of-Fiddler.aspx

どういう情報が得られるかは、後で回答欄に書いておきます。

Answer 2

こんにちは。

「接続に失敗する」というのは状況がよくわかりませんが、
PostAsyncの結果から中身を取り出すには、Contentに対してReadAsStringAsyncを使います。

            var message = client.PostAsync(url, stringContent);
            return message.Result.Content.ReadAsStringAsync().Result;

接続ができているなら、上のやり方で結果を取り出すことができると思います。

---

本来HttpClientは非同期APIなので、基本的には非同期コンテキストで走らせるものです。

            var response = await client.PostAsync(url, stringContent);
            return await response.Content.ReadAsStringAsync();

正しく扱うには非同期処理の基礎を学ぶ必要があるため、習得していないうちは同期記法でもよいです(HttpClientの場合は例外的に。大半の非同期APIは同期で書こうとするとほぼデッドロックするので非常に危険です。)
UWP以降になると非同期処理の習得がほぼ必須なので、そちらの学習を優先したほうが良いです。

Comments

[TrainRain]

早速のご返答ありがとうございます。検証します。

[TrainRain]

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

そのMethodはうまくできたようなのですが、ご心配頂いていた通り、非同期処理で新たに課題が発生しました。
var response = GetHttpResponse(baseUrl, data).ToString();
var json = JArray.Parse(response);//<-このresponseが空のまま実行してしまう。
return json;
これを修正するには、
var response = await GetHttpResponse(baseUrl, data).ToString();
var json = await JArray.Parse(response);
と両方にawaitすればよいのでしょうか？
あるいはJArray.Parse(response);をGetHttpResponseで実行して、Parseずみのjsonをawaitで戻せばよいのか。いずれにしても非同期にするために、あちこちだいぶ手を入れないとダメっぽくて…。

[tamoto]

根本的に非同期が理解できていないまま非同期フローを書くのはおそらく不可能です。
現状のGetHttpResponseの実装がどうなっているのかがわからないとコメントへの回答は難しいです。
仮にそのGetHttpResponseの中身が本回答の1つ目で書いた同期処理版であるとすれば、GetHttpResponseの型はstringなのでToString()は不要なはずです。そして、responseが空であるというのは、HTTP通信のレスポンス自体が空ということになります。
もしGetHttpResponseを非同期メソッドにしようとしてTaskを返していた場合は、それをToString()しても当然正しい結果は得られません。

[TrainRain]

おっしゃるとおりです。ありがとうございました。この質問はとりあえずここで完了にします。