Wprowadzenie do rozszerzeń systemu macOS

Ważne

Program Visual Studio App Center ma zostać wycofany 31 marca 2025 r. Chociaż możesz nadal używać programu Visual Studio App Center do momentu jego pełnego wycofania, istnieje kilka zalecanych alternatyw, do których można rozważyć migrację.

Dowiedz się więcej o osiach czasu pomocy technicznej i alternatywach.

Rozszerzenia obsługują tylko raportowanie awarii.

Aby dowiedzieć się, jak dodać zestaw SDK centrum aplikacji do aplikacji kontenera, zapoznaj się z dokumentacją centrum aplikacji dla systemu macOS Wprowadzenie.

Zacznijmy od konfigurowania zestawu SDK systemu macOS w centrum aplikacji w celu korzystania z usługi App Center Crash.

1. Wymagania wstępne

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

  • Projekt systemu macOS został skonfigurowany w środowisku Xcode 13 lub nowszym w systemie 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.

2. Tworzenie aplikacji w portalu Centrum aplikacji w celu uzyskania wpisu tajnego 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 komunikatem 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 potrójne pionowe kropki i wybierz pozycję Copy app secret , aby uzyskać wpis tajny aplikacji.

Uwaga

Używanie istniejącego wpisu tajnego aplikacji z innego projektu systemu macOS ma skutki uboczne. Usługa App Center nie obsługuje filtrowania według projektu w tej samej aplikacji Centrum aplikacji. Na przykład wyświetlenie listy awarii dla określonej wersji spowoduje wyświetlenie listy wszystkich awarii z obu projektów dla tej wersji bez rozróżnienia. Może to być mylące.

Uwaga

4.0.0 Wprowadzono zmiany powodujące niezgodność w usłudze App Center. Postępuj zgodnie z sekcją Migrate to App Center SDK 4.0.0 and higher (Migrowanie do zestawu APP Center SDK 4.0.0 i nowszych), aby przeprowadzić migrację centrum aplikacji z poprzednich wersji.

3. Dodawanie modułów zestawu SDK centrum aplikacji

Zestaw SDK centrum aplikacji można zintegrować z aplikacją za pośrednictwem cocoapods, Carthage lub ręcznie dodając pliki binarne do projektu.

3.1 Integracja za pośrednictwem kakapodów

  1. Dodaj do aplikacji podfile następujące zależności, aby uwzględnić awarie usługi App Center w aplikacji. Spowoduje to ściągnięcie następujących struktur: AppCenter i AppCenterCrashes.

     pod 'AppCenter/Crashes'
    
  2. Uruchom polecenie pod install , aby zainstalować nowo zdefiniowany zasobnik i otworzyć projekt .xcworkspace.

Uwaga

Jeśli podczas uruchamiania pod installzostanie wyświetlony błąd [!] Unable to find a specification for `AppCenter` , uruchom polecenie pod repo update , aby pobrać najnowsze zasobniki z repozytorium Cocoapods, a następnie uruchom polecenie pod install.

Teraz, 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 pakietu 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 aplikacji Cartfile , aby uwzględnić centrum aplikacji. Spowoduje to ściągnięcie wszystkich struktur. Następnie możesz połączyć tylko te struktury, które będą używane 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 polecenie carthage update. 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 i AppCenterCrashes.framework z folderu Carthage/Build/ do nawigatora projektu programu 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 element docelowy aplikacji jest zaznaczony. Następnie kliknij przycisk Zakończ.

    Uwaga

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

Teraz, 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. W menu programu Xcode kliknij pozycję File Swift Packages > Add Package Dependency (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 następnego majora i wybierz opcję domyślną.
  4. Wybierz potrzebne moduły w kolumnie Package Product (Produkt pakietu ).

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

Uwaga

Jeśli integrujesz usługę App Center za pośrednictwem usługi SwiftPM i chcesz jej używać również w miejscu docelowym rozszerzenia aplikacji, upewnij się, że został on w podanej DISABLE_DIAMOND_PROBLEM_DIAGNOSTIC=YES konfiguracji. Jest to konieczne, aby uniknąć ograniczeń swiftPM podczas łączenia modułu z wieloma miejscami docelowymi.

3.4 Integracja przez skopiowanie plików binarnych do projektu

Poniżej przedstawiono procedurę integrowania skompilowanych plików binarnych w projekcie Xcode w celu skonfigurowania usługi App Center Crash dla rozszerzenia aplikacji.

Uwaga

Zestaw SDK usługi App Center obsługuje korzystanie z usługi XCframework. Jeśli chcesz zintegrować aplikację XCframeworks z projektem, pobierz AppCenter-SDK-Apple-XCFramework.zip ze strony wydań i rozpakuj go. Wynikowa zawartość folderu nie jest specyficzna dla platformy, a nie zawiera XCframeworks dla każdego modułu. Można je zintegrować w taki sam sposób jak zwykłe struktury, jak opisano poniżej.

  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.

    • Najlepszym rozwiązaniem jest to, że biblioteki innych firm są zwykle w podkatalogu, często nazywanego dostawcą. Jeśli projekt nie jest zorganizowany za pomocą 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 podfolderów, których nie potrzebujesz.

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

    • Upewnij się, że nawigator projektu jest widoczny ((*)+1).
    • Teraz przeciągnij i upuść elementy AppCenter.framework i AppCenterCrashes.framework z narzędzia Finder (w lokalizacji z poprzedniego kroku) do nawigatora projektu programu 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 rozszerzenie aplikacji nie zostanie skompilowane.
    • Zostanie wyświetlone okno dialogowe, upewnij się, że element docelowy rozszerzenia aplikacji jest zaznaczony. Następnie kliknij przycisk Zakończ.

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

4. Uruchamianie zestawu SDK

Aby korzystać z usługi App Center, musisz wyrazić zgodę na korzystanie z modułów. Domyślnie nie są uruchamiane żadne moduły i należy jawnie wywołać każdą z nich podczas uruchamiania zestawu SDK.

4.1 Dodawanie instrukcji importu

Wstaw następujące wiersze w pliku zawierającym punkt wejścia rozszerzenia aplikacji. Na przykład wewnątrz głównego pliku ViewController rozszerzenia Today.

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

4.2 Dodawanie start:withServices: metody

Wstaw następujący wiersz w punkcie wejścia rozszerzenia aplikacji. Na przykład wewnątrz viewDidLoad metody głównego pliku ViewController rozszerzenia Today.

[MSACAppCenter start:@"{Your App Secret}" withServices:@[[MSACCrashes class]]];
AppCenter.start(withAppSecret: "{Your App Secret}", services: [Crashes.self])

Obecnie w przypadku rozszerzeń aplikacji obsługiwane jest tylko raportowanie awarii.

4.3 Zastąp symbol zastępczy wpisem tajnym aplikacji

Pamiętaj, aby zastąpić {Your App Secret} tekst rzeczywistą wartością rozszerzenia 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 z wpisem tajnym aplikacji. Możesz skopiować i wkleić cały przykład.

Świetnie— wszystko jest gotowe do wizualizacji danych awarii w portalu, które zestaw SDK zbiera automatycznie.

Zapoznaj się z dokumentacją dotyczącą awarii usługi App Center , aby dowiedzieć się, jak dostosować rozszerzenie aplikacji i korzystać z bardziej zaawansowanych funkcji.