ASP.NET Core Blazor ortamları

Bu makale, bir Blazor uygulamasında ortamını nasıl yapılandıracağınızı ve okuyacağınızı açıklar.

Bir uygulamayı yerel olarak çalıştırırken, ortam varsayılan olarak Developmentolarak değiştirilir. Uygulama yayımlandığında ortam varsayılan olarak Productionolarak ayarlanır.

Aşağıdaki kuralları öneririz:

• Yerel geliştirme için her zaman "Development" ortam adını kullanın. Bunun nedeni, ASP.NET Core çerçevesinin uygulamayı yapılandırırken tam olarak bu adı beklemesi ve bir uygulamanın yerel geliştirme çalıştırmaları için araçlara sahip olmasıdır.

• Test, hazırlama ve üretim ortamları için uygulamayı her zaman yayımlayın ve dağıtın. Yayımlanan uygulamalar için istediğiniz ortam adlandırma düzenini kullanabilirsiniz, ancak her zaman ortam adıyla tam olarak eşleşen ortam kesiminin büyük/küçük harflerini içeren uygulama ayarı dosya adlarını kullanabilirsiniz. Hazırlama için ortam adı olarak "Staging" (büyük "S") kullanın ve uygulama ayarları dosyasını eşleşecek şekilde adlandırın (appsettings.Staging.json). Üretim için ortam adı olarak "Production" (büyük "P") kullanın ve uygulama ayarları dosyasını eşleşecek şekilde adlandırın (appsettings.Production.json).

Ortamı ayarlama

Yerel olarak çalışan tek başına bir Blazor WebAssembly uygulaması için geliştirme sunucusu, barındırma ortamından alınan ortam adıyla Blazor-Environment üst bilgisini ekler. Barındırma ortamı, projenin Properties/launchSettings.json dosyası tarafından oluşturulan ASPNETCORE_ENVIRONMENT ortam değişkeninden ortamı ayarlar. Blazor WebAssembly proje şablonundan oluşturulan bir projedeki ortam değişkeninin varsayılan değeri Development. Daha fazla bilgi için üst bilgi aracılığıyla istemci tarafı ortamını ayarlama bölümüne bakın.

Uygulamanın geliştirme aşamasında yerel olarak çalışması için uygulama varsayılan olarak Development ortamına ayarlı olur. Uygulamayı yayımlamak, ortamı varsayılan olarak Productionolarak ayarlıyor.

Blazor başlangıç yapılandırması aracılığıyla istemci tarafı ortamını ayarlama

Aşağıdaki örnek, konak adı localhostiçeriyorsa, Staging ortamında Blazor olarak başlar. Aksi takdirde ortam varsayılan değerine ayarlanır.

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

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

Yukarıdaki örnekte, {BLAZOR SCRIPT} yer tutucusu Blazor betik yolu ve dosya adıdır. Betiğin konumu için bkz. ASP.NET Core Blazor proje yapısı.

environment özelliğinin kullanılması, Blazor-Environment üst bilgisitarafından ayarlanan ortamı geçersiz kılar.

Önceki yaklaşım, istemcinin ortamını Blazor-Environment başlığının değerini değiştirmeden ayarlar ve genel Etkileşimli WebAssembly işlemeyi benimseyen bir Blazor Web App için sunucu projesinin başlangıç ortamının konsol kayıtlarını değiştirmez.

Bir Blazor WebAssembly projesi veya bir Blazor Web App.Client projesinde ortamı konsola kaydetmek için, WebAssemblyHost, WebAssemblyHostBuilder.CreateDefault ile oluşturulduktan sonra ve projeyi oluşturup çalıştıran satırdan önce aşağıdaki C# kodunu Program dosyasına yerleştirin (await builder.Build().RunAsync();).

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

Blazor başlangıç hakkında daha fazla bilgi için bkz. ASP.NET Core Blazor başlangıç.

üst bilgi aracılığıyla istemci tarafı ortamını ayarlayın

Blazor WebAssembly uygulamalar ortamı Blazor-Environment başlığı üzerinden ayarlayabilir. Özellikle, yanıt üst bilgisinin _framework/blazor.boot.json dosyasında ayarlanması gerekir, ancak diğer Blazor dosya istekleri veya Blazor dağıtımının tamamı için dosya sunucusu yanıtlarında üst bilgiyi ayarlamanın bir zararı yoktur.

Blazor çerçevesi üst bilgi adını karma harf durumunda kebap biçimiyle verir (Blazor-Environment), ancak tümü küçük harf veya tümü büyük harf kebap biçimi kullanabilirsiniz (blazor-environment, BLAZOR-ENVIRONMENT).

Blazor'nin yerleşik geliştirme sunucusuyla yerel geliştirme çalıştırmaları için, projenin Properties/launchSettings.json dosyasındaki ASPNETCORE_ENVIRONMENT ortam değişkeninin değerini ayarlayarak Blazor-Environment üst bilgisinin değerini denetleyebilirsiniz. Geliştirme sunucusuyla yerel olarak çalışırken, uygulamanın ortamını belirlemek için öncelik sırası Blazor.start yapılandırma (environment anahtar)>Blazor-Environment yanıt üst bilgisi (blazor.boot.json dosyası) >ASPNETCORE_ENVIRONMENT ortam değişkenidir (launchSettings.json). Dağıtılan bir Blazor WebAssembly uygulaması için ASPNETCORE_ENVIRONMENT ortam değişkeni (launchSettings.json) yaklaşımını kullanamazsınız. Bu teknik yalnızca uygulamanın yerel çalıştırmalarında geliştirme sunucusuyla çalışır.

IIS

Iis için aşağıdaki örnekte, yayımlanan web.config dosyasına özel üst bilgi (Blazor-Environment) eklenir. web.config dosyası, {TARGET FRAMEWORK} yer tutucusunun hedef çerçeve olduğu bin/Release/{TARGET FRAMEWORK}/publish klasöründe bulunur:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
  <system.webServer>
    ...
    <httpProtocol>
      <customHeaders>
        <add name="Blazor-Environment" value="Staging" />
      </customHeaders>
    </httpProtocol>
  </system.webServer>
</configuration>

Nginx

Nginx sunucuları için ngx_http_headers_moduleadd_header yönergesini kullanın:

http {
    server {
        ...
        location / {
            ...
            add_header Blazor-Environment "Staging";
        }
    }
}

Daha fazla bilgi için aşağıdaki kaynaklara bakın:

• Nginx belgeleri
• Blazor WebAssembly Nginx barındırma kılavuzu

Apache

Apache sunucuları için mod_headers modülündeki Header yönergesini kullanın:

<VirtualHost *:80>
    ...
    Header set Blazor-Environment "Staging"
    ...
</VirtualHost>

Daha fazla bilgi için:

• Apache belgelerine ("mod_headers")
• apache barındırma kılavuzu

Azure App Service ortamını ayarlama

Blazor WebAssembly bağımsız bir uygulama için, başlatma yapılandırması veya Blazor-Environment üst bilgisiüzerinden ortamı el ile ayarlayabilirsiniz.

Sunucu tarafı bir uygulama için Ortamı Azure'daki bir ASPNETCORE_ENVIRONMENT uygulama ayarı aracılığıyla ayarlayın:

1. Uygulama ayarları dosya adlarındaki ortam segmentlerinin, ortam adıyla büyük/küçük harf uyumunu tam olarak sağladığından emin olun. Örneğin, Staging ortamı için eşleşen uygulama ayarları dosya adı appsettings.Staging.json. Dosya adı appsettings.staging.json (küçük harf "s") ise, dosya bulunmaz ve dosyadaki ayarlar Staging ortamında kullanılmaz.

2. Visual Studio dağıtımı için uygulamanın doğru dağıtım yuvasına dağıtıldığını onaylayın. BlazorAzureAppSampleadlı bir uygulama için, uygulama Staging dağıtım yuvasına dağıtılır.

3. Ortamın dağıtım yuvası için Azure portalında ortamı ASPNETCORE_ENVIRONMENT uygulama ayarıyla ayarlayın. Bir BlazorAzureAppSampleuygulaması için hazırlık aşaması App Service Yuvası BlazorAzureAppSample/Stagingolarak adlandırılır. Staging yuvasının yapılandırması için ASPNETCORE_ENVIRONMENT için Stagingdeğerine sahip bir uygulama ayarı oluşturun. Dağıtım yuvası ayarı için etkinleştirilmiştir.

Tarayıcıda istendiğinde, BlazorAzureAppSample/Staging uygulaması https://blazorazureappsample-staging.azurewebsites.netkonumundaki Staging ortamında yüklenir.

Uygulama tarayıcıda yüklendiğinde, blazor.boot.json için yanıt üst bilgisi koleksiyonu Blazor-Environment üst bilgi değerinin Stagingolduğunu gösterir.

Uygulama, {ENVIRONMENT} yer tutucusunun uygulamanın ortamı olduğu appsettings.{ENVIRONMENT}.json dosyasındaki ayarları yükler. Yukarıdaki örnekte, appsettings.Staging.json dosyasındaki ayarlar yüklenir.

Blazor WebAssembly uygulamasında ortamı okuma

IWebAssemblyHostEnvironment ekleyerek ve Environment özelliğini okuyarak uygulamanın ortamını bir bileşende edinin.

ReadEnvironment.razor:

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

<h1>Environment example</h1>

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

using Microsoft.AspNetCore.Components.WebAssembly.Hosting;
using Microsoft.AspNetCore.Components;

public class ServerHostEnvironment(IWebHostEnvironment env, NavigationManager nav) : 
    IWebAssemblyHostEnvironment
{
    public string Environment => env.EnvironmentName;
    public string BaseAddress => nav.BaseUri;
}

builder.Services.TryAddScoped<IWebAssemblyHostEnvironment, ServerHostEnvironment>();

Başlatma sırasında istemci tarafı ortamını oku

Başlatma sırasında WebAssemblyHostBuilder, HostEnvironment özelliği aracılığıyla IWebAssemblyHostEnvironment'i, konak oluşturucu kodunda ortama özgü mantığı etkinleştiren şekilde kullanıma sunar.

Program dosyasında:

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

WebAssemblyHostEnvironmentExtensions aracılığıyla sağlanan aşağıdaki kolaylık uzantısı yöntemleri, Development, Production, Stagingve özel ortam adları için geçerli ortamı denetlemeye izin verir:

• IsDevelopment
• IsProduction
• IsStaging
• IsEnvironment

Program dosyasında:

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

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

IWebAssemblyHostEnvironment.BaseAddress özelliği, NavigationManager hizmeti kullanılamadığında başlatma sırasında kullanılabilir.

Ek kaynaklar

• ASP.NET Core Blazor başlatma
• ASP.NET Core'da birden çok ortam kullanma
• Blazor örnekleri GitHub deposu (dotnet/blazor-samples) (nasıl indirileceği)