ASP.NET Core アプリのブラウザタブが空白のまま 표시hbar、品牌的ロゴの代わりにフォールバック用の記号が描画される場合は、通常、favicon がレンダリングされる <head> に含まれていないか、静的コンテンツとして公開されるフォルダの外に保存されています。ASP.NET Core favicon の設定には2つの要素が必要です。1つは wwwroot 配下に配置する icon file、もう1つは共有 layout に追加する link declaration です。

この違いを理解ことが重要です。favicon.ico をプロジェクトルートに配置しても、wwwroot 配下には置かれません。また、wwwroot にファイルを追加しても、全ページに自動的に追加されるわけではありません。以下の手順は、conventional な共有 layout を使用する MVC および Razor Pages アプリを対象としています。

Prerequisites

アプリに public、account、admin 用の layout が個別に用意されている場合は、それぞれの layout で markup の追加手順をrepeat してください。API-only アプリには設定する page head がないため、代わりに landing page または documentation host に favicon を追加します。

ASP.NET Core favicon をステップバイステップで追加する

  1. 小さなアイコンセットを準備する

    次のフォルダ構成を作成します。

    wwwroot/
      favicon.ico
      icons/
        favicon.svg
        favicon-32x32.png
        apple-touch-icon.png

    16、32、48ピクセルの画像を含むICO、32ピクセルのPNG、シンプルなSVGを用意します。ユーザーがサイトをホーム画面に保存する可能性がある場合は、180ピクセルのApple touch iconも追加します。元になる素材がロゴまたはPNGなら、Mzu favicondlを使うことで、元ファイルを変更せずにICO、PNG、SVGの各variantを生成できます。

  2. 静的ファイルが配信されることを確認する

    ASP.NET Coreは、static-file middlewareを通じてwwwrootからファイルを配信します。アプリがすでにそのフォルダからCSSや画像を読み込んでいるなら、この手順は完了している可能性が高いです。そうでなければ、pipelineに次の処理が含まれていることを確認してください。

    var app = builder.Build();
    
    app.UseStaticFiles();
    
    // Keep your existing routing and endpoint registrations below.

    この呼び出しは1回だけ追加してください。middlewareの指定がすでに存在するする場合は、同じものを2回登録しないでください。

  3. 共通レイアウトのhead内にlinkを追加する

    MVCの場合はViews/Shared/_Layout.cshtmlを、Razor Pagesの場合はPages/Shared/_Layout.cshtmlを開いてください。これらの要素は、<head>内、stylesheet linkの隣に配置します。

    <link rel='icon' href='~/favicon.ico' sizes='16x16 32x32 48x48'>
    <link rel='icon' href='~/icons/favicon-32x32.png' type='image/png' sizes='32x32'>
    <link rel='icon' href='~/icons/favicon.svg' type='image/svg+xml' sizes='any'>
    <link rel='apple-touch-icon' href='~/icons/apple-touch-icon.png' sizes='180x180'>

    rel='icon'という形式は、HTML link-type documentationで定義されているとおり、外部アイコンリソースを指定します。Razorの~/パスを使えば、アプリをサブパス配下にホストした場合もURLが正しく保たれます。layoutに<head>がない場合は、linkを挿入する前に追加してください。

  4. ルートにICOのフォールバックを残す

    wwwroot/favicon.icoのファイルは、/favicon.icoとして利用できます。互換性対策として、このファイルと明示的なICO linkは残してください。ページテンプレートが不完全な場合でも、ブラウザが慣例的なroot pathに対するリクエストを行ったときに、有効なレスポンスを返せるためです。

  5. アプリを起動して各レスポンスを確認する

    dotnet runでサイトを起動し、local URLを開いて、ブラウザのdeveloper toolsを開きます。Networkパネルを選択し、faviconで絞り込んで、ページを再読み込みします。そこに表示されるアイコンのリクエストは、404レスポンスではなく、正常なステータスで返り、content typeが画像タイプになっている必要があります。View Sourceで、返されたHTMLに4つのlink要素が含まれていることを確認し、その後、ブラウザのタブに意図したアイコンが表示されるかも確認してください。

  6. 公開されたサイトを検証する

    アプリをデプロイし、公開ページのソースを確認して、Networkのチェックを繰り返します。アイコンはローカルでは動作する一方、本番環境で動作しない場合は、生成されたhrefの値とデプロイ先のURLを比較し、アイコンファイルが公開時のビルド出力に含まれていることを確認してください。古いアイコンが表示され続ける場合は、CDN、service worker、browserのfavicon cacheを調べる前に、private windowで試してください。

よくある落とし穴

markup とレスポンスが正しくても、タブにまだ誤ったアイコンが表示される場合は、より包括的な favicon のトラブルシューティングチェックリスト を確認してください。HTML のみを使った手順については、ウェブサイトに favicon を追加する方法 を参照してください。

クリーンな icon stack で仕上げる

ファイルが wwwroot の配下にあり、static-file middleware が有効で、shared layout が ICO、PNG、SVG の候補を宣言していれば、ASP.NET Core の favicon の準備は完了です。root の favicon.ico は残し、デプロイ後のレスポンスを確認してから、タブアイコンが完成したと判断してください。