Отладка надстройки Outlook на основе событий или сообщений о спаме

Статья
07/16/2024

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

Чтобы начать отладку, выберите вкладку для соответствующего клиента.

Используйте средства разработчика предпочитаемого браузера для отладки надстройки на основе событий в Outlook в Интернете. Дополнительные сведения см. в статье Отладка надстроек в Office в Интернете.

Чтобы отладить надстройку в новом классическом клиенте Outlook для Windows (предварительная версия), необходимо выполнить следующую команду, чтобы открыть средства разработки Microsoft Edge.

olk.exe --devtools

Дополнительные сведения см. в разделе "Отладка надстройки" статьи Разработка надстроек Outlook для нового Outlook в Windows.

Если вы использовали генератор Yeoman для надстроек Office для создания проекта надстройки (например, выполнив пошаговое руководство по активации на основе событий), следуйте инструкциям в этой статье с параметром Создано с помощью генератора Yeoman . В противном случае выполните другие действия . Visual Studio Code должна быть не менее версии 1.56.1.

Пометка надстройки для отладки и настройка порта отладчика

Получите идентификатор надстройки из манифеста.
- Манифест только надстройки. Используйте значение дочернего <элемента Id> корневого <элемента OfficeApp> .
- Унифицированный манифест для Microsoft 365: используйте значение свойства id корневого анонимного { ... } объекта.
Создайте значение реестра DWORD с именем UseDirectDebugger в HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]. Замените [Add-in ID] идентификатором надстройки из манифеста.
Примечание.

Developer Если ключ (папка) еще не существует в HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\, выполните следующие действия, чтобы создать его.
1. Щелкните правой кнопкой мыши (или выберите и удерживайте) ключ (папку ) WEF и выберите Новый>ключ.
2. Назовите новый ключ Разработчик.
Создано с помощью генератора Yeoman. В окне командной строки перейдите к корневой папке надстройки, а затем выполните следующую команду.
```
npm start
```
В дополнение к созданию кода и запуску локального сервера эта команда задает UseDirectDebugger значение DWORD реестра для этой надстройки 1в .

Другое. В параметре HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]\UseDirectDebugger DWORD реестра, где [Add-in ID] — это идентификатор надстройки из манифеста, задайте для данных значения значение 1.
В разделе HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]реестра , где [Add-in ID] — это идентификатор надстройки из манифеста, создайте новое DWORD значение со следующей конфигурацией.
- Имя значения: DebuggerPort
- Данные значений (шестнадцатеричные):00002407
При этом порт отладчика задается в 9223значение .
Запустите Outlook или перезапустите его, если он уже открыт.
Выполните действие, чтобы инициировать событие, для которое вы разрабатываете, например создайте новое сообщение для инициации события или сообщите OnNewMessageCompose о спаме. Должно появиться диалоговое окно Обработчик на основе событий отладки . Пока не взаимодействовать с диалогом.

Настройка Visual Studio Code

Создано с помощью генератора Yeoman

Вернитесь в окно командной строки, чтобы открыть проект надстройки в Visual Studio Code.
```
code .
```
В Visual Studio Code откройте файл ./.vscode/launch.json и добавьте следующий фрагмент в список конфигураций. Сохраните изменения.
```
{
  "name": "Direct Debugging",
  "type": "node",
  "request": "attach",
  "port": 9223,
  "timeout": 600000,
  "trace": true
}
```

Прочее

Создайте папку с именем Отладка (возможно, в папке "Рабочий стол ").
Откройте Visual Studio Code.
Перейдите в раздел Файл>Открыть папку, перейдите в только что созданную папку, а затем выберите Выбрать папку.
На панели действий выберите Запуск и отладка (CTRL+SHIFT+D).
Выберите ссылку создать файл launch.json .
В раскрывающемся списке Выбор среды выберите Edge: Запуск , чтобы создать файл launch.json.
Добавьте следующий фрагмент в список конфигураций. Сохраните изменения.
```
{
  "name": "Direct Debugging",
  "type": "node",
  "request": "attach",
  "port": 9223,
  "timeout": 600000,
  "trace": true
}
```

Подключение отладчика

Файлbundle.js надстройки содержит код JavaScript надстройки. Он создается при открытии классического Outlook в Windows. При запуске Outlook файлbundle.js каждой установленной надстройки кэшируется в папке Wef компьютера.

Чтобы найти файлbundle.js надстройки, перейдите в следующую папку в проводник. Замените текст, заключенный в [] , соответствующими сведениями о Outlook и надстройке.
```
%LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Outlook profile GUID]}\[Outlook mail account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]
```
Совет

Если файлbundle.js не отображается в папке Wef , попробуйте выполнить следующие действия:
- Если надстройка установлена или загружена неопубликованно, перезапустите Outlook.
- Удалите надстройку из Outlook, а затем снова загрузите ее неопубликованное приложение.
Откройте bundle.js в Visual Studio Code.
Разместите точки останова в bundle.js , где отладчик будет останавливаться.
В раскрывающемся списке ОТЛАДКА выберите Прямая отладка, а затем щелкните значок Начать отладку .

Запуск отладчика

Убедившись, что отладчик подключен, вернитесь в Outlook и в диалоговом окне Обработчик на основе событий отладки нажмите кнопку ОК .
Теперь вы можете достичь точек останова в Visual Studio Code, что позволяет отлаживать код активации на основе событий или сообщения о спаме.

Остановка отладчика

Чтобы остановить отладку остальной части текущего сеанса Outlook в Windows, в диалоговом окне Обработчик на основе событий отладки нажмите кнопку Отмена. Чтобы повторно включить отладку, перезапустите Outlook.

Чтобы предотвратить появление диалогового окна обработчика на основе событий отладки и прекращения отладки для последующих сеансов Outlook, удалите связанный раздел HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]\UseDirectDebuggerреестра или задайте для его значения 0значение .

Остановка локального сервера

Если вы хотите остановить локальный веб-сервер и удалить надстройку, следуйте применимым инструкциям:

Чтобы остановить сервер, выполните следующую команду. Если вы использовали npm start, следующая команда также должна удалить надстройку.
```
npm stop
```
Если вы вручную загрузили неопубликованную надстройку, см. статью Удаление неопубликоченной надстройки.

Надстройки на основе событий, которые выполняются в Outlook на Mac, используют среду выполнения браузера. По этой причине надстройку можно отлаживать с помощью Веб-инспектора Safari.

Чтобы использовать веб-инспектор Safari в Outlook, выполните действия, описанные в статье Отладка с помощью Веб-инспектора Safari на компьютере Mac.
Откройте Outlook, а затем загрузите неопубликованную надстройку.
Выполните действие, которое инициирует событие, которое обрабатывает ваша надстройка. Например, создайте новое сообщение, чтобы инициировать OnNewMessageCompose событие. Откроется пустое окно разработчика. Имя надстройки отображается в строке заголовка окна.
Щелкните правой кнопкой мыши (или выберите и удерживайте) в любом месте окна разработчика, а затем выберите Пункт Проверить элемент. Откроется инспектор, где можно задать точки останова и отладить надстройку.

Поделиться через