導入設定檔結構定義 API

Android 平台包含許多用於儲存設定的 XML 檔案 資料 (例如音訊設定)。許多 XML 檔案都位於 vendor 不過是在 system 分區中讀取。在這個例子中 XML 檔案的介面代表兩個分區的介面,因此 必須明確指定結構定義,且發展須回溯相容 。

在 Android 10 之前,平台不提供 要求指定及使用 XML 架構,或 結構定義中不相容的變更Android 10 提供 這項機制稱為 Config File Schema API這個機制是由工具 名為 xsdc 的建構規則,以及名為 xsd_config 的建構規則。

xsdc 工具是 XML 架構文件 (XSD) 編譯器。剖析 XSD 檔案 說明 XML 檔案的結構,並產生 Java 和 C++ 程式碼。 而產生的程式碼會將符合 XSD 架構的 XML 檔案剖析為 物件,而每個物件都會建立 XML 標記的模型。XML 屬性會模擬為物件的欄位。

xsd_config 建構規則會將 xsdc 工具整合至建構系統。對於特定的 XSD 輸入檔案,建構規則會產生 Java 和 C++ 程式庫。個人中心 可以將程式庫連結至 XML 檔案符合 會讀取及使用 XSD。您可以針對自己的自有 XML 檔案使用建構規則 跨 systemvendor 分區。

建構設定檔案架構 API

本節說明如何建構設定檔 Schema API。

在 Android.bp 中設定 xsd_config 建構規則

xsd_config 建構規則使用 xsdc 工具產生剖析器程式碼。xsd_config 建構規則的 package_name 屬性會決定產生 Java 程式碼的套件名稱。

Android.bp 中的 xsd_config 建構規則範例:

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

目錄結構範例:

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

建構系統會使用產生的 Java 程式碼和檢查工具,產生 API 清單 與 API 相關這項 API 檢查已新增至 DroidCore,並在 m -j 執行。

建立 API 清單檔案

API 檢查需要來源程式碼中的 API 清單檔案。

API 清單檔案包括:

  • current.txtremoved.txt 會在建構期間與產生的 API 檔案進行比較,檢查 API 是否有變更。
  • last_current.txtlast_removed.txt 會比較 API 檔案,檢查 API 是否具有向後相容性。

如要建立 API 清單檔案,請按照下列指示操作:

  1. 建立空白清單檔案。
  2. 執行 make update-api 指令。

使用產生的剖析器程式碼

如要使用產生的 Java 程式碼,請在 Java srcs 屬性中的 xsd_config 模組名稱前方加上 :。產生的 Java 程式碼套件是 與 package_name 屬性相同。

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

如要使用產生的 C++ 程式碼,請將 xsd_config 模組名稱新增至 generated_sourcesgenerated_headers 屬性。並將 libxml2 新增至 static_libsshared_libs,因為產生的剖析器程式碼需要 libxml2。產生的 C++ 程式碼命名空間與 package_name 屬性相同。舉例來說,如果 xsd_config 模組名稱為 hal.manifest,則命名空間為 hal::manifest

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

使用剖析器

如要使用 Java 剖析器程式碼,請使用 XmlParser#read 或 用於傳回根類別類別的 read{class-name} 方法 元素。系統會在此時進行剖析。

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();
            …
        }
    }
    …
}

如要使用 C++ 剖析器程式碼,請先加入標頭檔案。標頭檔案的名稱是套件名稱,其中句點 (.) 已轉換為底線 (_)。然後使用 readread{class-name} 方法傳回 根元素的類別系統會在此時進行剖析。傳回值為 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();
        …
    }
    …
}

所有用於使用剖析器的 API 都位於 api/current.txt 中。適用對象 統一,所有元素和屬性名稱都會轉換為駝峰式大小寫 (適用於 例如 ElementName),並做為對應的變數、方法和 類別名稱。您可以使用 read{class-name} 函式取得剖析的根元素類別。如果只有一個根元素,函式名稱就是 read。您可以使用 get{variable-name} 函式取得剖析的子元素或屬性的值。

產生剖析器程式碼

在多數情況下,您不需要直接執行 xsdc。使用 xsd_config 版本 設定新的規則 在 Android.bp 中設定 xsd_config 建構規則。這個 本節說明 xsdc 指令列介面,這只是為了取得完整資訊而已。這可能對偵錯作業有所幫助。

您必須為 xsdc 工具提供 XSD 檔案的路徑和套件。 package 是 Java 程式碼中的套件名稱,也是 C++ 程式碼中的命名空間。選項 判斷產生的程式碼是 -j 還是 -c-o 選項是輸出目錄的路徑。

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

指令範例:

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