アプリ開発ときどきアウトドア

主にJavaを使ったアプリ開発やトラブルシューティング等のノウハウ、キャンプや登山の紹介や体験談など。

1. システムエンジニアリング ASP.NET Core 実装技術

ASP.NET Core: IHttpClientFactoryの単純サンプル

投稿日:2020年5月16日 更新日:


IHttpClientの使い方やサンプルの記事を書きましたが、後から見るとちょっと量が多いと感じました。
とりあえず動かしてみたい、概略を知りたい、急いでいる等の人向けに、もっと単純なサンプルを用意してみました。
冒頭の「IHttpClientの使い方やサンプルの記事」については下記をご覧ください。

使い方の要点

単純なサンプル

ASP.NET CoreのコントローラからIHttpClientFactoryを使ってWebAPIを実行するサンプルになります。

  1. サービス登録
    IHttpClientFactoryを使ってHttpClientクライアントを使う方法は、既定のクライアントを使う方法、名前付きクライアントを使う方法、型付きクライアントを使う方法等があります。
    その中で最も単純な「既定のクライアント」を使う場合、次のようにAddHttpClient()を宣言するのみです。
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddControllersWithViews();
    
        services.AddHttpClient();
    ...
    
  2. GET/POSTの実行
    IHttpClientFactoryは「依存関係の注入」で使用するため、コンストラクタの引数で指定します。
    HTTP要求を送信する場合、汎用的なHttpClient.SendAsync()を使う方法、シンプルなGetAsync(), PostAsync()等を使う方法があります。ここではシンプルな後者の方法で記載しています。
    public class HomeController : Controller
    {
    
        private readonly IHttpClientFactory _factory;
    
        private readonly ILogger<HomeController> _logger;
    
        public HomeController(
            IHttpClientFactory factory, 
            ILogger<HomeController> logger)
        {
            _factory = factory;
            _logger = logger;
        }
    
        public IActionResult Index()
        {
            return View();
        }
    
        public async Task<IActionResult> DoGet()
        {
            // HTTP要求の実行
            HttpClient client = _factory.CreateClient();
            HttpResponseMessage response = 
                await client.GetAsync("https://localhost:44372/api/ApiTest?param1=abc&param2=xyz");
    
            // ApiTestから取得した応答をテキストとして応答
            return Content(await response.Content.ReadAsStringAsync(), "text/plain");
        }
    
        public async Task<IActionResult> DoPost()
        {
            // フォームデータの作成
            var values = new Dictionary<string, string>();
            values.Add("param1", "123");
            values.Add("param2", "234");
            HttpContent content = new FormUrlEncodedContent(values);
    
            // HTTP要求の実行
            HttpClient client = _factory.CreateClient();
            HttpResponseMessage response =
                await client.PostAsync("https://localhost:44372/api/ApiTest", content);
    
            // ApiTestから取得した応答をテキストとして応答
            string responseBody = await response.Content.ReadAsStringAsync();
            return Content(responseBody, "text/plain");
        }
    
    }
    
  3. 参考:WebAPIのサンプル

    前述のIHttpClientFactory/HttpClientの接続先として使っているWebAPIも載せておきます。
    これらのWebAPIのURLはhttps://localhost:44372/api/ApiTestであり、GET/POSTに対応しています。
    GETの場合、クエリパラメータをJSONに格納して応答します。
    POSTの場合、フォーム内容をJSONに格納して応答します。

    
    [Route("api/[controller]")]
    public class ApiTestController : Controller
    {
        private ILogger<ApiTestController> _logger;
    
        public ApiTestController(ILogger<ApiTestController> logger)
        {
            _logger = logger;
        }
    
        [HttpGet]
        public IActionResult Get([FromQuery]string param1, [FromQuery]string param2)
        {
            _logger.LogDebug("Get() is invoked!");
    
            var dic = new Dictionary<string, string>();
            dic.Add("from", "ApiTest.Get()");
            dic.Add("param1", param1);
            dic.Add("param2", param2);
            return Json(dic);
        }
    
        [HttpPost]
        public IActionResult Post([FromForm]string param1, [FromForm]string param2)
        {
            _logger.LogDebug("Post() is invoked!");
    
            var dic = new Dictionary<string, string>();
            dic.Add("from", "ApiTest.Post()");
            dic.Add("param1", param1);
            dic.Add("param2", param2);
            return Json(dic);
        }
    
    }
    


(adsbygoogle = window.adsbygoogle || []).push({});


(adsbygoogle = window.adsbygoogle || []).push({});

-1. システムエンジニアリング, ASP.NET Core, 実装技術

執筆者:

関連記事

Apache HttpClientの通信内容をダンプ

アプリやミドルウェの動作の正常性確認や問題発生時の問題切り分けのために、HTTPリクエストやレスポンスのヘッダやボディを確認したい場合がある。Java系のアプリではApacheのHttpClientが …

postgresqlでの拡張のインストール

PostgreSQL10で暗号化関数を使用するため拡張(pgcrypto)をインストールした際の出来事を記載します。 事象 pgcryptoの拡張をインストールしたり、インストールの確認を行うと、その …

Javaでのパスワード付きzipファイルの圧縮/解凍方法(ZipCrypto/AES)

先日、JavaでのZIP暗号化の考察という記事を書きましたが、zip4jのメンテナンスが再開されており、バージョン2系が公開されていましたので、これを使って通常のzip圧縮/解凍、パスワード付きzip …

ASP.NET Core: エラーメッセージの日本語化

ASP.NET Coreでは入力値を検証するための[Required]等の検証属性が提供されていますが、エラーメッセージが英語になっています。 検証属性以外でも画面の実装方法によってはモデルバインディ …

chromeのjavascriptを一時的に無効化

Webアプリの開発やテストで、クライアント側のバリデーションを無効にしてサーバ側バリデーションの動作確認する、等のように一時的にjavascriptを無効にしたい場合があります。これを実現するための方 …