язык AIDL

Язык AIDL в некоторой степени основан на языке Java. Файлы определяют контракт интерфейса и различные типы данных и константы, используемые в этом контракте.

Упаковка

Каждый файл AIDL начинается с необязательного пакета, соответствующего именам пакетов в различных бэкендах. Декларация пакета выглядит следующим образом:

    package my.package;

Подобно Java, файлы AIDL должны находиться в структуре папок, соответствующей их пакету. Файлы с пакетом my.package должны находиться в папке my/package/ .

Типы

В файлах AIDL есть много мест, где можно указать типы. Точный список типов, поддерживаемых в языке AIDL, см. в разделе Типы бэкендов AIDL .

Аннотации

Несколько частей языка AIDL поддерживают аннотации. Список аннотаций и где их можно применять, см. в разделе Аннотации AIDL .

Импорт

Чтобы использовать типы, определенные в других интерфейсах, необходимо сначала добавить зависимости в систему сборки. В модулях cc_* и java_* Soong, где файлы .aidl используются непосредственно под srcs в сборках платформы Android, можно добавлять каталоги с помощью поля aidl: { include_dirs: ... } . Для импорта с использованием aidl_interface см. здесь .

Импорт выглядит так:

    import some.package.Foo;  // explicit import

При импорте типа в том же пакете пакет может быть опущен. Однако, пропуск пакета может привести к неоднозначным ошибкам импорта, когда типы указаны без пакета и помещены в глобальное пространство имен (обычно все типы должны быть в пространстве имен):

    import Foo;  // same as my.package.Foo

Определить типы

Файлы AIDL обычно определяют типы, которые используются в качестве интерфейса.

Интерфейсы

Вот пример интерфейса AIDL:

    interface ITeleport {
        // Location defined elsewhere
        void teleport(Location baz, float speed);
        String getName();

        // ITeleportCallback defined elsewhere
        void methodWithCallback(ITeleportCallback callback);

        // ITeleportSession defined elsewhere
        ITeleportSession getASubInterface();
    }

Интерфейс определяет объект с серией методов. Методы могут быть oneway ( oneway void doFoo() ) или синхронными. Если интерфейс определен как oneway ( oneway interface ITeleport {...} ), то все методы в нем неявно oneway . Односторонние методы отправляются асинхронно и не могут возвращать результат. Односторонние методы из одного потока в один и тот же связующий также выполняются последовательно (хотя потенциально в разных потоках). Для обсуждения того, как настроить потоки, см. AIDL backends thread management .

Binder позволяет многим интерфейсам и объектам-связкам совместно использоваться через интерфейсы-связки. Интерфейсы AIDL часто используют обратные вызовы как часть вызовов методов, например, с помощью ITeleportCallback в предыдущем примере. Вы можете повторно использовать объекты обратного вызова между вызовами одного и того же метода или вызовами разных методов. Другое распространенное использование типов интерфейсов — возврат подинтерфейсов или объектов сеанса из методов, например, с помощью ITeleportSession в предыдущем примере. Такое вложение позволяет инкапсулировать различные API либо в API, либо на основе состояния времени выполнения. Например, сеанс может представлять владение определенным ресурсом. Когда интерфейсы передаются несколько раз или возвращаются клиенту или серверу, с которого они пришли, они всегда сохраняют равенство указателей базового объекта-связку.

Методы могут иметь ноль или более аргументов. Аргументы методов могут быть in , out или inout . Для обсуждения того, как это влияет на типы аргументов, см. AIDL backends directionality .

Посылки

Описание того, как создавать специфичные для бэкенда parcelables, см. в разделе Пользовательские parcelables бэкендов AIDL .

Android 10 и выше поддерживают определения parcelable непосредственно в AIDL. Этот тип parcelable называется структурированным parcelable. Для получения дополнительной информации о том, как структурированный и стабильный AIDL связаны в компиляторе AIDL и нашей системе сборки, см. раздел Структурированный и стабильный AIDL .

Например:

    package my.package;

    import my.package.Boo;

    parcelable Baz {
        @utf8InCpp String name = "baz";
        Boo boo;
    }

Профсоюзы

Android 12 и выше поддерживают помеченные декларации союза. Например:

    package my.package;

    import my.package.FooSettings;
    import my.package.BarSettings;

    union Settings {
        FooSettings fooSettings;
        BarSettings barSettings;
        @utf8InCpp String str;
        int number;
    }

Подробную информацию о бэкендах см. в разделе AIDL Backends Unions .

Перечисления

Android 11 и выше поддерживают объявления enum. Например:

    package my.package;

    enum Boo {
        A = 1 * 4,
        B = 3,
    }

Вложенные объявления типов

Android 13 и выше поддерживают вложенные объявления типов. Например:

    package my.package;

    import my.package.Baz;

    interface IFoo {
        void doFoo(Baz.Nested nested);  // defined in my/package/Baz.aidl
        void doBar(Bar bar);            // defined below

        parcelable Bar { ... }          // nested type definition
    }

Константы

Пользовательские интерфейсы AIDL, парцелляты и объединения также могут содержать целочисленные и строковые константы, например:

    const @utf8InCpp String HAPPY = ":)";
    const String SAD = ":(";
    const byte BYTE_ME = 1;
    const int ANSWER = 6 * 7;

Постоянные выражения

Константы AIDL, размеры массивов и перечислители можно указывать с помощью константных выражений. Выражения могут использовать скобки для вложения операций. Значения константных выражений можно использовать с целыми или плавающими значениями.

Литералы true и false представляют логические значения. Значения с . но без суффикса, например, 3.8 , считаются значениями double. Значения с плавающей точкой имеют суффикс f , например, 2.4f . Целочисленное значение с суффиксом l или L указывает на 64-битное длинное значение. В противном случае целочисленные значения получают наименьший сохраняющий значение знаковый тип между 8-битным (byte), 32-битным (int) и 64-битным (long). Таким образом, 256 считается int , но 255 + 1 переполняется, становясь byte 0 . Шестнадцатеричные значения, например, 0x3 , сначала интерпретируются как наименьший сохраняющий значение беззнаковый тип между 32-битным и 64-битным, а затем повторно интерпретируются как беззнаковые значения. Таким образом, 0xffffffff имеет значение int -1 . Начиная с Android 13, суффикс u8 может быть добавлен к константам, таким как 3u8 , для представления значения byte . Этот суффикс важен, так как вычисление, такое как 0xffu8 * 3 , интерпретируется как -3 с типом byte , тогда как 0xff * 3 — это 765 с типом int .

Поддерживаемые операторы имеют семантику C++ и Java. В порядке от низшего к высшему приоритету бинарные операторы: || && | ^ & == != < > <= >= << >> + - * / % . Унарные операторы: + - ! ~ .