Instale o SDK para iOS, macOS, tvOS e watchOS

Visão geral

O Atlas Device SDK para Swift permite que você crie aplicações para iOS, macOS, tvOS e watchOS usando linguagens de programação Swift ou Objective-C. Esta página detalha como instalar o SDK no seu projeto e como começar.

Pré-requisitos

Antes de começar, certifique-se de que seu ambiente de desenvolvimento atenda aos seguintes pré-requisitos:

• Seu projeto usa uma versão do Xcode e uma versão mínima do sistema operacional listadas na seção Suporte do sistema operacional desta página.

• A reflexão está habilitada no seu projeto. O Swift SDK usa reflexão para determinar as propriedades do modelo. Seu projeto não pode definir SWIFT_REFLECTION_METADATA_LEVEL = none, ou o SDK não pode visualizar propriedades em seu modelo. O reflexo será habilitado por padrão se o projeto não definir especificamente um nível para essa configuração.

Instalação

Você pode usar SwiftPM, CocoaPods ou Carthage para adicionar o Swift SDK ao seu projeto.

SwiftPM

CocoaPods

Carthage

Framework dinâmico

1

Adicionar dependência do pacote

No Xcode, selecione File > Add Packages....

2

Especifique o repositório

Copie e cole o seguinte na caixa de pesquisa/entrada.

https://github.com/realm/realm-swift.git

3

Especifique as opções

Nas opções do realm-swift pacote , recomendamos configurar Dependency Rule Up to Next Major Versioncomo e inserir a versão atual do Realm Swift SDK . Em seguida, clique em Add Package.

4

Selecione os produtos do pacote

Alterado na versão 10.49.3: Em vez de adicionar ambos, adicione apenas um pacote.

Selecione RealmSwift ou Realm e clique em Add Package.

• Se você usar APIs Swift ou Swift e Objective-C, adicione RealmSwift.

• Se você usar apenas APIs do Objective-C, adicione Realm.

5

(Opcional) Crie o RealmSwift como uma estrutura dinâmica

Para usar o manifesto de privacidade fornecido pelo SDK, crie RealmSwift como uma estrutura dinâmica. Se você construir o RealmSwift como uma estrutura estática, você deverá fornecer seu próprio Manifesto de Privacidade.

Para construir o RealmSwift como uma estrutura dinâmica:

1. Em seu projeto Targets, selecione seu destino de construção.

2. Acesse a aba General.

3. Expanda o elemento Frameworks and Libraries .

4. Para o framework RealmSwift , altere a opção Embed de "Não incorporar" para "Incorporar e assinar".

Agora, o Xcode compila RealmSwift dinamicamente e pode fornecer o manifesto de privacidade fornecido pelo SDK.

Se você estiver instalando com CocoaPods, você precisa de CocoaPods 1.10.1 ou mais tarde.

1

Atualizar os repositórios CocoaPods

Na linha de comando, execute pod repo update para garantir que os CocoaPods possam acessar as versões mais recentes disponíveis do Realm .

2

Inicialize CocoaPods para seu projeto

Se você ainda não tiver um Podfile para seu projeto, execute pod init no diretório raiz do seu projeto para criar um Podfile para seu projeto. Um Podfile permite especificar dependências de projeto para CocoaPods.

3

Adicione o SDK como uma dependência em seu Podfile

Objective-C

Swift

Adicione a linha pod 'Realm', '~>10' aos seus destinos principais e de teste.

Adicione a linha use_frameworks! também, se ela ainda não estiver lá.

Quando terminar, seu Podfile deverá ter a seguinte aparência:

# Uncomment the next line to define a global platform for your project
# platform :ios, '11.0'
target 'MyDeviceSDKProject' do
# Comment the next line if you don't want to use dynamic frameworks
use_frameworks!
# Pods for MyDeviceSDKProject
pod 'Realm', '~>10'
target 'MyRealmProjectTests' do
   inherit! :search_paths
   # Pods for testing
   pod 'Realm', '~>10'
end
end

Adicione a linha use_frameworks! se ainda não estiver lá.

Adicione a linha pod 'RealmSwift', '~>10' aos seus destinos principais e de teste.

Quando terminar, seu Podfile deverá ter a seguinte aparência:

platform :ios, '12.0'
target 'MyDeviceSDKProject' do
  # Comment the next line if you don't want to use dynamic frameworks
  use_frameworks!
  # Pods for MyDeviceSDKProject
  pod 'RealmSwift', '~>10'
end

4

Instalar as dependências

Na linha de comando, execute pod install para buscar as dependências.

5

Usar o .xcworkspace arquivo gerado pelo CocoaPods

O CocoaPods gera um arquivo .xcworkspace para você. Este arquivo tem todas as dependências configuradas. A partir de agora, abra este arquivo -- não o arquivo .xcodeproj -- para trabalhar no seu projeto.

Se você estiver instalando com o Carthage, você precisa de Cartago 0.33 ou posterior.

1

Adicione o SDK como uma dependência em seu Chartfile

Adicione o SDK como uma dependência anexando a linha github "realm/realm-swift" ao seu Chartfile.

Você pode criar um Chartfile ou anexar a um existente executando o seguinte comando no diretório do projeto :

echo 'github "realm/realm-swift"' >> Cartfile

2

Instalar as dependências

Na linha de comando, execute carthage update --use-xcframeworks para buscar as dependências.

3

Adicione as estruturas ao seu projeto

Carthage coloca as dependências construídas no diretório Carthage/Build .

Abra o arquivo xcodeproj do seu projeto no Xcode. Go até o painel Navegador de projeto e clique no nome do seu aplicativo para abrir o editor de configurações do projeto. Selecione a guia General .

No Finder, abra o diretório Carthage/Build/ . Arraste os arquivos RealmSwift.xcframework e Realm.xcframework encontrados neste diretório para a seção Frameworks, Libraries, and Embedded Content das configurações do General do seu projeto.

clique para ampliar

1

Baixe e extraia a estrutura

Baixe a versão mais recente do Swift SDK e extraia o zip.

2

Copiar estrutura(s) em seu projeto

Arraste Realm.xcframework e RealmSwift.xcframework (se estiver usando) para o Navegador de arquivos do seu projeto Xcode. Marque a caixa de seleção Copy items if needed e pressione Finish.

Dica

Se estiver usando a API do Objective-C em um projeto Swift, recomendamos que você inclua o Realm Swift e o Realm Objective-C em seu projeto. Dentro de seus arquivos Swift, você pode acessar a API Swift e todos os wrappers necessários. O uso da API RealmSwift em projetos mistos Swift/Objective-C é possível porque a grande maioria dos tipos RealmSwift é diretamente derivada de suas contrapartes Objective-C.

Importar o SDK

Adicione a seguinte linha na parte superior dos seus arquivos de origem para usar o SDK:

#include <Realm/Realm.h>

import RealmSwift

Tamanho do arquivo de download do aplicativo

O SDK deve adicionar apenas cerca de 5 a 8 MB ao tamanho de download do seu aplicativo. Os lançamentos que distribuímos são significativamente maiores porque incluem suporte para os simuladores iOS, watchOS e tvOS, alguns símbolos de depuração e bitcode, todos os quais são removidos pela App Store automaticamente quando os aplicativos são baixados.

Solução de problemas

Se você tiver problemas de construção após usar um desses métodos para instalar o SDK, consulte nossas diretrizes de solução de problemas para saber mais sobre como resolver esses problemas.

Suporte ao sistema operacional

Suporte à simultaneidade do Swift

O Swift SDK oferece suporte às funcionalidades de linguagem relacionadas à simultaneidade do Swift. Para obter as melhores práticas sobre o uso das funcionalidades de simultaneidade do Swift SDK, consulte a documentação abaixo.

Manifesto de privacidade da Apple

A Apple exige que os aplicativos que usam o RealmSwift forneçam um manifesto de privacidade contendo detalhes sobre a coleta de dados e práticas de uso do SDK. O arquivo de manifesto agrupado deve ser incluído ao enviar novos aplicativos ou atualizações de aplicativos para a App Store. Para obter mais detalhes sobre os requisitos da Apple, consulte Próximos requisitos de SDK de terceiros no site da Apple Developer.

A partir da versão 10.46.0 do SDK Swift, o SDK é fornecido com manifestos de privacidade para Realm e RealmSwift. Cada pacote contém seu próprio manifesto de privacidade com as divulgações de API exigidas pela Apple e os motivos para o uso dessas API.

Você pode visualizar os manifestos de privacidade em cada pacote ou no repositório realm-swift do Github :

• Realm: https://github.com/realm/realm-swift/blob/master/Realm/PrivacyInfo.xcprivacy

• RealmSwift: https://github.com/realm/realm-swift/blob/master/RealmSwift/PrivacyInfo.xcprivacy

Para incluir estes manifestos em um destino de compilação que utiliza RealmSwift, você deve construir RealmSwift como uma estrutura dinâmica. Para obter detalhes, consulte a etapa de instruções de instalação do Swift Package Manager (Opcional) Construir RealmSwift como uma estrutura dinâmica.

O Swift SDK não inclui código analítico em compilações para a App Store. O SDK não faz login no Atlas em seu próprio nome.

Se você escrever uma aplicação que usa qualquer funcionalidade dos App Services, como inicializar um cliente de aplicação para:

• Chamar uma Função do Atlas

• Autenticar e gerenciar usuários

• Query MongoDB Atlas

• Abrir um banco de dados sincronizado

Talvez seja necessário adicionar divulgações adicionais ao manifesto de privacidade da aplicação, detalhando sua collection de dados e práticas de uso ao usar essas APIs.

Para obter mais informações, consulte a Documentação dos arquivos de manifesto de privacidade da Apple.