Introdução às extensões do macOS

  • Artigo

Importante

O Visual Studio App Center está programado para ser desativado em 31 de março de 2025. Embora você possa continuar a usar o Visual Studio App Center até que ele seja totalmente desativado, há várias alternativas recomendadas para as quais você pode considerar migrar.

Saiba mais sobre linhas do tempo e alternativas de suporte.

As extensões só dão suporte a relatórios de falhas.

Para saber como adicionar o SDK do App Center ao aplicativo de contêiner, consulte a documentação do app Center macOS Introdução.

Vamos começar a configurar o SDK do macOS do App Center em sua extensão de aplicativo para usar falhas do App Center.

1. Pré-requisitos

Os seguintes requisitos devem ser atendidos para usar o SDK do App Center:

  • Seu projeto macOS está configurado no Xcode 13 ou posterior no macOS versão 10.14.4 ou posterior.
  • Você está direcionando dispositivos em execução no macOS 10.13 ou posterior.
  • Você não está usando nenhuma outra biblioteca que forneça funcionalidade de Relatório de Falhas.

2. Crie seu aplicativo no Portal do App Center para obter o Segredo do Aplicativo

Se você já criou seu aplicativo no portal do App Center, ignore esta etapa.

  1. Vá para appcenter.ms.
  2. Inscreva-se ou faça logon e pressione o botão azul no canto superior direito do portal que diz Adicionar novo e selecione Adicionar novo aplicativo no menu suspenso.
  3. Insira um nome e uma descrição opcional para seu aplicativo.
  4. Selecione macOS como o sistema operacional e Objective-C/Swift como uma plataforma.
  5. Pressione o botão na parte inferior direita que diz Adicionar novo aplicativo.

Depois de criar um aplicativo, você pode obter seu Segredo do Aplicativo na página Configurações no Portal do App Center. No canto superior direito da página Configurações , clique nos pontos verticais triplos e selecione Copy app secret para obter o Segredo do Aplicativo.

Observação

O uso de um Segredo do Aplicativo existente de outro projeto do macOS tem efeitos colaterais. O App Center não dá suporte à filtragem por projeto no mesmo aplicativo do App Center. Por exemplo, a listagem de falhas de uma versão específica listará todas as falhas de ambos os projetos para esta versão sem distinção. Pode ser confuso.

Observação

4.0.0 Na versão do App Center foram introduzidas alterações interruptivas. Siga a seção Migrar para o SDK do App Center 4.0.0 e superior para migrar o App Center de versões anteriores.

3. Adicionar os módulos do SDK do App Center

O SDK do App Center pode ser integrado ao seu aplicativo por meio do Cocoapods, carthage ou adicionando manualmente os binários ao seu projeto.

3.1 Integração via Cocoapods

  1. Adicione as dependências a seguir ao seu podfile para incluir falhas do App Center em seu aplicativo. Isso efetua pull nas seguintes estruturas: AppCenter e AppCenterCrashes.

     pod 'AppCenter/Crashes'

  2. Execute pod install para instalar o pod recém-definido e abra o do .xcworkspaceprojeto.

Observação

Se você vir um erro como [!] Unable to find a specification for `AppCenter` durante a execução pod installde , execute pod repo update para obter os pods mais recentes do repositório Cocoapods e execute pod install.

Agora que você integrou as estruturas em seu aplicativo, é hora de iniciar o SDK e fazer uso dos serviços do App Center.

3.2 Integração via Cartago

Abaixo estão as etapas sobre como integrar o SDK do App Center em seu projeto Xcode usando o Carthage versão 0.30 ou superior, um gerenciador de dependências descentralizado que cria suas dependências e fornece estruturas binárias.

  1. Adicione as dependências a seguir ao seu Cartfile para incluir o App Center em seu aplicativo. Isso efetua pull em todas as estruturas. Em seguida, você pode vincular apenas essas estruturas para usar em seu aplicativo.

    # 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. Execute carthage update. Isso busca dependências em uma pasta Carthage/Checkouts e, em seguida, cria cada estrutura.

  3. Abra a guia Configurações gerais do destino do aplicativo. Arraste e solte os arquivos AppCenter.framework e AppCenterCrashes.framework da pasta Carthage/Build/ para o Navegador de Projeto do Xcode. O AppCenter.framework é necessário para iniciar o SDK. Se ele não for adicionado ao projeto, os outros módulos não funcionarão e seu aplicativo não será compilado.

  4. Uma caixa de diálogo será exibida, verifique se o destino do aplicativo está marcado. Em seguida, clique em Concluir.

    Observação

    Se você usar carthage copy-frameworks em sua Fase de Build , não deverá adicionar os SDKs do App Center lá, pois eles são enviados como estruturas estáticas.

Agora que você integrou as estruturas em seu aplicativo, é hora de iniciar o SDK e fazer uso dos serviços do App Center.

3.3 Integração por meio do Gerenciador de Pacotes Swift

  1. No menu Xcode, clique em Arquivo > Pacotes > Swift Adicionar Dependência de Pacote.
  2. Na caixa de diálogo exibida, insira a URL do repositório: https://github.com/microsoft/appcenter-sdk-apple.git.
  3. Em Versão, selecione Até Próximo Principal e use a opção padrão.
  4. Escolha os módulos necessários na coluna Produto do Pacote .

Agora que você integrou as estruturas em seu aplicativo, é hora de iniciar o SDK e fazer uso dos serviços do App Center.

Observação

Se você estiver integrando o App Center por meio do SwiftPM e quiser usá-lo no destino de extensão do aplicativo também, certifique-se de fornecer DISABLE_DIAMOND_PROBLEM_DIAGNOSTIC=YES em sua configuração. Isso é necessário para evitar limitações do SwiftPM na vinculação de um módulo a vários destinos.

3.4 Integração copiando os binários para seu projeto

Abaixo estão as etapas sobre como integrar os binários compilados em seu projeto Xcode para configurar falhas do App Center para sua extensão de aplicativo.

Observação

O SDK do App Center dá suporte ao uso de XCframework. Se você quiser integrar o XCframeworks ao seu projeto, baixe o AppCenter-SDK-Apple-XCFramework.zip da página de versões e descompacte-o. O conteúdo da pasta resultante não é específico da plataforma, em vez disso, contém XCframeworks para cada módulo. Eles podem ser integrados da mesma maneira que as estruturas usuais, conforme descrito abaixo.

  1. Baixe as estruturas do SDK do App Center fornecidas como um arquivo zip.

  2. Descompacte o arquivo e você verá uma pasta chamada AppCenter-SDK-Apple que contém estruturas diferentes para cada serviço do App Center em cada pasta da plataforma. A estrutura chamada AppCenter é necessária no projeto, pois contém código compartilhado entre os diferentes módulos.

  3. [Opcional] Crie um subdiretório para bibliotecas de terceiros.

    • Como prática recomendada, as bibliotecas de terceiros geralmente estão em um subdiretório, geralmente chamado de Fornecedor. Se o projeto não estiver organizado com um subdiretório para bibliotecas, crie um subdiretório Vendor agora.
    • Crie um grupo chamado Vendor dentro de seu projeto Xcode para imitar sua estrutura de arquivos no disco.

  4. Abra a pasta AppCenter-SDK-Apple descompactada no Finder e copie a pasta para a pasta do projeto no local desejado. A pasta contém estruturas em subpastas para outras plataformas às quais o SDK do App Center dá suporte, portanto, talvez seja necessário excluir subpastas de que não precisa.

  5. Adicione as estruturas do SDK ao projeto no Xcode:

    • Verifique se o Navegador do Projeto está visível (⌘+1).
    • Agora, arraste e solte AppCenter.framework e AppCenterCrashes.framework do Finder (no local da etapa anterior) para o Navegador de Projeto do Xcode. O AppCenter.framework é necessário para iniciar o SDK. Se ele não for adicionado ao projeto, os outros módulos não funcionarão e sua extensão de aplicativo não será compilada.
    • Uma caixa de diálogo será exibida, verifique se o destino da extensão do aplicativo está marcado. Em seguida, clique em Concluir.

Agora que você integrou as estruturas em sua extensão de aplicativo, é hora de iniciar o SDK e fazer uso dos serviços do App Center.

4. Iniciar o SDK

Para usar o App Center, você deve aceitar os módulos a serem usados. Por padrão, nenhum módulo é iniciado e você deve chamar explicitamente cada um deles ao iniciar o SDK.

4.1 Adicionar as instruções de importação

Insira as linhas a seguir no arquivo que contém o ponto de entrada da extensão de aplicativo. Por exemplo, dentro do arquivo Main ViewController de uma extensão Today.

@import AppCenter;
@import AppCenterCrashes;

import AppCenter
import AppCenterCrashes

4.2 Adicionar o start:withServices: método

Insira a linha a seguir no ponto de entrada da extensão de aplicativo. Por exemplo, dentro do viewDidLoad método do arquivo main ViewController de uma extensão Today.

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

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

Atualmente, há suporte apenas para relatórios de falhas para extensões de aplicativo.

4.3 Substitua o espaço reservado pelo segredo do aplicativo

{Your App Secret} Substitua o texto pelo valor real da extensão do aplicativo. O Segredo do Aplicativo pode ser encontrado na página Introdução ou na página Configurações no portal do App Center.

A página Introdução contém o exemplo de código acima com seu Segredo do Aplicativo, você pode copiar e colar todo o exemplo.

Ótimo, você está pronto para visualizar dados de falhas no portal que o SDK coleta automaticamente.

Examine a documentação de Falhas do App Center para saber como personalizar a extensão do aplicativo e usar funcionalidades mais avançadas.