Wprowadzenie do systemu macOS

Zestaw SDK centrum aplikacji korzysta z architektury modułowej, dzięki czemu można używać dowolnych lub wszystkich usług.

Zacznijmy od ustanowienia zestawu SDK App Center dla macOS w Twojej aplikacji, aby korzystać z usług App Center Analytics i App Center Crashes.

1. Wymagania wstępne

Aby można było korzystać z zestawu SDK usługi App Center, należy spełnić następujące wymagania:

• Projekt dla macOS jest skonfigurowany w Xcode 13 lub nowszym na macOS w wersji 10.14.4 lub nowszej.
• Dotyczy to urządzeń z systemem macOS 10.13 lub nowszym.
• Nie używasz żadnej innej biblioteki, która zapewnia funkcję raportowania awarii.

Analizy i zdarzenia crash zestawu SDK App Center są kompatybilne z Mac Catalyst poprzez XCFramework lub SwiftPM.

Zestaw SDK usługi App Center jest zgodny z aplikacją Apple Silicon.

2. Utwórz swoją aplikację w Centrum aplikacji Portalu, aby uzyskać tajny klucz aplikacji.

Jeśli aplikacja została już utworzona w portalu Centrum aplikacji, możesz pominąć ten krok.

1. Przejdź do appcenter.ms.
2. Zarejestruj się lub zaloguj się i naciśnij niebieski przycisk w prawym górnym rogu portalu z komunikatem Dodaj nową i wybierz pozycję Dodaj nową aplikację z menu rozwijanego.
3. Wprowadź nazwę i opcjonalny opis aplikacji.
4. Wybierz system macOS jako system operacyjny i język Objective-C/Swift jako platformę.
5. Naciśnij przycisk w prawym dolnym rogu z napisem Dodaj nową aplikację.

Po utworzeniu aplikacji możesz uzyskać jej wpis tajny aplikacji na stronie Ustawienia w portalu Centrum aplikacji. W prawym górnym rogu strony Ustawienia kliknij w menu z trzema kropkami i wybierz Copy app secret, aby uzyskać Tajemnicę aplikacji.

3. Dodawanie modułów zestawu SDK usługi App Center

Zestaw SDK centrum aplikacji dla systemu macOS można dodać do aplikacji za pomocą narzędzia Cocoapods, Carthage, Swift Package Manager lub ręcznie dodając pliki binarne do projektu.

3.1 Integracja za pośrednictwem cocoapods

1. Dodaj następujące zależności do podfile, aby uwzględnić App Center Analytics i App Center Crashes w aplikacji. Spowoduje to pobranie następujących frameworków: AppCenter, AppCenterAnalytics i AppCenterCrashes. Zamiast tego możesz określić, które usługi mają być używane w aplikacji. Każda usługa ma własną specyfikację podrzędną i wszystkie polegają na AppCenter. Zostanie automatycznie ściągnięty.

    # Use the following line to use App Center Analytics and Crashes.
    pod 'AppCenter'
   
    # Use the following lines if you want to specify which service you want to use.
    pod 'AppCenter/Analytics'
    pod 'AppCenter/Crashes'
   

2. Uruchom pod install, aby zainstalować nowo zdefiniowany pod i otworzyć projekt .xcworkspace.

Po zintegrowaniu struktur w aplikacji nadszedł czas, aby uruchomić zestaw SDK i korzystać z usług App Center.

3.2 Integracja za pośrednictwem Carthage

Poniżej przedstawiono procedurę integrowania zestawu SDK centrum aplikacji w projekcie Xcode przy użyciu programu Carthagew wersji 0.30 lub nowszej, zdecentralizowanego menedżera zależności, który tworzy zależności i udostępnia struktury binarne.

1. Dodaj następujące zależności do Cartfile, aby dodać App Center do swojej aplikacji. Spowoduje to ściągnięcie wszystkich struktur. Następnie możesz połączyć tylko te struktury, których chcesz użyć w aplikacji.

   # 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. Uruchom program carthage update --platform macOS. Spowoduje to pobranie zależności do folderu Carthage/Checkouts , a następnie skompilowanie każdej platformy.

3. Otwórz kartę Ustawienia ogólne aplikacji docelowej. Przeciągnij i upuść pliki AppCenter.framework, AppCenterAnalytics.framework i AppCenterCrashes.framework z folderu Carthage/Build/macOS do nawigatora projektu Xcode. Do uruchomienia zestawu SDK jest wymagany program AppCenter.framework . Jeśli nie zostanie dodany do projektu, inne moduły nie będą działać, a aplikacja nie zostanie skompilowana.

4. Zostanie wyświetlone okno dialogowe, upewnij się, że docelowa aplikacja jest zaznaczona. Następnie kliknij przycisk Zakończ.

   Uwaga / Notatka

   Jeśli używasz carthage copy-frameworks w fazie kompilacji , nie należy dodawać zestawów SDK centrum aplikacji, ponieważ są one dostarczane jako struktury statyczne.

Po zintegrowaniu struktur w aplikacji nadszedł czas, aby uruchomić zestaw SDK i korzystać z usług App Center.

3.3 Integracja za pośrednictwem menedżera pakietów Swift

1. Z menu Xcode kliknij pozycję File > Swift Packages > Dodaj zależność pakietu.
2. W wyświetlonym oknie dialogowym wprowadź adres URL repozytorium: https://github.com/microsoft/appcenter-sdk-apple.git.
3. W obszarze Wersja wybierz pozycję Do kolejnej wersji głównej, a następnie opcję domyślną.
4. Wybierz moduły potrzebne w kolumnie Package Product (Produkt pakietu ).

Po zintegrowaniu struktur w aplikacji nadszedł czas, aby uruchomić zestaw SDK i korzystać z usług App Center.

3.4 Integracja przez skopiowanie plików binarnych do projektu

Poniżej przedstawiono kroki, jak zintegrować skompilowane pliki binarne w projekcie Xcode, aby skonfigurować usługi App Center Analytics i App Center Crashes dla aplikacji macOS.

1. Pobierz struktury zestawu SDK centrum aplikacji udostępnione jako plik zip.

2. Rozpakuj plik i zobaczysz folder o nazwie AppCenter-SDK-Apple zawierający różne struktury dla każdej usługi App Center w każdym folderze platformy. Struktura o nazwie AppCenter jest wymagana w projekcie, ponieważ zawiera kod współużytkowany między różnymi modułami.

3. [Opcjonalnie] Utwórz podkatalog dla bibliotek innych firm.

   • Biblioteki innych firm są zwykle w podkatalogu (często nazywanym Vendor), więc jeśli projekt nie używa podkatalogu dla bibliotek, utwórz teraz podkatalog Vendor.
   • Utwórz grupę o nazwie Vendor wewnątrz projektu Xcode, aby naśladować strukturę plików na dysku.

4. Otwórz rozpakowany folder AppCenter-SDK-Apple w programie Finder i skopiuj folder do folderu projektu w lokalizacji, w której chcesz. Folder zawiera struktury w podfolderach dla innych platform, które obsługuje zestaw SDK centrum aplikacji, więc może być konieczne usunięcie niepotrzebnych podfolderów.

5. Dodaj struktury zestawu SDK do projektu w środowisku Xcode:

   • Upewnij się, że nawigator projektu jest widoczny (⌘+1).
   • Teraz przeciągnij i upuść AppCenter.framework, AppCenterAnalytics.framework i AppCenterCrashes.framework z Findera (tych w folderze Vendor) do Nawigatora Projektu Xcode. Do uruchomienia zestawu SDK jest wymagany program AppCenter.framework. Jeśli brakuje tego modułu, inne moduły nie będą działały, a aplikacja nie zostanie skompilowana.
   • Zostanie wyświetlone okno dialogowe, upewnij się, że docelowa aplikacja jest zaznaczona. Następnie kliknij przycisk Zakończ.

Po zintegrowaniu struktur w aplikacji nadszedł czas, aby uruchomić zestaw SDK i korzystać z usług App Center.

4. Uruchamianie zestawu SDK

Aby korzystać z Centrum aplikacji, musisz wyrazić zgodę na moduły, których chcesz użyć. Domyślnie nie są uruchamiane żadne moduły i podczas uruchamiania zestawu SDK należy wywoływać poszczególne moduły. Jeśli tworzysz rozszerzenie, zapoznaj się ze stroną Wprowadzenie do rozszerzenia.

4.1 Dodaj instrukcje importu

Otwórz plik AppDelegate projektu i dodaj następujące instrukcje importowania:

@import AppCenter;
@import AppCenterAnalytics;
@import AppCenterCrashes;

import AppCenter
import AppCenterAnalytics
import AppCenterCrashes

4.2. Dodawanie start:withServices: metody

Wstaw następujący wiersz w metodzie delegata didFinishLaunchingWithOptions aplikacji:

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

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

Jeśli masz aplikację Catalyst, możesz przekazać sekrety aplikacji dla systemów iOS i macOS jednocześnie.

[MSACAppCenter start:@"ios={Your iOS App Secret};macos={Your macOS App Secret}" withServices:@[[MSACAnalytics class], [MSACCrashes class]]];

AppCenter.start(withAppSecret:"ios={Your iOS App Secret};macos={Your macOS App Secret}", services: [Analytics.self, Crashes.self])

Jeśli musisz uruchomić usługi App Center oddzielnie, wykonaj następujące kroki:

1. Skonfiguruj lub uruchom go przy użyciu klucza tajnego aplikacji.
2. Jeśli kod może być wywoływany wiele razy, sprawdź, czy centrum aplikacji jest już skonfigurowane.
3. Uruchom wymagane usługi bez sekretu aplikacji.

[MSACAppCenter configureWithAppSecret:@"{Your App Secret}"];
if ([MSACAppCenter isConfigured]) {
   [MSACAppCenter startService:[MSACAnalytics class]];
   [MSACAppCenter startService:[MSACCrashes class]];
}

AppCenter.configure(withAppSecret: "{Your App Secret}")
if AppCenter.isConfigured {
    AppCenter.startService(Analytics.self)
    AppCenter.startService(Crashes.self)
}

4.3 Zastąp zastępczy tekst sekretem swojej aplikacji

Pamiętaj, aby zastąpić {Your App Secret} tekst rzeczywistą wartością aplikacji. Wpis tajny aplikacji można znaleźć na stronie Wprowadzenie lub stronie Ustawienia w portalu Centrum aplikacji.

Strona 'Wprowadzenie' zawiera powyższy przykładowy kod, zawierający twój tajny klucz aplikacji. Możesz skopiować i wkleić cały ten przykład.

W powyższym przykładzie pokazano użycie metody start:withServices (start(withAppSecret:services:) dla Swift) i uwzględnienie zarówno App Center Analytics, jak i App Center Crashes.

Jeśli nie chcesz używać jednej z dwóch usług, usuń odpowiedni parametr z powyższego wywołania metody.

Jeśli nie określisz jawnie każdego modułu jako parametrów w metodzie uruchamiania, nie możesz skorzystać z tej usługi App Center. start:withServices Ponadto interfejs API (start(withAppSecret:services:)dla języka Swift) może być używany tylko raz w cyklu życia aplikacji — wszystkie inne wywołania będą rejestrować ostrzeżenie do konsoli i będą dostępne tylko moduły zawarte w pierwszym wywołaniu.

Na przykład — jeśli chcesz dołączyć do usługi App Center Analytics, należy zmodyfikować wywołanie interfejsu start:withServices API (start(withAppSecret:services:) for Swift) w następujący sposób:

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

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

4.4 Dodawanie funkcji internetowych dla aplikacji działających w trybie piaskownicy

Jeśli aplikacja korzysta z App Sandbox, musisz skonfigurować możliwość zezwalania na połączenia wychodzące (Klient), aby umożliwić aplikacji dostęp do Internetu. Program Xcode 9 domyślnie włącza piaskownicę aplikacji, ale możliwości dla połączeń wychodzących muszą być ustawiane jawnie.

Wybierz projekt w nawigatorze projektu, wybierz kartę Możliwości , a jeśli aplikacja korzysta z piaskownicy, włącz połączenia wychodzące.

Świetnie, jesteś gotowy, aby wyświetlić dane analizy i awarii na portalu, które SDK zbiera automatycznie.

Zapoznaj się z dokumentami usługi App Center Analytics i Dokumentami awarii usługi App Center, aby dowiedzieć się, jak dostosowywać i używać zaawansowanych funkcji każdej usługi.