Отладка приложений ASP.NET Core

В этой статье описывается отладка приложений, включая отладку BlazorBlazor WebAssembly приложений с помощью средств разработчика браузера или интегрированной среды разработки (IDE).

Предварительные требования

В этом разделе описываются предварительные требования для отладки.

Предварительные требования для браузера

Убедитесь, что брандмауэры или прокси-серверы не блокируют обмен данными с прокси-сервером отладки (процесс NodeJS). Дополнительные сведения см. в разделе Настройка брандмауэра.

Предварительные требования к интегрированной среде разработки

Требуется последняя версия Visual Studio или Visual Studio Code.

Предварительные требования Visual Studio Code

Для Visual Studio Code требуется пакет средств разработки C# для Visual Studio Code (начало работы с C# в VS Code). В Visual Studio Code Extensions Marketplace отфильтруйте список расширений с помощью "c# dev kit", чтобы найти расширение:

Установка комплекта разработки C# автоматически устанавливает следующие дополнительные расширения:

• Средство установки .NET
• C#
• Набор средств разработки IntelliCode для C#

При возникновении предупреждений или ошибок можно открыть проблему (microsoft/vscode-dotnettools репозиторий GitHub), описывающую проблему.

Предварительные требования к конфигурации приложений

Руководство в этом подразделе относится к отладке на стороне клиента.

Properties/launchSettings.json Откройте файл запускаемого проекта. Подтвердите наличие следующего свойства inspectUri в каждом профиле запуска узла profiles файла. Если следующее свойство отсутствует, добавьте его в каждый профиль:

"inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}"

Свойство inspectUri:

• Позволяет интегрированной среде разработки обнаруживать, что приложение является приложением Blazor.
• Предписывает инфраструктуре отладки сценариев подключаться к браузеру через прокси-сервер отладки Blazor.

Прототипы значений для протокола WebSocket (wsProtocol), узла (url.hostname), порта (url.port) и URI инспектора в запущенном браузере (browserInspectUri) предоставляются платформой.

Пакеты

Автономный режим Blazor WebAssembly: Microsoft.AspNetCore.Components.WebAssembly.DevServer: сервер разработки, используемый при создании приложений Blazor WebAssembly. Вызывает UseWebAssemblyDebugging на внутреннем уровне, чтобы добавить ПО промежуточного слоя для отладки приложений Blazor WebAssembly в средствах для разработчика Chromium.

Отладьте Blazor WebAssembly приложение в IDE

<DebuggerSupport>true</DebuggerSupport>
<CopyOutputSymbolsToPublishDirectory>true</CopyOutputSymbolsToPublishDirectory>

Подключиться к существующему сеансу отладки Visual Studio Code

Чтобы подключиться к работающему Blazor приложению, откройте .vscode/launch.json файл и замените {URL} заполнитель URL-адресом, в котором выполняется приложение:

{
  "name": "Attach and Debug",
  "type": "blazorwasm",
  "request": "attach",
  "url": "{URL}"
}

Параметры запуска Visual Studio Code

Параметры конфигурации запуска в следующей blazorwasm таблице поддерживаются для типа отладки (.vscode/launch.json).

Отладка Blazor WebAssembly с помощью Google Chrome или Microsoft Edge

В этом разделе описано, как применить отладку Blazor WebAssembly приложений:

• Google Chrome, работающий в Windows или macOS.
• Microsoft Edgeработает в Windows.

1. Запустите приложение в командной оболочке с dotnet watch (или dotnet run).

2. Запустите браузер и перейдите по URL-адресу приложения.

3. Запустите удаленную отладку, нажав клавишу:

   • Shift+Alt+d в Windows.
   • Shift+⌘+d в macOS.

   Браузер должен работать с включенной удаленной отладкой (это не поведение по умолчанию). Если удаленная отладка отключена, отобразится страница с ошибкой Не удается найти вкладку браузера для отладки с инструкциями по запуску браузера с открытым портом отладки. Следуйте инструкциям в браузере.

   После выполнения инструкций по включению удаленной отладки приложение открывается в новом окне браузера. Запустите удаленную отладку, нажав сочетание HotKey в новом окне браузера:

   • Shift+Alt+d в Windows.
   • Shift+⌘+d на macOS.

   Открывается новая вкладка в инструментах разработчика браузера, на которой отображается полупрозрачное изображение приложения.

   Примечание.

   Если вы следовали инструкциям, чтобы открыть новую вкладку браузера с включенной удаленной отладкой, можно закрыть исходное окно браузера, оставив второе окно открытым с первой вкладкой, на которой запущено приложение, и на второй вкладке, на которой запущен отладчик.

4. Через некоторое время на вкладке "Источники" отображается список сборок и страниц приложения .NET.

5. Откройте узел file://. В коде компонентов (в файлах .razor) и в файлах кода C# (.cs) установленные вами точки останова срабатывают при выполнении кода на вкладке браузера приложения (на исходной вкладке, открытой после запуска удаленной отладки). После срабатывания точки останова на вкладке отладки можно пошагово выполнять код (F10) или возобновить выполнение кода в обычном режиме (F8).

Для отладки браузеров на основе Chromium Blazor предоставляет прокси-сервер отладки, реализующий Chrome DevTools Protocol и дополняющий этот протокол сведениями, относящимися к .NET. При нажатии сочетания клавиш для отладки Blazor указывает Chrome DevTools на прокси-сервер. Прокси-сервер подключается к окну браузера, для которого выполняется отладка (поэтому и надо было включить удаленную отладку).

Разрыв с необработанными исключениями

Отладчик не останавливается на необработанных исключениях, так как Blazor перехватывает исключения, которые не обрабатываются кодом разработчика.

Чтобы разорвать необработанные исключения, выполните приведенные действия.

• Откройте параметры исключений отладчика (Отладка>Окна>Параметры исключений) в Visual Studio.
• Задайте следующие параметры исключений JavaScript:
  • Все исключения
  • Неуловимые исключения

Карты исходного кода в браузере

Сопоставители с исходным кодом в браузере позволяют браузеру сопоставлять скомпилированные файлы с исходными файлами и обычно используются для отладки на стороне клиента. В настоящее время Blazor не сопоставляет C# напрямую с JavaScript/Wasm. Вместо этого Blazor интерпретирует IL в браузере, поэтому карты исходного кода не имеют значения.

Настройка брандмауэра

Если брандмауэр блокирует обмен данными с прокси-сервером отладки, создайте правило исключения брандмауэра, которое разрешает обмен данными между браузером и процессом NodeJS.

Инструкции по настройке брандмауэра Windows см. в статье Создание правила для входящего трафика для программы или службы. Дополнительные сведения см. в статье Брандмауэр Защитника Windows с расширенными функциями безопасности и в связанных статьях в наборе документации по брандмауэру Windows.

Устранение неполадок

При возникновении ошибок воспользуйтесь следующими советами:

• Удалите точки останова:
  • Google Chrome: на вкладке "Отладчик " откройте средства разработчика в браузере. В консоли выполните localStorage.clear(), чтобы удалить все точки останова.
  • Microsoft Edge: на вкладке "Приложение " откройте локальное хранилище. Щелкните правой кнопкой мыши сайт и нажмите кнопку "Очистить".
• Убедитесь, что вы установили и доверяете HTTPS-сертификату разработки ASP.NET Core. Дополнительные сведения см. в статье Принудительное применение HTTPS в ASP.NET Core.
• Visual Studio требует, чтобы был включен параметр Включить отладку JavaScript для ASP.NET (Chrome и Edge) в разделе Сервис>Параметры>Отладка>Общие. Этот параметр включен в Visual Studio по умолчанию. Если отладка не работает, проверьте, выбран ли этот параметр.
• Если в среде используется прокси-сервер HTTP, необходимо включить localhost в параметры обхода прокси-сервера. Это можно сделать, задав NO_PROXY переменную среды в следующих параметрах:
  • Файл launchSettings.json для проекта.
  • на уровне пользовательских или системных переменных среды для применения ко всем приложениям. Перезапустите Visual Studio, чтобы изменение переменной среды вступило в силу.
• Убедитесь, что брандмауэры или прокси-серверы не блокируют обмен данными с прокси-сервером отладки (процесс NodeJS). Дополнительные сведения см. в разделе Настройка брандмауэра.

Точки останова в OnInitialized{Async} не срабатывают

Отладочный прокси-сервер фреймворка Blazor не запускается мгновенно при запуске приложения, поэтому точки останова в OnInitialized{Async} методах жизненного цикла могут не сработать. Мы рекомендуем добавить задержку в начале тела метода, чтобы отладочный прокси успел запуститься до срабатывания точки останова. Вы можете добавить задержку с помощью ifдирективы компилятора, чтобы в релизной сборке приложения этой задержки не было.

OnInitialized:

protected override void OnInitialized()
{
#if DEBUG
    Thread.Sleep(10000);
#endif

    ...
}

OnInitializedAsync:

protected override async Task OnInitializedAsync()
{
#if DEBUG
    await Task.Delay(10000);
#endif

    ...
}

истекло время ожидания Visual Studio (Windows)

Если Visual Studio вызывает исключение о том, что не удалось запустить адаптер отладки, указав, что истекло время ожидания, то можно настроить время ожидания с помощью параметра реестра.

VsRegEdit.exe set "<VSInstallFolder>" HKCU JSDebugger\Options\Debugging "BlazorTimeoutInMilliseconds" dword {TIMEOUT}

Заполнитель {TIMEOUT} в предыдущей команде выражается в миллисекундах. Например, одной минуте соответствует значение 60000.

<PropertyGroup>
  <WasmEnableHotReload>true</WasmEnableHotReload>
</PropertyGroup>

<PropertyGroup>
  <WasmEnableHotReload>false</WasmEnableHotReload>
</PropertyGroup>