Skip to content

Most visited

Recently visited

navigation

Lenguaje de definición de la interfaz de Android (AIDL)

El Lenguaje de definición de la interfaz de Android (AIDL) es similar a otros IDL con los que puedes haber trabajado. Te permite definir la interfaz de programación que el cliente y el servicio acuerdan utilizar para establecer comunicación entre procesos (IPC). En Android, generalmente un proceso no puede acceder a la memoria de otro proceso. Por esto, para hablar, tienen que descomponer sus objetos en primitivas que el sistema operativo puede comprender y ordenar los objetos entre esos límites para ti. Es tedioso escribir el código para ese ordenamiento, así que Android lo maneja por ti con AIDL.

Nota: Solo es necesario usar AIDL si permites que los clientes de distintas aplicaciones tengan acceso a tu servicio para IPC y deseas manejar múltiples subprocesos en tu servicio. Si no tienes que establecer una IPC concurrente entre diferentes aplicaciones, debes crear la interfaz implementando un Binder o, si deseas realizar una IPC, pero no necesitas manejar múltiples subprocesos, implementa la interfaz con un Messenger. Sin importar cuál utilices, asegúrate de comprender los servicios enlazados antes de implementar un AIDL.

Antes de comenzar a diseñar tu interfaz de AIDL, ten en cuenta que las llamadas a una interfaz de AIDL son llamadas de funciones directas. No debes realizar suposiciones sobre el subproceso en el que se produce la llamada. Lo que sucede es diferente según si la llamada proviene de un subproceso en el proceso local o un proceso remoto. Específicamente:

Definir una interfaz de AIDL

Debes definir la interfaz de AIDL en un archivo .aidl con sintaxis del lenguaje de programación Java y guardarlo en el código fuente (en el directorio src/) de la aplicación que aloja el servicio y cualquier otra aplicación que cree un enlace con el servicio.

Cuando crees cada aplicación que contiene el archivo .aidl, las herramientas de Android SDK generan una interfaz IBinder basada en el archivo .aidl y la guardan en el directorio gen/ del proyecto. El servicio debe implementar la interfaz IBinder según corresponda. Las aplicaciones cliente pueden enlazarse con el servicio y llamar a los métodos desde la interfaz IBinder para establecer IPC.

Para crear un servicio enlazado con AIDL, sigue estos pasos:

  1. Crear el archivo .aidl

    Este archivo define la interfaz de programación con firmas de métodos.

  2. Implementar la interfaz

    Las herramientas de Android SDK generan una interfaz con el lenguaje de programación Java, según tu archivo .aidl. Esta interfaz tiene una clase abstracta interna denominada Stub que extiende la interfaz Binder e implementa los métodos de la interfaz de AIDL. Debes extender la clase Stub e implementar los métodos.

  3. Exponer la interfaz a los clientes

    Implementa un Service y sobrescribe el onBind() para mostrar tu implementación de la clase Stub.

Advertencia: Los cambios que realices en la interfaz de AIDL después del primer lanzamiento debe tener compatibilidad con versiones anteriores para evitar romper otras aplicaciones que usan tu servicio. Es decir, debido a que tu archivo .aidl se debe copiar a otras aplicaciones para que estas accedan a la interfaz de tu servicio, debes mantener la compatibilidad con la interfaz original.

1. Crear el archivo .aidl

El AIDL usa una sintaxis simple que te permite declarar una interfaz con uno o más métodos que pueden tomar parámetros y devolver valores. Los parámetros y los valores de devolución pueden ser de cualquier tipo, incluso otras interfaces generadas con AIDL.

Debes desarrollar el archivo .aidl con lenguaje de programación Java. Cada archivo .aidl debe definir una única interfaz y solo requiere la declaración de la interfaz y las firmas de los métodos.

De manera predeterminada, el AIDL admite los siguientes tipos de datos:

Debes incluir una instrucción import para cada tipo adicional que no figure en la lista precedente, incluso si estos están definidos en el mismo paquete que tu interfaz.

Cuando definas la interfaz de tu servicio, ten en cuenta lo siguiente:

A continuación, te mostramos un ejemplo de archivo .aidl:

// IRemoteService.aidl
package com.example.android;

// Declare any non-default types here with import statements

/** Example service interface */
interface IRemoteService {
    /** Request the process ID of this service, to do evil things with it. */
    int getPid();

    /** Demonstrates some basic types that you can use as parameters
     * and return values in AIDL.
     */
    void basicTypes(int anInt, long aLong, boolean aBoolean, float aFloat,
            double aDouble, String aString);
}

Guarda tu archivo .aidl en el directorio src/ del proyecto y, cuando crees la aplicación, las herramientas del SDK generarán la interfaz IBinder en el directorio gen/ de tu proyecto. El nombre del archivo generado coincide con el nombre del archivo .aidl, aunque con la extensión .java (por ejemplo, con IRemoteService.aidl, se genera IRemoteService.java).

Si usas Android Studio, la compilación progresiva genera la clase binder casi inmediatamente. Si no usas Android Studio, la herramienta Gradle generará la clase binder la siguiente vez que crees tu aplicación; debes crear tu proyecto con gradle assembleDebug (o gradle assembleRelease) no bien termines de escribir el archivo .aidl, para que el código pueda realizar enlaces con la clase generada.

2. Implementa la interfaz

Cuando crees tu aplicación, las herramientas del Android SDK generarán un archivo de interfaz .java , cuyo nombre se derivará del archivo .aidl. La interfaz generada incluye una subclase denominada Stub que es una implementación abstracta de la interfaz principal (por ejemplo, YourInterface.Stub) y declara todos los métodos del archivo .aidl.

Nota: el Stub también identifica algunos métodos de ayuda, principalmente asInterface(), que toma un IBinder (generalmente, el que se pasó a un método de callback onServiceConnected() del cliente) y devuelve una instancia de la interfaz del código auxiliar. Para obtener más detalles sobre cómo realizar esta conversión, consulta la sección Llamar a un método de IPC.

Para implementar la interfaz generada del .aidl, extiende la interfaz Binder generada (por ejemplo, YourInterface.Stub) e implementa los métodos heredados del archivo .aidl.

A continuación, se muestra un ejemplo de implementación de una interfaz denominada IRemoteService (definida por el ejemplo IRemoteService.aidl anterior) con una instancia anónima:

private final IRemoteService.Stub mBinder = new IRemoteService.Stub() {
    public int getPid(){
        return Process.myPid();
    }
    public void basicTypes(int anInt, long aLong, boolean aBoolean,
        float aFloat, double aDouble, String aString) {
        // Does nothing
    }
};

Ahora, el mBinder es una instancia de la clase Stub (un Binder), que define la interfaz de RCP para el servicio. En el siguiente paso, esta instancia se expone a los clientes para que puedan interactuar con el servicio.

Existen unas pocas reglas que debes conocer cuando implementas tu interfaz de AIDL.

3. Exponer la interfaz a los clientes

Una vez implementada la interfaz para tu servicio, tienes que exponerla a los clientes para que puedan enlazarse con ella. Para exponer la interfaz de tu servicio, extiende el Service e implementa onBind() para mostrar una instancia de la clase que implemente el Stub generado (como en la sección anterior). A continuación, se muestra un ejemplo del servicio que expone la interfaz IRemoteService de ejemplo a los clientes.

public class RemoteService extends Service {
    @Override
    public void onCreate() {
        super.onCreate();
    }

    @Override
    public IBinder onBind(Intent intent) {
        // Return the interface
        return mBinder;
    }

    private final IRemoteService.Stub mBinder = new IRemoteService.Stub() {
        public int getPid(){
            return Process.myPid();
        }
        public void basicTypes(int anInt, long aLong, boolean aBoolean,
            float aFloat, double aDouble, String aString) {
            // Does nothing
        }
    };
}

Cuando un cliente (como una actividad) llama a bindService() para conectarse a este servicio, el callback onServiceConnected() recibe la instancia de mBinder que muestra el método onBind() del servicio.

El cliente también debe tener acceso a la clase de la interfaz. Por lo tanto, si el cliente y el servicio están en aplicaciones separadas, la aplicación del cliente debe tener una copia del archivo .aidl en el directorio src/ (que genera la interfaz ,android.os.Binder lo cual brinda acceso al cliente a los métodos del AIDL).

Cuando el cliente recibe el IBinder en el callback onServiceConnected(), debe llamar a YourServiceInterface.Stub.asInterface(service) para convertir el parámetro mostrado al tipo YourServiceInterface. Por ejemplo:

IRemoteService mIRemoteService;
private ServiceConnection mConnection = new ServiceConnection() {
    // Called when the connection with the service is established
    public void onServiceConnected(ComponentName className, IBinder service) {
        // Following the example above for an AIDL interface,
        // this gets an instance of the IRemoteInterface, which we can use to call on the service
        mIRemoteService = IRemoteService.Stub.asInterface(service);
    }

    // Called when the connection with the service disconnects unexpectedly
    public void onServiceDisconnected(ComponentName className) {
        Log.e(TAG, "Service has unexpectedly disconnected");
        mIRemoteService = null;
    }
};

Para acceder a otros ejemplos de código, consulta la clase RemoteService.java en ApiDemos.

Pasar objetos por IPC

Si deseas enviar una clase de un proceso a otro mediante una interfaz de IPC, puedes hacerlo. Sin embargo, debes asegurarte de que el código de la clase esté disponible para el otro lado del canal de la IPC y tu clase debe admitir la interfaz Parcelable. Admitir la interfaz Parcelable es importante porque le permite al sistema Android descomponer objetos en primitivas que se pueden ordenar entre los procesos.

Para crear una clase que admita el protocolo Parcelable, debes hacer lo siguiente:

  1. Haz que tu clase implemente la interfaz Parcelable.
  2. Implementa writeToParcel, que toma el estado actual del objeto y lo escribe en un Parcel.
  3. Agrega un campo estático denominado CREATOR a la clase, que es un objeto que implementa la interfaz Parcelable.Creator.
  4. Por último, crea un archivo .aidl que declare tu clase parcelable (como se muestra para el archivo Rect.aidl, a continuación).

    Si usas un proceso de creación personalizado, no agregues el archivo .aidl a tu compilación. Casi al igual que en el caso del archivo de encabezado en lenguaje C, este archivo .aidl no se compila.

El AIDL usa estos métodos y campos en el código que genera para ordenar tus objetos y anular el orden.

Por ejemplo, este es un archivo Rect.aidl para crear una clase Rect que se pueda convertir en parcelable:

package android.graphics;

// Declare Rect so AIDL can find it and knows that it implements
// the parcelable protocol.
parcelable Rect;

Este es un ejemplo de cómo la clase Rect implementa el protocolo Parcelable.

import android.os.Parcel;
import android.os.Parcelable;

public final class Rect implements Parcelable {
    public int left;
    public int top;
    public int right;
    public int bottom;

    public static final Parcelable.Creator<Rect> CREATOR = new
Parcelable.Creator<Rect>() {
        public Rect createFromParcel(Parcel in) {
            return new Rect(in);
        }

        public Rect[] newArray(int size) {
            return new Rect[size];
        }
    };

    public Rect() {
    }

    private Rect(Parcel in) {
        readFromParcel(in);
    }

    public void writeToParcel(Parcel out) {
        out.writeInt(left);
        out.writeInt(top);
        out.writeInt(right);
        out.writeInt(bottom);
    }

    public void readFromParcel(Parcel in) {
        left = in.readInt();
        top = in.readInt();
        right = in.readInt();
        bottom = in.readInt();
    }
}

El ordenamiento en la clase Rect es bastante simple. Observa los otros métodos en el Parcel para ver los otros tipos de valores que puedes escribir en un Parcel.

Advertencia: No olvides las implicancias de seguridad relacionadas con la recepción de datos de otros procesos. En este caso, Rect lee cuatro números del Parcel, pero depende de ti asegurarte de que estén dentro del intervalo aceptable de valores para lo que el emisor intente hacer. Para obtener más información sobre cómo mantener tu aplicación segura contra software malicioso, consulta Seguridad y permisos.

Llamar a un método de IPC

Estos son los pasos que una clase que realiza una llamada debe realizar para llamar a una interfaz remota definida con el AIDL.

  1. Incluir el archivo .aidl en el directorio src/ del proyecto.
  2. Declarar una instancia de la interfaz IBinder (generada con base en el AIDL).
  3. Implementa ServiceConnection.
  4. Llama a Context.bindService() pasando tu implementación de ServiceConnection.
  5. En tu implementación de onServiceConnected(), recibirás una instancia del IBinder (denominada service). Llamar a YourInterfaceName.Stub.asInterface((IBinder)service) para convertir el parámetro devuelto en un tipo YourInterface.
  6. Llamar a los métodos que definiste en la interfaz. Siempre debes capturar las excepciones DeadObjectException, que se producen cuando se pierde la conexión.; esta será la única excepción que producirán los métodos remotos.
  7. Para la desconexión, llama a Context.unbindService() con la instancia de tu interfaz.

Algunos comentarios sobre llamar a un servicio de IPC:

Para obtener más información sobre enlaces a un servicio, consulta el documento Servicios enlazados.

Aquí se muestra un código de ejemplo que demuestra la llamada a un servicio creado con el AIDL, tomado del ejemplo del servicio remoto en el proyecto ApiDemos.

public static class Binding extends Activity {
    /** The primary interface we will be calling on the service. */
    IRemoteService mService = null;
    /** Another interface we use on the service. */
    ISecondary mSecondaryService = null;

    Button mKillButton;
    TextView mCallbackText;

    private boolean mIsBound;

    /**
     * Standard initialization of this activity.  Set up the UI, then wait
     * for the user to poke it before doing anything.
     */
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        setContentView(R.layout.remote_service_binding);

        // Watch for button clicks.
        Button button = (Button)findViewById(R.id.bind);
        button.setOnClickListener(mBindListener);
        button = (Button)findViewById(R.id.unbind);
        button.setOnClickListener(mUnbindListener);
        mKillButton = (Button)findViewById(R.id.kill);
        mKillButton.setOnClickListener(mKillListener);
        mKillButton.setEnabled(false);

        mCallbackText = (TextView)findViewById(R.id.callback);
        mCallbackText.setText("Not attached.");
    }

    /**
     * Class for interacting with the main interface of the service.
     */
    private ServiceConnection mConnection = new ServiceConnection() {
        public void onServiceConnected(ComponentName className,
                IBinder service) {
            // This is called when the connection with the service has been
            // established, giving us the service object we can use to
            // interact with the service.  We are communicating with our
            // service through an IDL interface, so get a client-side
            // representation of that from the raw service object.
            mService = IRemoteService.Stub.asInterface(service);
            mKillButton.setEnabled(true);
            mCallbackText.setText("Attached.");

            // We want to monitor the service for as long as we are
            // connected to it.
            try {
                mService.registerCallback(mCallback);
            } catch (RemoteException e) {
                // In this case the service has crashed before we could even
                // do anything with it; we can count on soon being
                // disconnected (and then reconnected if it can be restarted)
                // so there is no need to do anything here.
            }

            // As part of the sample, tell the user what happened.
            Toast.makeText(Binding.this, R.string.remote_service_connected,
                    Toast.LENGTH_SHORT).show();
        }

        public void onServiceDisconnected(ComponentName className) {
            // This is called when the connection with the service has been
            // unexpectedly disconnected -- that is, its process crashed.
            mService = null;
            mKillButton.setEnabled(false);
            mCallbackText.setText("Disconnected.");

            // As part of the sample, tell the user what happened.
            Toast.makeText(Binding.this, R.string.remote_service_disconnected,
                    Toast.LENGTH_SHORT).show();
        }
    };

    /**
     * Class for interacting with the secondary interface of the service.
     */
    private ServiceConnection mSecondaryConnection = new ServiceConnection() {
        public void onServiceConnected(ComponentName className,
                IBinder service) {
            // Connecting to a secondary interface is the same as any
            // other interface.
            mSecondaryService = ISecondary.Stub.asInterface(service);
            mKillButton.setEnabled(true);
        }

        public void onServiceDisconnected(ComponentName className) {
            mSecondaryService = null;
            mKillButton.setEnabled(false);
        }
    };

    private OnClickListener mBindListener = new OnClickListener() {
        public void onClick(View v) {
            // Establish a couple connections with the service, binding
            // by interface names.  This allows other applications to be
            // installed that replace the remote service by implementing
            // the same interface.
            Intent intent = new Intent(Binding.this, RemoteService.class);
            intent.setAction(IRemoteService.class.getName());
            bindService(intent, mConnection, Context.BIND_AUTO_CREATE);
            intent.setAction(ISecondary.class.getName());
            bindService(intent, mSecondaryConnection, Context.BIND_AUTO_CREATE);
            mIsBound = true;
            mCallbackText.setText("Binding.");
        }
    };

    private OnClickListener mUnbindListener = new OnClickListener() {
        public void onClick(View v) {
            if (mIsBound) {
                // If we have received the service, and hence registered with
                // it, then now is the time to unregister.
                if (mService != null) {
                    try {
                        mService.unregisterCallback(mCallback);
                    } catch (RemoteException e) {
                        // There is nothing special we need to do if the service
                        // has crashed.
                    }
                }

                // Detach our existing connection.
                unbindService(mConnection);
                unbindService(mSecondaryConnection);
                mKillButton.setEnabled(false);
                mIsBound = false;
                mCallbackText.setText("Unbinding.");
            }
        }
    };

    private OnClickListener mKillListener = new OnClickListener() {
        public void onClick(View v) {
            // To kill the process hosting our service, we need to know its
            // PID.  Conveniently our service has a call that will return
            // to us that information.
            if (mSecondaryService != null) {
                try {
                    int pid = mSecondaryService.getPid();
                    // Note that, though this API allows us to request to
                    // kill any process based on its PID, the kernel will
                    // still impose standard restrictions on which PIDs you
                    // are actually able to kill.  Typically this means only
                    // the process running your application and any additional
                    // processes created by that app as shown here; packages
                    // sharing a common UID will also be able to kill each
                    // other's processes.
                    Process.killProcess(pid);
                    mCallbackText.setText("Killed service process.");
                } catch (RemoteException ex) {
                    // Recover gracefully from the process hosting the
                    // server dying.
                    // Just for purposes of the sample, put up a notification.
                    Toast.makeText(Binding.this,
                            R.string.remote_call_failed,
                            Toast.LENGTH_SHORT).show();
                }
            }
        }
    };

    // ----------------------------------------------------------------------
    // Code showing how to deal with callbacks.
    // ----------------------------------------------------------------------

    /**
     * This implementation is used to receive callbacks from the remote
     * service.
     */
    private IRemoteServiceCallback mCallback = new IRemoteServiceCallback.Stub() {
        /**
         * This is called by the remote service regularly to tell us about
         * new values.  Note that IPC calls are dispatched through a thread
         * pool running in each process, so the code executing here will
         * NOT be running in our main thread like most other things -- so,
         * to update the UI, we need to use a Handler to hop over there.
         */
        public void valueChanged(int value) {
            mHandler.sendMessage(mHandler.obtainMessage(BUMP_MSG, value, 0));
        }
    };

    private static final int BUMP_MSG = 1;

    private Handler mHandler = new Handler() {
        @Override public void handleMessage(Message msg) {
            switch (msg.what) {
                case BUMP_MSG:
                    mCallbackText.setText("Received from service: " + msg.arg1);
                    break;
                default:
                    super.handleMessage(msg);
            }
        }

    };
}

This site uses cookies to store your preferences for site-specific language and display options.

Hooray!

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a one-minute survey?
Help us improve Android tools and documentation.