.NET MAUIアプリ構築で、APIキーをサーバーから安全に取得する
マルチターゲットアプリ開発の新しいアプローチ~.NET 9 新テンプレートの基本~ 第6回
ダウンロード サンプルファイル (224.7 KB)
MAUI側のAPIキー取得処理の変更
ImageGeneratorプロジェクトのMauiKeyStorageクラスを、サーバーからAPIキーを取得するように変更します。IHttpClientFactoryを使用して、HttpClientを適切に管理します。
IHttpClientFactory
HTTP通信を行う際、HttpClientクラスを都度インスタンス生成すると、ソケットの枯渇などの問題が発生する可能性があります。.NETでは、IHttpClientFactoryを使用してHttpClientインスタンスを管理することが推奨されています。
IHttpClientFactoryにHttpClientの生成と破棄を任せることができ、インスタンスの問題を気にする必要がなくなります。またDIコンテナに登録することで、アプリケーション全体で、安全にHttpClientを使用できます。
HttpClientの登録
NuGetパッケージの管理から、Microsoft.Extensions.Httpパッケージを追加します。それから、MauiProgram.csに、IHttpClientFactoryを登録するコードを追加します。
// HttpClientFactoryの登録 builder.Services.AddHttpClient();
AddHttpClient()を呼び出すことで、IHttpClientFactoryがDIコンテナに登録されます。このコードは本番環境向けの登録です。Androidから開発サーバーへ接続する場合は、自己署名証明書による証明書エラーが発生するため、別途対処が必要です。詳しくは、後述の「HTTPS証明書のエラー」を参照してください。
また、AddHttpClient()は、IHttpClientFactoryを使用するサービス(MauiImageSaveService、MauiKeyStorage)より前に登録する必要があります。
実装クラスの変更
MauiKeyStorageクラスを、サーバーからAPIキーを取得するように変更します。
public class MauiKeyStorage(IHttpClientFactory httpClientFactory) : IApiKeyStorage
{
private const string KeyName = "openai_api_key";
public async Task<string> GetKeyAsync()
{
// まずSecureStorageから取得を試みる (1)
var key = await SecureStorage.GetAsync(KeyName);
if (!string.IsNullOrEmpty(key))
{
return key;
}
// SecureStorageにない場合はサーバーから取得 (2)
try
{
var apiServerUrl = GetApiServerUrl();
// HttpClientFactoryからHttpClientを取得 (3)
using var httpClient = httpClientFactory.CreateClient();
var response = await httpClient.GetFromJsonAsync<ApiConfigResponse>(
$"{apiServerUrl}/api/config");
if (response != null && !string.IsNullOrEmpty(response.ApiKey))
{
// 取得したキーをSecureStorageに保存 (4)
await SecureStorage.SetAsync(KeyName, response.ApiKey);
return response.ApiKey;
}
}
catch (Exception ex)
{
Console.WriteLine($"APIキー取得エラー: {ex.Message}");
}
throw new Exception("APIキーを取得できませんでした");
}
// プラットフォームに応じたURLを返す (5)
private static string GetApiServerUrl()
{
#if ANDROID
// Androidエミュレータからのlocalhost接続は10.0.2.2を使用
return "https://10.0.2.2:7299";
#else
return "https://localhost:7299";
#endif
}
private class ApiConfigResponse
{
public string? ApiKey { get; set; }
}
}
SecureStorageにキーがあれば返し(1)、なければサーバーから取得します(2)。IHttpClientFactoryのCreateClient()メソッドでHttpClientを取得することで(3)、接続プールが効率的に管理されます。取得したキーは次回以降のためにSecureStorageに保存します(4)。
Androidエミュレータからlocalhostにアクセスする場合は、10.0.2.2というIPアドレスを使用する必要があります(5)。10.0.2.2は、エミュレータから、ホストPCのlocalhostへアクセスするための特別なIPアドレスです。 ポート番号は、先ほど確認した値に置き換えてください。
Androidでのネットワーク設定
Androidエミュレータから開発サーバーに接続するには、追加の設定が必要です。
まず、MAUIプロジェクトでPlatforms/Android/Resources/xmlフォルダを作成し、network_security_config.xmlを新規作成します。
<?xml version="1.0" encoding="utf-8"?>
<network-security-config>
<domain-config cleartextTrafficPermitted="true">
<domain includeSubdomains="true">10.0.2.2</domain>
</domain-config>
<base-config cleartextTrafficPermitted="false">
<trust-anchors>
<certificates src="system" />
<certificates src="user" />
</trust-anchors>
</base-config>
</network-security-config>
ファイル作成後、ソリューションエクスプローラーで、network_security_config.xmlを右クリックし、[プロパティ]を選択します。ビルドアクションに、AndroidResourceを設定します。次に、Platforms/Android/AndroidManifest.xmlのapplicationタグ内に、この設定ファイルへの参照を追加します。
<application
android:networkSecurityConfig="@xml/network_security_config"
android:usesCleartextTraffic="true"
~略~ >
この記事は参考になりましたか?
- マルチターゲットアプリ開発の新しいアプローチ~.NET 9 新テンプレートの基本~連載記事一覧
-
- .NET MAUIアプリ構築で、より安全なプロキシ方式を実装する
- .NET MAUIアプリ構築で、APIキーをサーバーから安全に取得する
- .NET MAUI Blazorで生成した画像を保存する。ネイティブ機能との連携
- この記事の著者
-
WINGSプロジェクト 高江 賢(タカエ ケン)
<WINGSプロジェクトについて>有限会社 WINGSプロジェクトが運営する、テクニカル執筆コミュニティ(代表 山田祥寛)。主にWeb開発分野の書籍/記事執筆、翻訳、講演等を幅広く手がける。 2026年時点での登録メンバは約50名で、現在も執筆メンバを募集中。興味のある方は、どしどし応募頂きたい。著書、記事多数。 RSS X: @WingsPro_info(公式)、@WingsPro_info/wings(メンバーリスト) Facebook
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です
-
山田 祥寛(ヤマダ ヨシヒロ)
静岡県榛原町生まれ。一橋大学経済学部卒業後、NECにてシステム企画業務に携わるが、2003年4月に念願かなってフリーライターに転身。Microsoft MVP for Visual Studio and Development Technologies。執筆コミュニティ「WINGSプロジェクト」代表。主な著書に「独習シリーズ(Java・C#・Python・PHP・Ruby・JSP&サーブレットなど)」「速習シリーズ(ASP.NET Core・Vue.js・React・TypeScript・ECMAScript、Laravelなど)」「改訂3版JavaScript本格入門」「これからはじめるLaravel実践入門」「はじめてのAndroidアプリ開発 Kotlin編 」他、著書多数。
※プロフィールは、執筆時点、または直近の記事の寄稿時点での内容です
この記事は参考になりましたか?
この記事をシェア
