Vývoj aplikací ASP.NET Core pomocí sledovacího nástroje pro soubory

Rick Anderson a Victor Hurdugaci

dotnet watch je nástroj, který při změně zdrojových souborů spouští příkaz .NET CLI . Například změna souboru může aktivovat kompilaci, spuštění testu nebo nasazení.

Tento kurz používá existující webové rozhraní API se dvěma koncovými body: jedno, které vrací součet a jedno, které vrací produkt. Metoda produktu obsahuje chybu, která je opravena v tomto kurzu.

Stáhněte si ukázkovou aplikaci. Skládá se ze dvou projektů: Webová aplikace (webové rozhraní API ASP.NET Core) a WebAppTests (testy jednotek pro webové rozhraní API).

V příkazovém prostředí přejděte do složky Webové aplikace . Spusťte následující příkaz:

dotnet run

Výstup konzoly zobrazuje podobné zprávy (označující, že aplikace běží a čeká na žádosti):

$ 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.

Ve webovém prohlížeči přejděte na http://localhost:<port number>/api/math/sum?a=4&b=5. Měli byste vidět výsledek 9.

Přejděte do rozhraní API produktu (http://localhost:<port number>/api/math/product?a=4&b=5). 9Vrátí , ne 20 tak, jak byste očekávali. Tento problém je opraven později v kurzu.

Spouštění příkazů rozhraní příkazového řádku .NET pomocí dotnet watch

Jakýkoli příkaz .NET CLI lze spustit pomocí dotnet watchpříkazu . Příklad:

Spusťte dotnet watch run ve složce webové aplikace . Výstup konzoly indikuje watch , že se spustil.

Provádění změn pomocí dotnet watch

Ujistěte se, že dotnet watch je spuštěný.

Opravte chybu v Product metodě MathController.cs tak, aby vrátil produkt, a ne součet:

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

Uložte soubor. Výstup konzoly označuje, že dotnet watch se zjistila změna souboru a restartovala aplikaci.

Ověřte http://localhost:<port number>/api/math/product?a=4&b=5 , že vrátí správný výsledek.

Spouštění testů pomocí dotnet watch

1. Změňte metodu Product MathController.cs zpět na vrácení součtu. Uložte soubor.

2. V příkazovém prostředí přejděte do složky WebAppTests .

3. Spusťte dotnet restore.

4. Spusťte dotnet watch test. Jeho výstup označuje, že test selhal a že sledovací proces čeká na změny souboru:

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

5. Product Opravte kód metody tak, aby vrátil produkt. Uložte soubor.

dotnet watch zjistí změnu souboru a znovu spustí testy. Výstup konzoly označuje úspěšné testy.

Přizpůsobení seznamu souborů ke sledování

Ve výchozím nastavení sleduje všechny soubory odpovídající dotnet-watch následujícím vzorům globu:

• **/*.cs
• *.csproj
• **/*.resx
• Soubory obsahu: wwwroot/**, **/*.config, **/*.json

Do seznamu sledování můžete přidat další položky úpravou .csproj souboru. Položky lze zadat jednotlivě nebo pomocí vzorů globu.

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

Odhlášení souborů, které se mají sledovat

dotnet-watch je možné nakonfigurovat tak, aby ignorovala výchozí nastavení. Pokud chcete určité soubory ignorovat, přidejte Watch="false" do definice položky v .csproj souboru atribut:

<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>

Projekty vlastních hodinek

dotnet-watch není omezena na projekty jazyka C#. Projekty vlastních hodinek je možné vytvořit pro zpracování různých scénářů. Zvažte následující rozložení projektu:

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

Pokud je cílem sledovat oba projekty, vytvořte vlastní soubor projektu nakonfigurovaný tak, aby sledoval oba projekty:

<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>

Pokud chcete spustit sledování souborů v obou projektech, přejděte do testovací složky. Spusťte následující příkaz:

dotnet watch msbuild /t:Test

VSTest se spustí, když se jakýkoli soubor změní v některém testovacím projektu.

konfigurace dotnet-watch

Některé možnosti konfigurace je možné předat dotnet watch prostřednictvím proměnných prostředí. Dostupné proměnné jsou:

Aktualizace prohlížeče

dotnet watch vloží skript do aplikace, která umožňuje aktualizovat prohlížeč při změně obsahu. V některých scénářích, například když aplikace povolí kompresi odpovědí, dotnet watch nemusí být schopná vložit skript. V takových případech při vývoji ručně vložte skript do aplikace. Pokud chcete například nakonfigurovat webovou aplikaci tak, aby skript vložil ručně, aktualizujte soubor rozložení tak, aby zahrnoval _framework/aspnet-browser-refresh.js:

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

Jiné znaky než ASCII

Visual Studio 17.2 a novější obsahuje sadu .NET SDK 6.0.300 a novější. Se sadou .NET SDK a 6.0.300 novějším dotnet-watch vygeneruje do konzoly znaky jiné než ASCII během relace opětovného načítání za provozu. U některých hostitelů konzoly, jako je například hostitel systému Windows, se tyto znaky můžou objevit zkomolené. Abyste se vyhnuli zkomoleným znakům, zvažte jeden z následujících přístupů:

• Nakonfigurujte proměnnou DOTNET_WATCH_SUPPRESS_EMOJIS=1 prostředí tak, aby potlačí generování těchto hodnot.
• Přepněte na jiný terminál, například https://github.com/microsoft/terminal, který podporuje vykreslování znaků jiných než ASCII.