Implementación de la API de esquema de archivos de configuración

La plataforma Android contiene muchos archivos XML para almacenar datos de configuración (por ejemplo, configuración de audio). Muchos de los archivos XML están en la partición vendor , pero se leen en la partición system . En este caso, el esquema del archivo XML sirve como interfaz entre las dos particiones y, por lo tanto, el esquema debe especificarse explícitamente y debe evolucionar de manera compatible con versiones anteriores.

Antes de Android 10, la plataforma no proporcionaba mecanismos para exigir la especificación y el uso del esquema XML, ni para evitar cambios incompatibles en el esquema. Android 10 proporciona este mecanismo, llamado API de esquema de archivo de configuración. Este mecanismo consta de una herramienta llamada xsdc y una regla de compilación llamada xsd_config .

La herramienta xsdc es un compilador de documentos de esquema XML (XSD). Analiza un archivo XSD que describe el esquema de un archivo XML y genera código Java y C++. El código generado analiza archivos XML que se ajustan al esquema XSD en un árbol de objetos, cada uno de los cuales modela una etiqueta XML. Los atributos XML se modelan como campos de los objetos.

La regla de compilación xsd_config integra la herramienta xsdc en el sistema de compilación. Para un archivo de entrada XSD determinado, la regla de compilación genera bibliotecas Java y C++. Puede vincular las bibliotecas a los módulos donde se leen y utilizan los archivos XML que se ajustan al XSD. Puede utilizar la regla de compilación para sus propios archivos XML utilizados en el system y en las particiones vendor .

Creación de API de esquema de archivo de configuración

Esta sección describe cómo crear la API de esquema de archivos de configuración.

Configurar la regla de compilación xsd_config en Android.bp

La regla de compilación xsd_config genera el código del analizador con la herramienta xsdc . La propiedad package_name de la regla de compilación xsd_config determina el nombre del paquete del código Java generado.

Ejemplo de regla de compilación xsd_config en Android.bp :

xsd_config {
    name: "hal_manifest",
    srcs: ["hal_manifest.xsd"],
    package_name: "hal.manifest",
}

Ejemplo de estructura de directorio:

├── Android.bp
├── api
│   ├── current.txt
│   ├── last_current.txt
│   ├── last_removed.txt
│   └── removed.txt
└── hal_manifest.xsd

El sistema de compilación genera una lista de API utilizando el código Java generado y compara la API con él. Esta verificación de API se agrega a DroidCore y se ejecuta en m -j .

Crear archivos de listas API

Las comprobaciones de API requieren que la API enumere los archivos en el código fuente.

Los archivos de listas de API incluyen:

  • current.txt y removed.txt verifican si las API se cambian comparándolas con los archivos API generados en el momento de la compilación.
  • last_current.txt y last_removed.txt comprueban si las API son compatibles con versiones anteriores comparándolas con los archivos API.

Para crear los archivos de listas API:

  1. Crea archivos de listas vacías.
  2. Ejecute el comando make update-api .

Usando el código del analizador generado

Para utilizar el código Java generado, agregue : como prefijo al nombre del módulo xsd_config en la propiedad srcs de Java. El paquete del código Java generado es el mismo que la propiedad package_name .

java_library {
    name: "vintf_test_java",
    srcs: [
        "srcs/**/*.java"
        ":hal_manifest"
    ],
}

Para utilizar el código C++ generado, agregue el nombre del módulo xsd_config a las propiedades generated_sources y generated_headers . Y agregue libxml2 a static_libs shared_libs , ya que se requiere libxml2 en el código del analizador generado. El espacio de nombres del código C++ generado es el mismo que el de la propiedad package_name . Por ejemplo, si el nombre del módulo xsd_config es hal.manifest , el espacio de nombres es hal::manifest .

cc_library{
    name: "vintf_test_cpp",
    srcs: ["main.cpp"],
    generated_sources: ["hal_manifest"],
    generated_headers: ["hal_manifest"],
    shared_libs: ["libxml2"],
}

Usando el analizador

Para utilizar el código del analizador Java, utilice el método XmlParser#read o read{ class-name } para devolver la clase del elemento raíz. El análisis ocurre en este momento.

import hal.manifest.*;

…

class HalInfo {
    public String name;
    public String format;
    public String optional;
    …
}

void readHalManifestFromXml(File file) {
    …
    try (InputStream str = new BufferedInputStream(new FileInputStream(file))) {
        Manifest manifest = XmlParser.read(str);
        for (Hal hal : manifest.getHal()) {
            HalInfo halinfo;
            HalInfo.name = hal.getName();
            HalInfo.format = hal.getFormat();
            HalInfo.optional = hal.getOptional();
            …
        }
    }
    …
}

Para utilizar el código del analizador C++, primero incluya el archivo de encabezado. El nombre del archivo de encabezado es el nombre del paquete con puntos (.) convertidos en guiones bajos (_). Luego use el método read o read{ class-name } para devolver la clase del elemento raíz. El análisis ocurre en este momento. El valor de retorno es std::optional<> .

include "hal_manifest.h"

…
using namespace hal::manifest

struct HalInfo {
    public std::string name;
    public std::string format;
    public std::string optional;
    …
};

void readHalManifestFromXml(std::string file_name) {
    …
    Manifest manifest = *read(file_name.c_str());
    for (Hal hal : manifest.getHal()) {
        struct HalInfo halinfo;
        HalInfo.name = hal.getName();
        HalInfo.format = hal.getFormat();
        HalInfo.optional = hal.getOptional();
        …
    }
    …
}

Todas las API proporcionadas para utilizar el analizador se encuentran en api/current.txt . Para lograr uniformidad, todos los nombres de elementos y atributos se convierten a mayúsculas y minúsculas (por ejemplo, ElementName ) y se utilizan como la variable, método y nombre de clase correspondiente. La clase del elemento raíz analizado se puede obtener utilizando la función read{ class-name } . Si solo hay un elemento raíz, entonces se read el nombre de la función. El valor de un subelemento o atributo analizado se puede obtener utilizando la función get{ variable-name } .

Generando código de analizador

En la mayoría de los casos, no es necesario ejecutar xsdc directamente. Utilice la regla de compilación xsd_config en su lugar, como se describe en Configuración de la regla de compilación xsd_config en Android.bp . Esta sección explica la interfaz de línea de comandos xsdc , solo para que esté completa. Esto podría resultar útil para la depuración.

Debe proporcionar a la herramienta xsdc la ruta al archivo XSD y un paquete. El paquete es un nombre de paquete en código Java y un espacio de nombres en código C++. Las opciones para determinar si el código generado es Java o C son -j o -c , respectivamente. La opción -o es la ruta del directorio de salida.

usage: xsdc path/to/xsd_file.xsd [-c] [-j] [-o <arg>] [-p]
 -c,--cpp           Generate C++ code.
 -j,--java          Generate Java code.
 -o,--outDir <arg>  Out Directory
 -p,--package       Package name of the generated java file. file name of
                    generated C++ file and header

Comando de ejemplo:

$ xsdc audio_policy_configuration.xsd -p audio.policy -j