Dosya izleyici kullanarak ASP.NET Core uygulamaları geliştirme

Tarafından Rick Anderson ve Victor Hurdugaci

dotnet watch, kaynak dosyalar değiştiğinde .NET CLI komutu çalıştıran bir araçtır. Örneğin, bir dosya değişikliği derlemeyi, test yürütmeyi veya dağıtımı tetikleyebilir.

Bu öğreticide, biri toplam, diğeri de ürün döndüren olmak üzere iki uç noktası olan mevcut bir web API'si kullanılır. Ürün yönteminde bu öğreticide düzeltilen bir hata var.

Örnek uygulamayı indirin. İki projeden oluşur: WebApp (ASP.NET Core web API'si) ve WebAppTests (web API'sinin birim testleri).

Komut kabuğunda WebApp klasörüne gidin. Aşağıdaki komutu çalıştırın:

dotnet run

Konsol çıkışı aşağıdakine benzer iletiler gösterir (uygulamanın çalıştığını ve istekleri beklediğini belirtir):

$ dotnet run
Hosting environment: Development
Content root path: C:/Docs/aspnetcore/tutorials/dotnet-watch/sample/WebApp
Now listening on: http://localhost:5000
Application started. Press Ctrl+C to shut down.

Web tarayıcısında adresine http://localhost:<port number>/api/math/sum?a=4&b=5gidin. sonucunu 9görmeniz gerekir.

Ürün API'sine (http://localhost:<port number>/api/math/product?a=4&b=5) gidin. Beklediğiniz gibi değil 20 döndürür9. Bu sorun öğreticinin ilerleyen bölümlerinde düzeltilmiştir.

kullanarak .NET CLI komutlarını çalıştırma dotnet watch

Herhangi bir .NET CLI komutu ile dotnet watchçalıştırılabilir. Örneğin:

WebApp klasöründe komutunu çalıştırındotnet watch run. Konsol çıkışı başlatıldığını gösterir watch .

ile değişiklik yapma dotnet watch

Çalıştığından emin dotnet watch olun.

yönteminin Product toplamını değil ürünü döndürmesi MathController.cs için hata düzeltildi:

public static int Product(int a, int b)
{
    return a * b;
}

Dosyayı kaydedin. Konsol çıkışı, bir dosya değişikliği algılandığını dotnet watch ve uygulamayı yeniden başlatıldığını gösterir.

Doğrula http://localhost:<port number>/api/math/product?a=4&b=5 işlevi doğru sonucu verir.

Kullanarak testleri çalıştırma dotnet watch

1. Product geri yöntemini MathController.cs toplamı döndürecek şekilde değiştirin. Dosyayı kaydedin.

2. Komut kabuğunda WebAppTests klasörüne gidin.

3. dotnet restore komutunu çalıştırın.

4. dotnet watch test'i çalıştırın. Çıktısı bir testin başarısız olduğunu ve izleyicinin dosya değişikliklerini beklediğini gösterir:

   Total tests: 2. Passed: 1. Failed: 1. Skipped: 0.
   Test Run Failed.
   

5. Yöntem kodunu düzelterek Product ürünü döndürmesini sağlayın. Dosyayı kaydedin.

dotnet watch dosya değişikliğini algılar ve testleri yeniden çalıştırır. Konsol çıkışı, geçirilen testleri gösterir.

İzleyebileceğiniz dosya listesini özelleştirme

Varsayılan olarak, dotnet-watch aşağıdaki glob desenleri ile eşleşen tüm dosyaları izler:

• **/*.cs
• *.csproj
• **/*.resx
• İçerik dosyaları: wwwroot/**, **/*.config, **/*.json

Dosyayı düzenleyerek .csproj izleme listesine daha fazla öğe eklenebilir. Öğeler tek tek veya glob desenleri kullanılarak belirtilebilir.

<ItemGroup>
    <!-- extends watching group to include *.js files -->
    <Watch Include="**\*.js" Exclude="node_modules\**\*;**\*.js.map;obj\**\*;bin\**\*" />
</ItemGroup>

İzlenecek dosyaları geri çevirme

dotnet-watch varsayılan ayarlarını yoksayacak şekilde yapılandırılabilir. Belirli dosyaları yoksaymak için özniteliğini Watch="false" dosyadaki bir öğenin tanımına .csproj ekleyin:

<ItemGroup>
    <!-- exclude Generated.cs from dotnet-watch -->
    <Compile Include="Generated.cs" Watch="false" />

    <!-- exclude Strings.resx from dotnet-watch -->
    <EmbeddedResource Include="Strings.resx" Watch="false" />

    <!-- exclude changes in this referenced project -->
    <ProjectReference Include="..\ClassLibrary1\ClassLibrary1.csproj" Watch="false" />
</ItemGroup>

<ItemGroup>
     <!-- Exclude all Content items from being watched. -->
    <Content Update="@(Content)" Watch="false" />
</ItemGroup>

Özel izleme projeleri

dotnet-watch C# projeleri ile sınırlı değildir. Farklı senaryoları işlemek için özel izleme projeleri oluşturulabilir. Aşağıdaki proje düzenini göz önünde bulundurun:

• Test/
  • UnitTests/UnitTests.csproj
  • IntegrationTests/IntegrationTests.csproj

Hedef her iki projeyi de izlemekse, her iki projeyi de izlemek üzere yapılandırılmış özel bir proje dosyası oluşturun:

<Project>
    <ItemGroup>
        <TestProjects Include="**\*.csproj" />
        <Watch Include="**\*.cs" />
    </ItemGroup>

    <Target Name="Test">
        <MSBuild Targets="VSTest" Projects="@(TestProjects)" />
    </Target>

    <Import Project="$(MSBuildExtensionsPath)\Microsoft.Common.targets" />
</Project>

Her iki projede de dosya izlemeye başlamak için test klasörüne geçin. Şu kodu yürütün:

dotnet watch msbuild /t:Test

VsTest, herhangi bir test projesinde herhangi bir dosya değiştiğinde yürütülür.

dotnet-watch yapılandırması

Bazı yapılandırma seçenekleri ortam değişkenleri aracılığıyla geçirilebilir dotnet watch . Kullanılabilir değişkenler şunlardır:

Tarayıcı yenileme

dotnet watch uygulamaya, içerik değiştiğinde tarayıcıyı yenilemesini sağlayan bir betik ekler. Uygulamanın yanıt sıkıştırmayı dotnet watch etkinleştirdiği durumlar gibi bazı senaryolarda betiği ekleyemeyebilir . Geliştirme aşamasındaki bu gibi durumlarda betiği uygulamaya el ile ekleyin. Örneğin, web uygulamasını betiği el ile eklenecek şekilde yapılandırmak için düzen dosyasını içerecek _framework/aspnet-browser-refresh.jsşekilde güncelleştirin:

@* _Layout.cshtml *@
<environment names="Development">
    <script src="/_framework/aspnetcore-browser-refresh.js"></script>
</environment>

ASCII olmayan karakterler

Visual Studio 17.2 ve üzeri .NET SDK 6.0.300 ve üzerini içerir. .NET SDK ve 6.0.300 sonraki sürümlerinde, dotnet-watch etkin yeniden yükleme oturumu sırasında konsola ASCII olmayan karakterler yayar. Windows conhost gibi bazı konsol konaklarında bu karakterler bozuk görünebilir. Bozuk karakterleri önlemek için aşağıdaki yaklaşımlardan birini göz önünde bulundurun:

• Ortam değişkenini DOTNET_WATCH_SUPPRESS_EMOJIS=1 bu değerlerin yayılmalarını engelleyerek yapılandırın.
• ASCII olmayan karakterlerin işlenmesini destekleyen gibi https://github.com/microsoft/terminalfarklı bir terminale geçin.