質問をすることでしか得られない、回答やアドバイスがある。

15分調べてもわからないことは、質問しよう!

ただいまの
回答率

87.78%

Content-Typeにform-urlencodedを指定したリクエストにおいて、MVCを用いてControllerBase.Request内のBodyから値を取得したい。

解決済

回答 1

投稿 編集

  • 評価
  • クリップ 0
  • VIEW 293

score 5

前提・実現したいこと

初めまして。
C#(asp.netcore)を使用したAPIを作成しております。
受け取ったHttpリクエストをForwardする機能を実現したいと思っています。
C#のForwardするメソッド等を検索したところ、見当たらなかったので自力で実装しようと思っております。

その機能を実現する前段として、リクエスト時のBody値が取得できないため、質問した次第です。

補足(2021/04/12)
実現したい内容の「Forward」という言葉が曖昧であるとご指摘をいただけたため、補足させてください。
実現したい内容といたしましては以下となります。

クライアント(指定なし。ブラウザ、外部APIやアプリ等)⇔ ASP.NET Core Web アプリ(質問部)⇔ どこか他のAPIやWEBアプリ

クライアントからどこか他のWEBアプリへ送られるHttpリクエストを仲介するアプリを作成したいと思っております。

意図といたしましては、ヘッダーで指定した宛先(他のWEBアプリ)へのリクエストを時間帯によって接続不可といったような制御を行いたいためです。
あくまで制御を行いたいという目的のため、送られてきたリクエスト情報と同一のリクエスト内容をどこか他のWEBアプリ等に再度リクエストしたいのです。
また、接続不可の際にあらかじめ用意しているエラー画面を表示させたいため、MVCで実装したいと思っております。

------補足ここまで------

初学者かつ、初めての質問となります。
至らない点等ありましたらご指摘いただけると幸いです。

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

ControllerでHttpリクエストを受け取った際に、ControllerBase.Request内のBodyの値がStreamで取得できると思いますが、リクエスト時の'Content-Type'ヘッダーに'application/x-www-form-urlencoded'を指定すると取得したStreamが空となってしまいます。

Content-Typeに'application/x-www-form-urlencoded'を指定した際にControllerBase.Request内のBodyの値を取得したいというのが本質問の趣旨となります。

'text/plain'等のContent-Typeを設定した際は取得できますので、困っている次第です。

該当のソースコード

以下、コントローラーのリクエスト受取部になります。

[Route("Test")]
public class TestController : Controller
{
    private IHttpClientFactory _clientFactory;

    // DI
    public TestController(IHttpClientFactory clientFactory)
    {
        _clientFactory = clientFactory;
    }

    [HttpPost]
    public async Task<IActionResult> PostAsync([FromHeader]TestHeader header)
    {
        var bodyStr = string.Empty;

        using(StreamReader reader = new StreamReader(Request.Body))
        {
            bodyStr = await reader.ReadToEndAsync().ConfigureAwait(false);
        }

        return Ok(bodyStr);
    }
}

以下、リクエストはPowerShellから投げております。

#読み取れるリクエスト
Invoke-WebRequest 'http://localhost:8080/Test' `
    -mehtod post `
    -Headers @{"Content-type"="text/plain"} `
    -body 'hoge'

#以下問題のリクエスト
Invoke-WebRequest 'http://localhost:8080/Test' `
    -mehtod post `
    -Headers @{"Content-type"="application/x-www-form-urlencoded"} `
    -body 'hoge'  # 本来は"aaa=aaa&bbb=bbb"のような値を送りたい。

試したこと

Postメソッドの引数に'[FromForm]'を指定すれば解決するのですが、Bodyの型を指定したくなく、すべてのリクエストに対応したいためあえてStreamを読み込んでおります。

前提に書きました通り、他のContent-Type(text/plain, text/xml, application/json等)で試行しております。その際は文字列は返却できておりました。

またStreamを読み込んだ時点で値が空となりますので、リクエスト返却時ではなくリクエスト受付時の問題と認識しております。

stackoverflowにてForwardを実装している記事を見たのですが、mvcではなくWebHttpRequestを利用したものとなっており、本問題には使えないかなと思い手詰まりとなってしまいました。
該当URL:stackoverflowのリンク

明確な質問とならず申し訳ございません。
ご助力いただけますと幸いです。

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

言語:C#
フレームワーク:.NetCore3.1
実行環境:VisualStudioProfessional2019 Version 16.8.5内のIISExpress

  • 気になる質問をクリップする

    クリップした質問は、後からいつでもマイページで確認できます。

    またクリップした質問に回答があった際、通知やメールを受け取ることができます。

    クリップを取り消します

  • 良い質問の評価を上げる

    以下のような質問は評価を上げましょう

    • 質問内容が明確
    • 自分も答えを知りたい
    • 質問者以外のユーザにも役立つ

    評価が高い質問は、TOPページの「注目」タブのフィードに表示されやすくなります。

    質問の評価を上げたことを取り消します

  • 評価を下げられる数の上限に達しました

    評価を下げることができません

    • 1日5回まで評価を下げられます
    • 1日に1ユーザに対して2回まで評価を下げられます

    質問の評価を下げる

    teratailでは下記のような質問を「具体的に困っていることがない質問」、「サイトポリシーに違反する質問」と定義し、推奨していません。

    • プログラミングに関係のない質問
    • やってほしいことだけを記載した丸投げの質問
    • 問題・課題が含まれていない質問
    • 意図的に内容が抹消された質問
    • 過去に投稿した質問と同じ内容の質問
    • 広告と受け取られるような投稿

    評価が下がると、TOPページの「アクティブ」「注目」タブのフィードに表示されにくくなります。

    質問の評価を下げたことを取り消します

    この機能は開放されていません

    評価を下げる条件を満たしてません

    評価を下げる理由を選択してください

    詳細な説明はこちら

    上記に当てはまらず、質問内容が明確になっていない質問には「情報の追加・修正依頼」機能からコメントをしてください。

    質問の評価を下げる機能の利用条件

    この機能を利用するためには、以下の事項を行う必要があります。

質問への追記・修正、ベストアンサー選択の依頼

  • SurferOnWww

    2021/04/12 15:35 編集

    > 受け取ったHttpリクエストをForwardする

    その Forward というのは具体的に何ですか?

    クライアント(ブラウザ) ⇔ ASP.NET Core Web アプリ ⇔ どこか他の Web API

    というような構成で、クライアントからの要求を受けて、「どこか他の Web API」から情報を入手して、それをクライアントに返すというようなことですか?

    そのあたりを詳しく、ここに書いてあること以外は知り得ない第三者が読んで分かるように書いてください。

    キャンセル

  • apiu0191

    2021/04/12 16:25

    修正依頼ありがとうございます。
    お時間かかってしまい申し訳ございません。
    書けることを書いたつもりではありますが、まだ足りていない点がありましたらお手数ですが再度ご指摘いただけますと幸いです。

    キャンセル

  • SurferOnWww

    2021/04/12 16:59 編集

    回答欄に移しました

    キャンセル

  • SurferOnWww

    2021/04/13 11:45

    質問者さん、回答欄に Body から取得する方法を追記しておきましたので、それに対するフィードバックを書いてください。このスレッドの課題にはすべて答えていると思います。疑問などがなければフィードバックしていただかなくても結構ですが、このスレッドはクローズしてください。

    キャンセル

回答 1

checkベストアンサー

0

「Bodyから値を取得」とのことですが、MVC で受け取ってそれをそのまま「どこか他のAPIやWEBアプリ」に投げるということですか? それは全く普通ではない、少なくとも私の理解のはるか斜め上のことを考えておられるような気がします。時間制限するのが目的とのことですが、それだけならプロキシサーバーでも間に入れるとか、別の手段を考えた方が良いのでは?

【追記】

下の 2021/04/13 10:47 の私のコメントで「後で回答欄に書いておきます」と書いた件です。

コメント欄で紹介した stackoverflow の記事 (URL 下記) の回答を検証してみました。それに書いてあるようにして Body から文字列を取得できます。

How to read ASP.NET Core Response.Body?
https://stackoverflow.com/questions/43403941/how-to-read-asp-net-core-response-body

startup.cs の Configure メソッドにミドルウェアとして以下を登録。Controller では効果は無いようです。

app.Use(async (context, next) => {
    context.Request.EnableBuffering();
    await next();
});

application/x-www-form-urlencoded 形式でデータを POST。下の画像は Fiddler で見た要求ヘッダとボディ。

イメージ説明

アクションメソッドで HttpRequest.Body を取得。Position が末尾になっているので巻き戻してから(Position を 0 に設定してから)StreamReader で読むと Body の文字列を取得できます。。

イメージ説明

デフォルトでは 1 回しか Body から読めないが、アクションメソッドで Body を取得する時点ではすでに読んでしまっているので Body から読めないということのようです。

上のようにすればアクションメソッドで巻き戻してもう一回読むことは可能です。ただし、わざわざそうしているのは "to make the default configuration of request handling as lightweight and performant as possible" ということだそうで、性能上の劣化が生じる可能性はあるかも。

あと、問題とは直接関係ない話ですが、stackoverflow の記事に書いてあるように、using は使わない、取得し終わったら Stream を巻き戻すようにするのがよいかもしれません。

投稿

編集

  • 回答の評価を上げる

    以下のような回答は評価を上げましょう

    • 正しい回答
    • わかりやすい回答
    • ためになる回答

    評価が高い回答ほどページの上位に表示されます。

  • 回答の評価を下げる

    下記のような回答は推奨されていません。

    • 間違っている回答
    • 質問の回答になっていない投稿
    • スパムや攻撃的な表現を用いた投稿

    評価を下げる際はその理由を明確に伝え、適切な回答に修正してもらいましょう。

  • 2021/04/13 06:50

    以下の記事が参考になるかも。ググって見つけただけで未検証・未確認ですが・・・

    https://stackoverflow.com/questions/43403941/how-to-read-asp-net-core-response-body

    キャンセル

  • 2021/04/13 10:47

    上の私のコメントの stackoverflow の記事の回答を検証してみました。それに書いてあるようにして Body から文字列を取得できました。後で回答欄に書いておきます。

    デフォルトでは 1 回しか Body から読めないが、アクションメソッドで Body を取得する時点ではすでに読んでしまっているのでダメということのようです。記事のようにすればアクションメソッドで rewind してもう一回読むことは可能です。ただし、わざわざそうしているのは "to make the default configuration of request handling as lightweight and performant as possible" ということだそうで、性能上の劣化が生じる可能性はあるかも。

    キャンセル

  • 2021/04/13 21:32

    検証までしていただきましてありがとうございます。
    プロパティにそれらしい値があったので使用しようと思ったのですが、本来の用途とは違ったのですね。
    また、実装次第でとれると分かりすっきりいたしました。
    使用しようとは思いませんが、検証いただいた結果を踏まえて再度実装してみたいと思います。
    この度はありがとうございました。

    キャンセル

15分調べてもわからないことは、teratailで質問しよう!

  • ただいまの回答率 87.78%
  • 質問をまとめることで、思考を整理して素早く解決
  • テンプレート機能で、簡単に質問をまとめられる

関連した質問

同じタグがついた質問を見る

  • トップ
  • C#に関する質問
  • Content-Typeにform-urlencodedを指定したリクエストにおいて、MVCを用いてControllerBase.Request内のBodyから値を取得したい。