ASP.NET Core-apps ontwikkelen met behulp van een file watcher

Door Rick Anderson en Victor Hurdugaci

dotnet watch is een hulpprogramma waarmee een .NET CLI-opdracht wordt uitgevoerd wanneer bronbestanden worden gewijzigd. Een bestandswijziging kan bijvoorbeeld compilatie, testuitvoering of implementatie activeren.

In deze zelfstudie wordt een bestaande web-API met twee eindpunten gebruikt: een api die een som retourneert en één die een product retourneert. De productmethode heeft een bug, die in deze handleiding is opgelost.

Download de voorbeeld-app. Het bestaat uit twee projecten: WebApp (een ASP.NET Core-web-API) en WebAppTests (eenheidstests voor de web-API).

Navigeer in een opdrachtshell naar de map WebApp . Voer de volgende opdracht uit:

dotnet run

In de console-uitvoer ziet u berichten die vergelijkbaar zijn met het volgende (waarmee wordt aangegeven dat de app wordt uitgevoerd en in afwachting is van aanvragen):

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

Navigeer in een webbrowser naar http://localhost:<port number>/api/math/sum?a=4&b=5. U zou het resultaat van 9 moeten zien.

Navigeer naar de product-API (http://localhost:<port number>/api/math/product?a=4&b=5). Het retourneert 9, niet 20 zoals u zou verwachten. Dit probleem is verderop in de zelfstudie opgelost.

.NET CLI-opdrachten uitvoeren met behulp van dotnet watch

Elke .NET CLI-opdracht kan worden uitgevoerd met dotnet watch. For example:

Voer dotnet watch run uit in de map WebApp. De console-uitvoer geeft aan dat watch is gestart.

Wijzigingen aanbrengen met dotnet watch

Zorg ervoor dat dotnet watch wordt uitgevoerd.

Corrigeer de fout in de Product methode zodat MathController.cs het het product retourneert en niet de som:

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

Sla het bestand op. De console-uitvoer geeft aan dat dotnet watch er een bestandswijziging is gedetecteerd en de app opnieuw is opgestart.

Controleer of http://localhost:<port number>/api/math/product?a=4&b=5 het juiste resultaat wordt geretourneerd.

Tests uitvoeren met dotnet watch

1. Wijzig de Product methode van MathController.cs zodat deze de som teruggeeft. Sla het bestand op.

2. Navigeer in een opdrachtshell naar de map WebAppTests .

3. Voer dotnet-herstel uit.

4. Voer dotnet watch testuit. De uitvoer geeft aan dat een test is mislukt en dat de watcher op bestandswijzigingen wacht:

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

5. Corrigeer de Product methodecode zodat het product wordt geretourneerd. Sla het bestand op.

dotnet watch detecteert de bestandswijziging en voert de tests opnieuw uit. De console-uitvoer geeft aan dat de tests zijn geslaagd.

Bestandenlijst aanpassen om te bekijken

dotnet-watch Standaard worden alle bestanden bijgehouden die overeenkomen met de volgende globpatronen:

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

Meer items kunnen aan de volglijst worden toegevoegd door het .csproj bestand te bewerken. Items kunnen afzonderlijk worden opgegeven of door globpatronen te gebruiken.

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

Afmelden voor bestanden die moeten worden bekeken

dotnet-watch kan worden geconfigureerd om de standaardinstellingen te negeren. Als u specifieke bestanden wilt negeren, voegt u het kenmerk toe aan de Watch="false" definitie van een item in het .csproj bestand:

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

Aangepaste horlogeprojecten

dotnet-watch is niet beperkt tot C#-projecten. Aangepaste watchprojecten kunnen worden gemaakt om verschillende scenario's af te handelen. Houd rekening met de volgende projectindeling:

• test/
  • UnitTests/UnitTests.csproj
  • IntegrationTests/IntegrationTests.csproj

Als het doel is om beide projecten te bekijken, maakt u een aangepast projectbestand dat is geconfigureerd om beide projecten te bekijken:

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

Om het bekijken van bestanden bij beide projecten te starten, ga naar de test map. Voer de volgende opdracht uit:

dotnet watch msbuild /t:Test

VSTest wordt uitgevoerd wanneer bestanden in een testproject worden gewijzigd.

dotnet-watch configuration

Sommige configuratieopties kunnen aan dotnet watch worden doorgegeven via omgevingsvariabelen. De beschikbare variabelen zijn:

Browser refresh

dotnet watch injecteert een script in de app dat het mogelijk maakt de browser te verversen wanneer de inhoud verandert. In sommige scenario's, zoals wanneer de app reactiecompressie inschakelt, dotnet watch kan het script mogelijk niet worden geïnjecteerd. Voor dergelijke gevallen in ontwikkeling moet u het script handmatig in de app injecteren. Als u bijvoorbeeld de web-app wilt configureren voor het handmatig injecteren van het script, werkt u het indelingsbestand bij met _framework/aspnet-browser-refresh.js:

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

Non-ASCII characters

Visual Studio 17.2 of hoger bevat de .NET SDK 6.0.300 of hoger. Met de .NET SDK versie 6.0.300 en later, verzendt dotnet-watch niet-ASCII-tekens naar de console tijdens een hot reload sessie. Op bepaalde consolehosts, zoals de Windows-conhost, kunnen deze tekens vervormd worden weergegeven. Als u vervormde tekens wilt voorkomen, kunt u een van de volgende methoden overwegen:

• Configureer de DOTNET_WATCH_SUPPRESS_EMOJIS=1 omgevingsvariabele om deze waarden te onderdrukken.
• Schakel over naar een andere terminal, zoals https://github.com/microsoft/terminal, die ondersteuning biedt voor het weergeven van niet-ASCII-tekens.