Начало работы с расширениями macOS

Это важно

Центр приложений Visual Studio был прекращен 31 марта 2025 г., за исключением функций аналитики и диагностики, которые будут поддерживаться до 30 июня 2026 г. Подробнее.

• Андроид
• iOS
• Расширения iOS
• React Native
• MAUI/Xamarin
• UWP
• WPF/WinForms
• Единство
• macOS
• Расширения macOS
• tvOS

Расширения поддерживают только отчеты о сбоях.

Чтобы узнать, как добавить SDK App Center в контейнерное приложение, ознакомьтесь с документацией по началу работы с macOS в App Center.

Давайте начнем с настройки пакета macOS SDK для Центра приложений в расширении вашего приложения, чтобы использовать функцию сбойного решения App Center.

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

Для использования пакета SDK Центра приложений необходимо выполнить следующие требования:

• Ваш проект для macOS настроен в Xcode 13 или более поздней версии на macOS версии 10.14.4 или более поздней.
• Вы нацелены на устройства, работающие на macOS 10.13 или более поздней версии.
• Вы не используете другую библиотеку, которая предоставляет функции отчетов о сбоях.

2. Создание приложения на портале Центра приложений для получения секрета приложения

Если вы уже создали приложение на портале Центра приложений, этот шаг можно пропустить.

1. Перейдите к appcenter.ms.
2. Зарегистрируйтесь или войдите и нажмите синюю кнопку в правом верхнем углу портала, где указано Добавить новое, и выберите Добавить новое приложение в раскрывающемся меню.
3. Введите имя и необязательное описание приложения.
4. Выберите macOS в качестве ОС и Objective-C/Swift в качестве платформы.
5. Нажмите кнопку в правом нижнем углу, где говорится, как добавить новое приложение.

После создания приложения вы можете получить секрет приложения на странице "Параметры " на портале Центра приложений. В правом верхнем углу страницы "Параметры " щелкните тройную вертикальную точку и выберите Copy app secret , чтобы получить секрет приложения.

Замечание

Использование существующего секрета приложения из другого проекта macOS имеет побочные эффекты. Центр приложений не поддерживает фильтрацию по проекту в одном приложении Центра приложений. Например, список сбоев для конкретной версии будет перечислять все сбои обоих проектов для этой версии без различия. Это может быть запутано.

Замечание

В версии 4.0.0 Центра приложений были введены критические изменения. Ознакомьтесь с разделом Миграция на SDK App Center 4.0.0 и выше для переноса Центра приложений с предыдущих версий.

3. Добавление модулей пакета SDK центра приложений

Пакет SDK Центра приложений можно интегрировать в приложение с помощью Cocoapods, Carthage или вручную добавить двоичные файлы в проект.

Интеграция с помощью Cocoapods 3.1

1. Добавьте следующие зависимости в podfile, чтобы включить App Center Crashes в ваше приложение. Подключает следующие фреймворки: AppCenter и AppCenterCrashes.

    pod 'AppCenter/Crashes'
   

2. Запустите pod install, чтобы установить вновь определённый pod и открыть проект .xcworkspace.

Замечание

Если при выполнении [!] Unable to find a specification for `AppCenter` отображается ошибка pod install, выполните команду pod repo update, чтобы получить последние pods из репозитория Cocoapods, а затем выполните команду pod install.

Теперь, когда вы интегрировали платформы в приложении, пришло время запустить пакет SDK и использовать службы Центра приложений.

Интеграция 3.2 с помощью Carthage

Ниже приведены инструкции по интеграции пакета SDK Центра приложений в проект Xcode с помощью Carthage версии 0.30 или более поздней, децентрализованного диспетчера зависимостей, который создает зависимости и предоставляет двоичные платформы.

1. Добавьте следующие зависимости в Cartfile, чтобы интегрировать Центр приложений в ваше приложение. Это подключает все фреймворки. Затем вы можете связать только эти платформы для использования в приложении.

   # Use the following line to get the latest version of App Center
   github "microsoft/appcenter-sdk-apple"
   

   # Use the following line to get the specific version of App Center
   github "microsoft/appcenter-sdk-apple" ~> X.X.X
   

2. Выполните carthage update. Это извлекает зависимости в папку Carthage/Checkouts, а затем создает каждый фреймворк.

3. Откройте вкладку "Общие параметры" целевого приложения. Перетащите файлы AppCenter.framework и AppCenterCrashes.framework из папки Carthage/Build/ в навигатор проекта Xcode. Для запуска пакета SDK требуется AppCenter.framework . Если он не добавлен в проект, другие модули не будут работать, и ваше приложение не будет компилироваться.

4. Откроется диалоговое окно, убедитесь, что выбран целевой объект вашего приложения. Затем нажмите кнопку "Готово".

   Замечание

   Если вы используете carthage copy-frameworks на этапе сборки , то не следует добавлять пакеты SDK центра приложений, так как они отправляются в виде статических платформ.

Теперь, когда вы интегрировали платформы в приложении, пришло время запустить пакет SDK и использовать службы Центра приложений.

Интеграция 3.3 с помощью диспетчера пакетов Swift

1. В меню Xcode выберите пункт "Файл > Swift Package > Add Package Dependency" (Добавить зависимость пакета).
2. В появившемся диалоговом окне введите URL-адрес репозитория: https://github.com/microsoft/appcenter-sdk-apple.git
3. В версии нажмите кнопку "Далее основной" и выберите параметр по умолчанию.
4. Выберите модули, необходимые в столбце "Продукт пакета ".

Теперь, когда вы интегрировали платформы в приложении, пришло время запустить пакет SDK и использовать службы Центра приложений.

Замечание

Если вы интегрируете Центр приложений через SwiftPM и хотите использовать его в целевом объекте расширения вашего приложения, убедитесь, что вы указали DISABLE_DIAMOND_PROBLEM_DIAGNOSTIC=YES в конфигурации. Это необходимо, чтобы избежать ограничений SwiftPM при связывании модуля с несколькими целевыми объектами.

Интеграция 3.4 путем копирования двоичных файлов в проект

Ниже приведены шаги по интеграции скомпилированных двоичных файлов в ваш проект Xcode для подключения функции App Center Crashes для вашего расширения приложения.

Замечание

Пакет SDK для Центра приложений XCframeworkподдерживает использование . Если вы хотите интегрировать XCframeworks в проект, скачайте AppCenter-SDK-Apple-XCFramework.zip на странице выпусков и распакуйте его. Результирующее содержимое папки не зависит от платформы, а содержит XCframeworks для каждого модуля. Они могут быть интегрированы так же, как и обычные платформы, как описано ниже.

1. Скачайте платформы ПАКЕТА SDK Центра приложений , предоставляемые в виде ZIP-файла.

2. Распакуйте файл и увидите папку с именем AppCenter-SDK-Apple , которая содержит разные платформы для каждой службы Центра приложений на каждой папке платформы. Вызываемая платформа AppCenter требуется в проекте, так как она содержит код, общий доступ между различными модулями.

3. [Необязательно] Создайте подкаталог для сторонних библиотек.

   • Рекомендуется, чтобы сторонние библиотеки обычно находились в подкаталоге, который часто называют Vendor. Если проект не упорядочен с подкаталогом библиотек, создайте подкаталог поставщика .
   • Создайте группу с именем Vendor внутри проекта Xcode, чтобы имитировать структуру файлов на диске.

4. Откройте папку AppCenter-SDK-Apple в Finder и скопируйте ее в папку проекта в нужном расположении. Папка содержит платформы в вложенных папках для других платформ, поддерживаемых пакетом SDK Для Центра приложений, поэтому вам может потребоваться удалить вложенные папки, которые вам не нужны.

5. Добавьте платформы SDK в проект в Xcode:

   • Убедитесь, что навигатор проекта отображается ([+1]).
   • Теперь перетащите AppCenter.framework и AppCenterCrashes.framework из Finder (в расположении из предыдущего шага) в навигатор проекта Xcode. Для запуска пакета SDK требуется AppCenter.framework . Если он не добавлен в проект, другие модули не будут работать, и расширение приложения не будет компилироваться.
   • Откроется диалоговое окно, убедитесь, что целевой объект расширения приложения установлен. Затем нажмите кнопку "Готово".

Теперь, когда вы интегрировали платформы в расширении приложения, пришло время запустить пакет SDK и использовать службы Центра приложений.

4. Запустите пакет SDK

Чтобы использовать Центр приложений, необходимо принять участие в используемых модулях. По умолчанию модули не запускаются, и при запуске пакета SDK необходимо явно вызывать каждый из них.

4.1 Добавьте инструкции импорта

Вставьте следующие строки в файл, содержащий точку входа расширения приложения. Например, внутри основного файла ViewController расширения Today.

@import AppCenter;
@import AppCenterCrashes;

import AppCenter
import AppCenterCrashes

4.2 Добавление start:withServices: метода

Вставьте следующую строку в точку входа расширения приложения. Например, в методе viewDidLoad основного файла ViewController для расширения Today.

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACCrashes class]]];

AppCenter.start(withAppSecret: "{Your App Secret}", services: [Crashes.self])

В настоящее время поддерживаются только отчеты о сбоях для расширений приложений.

4.3. Замените заполнитель секретом приложения

Обязательно замените {Your App Secret} текст фактическим значением расширения приложения. Секрет приложения можно найти на странице "Начало работы " или на странице "Параметры " на портале Центра приложений.

Страница "Начало работы" содержит приведенный выше пример кода с секретом приложения в нем, вы можете скопировать весь пример.

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

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