다음을 통해 공유

파일 감시자를 사용하여 ASP.NET Core 앱 개발

  • 아티클

작성자: Rick Anderson 및 Victor Hurdugaci

dotnet watch 는 원본 파일이 변경되면 .NET CLI 명령을 실행하는 도구입니다. 예를 들어 파일 변경은 컴파일, 테스트 실행 또는 배포를 트리거할 수 있습니다.

이 자습서에서는 합계를 반환하는 엔드포인트 및 제품을 반환하는 엔드포인트 등 두 개의 엔드포인트에서 기존 Web API를 사용합니다. 제품 메서드에는 버그가 있습니다. 이 문제가 이 자습서에서 해결되었습니다.

샘플 앱을 다운로드합니다. WebApp(ASP.NET Core Web API) 및 WebAppTests(Web API의 단위 테스트)라는 두 개의 프로젝트로 구성됩니다.

명령 셸에서 WebApp 폴더로 이동합니다. 다음 명령을 실행합니다.

dotnet run

참고 항목

dotnet run --project <PROJECT>를 사용하여 실행할 프로젝트를 지정할 수 있습니다. 예를 들어 샘플 앱의 루트에서 dotnet run --project WebApp을 실행하면 WebApp 프로젝트도 실행됩니다.

콘솔 출력은 다음과 유사한 메시지를 표시합니다(앱이 실행되고 요청을 대기하는 것을 나타냄).

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

웹 브라우저에서 http://localhost:<port number>/api/math/sum?a=4&b=5으로 이동합니다. 9라는 결과가 표시됩니다.

API 제품으로 이동합니다(http://localhost:<port number>/api/math/product?a=4&b=5). 예상한 대로 20이 아니라 9를 반환합니다. 이러한 문제는이 자습서의 뒷부분에서 해결되었습니다.

프로젝트에 dotnet watch 추가

dotnet watch 파일 감시자 도구는 .NET Core SDK 버전 2.1.300에 포함되어 있습니다. 다음 단계는 이전 버전의 .NET Core SDK를 사용하는 경우에 필요합니다.

  1. .csproj 파일에 Microsoft.DotNet.Watcher.Tools 패키지 참조를 추가합니다.

    <ItemGroup>
    <DotNetCliToolReference Include="Microsoft.DotNet.Watcher.Tools" Version="2.0.0" />
</ItemGroup>

  2. 다음 명령을 실행하여 Microsoft.DotNet.Watcher.Tools 패키지를 설치합니다.

    dotnet restore

를 사용하여 .NET CLI 명령 실행 dotnet watch

모든 .NET CLI 명령은 ..NET CLI 명령을 사용하여 dotnet watch실행할 수 있습니다. 예시:

명령 watch를 사용하는 명령
dotnet run dotnet watch run
dotnet run -f netcoreapp3.1 dotnet watch run -f netcoreapp3.1
dotnet run -f netcoreapp3.1 -- --arg1 dotnet watch run -f netcoreapp3.1 -- --arg1
dotnet test dotnet watch 테스트

WebApp 폴더에서 dotnet watch run을 실행합니다. 콘솔 출력은 watch가 시작했음을 나타냅니다.

웹앱에서 dotnet watch run을 실행하면 준비된 앱의 URL로 이동하는 브라우저가 시작됩니다. dotnet watch는 앱의 콘솔 출력값을 읽고 WebHost에서 표시하는 준비 메시지를 대기하여 이 작업을 수행합니다.

dotnet watch는 감시된 파일의 변경 내용을 검색할 때 브라우저를 새로 고칩니다. 이렇게 하려면 조사식 명령이 앱에서 만든 HTML 응답을 수정하는 미들웨어를 앱에 삽입합니다. 미들웨어는 dotnet watch를 허용하는 JavaScript 스크립트 블록을 페이지에 추가하여 브라우저를 새로 고치도록 합니다. 현재 감시된 모든 파일(예: .html 정적 콘텐츠 및 .css 파일)이 변경되면 앱이 다시 빌드됩니다.

dotnet watch:

  • 기본적으로 빌드에 영향을 주는 파일만 감시합니다.
  • 구성을 통해 추가로 감시된 파일이 있으면 빌드가 수행됩니다.

구성에 대한 자세한 내용은 이 문서의 dotnet-watch 구성을 참조하세요.

참고 항목

dotnet watch --project <PROJECT>를 사용하여 감시할 프로젝트를 지정할 수 있습니다. 예를 들어 샘플 앱의 루트에서 dotnet watch --project WebApp run을 실행하면 WebApp 프로젝트도 실행 및 감시됩니다.

dotnet watch 변경

dotnet watch가 실행되고 있는지 확인합니다.

합계가 아닌 제품을 반환하도록 MathController.cs의 Product 메서드에서 버그를 수정합니다.

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

파일을 저장합니다. 콘솔 출력은 dotnet watch에서 파일 변경을 검색했고 앱을 다시 시작했음을 나타냅니다.

http://localhost:<port number>/api/math/product?a=4&b=5에서 올바른 결과를 반환하는지 확인합니다.

dotnet watch를 사용하여 테스트 실행

  1. 합계를 Product 반환하도록 다시 메서드 MathController.cs 를 변경합니다. 파일을 저장합니다.

  2. 명령 셸에서 WebAppTests 폴더로 이동합니다.

  3. dotnet restore를 실행합니다.

  4. dotnet watch test를 실행합니다. 이 출력은 테스트에 실패했으며 감시자가 파일 변경을 대기 중임을 나타냅니다.

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

  5. 제품을 반환하도록 Product 메서드 코드를 수정합니다. 파일을 저장합니다.

dotnet watch는 파일 변경을 검색하고 테스트를 다시 실행합니다. 콘솔 출력은 통과된 테스트를 나타냅니다.

조사할 파일 목록 사용자 지정

기본적으로 dotnet-watch는 다음 GLOB 패턴과 일치하는 모든 파일을 추적합니다.

  • **/*.cs
  • *.csproj
  • **/*.resx
  • 콘텐츠 파일: wwwroot/**, **/*.config, **/*.json

파일을 편집 .csproj 하여 조사식 목록에 더 많은 항목을 추가할 수 있습니다. 개별적으로 또는 GLOB 패턴을 사용하여 항목을 지정할 수 있습니다.

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

감시할 파일 옵트아웃

기본 설정을 무시하도록 dotnet-watch를 구성할 수 있습니다. 특정 파일을 무시하려면 .csproj 파일에서 Watch="false" 특성을 항목의 정의로 추가합니다.

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

사용자 정의 조사식 프로젝트

dotnet-watch는 C# 프로젝트로 제한되지 않습니다. 다른 시나리오를 처리하도록 사용자 지정 조사식 프로젝트를 만들 수 있습니다. 다음 프로젝트 레이아웃을 사용합니다.

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

두 프로젝트를 조사하는 것이 목적인 경우 두 프로젝트를 감시하도록 구성된 사용자 지정 프로젝트 파일을 만듭니다.

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

파일이 두 프로젝트를 감시하는 시작하려면 test 폴더를 변경합니다. 다음 명령을 실행합니다.

dotnet watch msbuild /t:Test

테스트 프로젝트 중 하나에서 파일을 변경하면 VSTest가 실행됩니다.

dotnet-watch 구성

환경 변수를 통해 일부 구성 옵션을 dotnet watch에 전달할 수 있습니다. 사용 가능한 변수는 다음과 같습니다.

설정 설명
DOTNET_USE_POLLING_FILE_WATCHER “1” 또는 “true”로 설정하면 dotnet watch에서 CoreFx의 FileSystemWatcher 대신 폴링 파일 감시자를 사용합니다. 네트워크 공유 또는 Docker 탑재 볼륨에서 파일을 감시할 때 사용됩니다.
DOTNET_WATCH_SUPPRESS_MSBUILD_INCREMENTALISM 기본적으로 dotnet watch는 파일이 변경될 때마다 복원 실행이나 감시된 파일 집합 다시 평가와 같은 특정 작업이 수행되지 않도록 하여 빌드를 최적화합니다. “1” 또는 “true”로 설정하면 이러한 최적화를 사용할 수 없습니다.
DOTNET_WATCH_SUPPRESS_LAUNCH_BROWSER dotnet watch run은 launchSettings.json에서 launchBrowser가 구성된 웹앱에 대해 브라우저를 시작하려고 합니다. “1” 또는 “true”로 설정하면 이 동작이 무시됩니다.
DOTNET_WATCH_SUPPRESS_BROWSER_REFRESH dotnet watch run은 파일 변경 내용을 검색할 때 브라우저를 새로 고치려고 합니다. “1” 또는 “true”로 설정하면 이 동작이 무시됩니다. 이 동작은 DOTNET_WATCH_SUPPRESS_LAUNCH_BROWSER가 설정된 경우에도 무시됩니다.

브라우저 새로 고침

dotnet watch는 콘텐츠가 변경될 때 브라우저를 새로 고칠 수 있게 해주는 스크립트를 앱에 삽입합니다. 앱에서 응답 압축을 사용하도록 설정하는 경우와 같은 일부 시나리오에서는 dotnet watch가 스크립트를 삽입하지 못할 수 있습니다. 이러한 경우에는 개발할 때 수동으로 스크립트를 앱에 삽입합니다. 예를 들어, 스크립트를 수동으로 삽입하도록 웹앱을 구성하려면 _framework/aspnet-browser-refresh.js를 포함하도록 레이아웃 파일을 업데이트 합니다.

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

비 ASCII 문자

Visual Studio 17.2 이상에는 .NET SDK 6.0.300 이상이 포함됩니다. .NET SDK 6.0.300 이상에서는 dotnet-watch가 핫 다시 로드 세션 중에 비 ASCII 문자를 콘솔로 내보냅니다. Windows conhost와 같은 특정 콘솔 호스트에서는 이러한 문자가 왜곡되어 보일 수 있습니다. 왜곡된 문자를 방지하려면 다음 방법 중 하나를 고려하세요.

  • 이러한 값을 내보내지 않도록 DOTNET_WATCH_SUPPRESS_EMOJIS=1 환경 변수를 구성합니다.
  • 비 ASCII 문자 렌더링을 지원하는 다른 터미널(예: https://github.com/microsoft/terminal)로 전환합니다.