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

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

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

olk.exe --devtools

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

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

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

1. Получите идентификатор надстройки из манифеста.

   • Манифест только надстройки. Используйте значение дочернего <элемента Id> корневого <элемента OfficeApp> .
   • Унифицированный манифест для Microsoft 365: используйте значение свойства id корневого анонимного { ... } объекта.

2. В реестре пометьте надстройку для отладки.

   • Создано с помощью генератора Yeoman. В окне командной строки перейдите к корневой папке надстройки, а затем выполните следующую команду.

     npm start
     

     Помимо сборки кода и запуска локального сервера эта команда задает для данных HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]\UseDirectDebugger DWORD реестра значение DWORD для этой надстройки 1. [Add-in ID] — это идентификатор надстройки из манифеста.

   • Другое. В параметре HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\Developer\[Add-in ID]\UseDirectDebugger DWORD реестра, где [Add-in ID] — это идентификатор надстройки из манифеста, задайте для его данных 1значение .

     Примечание.

     Developer Если ключ (папка) еще не существует в HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\WEF\, выполните следующие действия, чтобы создать его.

     1. Щелкните правой кнопкой мыши (или выберите и удерживайте) ключ (папку ) WEF и выберите Новый>ключ.
     2. Назовите новый ключ Разработчик.

3. В разделе HKEY_CURRENT_USER\SOFTWARE\Microsoft\Office\16.0\Wef\Developer\[Add-in ID]реестра , где [Add-in ID] — это идентификатор надстройки из манифеста, создайте новое DWORD значение со следующей конфигурацией.

   • Имя значения: DebuggerPort
   • Данные значений (шестнадцатеричные):00002407

   При этом порт отладчика задается в 9223значение .

4. Запустите Outlook или перезапустите его, если он уже открыт.

5. Выполните действие, чтобы инициировать событие, для которое вы разрабатываете, например создайте новое сообщение для инициации события или сообщите OnNewMessageCompose о спаме. Должно появиться диалоговое окно Обработчик на основе событий отладки . Пока не взаимодействовать с диалогом.

   

Настройка и подключение отладчика

Вы можете выполнить отладку надстройки с помощью средства проверки Microsoft Edge или Visual Studio Code.

Отладка с помощью Microsoft Edge

1. Откройте Microsoft Edge и перейдите к edge://inspect/#devices.

2. В разделе Удаленный целевой объект найдите надстройку, используя ее идентификатор из манифеста. Затем выберите Проверить.

   Откроется окно Средства разработки.

   Примечание.

   Для отображения надстройки в разделе Удаленный целевой объект может потребоваться некоторое время. Возможно, потребуется обновить страницу, чтобы появилась надстройка.

3. На вкладке Источники перейдите в раздел file://>Пользователи/[Пользователь]/AppData/Microsoft/Office/16.0/Wef/{[[Outlook profile GUID]}/[Кодировка учетной записи почты Outlook]/Javascript/[Идентификатор надстройки]_[Версия надстройки]_[языковой стандарт]>bundle.js.

   Совет

   Нет прямого метода для определения GUID профиля Outlook или кодировки учетной записи почты, используемой в bundle.js пути к файлу. При одновременной отладке нескольких надстроек самый простой способ получить доступ к файлуbundle.js надстройки из окна Средства разработки — найти идентификатор надстройки в пути к файлу.

4. В файлеbundle.js поместите точки останова в место остановки отладчика.

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

Отладка с помощью Visual Studio Code

Для отладки надстройки в Visual Studio Code необходимо установить не менее версии 1.56.1.

Настройка отладчика

Настройте отладчик в Visual Studio Code. Выполните действия, применимые к проекту надстройки.

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

1. В командной строке выполните следующую команду, чтобы открыть проект надстройки в Visual Studio Code.

   code .
   

2. В Visual Studio Code откройте файл ./.vscode/launch.json и добавьте следующий фрагмент в список конфигураций. Сохраните изменения.

   {
     "name": "Direct Debugging",
     "type": "node",
     "request": "attach",
     "port": 9223,
     "timeout": 600000,
     "trace": true
   }
   

Прочее

1. Создайте папку с именем Отладка (возможно, в папке "Рабочий стол ").

2. Откройте Visual Studio Code.

3. Перейдите в раздел Файл>Открыть папку, перейдите в только что созданную папку, а затем выберите Выбрать папку.

4. На панели действий выберите Выполнить и отладить (CTRL+SHIFT+D).

   

5. Выберите ссылку создать файл launch.json .

   

6. В раскрывающемся списке Выбор среды выберите Edge: Запуск , чтобы создать файл launch.json.

7. Добавьте следующий фрагмент в список конфигураций. Сохраните изменения.

   {
     "name": "Direct Debugging",
     "type": "node",
     "request": "attach",
     "port": 9223,
     "timeout": 600000,
     "trace": true
   }
   

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

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

1. Чтобы найти файлbundle.js надстройки, перейдите в следующую папку в проводник. Текст, заключенный в [] , представляет применимые сведения о Outlook и надстройке.

   %LOCALAPPDATA%\Microsoft\Office\16.0\Wef\{[Outlook profile GUID]}\[Outlook mail account encoding]\Javascript\[Add-in ID]_[Add-in Version]_[locale]
   

   Совет

   • Нет прямого метода для определения GUID профиля Outlook и кодировки учетной записи почты, используемых в bundle.js пути к файлу. Наиболее эффективный подход к поиску файлаbundle.js надстройки — вручную проверять каждую папку, пока не будет обнаружена папка Javascript , содержащая идентификатор надстройки.

   • Если файлbundle.js не отображается в папке Wef , а надстройка установлена или загружена неопубликованно, перезапустите Outlook. Кроме того, удалите надстройку из Outlook, а затем снова загрузите ее неопубликованное приложение.

2. Откройте bundle.js в Visual Studio Code.

3. Разместите точки останова в bundle.js , где отладчик будет останавливаться.

4. В раскрывающемся списке ОТЛАДКА выберите Прямая отладка, а затем щелкните значок Начать отладку .

   

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

Убедившись, что отладчик подключен, вернитесь в Outlook. В диалоговом окне Обработчик на основе событий отладки нажмите кнопку ОК .

Теперь вы можете достичь точек останова для отладки кода активации на основе событий или сообщения о спаме.

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

Чтобы остановить отладку остальной части текущего сеанса 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.

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