Diseño de la API de Xamarin.iOS

Artículo
07/13/2023

Además de las bibliotecas de clase base principales que forman parte de Mono, Xamarin.iOS se suministra con enlaces para varias API de iOS que permiten a los desarrolladores crear aplicaciones nativas de iOS con Mono.

En el núcleo de Xamarin.iOS hay un motor de interoperabilidad que une el mundo de C# con el de Objective-C y los enlaces para las API basadas en C de iOS, como CoreGraphics y OpenGL ES.

El entorno de ejecución de bajo nivel para comunicarse con código de Objective-C está en MonoTouch.ObjCRuntime. Aparte de esto, se proporcionan enlaces para Foundation, CoreFoundation y UIKit.

Principios de diseño

En esta sección se detallan algunos de los principios de diseño de los enlaces de Xamarin.iOS (también son válidos para Xamarin.Mac, los enlaces Mono para Objective-C en macOS):

Siga las instrucciones de diseño de los marcos.
Permita a los desarrolladores crear subclases de clases de Objective-C:
- Derive de una clase existente.
- Llame al constructor base para encadenar.
- Los métodos de reemplazo deben realizarse con el sistema de reemplazo de C#.
- La creación de subclases debe funcionar con construcciones estándar de C#.
No exponga a los desarrolladores a selectores de Objective-C
Proporcione un mecanismo para llamar a bibliotecas arbitrarias de Objective-C
Consiga que las tareas comunes de Objective-C sean fáciles y las tareas difíciles de Objective-C sean posibles
Exponga las propiedades de Objective-C como propiedades de C#
Exponga una API fuertemente tipada:
- Aumente la seguridad de los tipos.
- Minimice los errores en el entorno de ejecución.
- Obtenga IntelliSense del IDE en los tipos de valor devuelto.
- Permita la documentación del menú emergente del IDE.
Aliente la exploración en el IDE de las API:
- Por ejemplo, en lugar de exponer una matriz que no esté fuertemente tipada, como esta:
```
NSArray *getViews
```
  Exponga un tipo inflexible, como este:
```
NSView [] Views { get; set; }
```
  El uso de tipos fuertes proporciona a Visual Studio para Mac la capacidad de realizar una finalización automática mientras se examina la API, hace que todas las operaciones de System.Array estén disponibles en el valor devuelto y permite que el valor devuelto participe en LINQ.
Tipos de C# nativos:
- NSString se convierte en string.
- Convierta los parámetros int y uint que deberían haber sido enumeraciones en enumeraciones de C# y enumeraciones de C# con atributos [Flags].
- En lugar de objetos NSArray con tipos neutros, exponga matrices como matrices fuertemente tipadas.
- En el caso de eventos y notificaciones, proporcione a los usuarios una opción entre:
  - Una versión fuertemente tipada de manera predeterminada
  - Una versión que no está fuertemente tipada para casos de uso avanzados
Apoye el patrón de delegado de Objective-C:
- Sistema de eventos de C#.
- Exponga los delegados de C# (expresiones lambda, métodos anónimos y System.Delegate) a las API de Objective-C como bloques

Ensamblados

Xamarin.iOS incluye numerosos ensamblados que constituyen el Perfil de Xamarin.iOS. La página Ensamblados tiene más información.

Espacios de nombres importantes

ObjCRuntime

El espacio de nombres ObjCRuntime permite a los desarrolladores enlazar los mundos entre C# y Objective-C. Se trata de un nuevo enlace, diseñado específicamente para iOS, basado en la experiencia de Cocoa# y Gtk#.

Fundación

El espacio de nombres de Foundation proporciona los tipos de datos básicos diseñados para interoperar con el marco Foundation de Objective-C que forma parte de iOS y es la base para la programación orientada a objetos en Objective-C.

Xamarin.iOS refleja en C# la jerarquía de clases de Objective-C. Por ejemplo, la clase base de Objective-C NSObject se puede usar desde C# mediante Foundation.NSObject.

Aunque el espacio de nombres Foundation proporciona enlaces para los tipos subyacentes de Foundation de Objective-C, en algunos casos hemos asignado los tipos subyacentes a los tipos de .NET. Por ejemplo:

En lugar de tratar con NSString y NSArray, el entorno de ejecución los expone como cadenas de C# y matrices fuertemente tipadas en la API.
Aquí se muestran varias API auxiliares que permiten a los desarrolladores enlazar las API de Objective-C de terceros, otras API de iOS o las que actualmente no están enlazadas con Xamarin.iOS.

Para obtener más información sobre el enlace de las API, vea la sección del generador de enlaces de Xamarin.iOS.

NSObject

El tipo NSObject es la base de todos los enlaces de Objective-C. Los tipos de Xamarin.iOS reflejan dos clases de tipos de las API de CocoaTouch de iOS: los tipos de C (que normalmente se denominan tipos de CoreFoundation) y los tipos de Objective-C (que derivan de la clase NSObject).

Para cada tipo que refleje un tipo no administrado, es posible obtener el objeto nativo a través de la propiedad Handle.

Aunque Mono proporcionará la recolección de elementos no utilizados para todos los objetos, Foundation.NSObject implementa la interfaz System.IDisposable. Es posible liberar explícitamente los recursos de cualquier NSObject determinado sin tener que esperar a que se inicie el recolector de elementos no utilizados. Liberar recursos explícitamente es importante cuando se usan objetos NSObject pesados; por ejemplo, UIImages que pueden contener punteros a grandes bloques de datos.

Si el tipo necesita realizar una finalización determinista, invalide el método NSObject.Dispose(bool). El parámetro para Dispose es "bool disposing" y, si se establece en true, significa que se llama al método Dispose porque el usuario llamó explícitamente a Dispose () en el objeto. Un valor "false" significa que se llama al método Dispose(bool disposing) desde el finalizador en el subproceso del finalizador.

Categorías

A partir de Xamarin.iOS 8.10, es posible crear categorías de Objective-C desde C#.

Esto se hace mediante el atributo Category, especificando el tipo que se va a extender como argumento al atributo. En el ejemplo siguiente, por ejemplo, se ampliará NSString.

[Category (typeof (NSString))]

Cada método de categoría usa el mecanismo normal para exportar métodos a Objective-C mediante el atributo Export:

[Export ("today")]
public static string Today ()
{
    return "Today";
}

Todos los métodos de extensión administrados deben ser estáticos, pero es posible crear métodos de instancia de Objective-C con la sintaxis estándar para los métodos de extensión de C#:

[Export ("toUpper")]
public static string ToUpper (this NSString self)
{
    return self.ToString ().ToUpper ();
}

y el primer argumento del método de extensión será la instancia en la que se invocó el método.

Ejemplo completo:

[Category (typeof (NSString))]
public static class MyStringCategory
{
    [Export ("toUpper")]
    static string ToUpper (this NSString self)
    {
        return self.ToString ().ToUpper ();
    }
}

En este ejemplo se agregará un método de instancia toUpper nativo a la clase NSString, que se puede invocar desde Objective-C.

[Category (typeof (UIViewController))]
public static class MyViewControllerCategory
{
    [Export ("shouldAutoRotate")]
    static bool GlobalRotate ()
    {
        return true;
    }
}

Un escenario en el que esto resulta útil es agregar un método a un conjunto completo de clases en el código base, por ejemplo, esto haría que todas las instancias de UIViewController informen de que pueden girar:

[Category (typeof (UINavigationController))]
class Rotation_IOS6 {
      [Export ("shouldAutorotate:")]
      static bool ShouldAutoRotate (this UINavigationController self)
      {
          return true;
      }
}

PreserveAttribute

PreserveAttribute es un atributo personalizado que se usa para indicar a mtouch (la herramienta de implementación de Xamarin.iOS) que se debe conservar un tipo, o un miembro de un tipo, durante la fase en la que se procesa la aplicación para reducir su tamaño.

Todos los miembros no vinculados de forma estática por la aplicación podrían eliminarse. Por tanto, este atributo se usa para marcar los miembros a los que no se hace referencia de forma estática, pero que siguen siendo necesarios para la aplicación.

Por ejemplo, si crea instancias de tipos de forma dinámica, puede que desee conservar el constructor predeterminado de sus tipos. Si usa la serialización XML, puede que quiera conservar las propiedades de los tipos.

Este atributo se puede aplicar en todos los miembros de un tipo o en el propio tipo. Si desea conservar todo el tipo, puede usar la sintaxis [Preserve (AllMembers = true)] en dicho tipo.

UIKit

El espacio de nombres UIKit contiene una asignación de uno a uno a todos los componentes de la interfaz de usuario que componen CocoaTouch en forma de clases de C#. La API se ha modificado para seguir las convenciones usadas en el lenguaje de C#.

Se suministran delegados de C# para operaciones frecuentes. Para obtener más información, vea la sección sobre los delegados.

OpenGLES

En el caso de OpenGL ES, se distribuye una versión modificada de la API de OpenTK, un enlace orientado a objetos a OpenGL que se ha modificado para usar estructuras y tipos de datos CoreGraphics, y exponer solo la funcionalidad que está disponible en iOS.

La funcionalidad de OpenGLES 1.1 está disponible a través del tipo ES11.GL.

La funcionalidad de OpenGLES 2.0 está disponible a través del tipo ES20.GL.

La funcionalidad de OpenGLES 3.0 está disponible a través del tipo ES30.GL.

Diseño de enlace

Xamarin.iOS no es simplemente un enlace a la plataforma de Objective-C subyacente. Amplía el sistema de tipos de .NET y el sistema de distribución para fusionar mejor C# y Objective-C.

Del mismo modo que P/Invoke es una herramienta útil para invocar bibliotecas nativas en Windows y Linux, o cómo la compatibilidad de IJW se puede usar para la interoperabilidad COM en Windows, Xamarin.iOS amplía el entorno de ejecución para admitir el enlace de objetos de C# a objetos de Objective-C.

La explicación de las siguientes secciones no es necesaria para los usuarios que crean aplicaciones de Xamarin.iOS, pero ayudará a los desarrolladores a comprender cómo se realizan las cosas y a crear aplicaciones más complicadas.

Tipos

Cuando era posible, se exponían tipos de C#, en lugar de tipos de Foundation de bajo nivel, en el universo C#. Esto significa que la API usa el tipo "string" de C# en lugar de NSString y usa matrices de C# con establecimiento inflexible de tipos en lugar de exponer NSArray.

En general, en el diseño de Xamarin.iOS y Xamarin.Mac, no se expone el objeto de NSArray subyacente. En su lugar, el entorno de ejecución convierte automáticamente los valores NSArray en matrices con establecimiento inflexible de tipos de alguna clase NSObject. Por lo tanto, Xamarin.iOS no expone un método que no está fuertemente tipado como GetViews para devolver una propiedad NSArray:

NSArray GetViews ();

En su lugar, el enlace expone un valor devuelto con establecimiento inflexible de tipos, como se muestra a continuación:

UIView [] GetViews ();

Hay algunos métodos que se exponen en NSArray, en los casos excepcionales en los que podría querer usar una propiedad NSArray directamente, pero no se recomienda su uso en el enlace de API.

Además, en Classic API, en lugar de exponer CGRect, CGPoint y CGSize de la API de CoreGraphics, los reemplazamos por las implementaciones de System.DrawingRectangleF, PointF y SizeF, ya que ayudarían a los desarrolladores a conservar el código OpenGL existente que usa OpenTK. Cuando se usa el nuevo valor Unified API de 64 bits, se debe usar la API de CoreGraphics.

Herencia

El diseño de la API de Xamarin.iOS permite a los desarrolladores ampliar los tipos nativos de Objective-C de la misma manera que ampliarían un tipo C#, mediante la palabra clave "override" en una clase derivada, así como el encadenamiento hasta la implementación base mediante la palabra clave de C# "base".

Gracias a este diseño, los desarrolladores evitan trabajar con los selectores de Objective-C como parte de su proceso de desarrollo, ya que todo el sistema Objective-C ya está encapsulado dentro de las bibliotecas de Xamarin.iOS.

Tipos e Interface Builder

Al crear clases .NET que son instancias de tipos creados por Interface Builder, debe proporcionar un constructor que tome un solo parámetro IntPtr. Esto es necesario para enlazar la instancia del objeto administrado con el objeto no administrado. El código consta de una sola línea, como la siguiente:

public partial class void MyView : UIView {
   // This is the constructor that you need to add.
   public MyView (IntPtr handle) : base (handle) {}
}

Delegados

Objective-C y C# tienen significados diferentes para la palabra delegado en cada lenguaje.

En el mundo Objective-C, y en la documentación que encontrará en línea sobre CocoaTouch, un delegado es normalmente una instancia de una clase que responderá a un conjunto de métodos. Esto es similar a una interfaz de C#, con la diferencia de que los métodos no siempre son obligatorios.

Estos delegados desempeñan un papel importante en UIKit y otras API de CocoaTouch. Se usan para realizar varias tareas:

Para proporcionar notificaciones al código (similar a la entrega de eventos en C# o Gtk+).
Para implementar los modelos para los controles de visualización de datos.
Para controlar el comportamiento de un control.

El patrón de programación se diseñó para minimizar la creación de clases derivadas para modificar el comportamiento de un control. Esta solución es similar en espíritu a lo que otros kits de herramientas de GUI han hecho a lo largo de los años: señales de Gtk, ranuras Qt, eventos Winforms, eventos WPF/Silverlight, etc. Para evitar tener cientos de interfaces (una para cada acción) o requerir a los desarrolladores que implementen demasiados métodos que no necesitan, Objective-C admite definiciones de método opcionales. Esto es diferente de las interfaces de C# que requieren que se implementen todos los métodos.

En las clases de Objective-C, verá que las clases que usan este patrón de programación exponen una propiedad, denominada delegate, que es necesaria para implementar las partes obligatorias de la interfaz y cero (o más) elementos opcionales.

En Xamarin.iOS se ofrecen tres mecanismos mutuamente excluyentes para enlazar estos delegados:

A través de eventos.
Con establecimiento inflexible de tipos a través de una propiedad Delegate
Con establecimiento flexible de tipos flexible a través de una propiedad WeakDelegate

Por ejemplo, considere la siguiente clase UIWebView. Esto se envía a una instancia de UIWebViewDelegate, que se asigna a la propiedad del delegado.

A través de eventos

Para muchos tipos, Xamarin.iOS creará automáticamente un delegado adecuado que reenviará las llamadas de UIWebViewDelegate a los eventos de C#. Para UIWebView:

El método webViewDidStartLoad se asigna al evento UIWebView.LoadStarted.
El método webViewDidFinishLoad se asigna al evento UIWebView.LoadFinished.
El método webView:didFailLoadWithError se asigna al evento UIWebView.LoadError.

Por ejemplo, este sencillo programa registra las horas de inicio y finalización al cargar una vista web:

DateTime startTime, endTime;
var web = new UIWebView (new CGRect (0, 0, 200, 200));
web.LoadStarted += (o, e) => startTime = DateTime.Now;
web.LoadFinished += (o, e) => endTime = DateTime.Now;

A través de propiedades

Los eventos son útiles cuando puede haber más de un suscriptor al evento. Además, los eventos se limitan a los casos en los que no hay ningún valor devuelto del código.

En los casos en los que se espera que el código devuelva un valor, hemos optado por las propiedades. Esto significa que solo se puede establecer un método en un momento dado en un objeto.

Por ejemplo, puede usar este mecanismo para descartar el teclado en la pantalla del controlador de un UITextField:

void SetupTextField (UITextField tf)
{
    tf.ShouldReturn = delegate (textfield) {
        textfield.ResignFirstResponder ();
        return true;
    }
}

En este caso, la propiedad ShouldReturn de UITextField toma como argumento un delegado que devuelve un valor booleano y determina si TextField debe hacer algo con el botón de retorno que se presiona. En nuestro método, devolvemos true al autor de la llamada, pero también quitamos el teclado de la pantalla (esto sucede cuando TextField llama a ResignFirstResponder).

Con establecimiento inflexible de tipos a través de una propiedad de delegado

Si prefiere no usar eventos, puede proporcionar su propia subclase UIWebViewDelegate y asignarla a la propiedad UIWebView.Delegate. Una vez que se ha asignado UIWebView.Delegate, el mecanismo de envío de eventos UIWebView dejará de funcionar y los métodos UIWebViewDelegate se invocarán cuando se produzcan los eventos correspondientes.

Por ejemplo, este tipo simple registra el tiempo que se tarda en cargar una vista web:

class Notifier : UIWebViewDelegate  {
    DateTime startTime, endTime;

    public override LoadStarted (UIWebView webview)
    {
        startTime = DateTime.Now;
    }

    public override LoadingFinished (UIWebView webView)
    {
        endTime= DateTime.Now;
    }
}

Lo anterior se usa en código como el siguiente:

var web = new UIWebView (new CGRect (0, 0, 200, 200));
web.Delegate = new Notifier ();

Lo anterior creará un elemento UIWebViewer y le indicará que envíe mensajes a una instancia del notificador, una clase que hemos creado para responder a los mensajes.

Este patrón también se usa para controlar el comportamiento de determinados controles; por ejemplo, en el caso de UIWebView, la propiedad UIWebView.ShouldStartLoad permite a la instancia de UIWebView controlar si UIWebView cargará o no una página.

El patrón también se usa para proporcionar los datos a petición para algunos controles. Por ejemplo, el control UITableView es un control de representación de tabla eficaz, y el aspecto y el contenido están controlados por una instancia de UITableViewDataSource.

Con establecimiento flexible de tipos a través de la propiedad WeakDelegate

Además de la propiedad con establecimiento inflexible de tipos, también hay un delegado con tipos flexibles que permite al desarrollador enlazar elementos de manera diferente si se desea. En todas las partes en las que se expone una propiedad Delegate con establecimiento inflexible de tipos en un enlace de Xamarin.iOS, también se expone una propiedad WeakDelegate correspondiente.

Al utilizar WeakDelegate, el usuario es quien debe decorar correctamente la clase mediante el atributo Export para especificar el selector. Por ejemplo:

class Notifier : NSObject  {
    DateTime startTime, endTime;

    [Export ("webViewDidStartLoad:")]
    public void LoadStarted (UIWebView webview)
    {
        startTime = DateTime.Now;
    }

    [Export ("webViewDidFinishLoad:")]
    public void LoadingFinished (UIWebView webView)
    {
        endTime= DateTime.Now;
    }
}

[...]

var web = new UIWebView (new CGRect (0, 0, 200, 200));
web.WeakDelegate = new Notifier ();

Una vez que se ha asignado la propiedad WeakDelegate, no se usará la propiedad Delegate. Además, si implementa el método en una clase base heredada que desea usar [Export], debe convertirlo en un método público.

Asignación del patrón de delegado de Objective-C a C#

Cuando vea muestras de Objective-C que se parezcan a estas:

foo.delegate = [[SomethingDelegate] alloc] init]

Esto indica al lenguaje que cree y construya una instancia de la clase "SomethingDelegate" y asigne el valor a la propiedad de delegado en la variable foo. Este mecanismo es compatible con Xamarin.iOS y C# la sintaxis es:

foo.Delegate = new SomethingDelegate ();

En Xamarin.iOS hemos proporcionado clases fuertemente tipadas que se asignan a las clases de delegado de Objective-C. Para usarlas, creará subclases e invalidará los métodos definidos por la implementación de Xamarin.iOS. Para obtener más información sobre cómo funcionan, vea la sección "Modelos" a continuación.

Asignación de delegados a C#

En general, UIKit usa los delegados de Objective-C de dos formas.

En la primera de ellas, proporciona una interfaz al modelo de un componente. Por ejemplo, como mecanismo para proporcionar datos a petición para una vista, como la instalación de almacenamiento de datos para una vista de lista. En estos casos, siempre debe crear una instancia de la clase adecuada y asignar la variable.

En el ejemplo siguiente, se proporciona UIPickerView con una implementación para un modelo que utiliza cadenas:

public class SampleTitleModel : UIPickerViewTitleModel {

    public override string TitleForRow (UIPickerView picker, nint row, nint component)
    {
        return String.Format ("At {0} {1}", row, component);
    }
}

[...]

pickerView.Model = new MyPickerModel ();

La segunda forma es proporcionar una notificación para los eventos. En esos casos, aunque todavía exponemos la API en de la forma descrita anteriormente, también proporcionamos eventos de C#, que deben ser más fáciles de usar para las operaciones rápidas e integrarse con delegados anónimos y expresiones lambda en C#.

Por ejemplo, puede suscribirse a eventos de UIAccelerometer:

UIAccelerometer.SharedAccelerometer.Acceleration += (sender, args) => {
   UIAcceleration acc = args.Acceleration;
   Console.WriteLine ("Time={0} at {1},{2},{3}", acc.Time, acc.X, acc.Y, acc.Z);
}

Las dos opciones están disponibles cuando su uso es posible, pero como programador debe elegir una u otra. Si crea su propia instancia de un respondedor o delegado con establecimiento inflexible de tipos y la asigna, los eventos de C# no funcionarán. Si usa los eventos de C#, nunca se llamará a los métodos de la clase de respondedor/delegado.

El ejemplo anterior que usaba UIWebView se puede escribir con expresiones lambda C# 3.0 como esta:

var web = new UIWebView (new CGRect (0, 0, 200, 200));
web.LoadStarted += () => { startTime = DateTime.Now; }
web.LoadFinished += () => { endTime = DateTime.Now; }

Respuesta a eventos

En el código de Objective-C, los controladores de eventos para varios controles y proveedores de información para varios controles se hospedarán a veces en la misma clase. Esto es posible porque las clases responden a los mensajes; mientras que las clases respondan a los mensajes, es posible vincular los objetos entre sí.

Como se detalló anteriormente, Xamarin.iOS admite tanto el modelo de programación basado en eventos de C# como el patrón de delegado de Objective-C, donde puede crear una nueva clase que implemente el delegado e invalide los métodos deseados.

También es posible admitir el patrón de Objective-C, donde todos los respondedores de varias operaciones diferentes se hospedan en la misma instancia de una clase. Para ello, sin embargo, tendrá que usar características de bajo nivel del enlace de Xamarin.iOS.

Por ejemplo, si desea que la clase responda al mensaje UITextFieldDelegate.textFieldShouldClear: y a UIWebViewDelegate.webViewDidStartLoad: en la misma instancia de una clase, tendría que usar la declaración de atributo [Export]:

public class MyCallbacks : NSObject {
    [Export ("textFieldShouldClear:"]
    public bool should_we_clear (UITextField tf)
    {
        return true;
    }

    [Export ("webViewDidStartLoad:")]
    public void OnWebViewStart (UIWebView view)
    {
        Console.WriteLine ("Loading started");
    }
}

Los nombres de C# de los métodos no son importantes; lo único que importa son las cadenas que se pasan al atributo [Export].

Al usar este estilo de programación, asegúrese de que los parámetros de C# coincidan con los tipos reales que pasará el motor del entorno de ejecución.

Modelos

En las instalaciones de almacenamiento de UIKit, o en los respondedores que se implementan mediante clases auxiliares, se hace referencia a ellos en el código de Objective-C como delegados y se implementan como protocolos.

Los protocolos de Objective-C son similares a las interfaces, pero admiten métodos opcionales, es decir, no es necesario implementar todos los métodos para que el protocolo funcione.

Hay dos formas de implementar un modelo. Puede implementarlo manualmente o usar las definiciones existentes con establecimiento inflexible de tipos.

El mecanismo manual es necesario cuando se intenta implementar una clase que no está enlazada con Xamarin.iOS. Es fácil de hacer:

Marcado de la clase para el registro con el entorno de ejecución
Aplique el atributo [Export] con el nombre del selector real en cada método que quiera invalidar.
Cree una instancia de la clase y pásela.

Por ejemplo, a continuación se implementa solo uno de los métodos opcionales en la definición del protocolo de UIApplicationDelegate:

public class MyAppController : NSObject {
        [Export ("applicationDidFinishLaunching:")]
        public void FinishedLaunching (UIApplication app)
        {
                SetupWindow ();
        }
}

El nombre del selector de Objective-C ("applicationDidFinishLaunching:") se declara con el atributo Export y la clase se registra con el atributo [Register].

Xamarin.iOS proporciona declaraciones fuertemente tipadas, listas para usar, que no requieren enlace manual. Para admitir este modelo de programación, el entorno de ejecución de Xamarin.iOS admite el atributo [Model] en una declaración de clase. Dicho atributo informa al entorno de ejecución de que no debe conectar todos los métodos de la clase, a menos que los métodos se implementen explícitamente.

Esto significa que en UIKit, las clases que representan un protocolo con métodos opcionales se escriben de la siguiente manera:

[Model]
public class SomeViewModel : NSObject {
    [Export ("someMethod:")]
    public virtual int SomeMethod (TheView view) {
       throw new ModelNotImplementedException ();
    }
    ...
}

Cuando quiera implementar un modelo que solo implemente algunos de los métodos, todo lo que tiene que hacer es invalidar los métodos que le interesen y omitir los demás. El entorno de ejecución solo enlazará los métodos sobrescritos, no los métodos originales, al entorno de Objective-C.

El equivalente al ejemplo manual anterior es:

public class AppController : UIApplicationDelegate {
    public override void FinishedLaunching (UIApplication uia)
    {
     ...
    }
}

Las ventajas son que no es necesario profundizar en los archivos de encabezado de Objective-C para buscar el selector, los tipos de los argumentos o la asignación a C#, y que obtiene IntelliSense de Visual Studio para Mac, junto con tipos seguros.

Salidas de XIB y C#

Esta es una descripción de bajo nivel de cómo las salidas se integran con C# y se proporcionan para usuarios avanzados de Xamarin.iOS. Cuando se usa Visual Studio para Mac, la asignación se realiza automáticamente en segundo plano mediante código generado sobre la marcha.

Cuando se diseña la interfaz de usuario con Interface Builder, solo se diseña la apariencia de la aplicación y se establecen algunas conexiones predeterminadas. Si quiere obtener información mediante programación, modificar el comportamiento de un control en tiempo de ejecución o modificar el control en tiempo de ejecución; es necesario enlazar algunos de los controles al código administrado.

Para ello, siga estos pasos:

Agregue la declaración de salida al propietario del archivo.
Conecte el control al propietario del archivo.
Almacene la interfaz de usuario más las conexiones en el archivo XIB/NIB.
Cargue el archivo NIB en tiempo de ejecución.
Acceda a la variable de salida.

Los pasos (1) a (3) se describen en la documentación de Apple para la creación de interfaces con Interface Builder.

Al usar Xamarin.iOS, la aplicación deberá crear una clase que se derive de UIViewController. Se implementa de esta manera:

public class MyViewController : UIViewController {
    public MyViewController (string nibName, NSBundle bundle) : base (nibName, bundle)
    {
        // You can have as many arguments as you want, but you need to call
        // the base constructor with the provided nibName and bundle.
    }
}

Después, para cargar ViewController desde un archivo NIB, haga lo siguiente:

var controller = new MyViewController ("HelloWorld", NSBundle.MainBundle, this);

Esta acción carga la interfaz de usuario desde el archivo NIB. Ahora, para acceder a las salidas, es necesario informar al entorno de ejecución de que queremos acceder a ellas. Para ello, la subclase UIViewController debe declarar las propiedades y anotarlas con el atributo [Connect]. Por ejemplo:

[Connect]
UITextField UserName {
    get {
        return (UITextField) GetNativeField ("UserName");
    }
    set {
        SetNativeField ("UserName", value);
    }
}

La implementación de la propiedad es aquella que realmente captura y almacena el valor para el tipo nativo real.

No debe preocuparse por esto al usar Visual Studio para Mac e InterfaceBuilder. Visual Studio para Mac refleja automáticamente todas las salidas declaradas con código en una clase parcial que se compila como parte del proyecto.

Selectores

Un concepto básico de la programación de Objective-C son los selectores. A menudo, se encontrará con API que requieren que se pase un selector o se espera que el código responda a uno.

Crear nuevos selectores en C# es fácil: solo hay que crear una instancia de la clase ObjCRuntime.Selector y usar el resultado en cualquier lugar de la API que lo requiera. Por ejemplo:

var selector_add = new Selector ("add:plus:");

Para que un método de C# responda a una llamada del selector, debe heredarse del tipo NSObject y el método de C# se debe decorar con el nombre del selector mediante el atributo [Export]. Por ejemplo:

public class MyMath : NSObject {
    [Export ("add:plus:")]
    int Add (int first, int second)
    {
         return first + second;
    }
}

Los nombres de los selectores deben coincidir exactamente, incluidos todos los signos de dos puntos, intermedios y finales (":"), si existen.

Constructores NSObject

La mayoría de las clases de Xamarin.iOS que se derivan de NSObject expondrán constructores específicos de la funcionalidad del objeto, pero también expondrán varios constructores que no son obvios de inmediato.

Los constructores se usan de la siguiente manera:

public Foo (IntPtr handle)

Este constructor se usa para crear una instancia de la clase cuando el entorno de ejecución necesita asignar la clase a una clase no administrada. Esto sucede cuando se carga un archivo XIB/NIB. En este momento, el entorno de ejecución de Objective-C habrá creado un objeto en el entorno no administrado y se llamará a este constructor para inicializar el lado administrado.

Normalmente, todo lo que necesita hacer es llamar al constructor base con el parámetro del manipulador y, en el cuerpo, realizar cualquier inicialización necesaria.

public Foo ()

Este es el constructor predeterminado para una clase y, en las clases proporcionadas por Xamarin.iOS, inicializa la clase Foundation.NSObject y todas las clases que hay en medio y, al final, la encadena al método init de Objective-C en la clase.

public Foo (NSObjectFlag x)

Este constructor se usa para inicializar la instancia, pero evitar que el código llame al método "init" de Objective-C al final. Normalmente se usa cuando ya se ha registrado para la inicialización (cuando se usa [Export] en el constructor) o cuando ya se ha realizado la inicialización por otro medio.

public Foo (NSCoder coder)

Este constructor se proporciona en aquellos casos en los que el objeto se inicializa desde una instancia de NSCoding.

Excepciones

El diseño de la API de Xamarin.iOS no genera excepciones de Objective-C como excepciones de C#. El diseño exige que no se envíen elementos no utilizados al entorno de Objective-C en primer lugar, y que toda excepción que deba ocurrir se produzca por el propio enlace antes de que se pasen datos no válidos al entorno del mundo de Objective-C.

Notificaciones

Tanto en iOS como en OS X, los desarrolladores pueden suscribirse a las notificaciones que se emiten en la plataforma subyacente. Para ello, se usa el método NSNotificationCenter.DefaultCenter.AddObserver. El método AddObserver toma dos parámetros: uno es la notificación a la que desea suscribirse; el otro es el método que se va a invocar cuando se produzca la notificación.

En Xamarin.iOS y Xamarin.Mac, las claves para las distintas notificaciones se hospedan en la clase que las desencadena. Por ejemplo, las notificaciones generadas por UIMenuController se hospedan como propiedades static NSString en las clases UIMenuController que terminan con el nombre "Notification".

Administración de memoria

Xamarin.iOS tiene un recolector de elementos no utilizados que se encargará de liberar recursos cuando ya no estén en uso. Además del recolector de elementos no utilizados, todos los objetos que derivan de NSObject implementan la interfaz System.IDisposable.

NSObject e IDisposable

Una forma práctica de ayudar a los desarrolladores a liberar objetos que podrían encapsular grandes bloques de memoria (por ejemplo, un elemento UIImage podría parecer simplemente un puntero inocente, pero apuntar a una imagen de 2 megabytes) y otros recursos importantes y finitos (como un búfer de descodificación de vídeo) es exponer la interfaz IDisposable.

NSObject implementa la interfaz IDisposable y también el patrón .NET Dispose. Esto permite a los desarrolladores que aplican la subclase NSObject invalidar el comportamiento de Dispose y liberar sus propios recursos a petición. Por ejemplo, considere este controlador de vistas que se mantiene en torno a un montón de imágenes:

class MenuViewController : UIViewController {
    UIImage breakfast, lunch, dinner;
    [...]
    public override void Dispose (bool disposing)
    {
        if (disposing){
             if (breakfast != null) breakfast.Dispose (); breakfast = null;
             if (lunch != null) lunch.Dispose (); lunch = null;
             if (dinner != null) dinner.Dispose (); dinner = null;
        }
        base.Dispose (disposing)
    }
}

Cuando se elimina un objeto administrado, ya no es útil. Es posible que todavía tenga una referencia a los objetos, pero el objeto es para todas las intenciones y propósitos no válidos en este momento. Para garantizar esto, algunas API de .NET producirán una excepción ObjectDisposedException si intenta acceder a cualquier método en un objeto desechado, por ejemplo:

var image = UIImage.FromFile ("demo.png");
image.Dispose ();
image.XXX = false;  // this at this point is an invalid operation

Incluso si todavía puede acceder a la variable "image", en realidad es una referencia no válida y ya no apunta al objeto de Objective-C que contenía la imagen.

Sin embargo, desechar un objeto en C# no significa que el objeto se destruya necesariamente. Lo único que tiene que hacer es liberar la referencia que C# tenía al objeto. Es posible que el entorno de Cocoa haya mantenido una referencia para su propio uso. Por ejemplo, si establece una propiedad Image de UIImageView en una imagen y, luego, se deshace de la imagen, el elemento UIImageView subyacente habría tomado su propia referencia y mantendrá una referencia a este objeto hasta que termine de usarlo.

Cuándo llamar a Dispose

Llame a Dispose cuando necesite Mono para deshacerse del objeto. Un caso de uso posible es cuando Mono no tiene conocimiento de que NSObject contenga realmente una referencia a un recurso importante, como la memoria, o un grupo de información. En esos casos, debe llamar a Dispose para liberar inmediatamente la referencia a la memoria, en lugar de esperar a que Mono realice un ciclo de recolección de elementos no utilizados.

Internamente, cuando Mono crea referencias de NSString a partir de cadenas de C#, las eliminará inmediatamente para reducir la cantidad de trabajo que el recolector de elementos no utilizados tiene que hacer. Cuantos menos objetos haya con los que tratar, más rápido se ejecutará la recolección de elementos no utilizados.

Cuándo mantener referencias a objetos

Uno de los efectos secundarios que tiene la administración automática de memoria es que la recolección de elementos no utilizados se deshará de los objetos no utilizados mientras no haya referencias a ellos. En ocasiones, esto puede tener efectos secundarios sorprendentes, por ejemplo, si crea una variable local para que contenga el controlador de vista de nivel superior, o la ventana de nivel superior, y después hace que estos se desvanezcan a sus espaldas.

Si no mantiene una referencia en las variables de instancia o estáticas a los objetos, Mono llamará alegremente al método Dispose() que contienen y liberarán dicha referencia. Como esta podría ser la única referencia pendiente, el entorno de ejecución de Objective-C destruirá el objeto.

Campos de enlaces