ASP.NET Core prostředí Blazor

Tento článek vysvětluje, jak nakonfigurovat a přečíst prostředí v aplikaci Blazor.

Při místním spuštění aplikace se prostředí automaticky nastaví na Development. Po publikování aplikace se prostředí ve výchozím nastavení nastaví na Production.

Doporučujeme následující konvence:

• Pro místní vývoj vždy používejte název prostředíDevelopment. Důvodem je to, že architektura ASP.NET Core očekává přesně tento název při konfiguraci aplikace a nástrojů pro místní vývoj aplikací.

• Pro testování, přípravu a produkční prostředí vždy publikujte a nasaďte aplikaci. Můžete použít jakékoli schéma pojmenování prostředí pro publikované aplikace, ale vždy použijte názvy souborů nastavení aplikace s velkými a malými písmeny segmentu prostředí, které přesně odpovídají názvu prostředí. Pro přípravu použijte jako název prostředí "Staging" (velké písmeno "S") a pojmenujte soubor s nastavením aplikace tak, aby odpovídal (appsettings.Staging.json). Pro produkci použijte jako název prostředí "Production" (velké písmeno "P") a soubor s nastavením aplikace pojmenujte tak, aby odpovídal (appsettings.Production.json).

Nastavení prostředí

Prostředí se nastavuje pomocí některého z následujících přístupů:

• Blazor Web App nebo Blazor Server: Pro obecné aplikace ASP.NET Core použijte některý z přístupů popsaných v prostředích ASP.NET Core Runtime .
• Libovolná Blazor aplikace: Blazor spuštění konfigurace
• Samostatná Blazor WebAssembly: <WasmApplicationEnvironmentName> vlastnost

Na klientovi pro Blazor Web App prostředí je určeno serverem prostřednictvím komentáře HTML, se kterým vývojáři neinteragují.

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

Pro samostatnou Blazor WebAssembly aplikaci nastavte prostředí s <WasmApplicationEnvironmentName> vlastností MSBuild v souboru projektu aplikace (.csproj). Následující příklad nastaví Staging prostředí:

<WasmApplicationEnvironmentName>Staging</WasmApplicationEnvironmentName>

Výchozí prostředí jsou Development určená pro sestavení a Production publikování.

Během operací sestavení/publikování existuje několik přístupů k nastavení prostředí v samostatné Blazor WebAssembly aplikaci a jeden přístup pro spuštění nebo spuštění aplikace v klientovi:

• Nastavte hodnotu vlastnosti při spuštění dotnet build nebo dotnet publish. Následující příklad nastaví prostředí na Staging při publikování aplikace:

  dotnet publish -p:WasmApplicationEnvironmentName=Staging
  

• Nastavte vlastnost během sestavování nebo publikování na základě konfigurace aplikace v sadě Visual Studio. Následující skupiny vlastností je možné použít v souboru projektu aplikace nebo v libovolném konfiguračním souboru publikování (.pubxml). Přidejte další skupiny vlastností pro další používané konfigurace sestavení.

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

• Prostředí lze nastavit na základě použití profilu publikování. V následujícím příkladu první podmínka nastaví prostředí tak, aby Development se nepoužíval žádný profil publikování (platí pro operace sestavení i publikování bez profilu), zatímco druhá podmínka zahrnuje nastavení prostředí na Production při použití jakéhokoli profilu publikování:

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

• Vytvořte vlastní koncový bod webového rozhraní API na straně serveru. Samostatná Blazor WebAssembly aplikace vyžaduje své prostředí z webového rozhraní API buď při spuštění aplikace, nebo na vyžádání, když je spuštěná. Hodnota by měla být předána do WebAssemblyStartOptions nebo s withApplicationEnvironment.

  Poznámka

  Odkazy na referenční zdroj .NET v dokumentaci obvykle otevřou výchozí větev úložiště, která představuje aktuální vývoj další verze .NET. Pokud chcete vybrat značku pro konkrétní verzi, použijte rozevírací seznam pro přepnutí mezi větvemi nebo značkami. Další informace najdete v tématu Jak vybrat značku verze zdrojového kódu ASP.NET Core (dotnet/AspNetCore.Docs #26205).

Pro aplikaci běžící místně ve vývojovém prostředí se ve výchozím nastavení použije prostředí Development. Při publikování aplikace se prostředí automaticky nastaví na Production.

Nastavení prostředí na straně klienta pomocí spouštěcí konfigurace Blazor

Následující příklad spustí Blazor v Staging prostředí, pokud název hostitele obsahuje localhost. V opačném případě je prostředí nastaveno na výchozí hodnotu.

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>

V předchozím příkladu symbol {BLAZOR SCRIPT} představuje cestu ke skriptu a název souboru označený zástupcem Blazor. Viz umístění skriptu v ASP.NET Core Blazor struktuře projektu.

Poznámka

U Blazor Web App, které nastavily vlastnost webAssembly>environment v konfiguraci Blazor.start, je vhodné přizpůsobit prostředí na straně serveru prostředí nastavenému na vlastnosti environment. Jinak předběžné vykreslování na serveru funguje v jiném prostředí než vykreslování na klientovi, což vede k libovolným efektům. Obecné pokyny k nastavení prostředí pro Blazor Web App najdete v tématu prostředí modulu runtime ASP.NET Core.

Samostatný Blazor WebAssembly:

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

V předchozím příkladu symbol {BLAZOR SCRIPT} představuje cestu ke skriptu a název souboru označený zástupcem Blazor. Viz umístění skriptu v ASP.NET Core Blazor struktuře projektu.

Pokud chcete protokolovat prostředí do konzole buď v samostatné aplikaci Blazor WebAssembly, nebo v projektu .Client v rámci Blazor Web App, umístěte následující kód jazyka C# do souboru Program po vytvoření WebAssemblyHost pomocí WebAssemblyHostBuilder.CreateDefault a před řádek, který sestaví a spustí projekt (await builder.Build().RunAsync();):

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

Další informace o spuštění Blazor naleznete v tématu ASP.NET Core Blazor startup.

Čtěte prostředí v aplikaci Blazor WebAssembly

Získejte prostředí aplikace v komponentě vložením IWebAssemblyHostEnvironment a přečtením vlastnosti Environment.

ReadEnvironment.razor:

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

<h1>Environment example</h1>

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

Číst prostředí na straně klienta v Blazor Web App

Za předpokladu, že pro komponentu nebo aplikaci není zakázáno předvykreslení, je komponenta v projektu .Client předvykreslena na serveru. Vzhledem k tomu, že server nemá zaregistrovanou službu IWebAssemblyHostEnvironment, není možné službu vkládat a používat metody a vlastnosti rozšíření hostitelského prostředí implementace služby během předrenderingu serveru. Vložením služby do interaktivní WebAssembly nebo interaktivní automatizační komponenty dojde k následující běhové chybě:

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

Pokud to chcete vyřešit, vytvořte vlastní implementaci služby pro IWebAssemblyHostEnvironment na serveru. Další informace a ukázkovou implementaci najdete v části Vlastní implementace služby na serveru článku Prerendering , který se zobrazí dále v Blazor dokumentaci.

Načítání klientského prostředí při spuštění

Během spuštění WebAssemblyHostBuilder zpřístupňuje IWebAssemblyHostEnvironment prostřednictvím vlastnosti HostEnvironment, která umožňuje logiku specifickou pro prostředí v kódu tvůrce hostitelů.

V souboru Program:

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

Následující pomocné metody rozšíření poskytované prostřednictvím WebAssemblyHostEnvironmentExtensions umožňují kontrolovat aktuální prostředí na Development, Production, Staginga vlastní názvy prostředí:

• IsDevelopment
• IsProduction
• IsStaging
• IsEnvironment

V souboru Program:

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

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

Vlastnost IWebAssemblyHostEnvironment.BaseAddress lze použít při spuštění, pokud není služba NavigationManager k dispozici.

Další zdroje informací

• ASP.NET Core Blazor spouštěcí
• prostředí ASP.NET Core Runtime
• Blazor ukázky úložiště GitHub (dotnet/blazor-samples) (jak stáhnout)