Introdução ao iOS

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.

O SDK do App Center usa uma arquitetura modular para que você possa usar qualquer um ou todos os serviços.

Você pode encontrar informações sobre os dados coletados pelo App Center sobre dados coletados por SDKs do App Center, regulamento geral de proteção de dados e páginas de perguntas frequentes . Além disso, as perguntas frequentes contêm as respostas, que você precisa fornecer para App Store configuração de privacidade.

Vamos começar a configurar o SDK do iOS do App Center em seu aplicativo para usar a Análise do App Center e falhas do App Center. Para adicionar o App Center Distribute ao seu aplicativo, examine a documentação do App Center Distribute.

1. Pré-requisitos

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

  • Seu projeto do iOS está configurado no Xcode 13 ou posterior no macOS versão 10.14.4 ou posterior.
  • Você está direcionando dispositivos em execução no ios 11.0 ou posterior.
  • Você não está usando nenhuma outra biblioteca que forneça funcionalidade de Relatório de Falhas (somente para falhas do App Center).
  • Se você estiver usando o CocoaPods para integrar o App Center, precisará do CocoaPods versão 1.10 ou posterior.

A Análise e falhas do SDK do App Center são compatíveis com o Mac Catalyst via XCFramework ou SwiftPM.

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 iOS 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.

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

O SDK do App Center para iOS pode ser adicionado ao seu aplicativo por meio de Cocoapods, Carthage, Swift Package Manager ou adicionando manualmente os binários ao seu projeto.

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.1 Integração via Cocoapods

Observação

Os simuladores ARM64 (quando iniciados do Xcode em execução no Apple Silicon Mac) não têm suporte por meio do CocoaPods, considere o uso de outros métodos de integração para que funcionem.

  1. Adicione as dependências a seguir ao seu podfile para incluir a Análise do App Center e falhas do App Center em seu aplicativo. Essa ação efetua pull nas seguintes estruturas: AppCenter, AppCenterAnalytics e AppCenterCrashes. Em vez disso, você pode especificar os serviços desejados em seu aplicativo. Cada serviço tem sua própria subespec e todos eles dependem do AppCenter. Ele será retirado automaticamente.

     # Use the following line to use App Center Analytics and Crashes.x
     pod 'AppCenter'
    
     # Use the following lines if you want to specify which service you want to use.
     pod 'AppCenter/Analytics'
     pod 'AppCenter/Crashes'
     pod 'AppCenter/Distribute'
    
  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.

Observação

A integração do Carthage não funciona prontamente no Xcode 12. Para fazer funcionar, consulte esta instrução Carthage

  1. Adicione as dependências a seguir ao seu Cartfile para incluir o App Center. Essas dependências efetuam pull em todas as estruturas. Em seguida, você pode vincular somente as estruturas que deseja 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 para buscar dependências em uma pasta Carthage/Checkouts . Em seguida, crie cada estrutura.

  3. Abra a guia Configurações gerais do destino do aplicativo. Arraste e solte os arquivos AppCenter.framework, AppCenterAnalytics.framework e AppCenterCrashes.framework da pasta Carthage/Build/iOS no 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 a Análise do App Center e falhas do App Center para seu aplicativo iOS.

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 compatíveis com o SDK do App Center, portanto, talvez seja necessário excluir subpastas que você não precisa.

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

    • Verifique se o Project Navigator está visível (⌘+1).
    • Agora arraste & soltar AppCenter.framework, AppCenterAnalytics.framework e AppCenterCrashes.framework do Finder (no local da etapa anterior) para o Project Navigator 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.
    • Uma caixa de diálogo será exibida, verifique se o destino do aplicativo está marcado. Em seguida, clique em Concluir.

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

4. Iniciar o SDK

Para usar o App Center, aceite os módulos que você deseja usar. Por padrão, nenhum módulo é iniciado e você deve chamar cada um ao iniciar o SDK.

As instruções abaixo são ligeiramente diferentes dependendo do ciclo de vida que você está usando. A partir do Xcode 12, você pode selecionar um dos dois ciclos de vida: "Aplicativo de interface do usuário Swift" (selecionado por padrão no Xcode 12) e "UI Kit AppDelegate". Se você estiver desenvolvendo para uma extensão, consulte a página Introdução à extensão.

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

Abra o arquivo AppDelegate do projeto (para o ciclo de vida appDelegate do kit de interface do usuário) ou <o arquivo ProjectName>App.swift (para o ciclo de vida do aplicativo de interface do usuário swift) e adicione as seguintes instruções de importação:

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

4.2 Adicionar o start:withServices: método

AppDelegate do Kit de Interface do Usuário

Adicione o código de inicialização ao didFinishLaunchingWithOptions método delegado:

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

Ciclo de vida do aplicativo swift UI

Para garantir que o SDK do App Center funcione corretamente com a interface do usuário do Swift, inicialize-o após o carregamento da interface do usuário. A maneira mais simples de conseguir isso é usando o UIApplicationDelegate:

class AppDelegate: NSObject, UIApplicationDelegate {
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
          AppCenter.start(withAppSecret: "{Your App Secret}", services:[
            Crashes.self, Analytics.self, Distribute.self])
        return true
    }
}

Em seguida, use UIApplicationDelegateAdaptor em struct:

@main
struct YourAppName: App {

  @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Se você tiver um aplicativo Catalyst, poderá passar segredos do aplicativo para iOS e macOS ao mesmo tempo:

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

Aviso

Não é recomendável inserir seu Segredo do Aplicativo no código-fonte.

Se você precisar iniciar os serviços do App Center separadamente, deverá:

  1. Configure ou inicie-o com o Segredo do Aplicativo.
  2. Se o código puder ser chamado várias vezes, marcar se o App Center já estiver configurado.
  3. Inicie os serviços necessários sem o Segredo do Aplicativo.
[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 Substitua o espaço reservado pelo segredo do aplicativo

{Your App Secret} Substitua o texto pelo valor real 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.

O exemplo acima mostra como usar o start:withServices método (start(withAppSecret:services:) para Swift) e incluir a Análise do App Center e falhas do App Center.

Se você não quiser usar um dos dois serviços, remova o parâmetro correspondente da chamada de método acima.

A menos que você especifique explicitamente cada módulo como um parâmetro no método start, não será possível usar esse serviço do App Center. Além disso, a start:withServices API (start(withAppSecret:services:) para Swift) pode ser usada apenas uma vez no ciclo de vida do seu aplicativo – todas as outras chamadas registrarão um aviso no console e somente os módulos incluídos na primeira chamada estarão disponíveis.

Por exemplo- Se você quiser integrar-se à Análise do App Center, deverá modificar a start:withServices chamada à API (start(withAppSecret:services:) para Swift) da seguinte maneira:

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

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

Examine os documentos do App Center Analytics e os documentos de Falhas do App Center para saber como personalizar e usar funcionalidades mais avançadas de ambos os serviços.

Para saber como começar a usar as atualizações no aplicativo, leia a documentação do App Center Distribute.