Instalar el SDK para iOS, macOS, tvOS y watchOS

Overview

El SDK de dispositivos Atlas para Swift te permite crear aplicaciones para iOS, macOS, tvOS y watchOS con los lenguajes de programación Swift u Objective-C. Esta página detalla cómo instalar el SDK en tu proyecto y comenzar.

Requisitos previos

Antes de comenzar, asegúrese de que su entorno de desarrollo cumpla con los siguientes requisitos previos:

• Su proyecto utiliza una versión de Xcode y una versión mínima del sistema operativo que figuran en la Sección desoporte del sistema operativo de esta página.

• La reflexión está habilitada en tu proyecto. El SDK de Swift utiliza la reflexión para determinar las propiedades de tu modelo. Tu proyecto no debe configurar SWIFT_REFLECTION_METADATA_LEVEL = none, o el SDK no puede ver las propiedades de su modelo. Reflection está habilitado de forma predeterminada si su proyecto no define específicamente un nivel para esta configuración.

Instalación

Puede utilizar SwiftPM, CocoaPods o Carthage para agregar el Swift SDK a su proyecto.

SwiftPM

Vainas de cacao

Cartago

Marco dinámico

1

Agregar dependencia de paquete

En Xcode, seleccione File > Add Packages....

2

Especificar el repositorio

Copie y pegue lo siguiente en el cuadro de búsqueda/entrada.

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

3

Especificar opciones

En las opciones del realm-swift paquete, recomendamos configurar Dependency Rule Up to Next Major Versionen e ingresar la versión actual del SDK de Realm Swift. Luego, haga clic Add Package en.

4

Seleccione los productos del paquete

Cambiado en la 10.49.3 versión: En lugar de agregar ambos, solo agregue un paquete.

Seleccione RealmSwift o Realm y luego haga clic en Add Package.

• Si usas APIs de Swift o Swift y Objective-C, añade RealmSwift.

• Si usa solo las API de Objective-C, agrega Realm.

5

(Opcional) Construya RealmSwift como un marco dinámico

Para usar el Manifiesto de Privacidad proporcionado por el SDK, cree RealmSwift como un marco dinámico. Si crea RealmSwift como un marco estático, debe proporcionar su propio Manifiesto de Privacidad.

Para construir RealmSwift como un marco dinámico:

1. En tu proyecto Targets, seleccione su objetivo de compilación.

2. Vaya a la pestaña General.

3. Expandir el elemento Frameworks and Libraries.

4. Para el marco RealmSwift, cambie la opción Embed de "No incrustar" a "Incrustar y firmar".

Ahora, Xcode crea RealmSwift dinámicamente y puede proporcionar el Manifiesto de privacidad proporcionado por el SDK.

Si está instalando con CocoaPods, necesitará CocoaPods..1 101 o posterior.

1

Actualizar los repositorios de CocoaPods

En la línea de comando, ejecute pod repo update para garantizar que CocoaPods pueda acceder a las últimas versiones disponibles de Realm.

2

Inicializar CocoaPods para su proyecto

Si aún no tiene un Podfile para su proyecto, ejecute pod init en el directorio raíz para crear uno. Un Podfile le permite especificar las dependencias del proyecto con CocoaPods.

3

Agrega el SDK como dependencia en tu Podfile

Objetivo C

Swift

Agregue la línea pod 'Realm', '~>10' a sus objetivos principales y de prueba.

Agregue también la línea use_frameworks! si aún no está allí.

Cuando haya terminado, su Podfile debería verse así:

# 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

Añade la línea use_frameworks! si aún no está allí.

Agregue la línea pod 'RealmSwift', '~>10' a sus objetivos principales y de prueba.

Cuando haya terminado, su Podfile debería verse así:

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 las dependencias

Desde la línea de comando, ejecute pod install para obtener las dependencias.

5

Utilice el archivo generado por CocoaPods .xcworkspace

CocoaPods genera un archivo .xcworkspace para ti. Este archivo tiene todas las dependencias configuradas. A partir de ahora, abre este archivo -- no el archivo .xcodeproj -- para trabajar en tu proyecto.

Si está instalando con Carthage, necesitará Carthage.0 33 o posterior.

1

Agregue el SDK como una dependencia en su Cartfile

Agregue el SDK como una dependencia agregando la línea github "realm/realm-swift" a su Cartfile.

Puede crear un Cartfile o anexarlo a uno existente ejecutando el siguiente comando en el directorio de su proyecto:

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

2

Instalar las dependencias

Desde la línea de comando, ejecute carthage update --use-xcframeworks para obtener las dependencias.

3

Agrega los marcos a tu proyecto

Carthage coloca las dependencias creadas en el directorio Carthage/Build.

Abre el archivo xcodeproj de tu proyecto en Xcode. Ve al panel Navegador de Proyectos y haz clic en el nombre de tu aplicación para abrir el editor de configuración del proyecto. Selecciona la pestaña General.

En el Finder, abra el directorio Carthage/Build/. Arrastre los archivos RealmSwift.xcframework y Realm.xcframework que se encuentran en ese directorio a la sección Frameworks, Libraries, and Embedded Content de la configuración General de su proyecto.

haga clic para ampliar

1

Descargar y extraer el marco

Descargue la última versión del Swift SDK y extraiga el zip.

2

Copiar marcos de trabajo en su proyecto

Arrastre Realm.xcframework y RealmSwift.xcframework (si lo usa) al Navegador de archivos de su proyecto Xcode. Seleccione la casilla Copy items if needed y presione Finish.

Tip

Si usa la API de Objective-C en un proyecto Swift, le recomendamos incluir Realm Swift y Realm Objective-C en su proyecto. Desde sus archivos Swift, puede acceder a la API de Swift y a todos los wrappers necesarios. Usar la API de RealmSwift en proyectos que combinan Swift y Objective-C es posible porque la gran mayoría de los tipos de RealmSwift tienen alias directos de sus contrapartes de Objective-C.

Importar el SDK

Agrega la siguiente línea en la parte superior de los archivos fuente para utilizar el SDK:

#include <Realm/Realm.h>

import RealmSwift

Tamaño del archivo de descarga de la aplicación

El SDK solo debería añadir entre 5 y 8 MB al tamaño de descarga de tu aplicación. Las versiones que distribuimos son considerablemente más grandes porque incluyen compatibilidad con los simuladores de iOS, watchOS y tvOS, algunos símbolos de depuración y código binario, que la App Store elimina automáticamente al descargar las aplicaciones.

Solución de problemas

Si tiene problemas de compilación después de usar uno de estos métodos para instalar el SDK, consulte nuestras pautas de solución de problemas para obtener información sobre cómo resolver esos problemas.

Soporte del sistema operativo

Compatibilidad con concurrencia de Swift

El SDK de Swift es compatible con las funciones de concurrencia del lenguaje Swift. Para conocer las prácticas recomendadas sobre el uso de las funciones de concurrencia del SDK de Swift, consulte la documentación a continuación.

Manifiesto de privacidad de Apple

Apple requiere que las aplicaciones que utilizan RealmSwift proporcionen un manifiesto de privacidad que contenga detalles sobre las prácticas de colección y uso de datos del SDK. El archivo de manifiesto incluido debe incluirse al enviar nuevas aplicaciones o actualizaciones de aplicaciones a la App Store. Para obtener más detalles sobre los requisitos de Apple, consulta Próximos requisitos para SDKs de terceros en el sitio web de Apple Developer.

A partir de la versión 10.46.0 del SDK de Swift, este se entrega con manifiestos de privacidad para Realm y RealmSwift. Cada paquete contiene su propio manifiesto de privacidad con las divulgaciones de API requeridas por Apple y las razones para usarlas.

Puede ver los manifiestos de privacidad en cada paquete o en el repositorio de GitHub realm-swift:

• 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 estos manifiestos en un objetivo de compilación que RealmSwift use, debe compilar RealmSwift como un marco dinámico. Para obtener más información, consulte el paso (opcional) "Compilar RealmSwift como un marco dinámico" de las instrucciones de instalación del gestor de paquetes Swift.

El SDK de Swift no incluye código de análisis en las compilaciones para la App Store. El SDK no inicia sesión en Atlas por sí mismo.

Si escribe una aplicación que utiliza cualquier funcionalidad de App Services, como inicializar un cliente de aplicación para:

• Llamar a una función Atlas

• Autenticar y administrar usuarios

• Consulta de MongoDB Atlas

• Abrir una base de datos sincronizada

Es posible que deba agregar declaraciones adicionales al manifiesto de privacidad de su aplicación detallando sus prácticas de colección y uso de datos al utilizar estas API.

Para obtener más información, consulte la documentación de los archivos de manifiesto de privacidad de Apple.