ASP.NET Core-környezetek Blazor

Ez a cikk bemutatja, hogyan konfigurálhatja és olvashatja el a környezetet egy Blazor alkalmazásban.

Ha helyileg futtat egy alkalmazást, a környezet alapértelmezés szerint a következő lesz Development: . Az alkalmazás közzétételekor a környezet alapértelmezés szerint a következő lesz Production: .

A következő konvenciókat javasoljuk:

• A helyi fejlesztéshez mindig használja a "Development" környezet nevét. Ennek az az oka, hogy a ASP.NET Core-keretrendszer pontosan ezt a nevet várja az alkalmazás és az eszköz helyi fejlesztési futtatásához való konfigurálásakor.

• Teszteléshez, előkészítéshez és éles környezetekhez mindig tegye közzé és telepítse az alkalmazást. Bármilyen környezetelnevezési sémát használhat a közzétett alkalmazásoknál, de mindig olyan alkalmazásbeállítási fájlneveket használjon, amelyek környezetszegmense pontosan egyezik a környezet nevével. Az előkészítéshez használja a "Staging" (nagybetűs "S") nevet a környezet neveként, és nevezze el az alkalmazásbeállítások fájlját ennek megfelelően (appsettings.Staging.json). Éles környezetben használja a "Production" (nagybetűs "P") nevet a környezet neveként, és adja meg az alkalmazásbeállítások fájljának a megfelelő nevet (appsettings.Production.json).

A környezet beállítása

A környezet a következő módszerek bármelyikével van beállítva:

• Blazor Web App vagy Blazor Server: Az általános ASP.NET Core-alkalmazásokhoz használja az ASP.NET Core-futtatókörnyezetekben ismertetett módszerek bármelyikét.
• Bármely Blazor alkalmazás: Blazor konfiguráció indítása
• Önálló Blazor WebAssembly: <WasmApplicationEnvironmentName> tulajdonság

Egy ügyfélen Blazor Web Appa környezet egy HTML-megjegyzésen keresztül lesz meghatározva a kiszolgálóról, amellyel a fejlesztők nem kommunikálnak:

<!--Blazor-WebAssembly:{"environmentName":"Development", ...}-->

Önálló Blazor WebAssembly alkalmazás esetén állítsa be a környezetet az <WasmApplicationEnvironmentName> alkalmazás projektfájljában (.csproj) található MSBuild tulajdonsággal. A következő példa a környezetet állítja be Staging :

<WasmApplicationEnvironmentName>Staging</WasmApplicationEnvironmentName>

Az alapértelmezett környezetek a Development buildeléshez és Production a közzétételhez tartoznak.

A buildelési/közzétételi műveletek során több módszer is létezik a környezet beállítására egy különálló Blazor WebAssembly alkalmazásban, és az ügyfélen induló vagy futó alkalmazások egyik megközelítése:

• A tulajdonságérték beállítása, amikor a dotnet build vagy a dotnet publish végrehajtásra kerül. Az alábbi példa egy alkalmazás közzétételekor állítja be a környezetet Staging :

  dotnet publish -p:WasmApplicationEnvironmentName=Staging
  

• Állítsa be a tulajdonságot a buildelés vagy közzététel során az alkalmazás Visual Studióban való konfigurációja alapján. Az alábbi tulajdonságcsoportok használhatók az alkalmazás projektfájljában vagy bármely közzétételi konfigurációs fájlban (.pubxml). Adjon hozzá további tulajdonságcsoportokat a használatban lévő más buildkonfigurációkhoz.

  <PropertyGroup Condition="'$(Configuration)' == 'Debug'">
    <WasmApplicationEnvironmentName>Development</WasmApplicationEnvironmentName>
  </PropertyGroup>
  
  <PropertyGroup Condition="'$(Configuration)' == 'Release'">
    <WasmApplicationEnvironmentName>Production</WasmApplicationEnvironmentName>
  </PropertyGroup>
  

• A környezet egy közzétételi profil használata alapján állítható be. Az alábbi példában az első feltétel úgy állítja be a környezetet, hogy Development amikor nem használ közzétételi profilt (a profil nélküli buildelési és közzétételi műveletekre is vonatkozik), míg a második feltétel a környezetnek Production a közzétételi profilok használatakor való beállítására vonatkozik:

  <PropertyGroup Condition="'$(PublishProfile)' == ''">
    <WasmApplicationEnvironmentName>Development</WasmApplicationEnvironmentName>
  </PropertyGroup>
  
  <PropertyGroup Condition="'$(PublishProfile)' != ''">
    <WasmApplicationEnvironmentName>Production</WasmApplicationEnvironmentName>
  </PropertyGroup>
  

• Hozzon létre egy egyéni kiszolgálóoldali webes API-végpontot. Az önálló Blazor WebAssembly alkalmazás a webes API-ból kéri le a környezetét az alkalmazás indításakor vagy igény szerint, miközben fut. Az értéket vagy a WebAssemblyStartOptions-nek kell átadni, vagy a withApplicationEnvironment-vel.

  Megjegyzés:

  A .NET referenciaforrásra mutató dokumentációs hivatkozások általában betöltik az adattár alapértelmezett ágát, amely a .NET következő kiadásának aktuális fejlesztését jelöli. Egy adott kiadás címkéjének kiválasztásához használja az Ágak vagy címkék közötti váltás legördülő listát. További információ: A ASP.NET Core-forráskód (dotnet/AspNetCore.Docs #26205) verziócímkéjének kiválasztása.

Ha az alkalmazás helyileg fut a fejlesztés során, az alkalmazás alapértelmezés szerint a Development környezetet használja. Az alkalmazás közzététele alapértelmezetten a környezetet Production-re állítja.

Az ügyféloldali környezet beállítása indítási konfigurációval Blazor

Az alábbi példa Blazor elindul a Staging környezetben, ha a gazdagép neve tartalmazza localhost. Ellenkező esetben a környezet az alapértelmezett értékre van állítva.

Blazor Web App:

<script src="{BLAZOR SCRIPT}" autostart="false"></script>
<script>
  if (window.location.hostname.includes("localhost")) {
    Blazor.start({
      webAssembly: {
        environment: "Staging"
      }
    });
  } else {
    Blazor.start();
  }
</script>

Az előző példában a {BLAZOR SCRIPT} helyőrző a Blazor szkript elérési útja és fájlneve. A szkript helyéről lásd ASP.NET Core Blazor projektstruktúra.

Megjegyzés:

Ha Blazor Web Appa webAssembly>environmenttulajdonságot konfigurációban Blazor.start állítja be, célszerű a kiszolgálóoldali környezetet a tulajdonságon environment beállított környezethez igazítani. Ellenkező esetben a kiszolgálón az előrendelés más környezetben működik, mint az ügyfél renderelése, ami tetszőleges hatásokat eredményez. A környezet Blazor Web Appbeállításával kapcsolatos általános útmutatásért lásd a ASP.NET Core futtatókörnyezeteket.

Önálló Blazor WebAssembly:

<script src="{BLAZOR SCRIPT}" autostart="false"></script>
<script>
  if (window.location.hostname.includes("localhost")) {
    Blazor.start({
      environment: "Staging"
    });
  } else {
    Blazor.start();
  }
</script>

Az előző példában a {BLAZOR SCRIPT} helyőrző a Blazor szkript elérési útja és fájlneve. A szkript helyéről lásd ASP.NET Core Blazor projektstruktúra.

Ha egy különálló Blazor WebAssembly alkalmazásban vagy a .ClientBlazor Web App projektjében szeretné naplózni a környezetet a konzolon, helyezze a következő C#-kódot a Program fájlba, miután a WebAssemblyHost-t létrehozta a WebAssemblyHostBuilder.CreateDefault-el, és mielőtt a projektet építő és futtató sort (await builder.Build().RunAsync();) végrehajtja:

Console.WriteLine(
    $"Client Hosting Environment: {builder.HostEnvironment.Environment}");

További információt a Blazor indításról az ASP.NET Core Blazor indításicímű témakörben találhat.

A környezet olvasása egy Blazor WebAssembly alkalmazásban

Szerezze be az alkalmazás környezetét egy összetevőn keresztül úgy, hogy beinjektálja a IWebAssemblyHostEnvironment-t, és elolvassa a Environment tulajdonságot.

ReadEnvironment.razor:

@page "/read-environment"
@using Microsoft.AspNetCore.Components.WebAssembly.Hosting
@inject IWebAssemblyHostEnvironment Env

<h1>Environment example</h1>

<p>Environment: @Env.Environment</p>

Olvasd el a környezetet ügyféloldalon egy Blazor Web App

Feltételezve, hogy az előrendelés nincs letiltva egy összetevő vagy az alkalmazás esetében, a .Client projekt egyik összetevője előrerendelt a kiszolgálón. Mivel a kiszolgáló nem rendelkezik regisztrált IWebAssemblyHostEnvironment szolgáltatással, nem lehet beszúrni a szolgáltatást, és a szolgáltatás implementációjának gazdakörnyezet kiterjesztési módszereit és tulajdonságait használni a kiszolgáló előzetes renderelése során. Ha a szolgáltatást egy Interaktív WebAssembly vagy Interaktív automatikus összetevőbe injektálja, az a következő futtatókörnyezeti hibát eredményezi:

There is no registered service of type 'Microsoft.AspNetCore.Components.WebAssembly.Hosting.IWebAssemblyHostEnvironment'.

Ennek kezeléséhez hozzon létre egy egyéni szolgáltatás-implementációt IWebAssemblyHostEnvironment a kiszolgálón. További információkért és egy példa implementációért olvassa el az szerveren található egyéni szolgáltatás implementációját az Előrenderelési cikkben, amely később jelenik meg a Blazor dokumentációban.

Az ügyféloldali környezet olvasása indításkor

Az indítás során a WebAssemblyHostBuilder tulajdonágon keresztül a IWebAssemblyHostEnvironment elérhetővé teszi a HostEnvironment-t, amely lehetővé teszi a környezetspecifikus logikát a gazdagépszerkesztő kódjában.

A Program fájlban:

if (builder.HostEnvironment.Environment == "Custom")
{
    ...
};

A következő kényelmi kiterjesztési módszerek WebAssemblyHostEnvironmentExtensions lehetővé teszik az aktuális környezet ellenőrzését a Development, Production, Staging és egyéni környezetnevekkel szemben.

• IsDevelopment
• IsProduction
• IsStaging
• IsEnvironment

A Program fájlban:

if (builder.HostEnvironment.IsStaging())
{
    ...
};

if (builder.HostEnvironment.IsEnvironment("Custom"))
{
    ...
};

A IWebAssemblyHostEnvironment.BaseAddress tulajdonság akkor használható indításkor, ha a NavigationManager szolgáltatás nem érhető el.

További erőforrások

• ASP.NET Core Blazor indítási
• ASP.NET Core futtatókörnyezetek
• Blazor GitHub-adattár mintái (dotnet/blazor-samples) (hogyan lehet letölteni)