Vývoj ASP.NET Core aplikací pomocí služby File Watcher

Od Ricka Andersona a Odyma Hurd nesrozumite.

dotnet watch je nástroj, který spustí příkaz .NET Core CLI, když se změní zdrojové soubory. Například změna souboru může aktivovat kompilaci, spuštění testu nebo nasazení.

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

Stáhněte si ukázkovou aplikaci. Skládá se ze dvou projektů: Webová aplikace (ASP.NET Core webové rozhraní API) 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 jako v následujícím příkladu (což znamená, že aplikace běží a čeká na požadavky):

$ 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 adresu http://localhost:<port number>/api/math/sum?a=4&b=5. Měl by se zobrazit výsledek 9 .

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

Spouštění .NET Core CLI příkazů pomocí dotnet watch

Jakýkoli .NET Core CLI lze spustit pomocí dotnet watch příkazu . Například:

Spusťte dotnet watch run ve složce WebApp. Výstup konzoly watch indikuje, že se zahájilo.

Provedení změn pomocí dotnet watch

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

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

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

Soubor uložte. Výstup konzoly znamená, dotnet watch že se zjistila změna souboru a aplikace se restartoval.

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

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

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

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 indikuje, že test selhal a že se soubor čeká na provedení testu:

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

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

dotnet watch rozpozná změnu souboru a znovu testy. Výstup konzoly označuje, že testy byly úspěšně provedeny.

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

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

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

Další položky je možné přidat do seznamu ke zkoumkách úpravou souboru .csproj. Položky je možné zadat jednotlivě nebo pomocí vzorů glob.

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

Odhlášení ze sledování souborů

dotnet-watch lze nakonfigurovat tak, aby ignorovala výchozí nastavení. Pokud chcete ignorovat konkrétní soubory, přidejte atribut do Watch="false" definice položky v souboru .csproj:

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

Vlastní projekty hodinek

dotnet-watch není omezen na projekty C#. Vlastní projekty 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ý pro sledování obou projektů:

<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, změňte na testovací složku. Spusťte následující příkaz:

dotnet watch msbuild /t:Test

VSTest se spustí při změně jakéhokoli souboru v libovolném testovacím projektu.

konfigurace dotnet-watch

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

Aktualizace prohlížeče

dotnet watch vloží do aplikace skript, který umožňuje aktualizovat prohlížeč při změně obsahu. V některých scénářích, například když aplikace povoluje kompresi odpovědí, nemusí být skript dotnet watch schopen vložit. Pro takové případy vývoje ručně zadat skript do aplikace. Pokud například chcete nakonfigurovat webovou aplikaci pro ruční vložení skriptu, 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>