Aconfig-Flag deklarieren

Sie können aconfig-Flags in Java-, C-, C++- und Rust-Code verwenden. Das AOSP-Buildsystem startet ein Tool namens aconfig, mit dem eine sprachspezifische Bibliothek mit Methoden generiert wird, mit denen Sie auf den Wert jeder Flag zugreifen können. Bevor Sie die Bibliothek generieren können, müssen Sie Flags deklarieren und dem Build hinzufügen.

Flag „aconfig“ für Java deklarieren

So deklarieren Sie ein aconfig-Flag für Java:

  1. Erstellen Sie in einem Verzeichnis, in dem sich der neue Code befindet, eine Datei mit der Erweiterung .aconfig, z. B. my_new_aconfig_flag_declarations.aconfig. Eine aconfig-Datei ist eine .proto-Textdatei, die einem Standardschema folgt.

  2. Fügen Sie eine Flag-Deklaration wie die folgende hinzu:

    package: "com.example.android.aconfig.demo.flags"
container: "system"

flag {
    name: "my_new_flag"
    namespace: "aconfig_demo_namespace"
    description: "This flag controls untested code"
    bug: "<none>"
}

    Dabei gilt:

    • In Kombination mit dem Flag-Namen liefert package einen eindeutigen Schlüssel. In Java führt das Festlegen von package auf foo.bar zu einer automatisch generierten Klasse namens foo.bar.Flags. In C++ würden Methoden zum Lesen von Flags foo::bar::"flagname" heißen. Flags in derselben Deklaration zum selben Paket gehören, mehrere Deklarationsdateien Flags zum selben Paket beisteuern.

    • container definiert eine Codesammlung, die zusammen erstellt und versendet wird als Binärcode. Gültige Container sind system, vendor, system_ext, product, name.of.apex und name.of.apk.

    • name enthält den Namen des Flags, der nur Kleinbuchstaben enthält. Unterstriche und Zahlen verwendet werden.

    • namespace enthält den Namespace für Beiträge. Sie müssen mit den zugewiesenen Google-Prüfer, um Ihren Namespace zu bestimmen. Wenn Sie um die Stabilität Ihres eigenen AOSP-Spiegels aufrechtzuerhalten, können Sie Sie können Namespace beliebig verwenden.

    • description enthält eine kurze Beschreibung der Funktion oder Änderung, die gekennzeichnet.

    • bug ist die Fehlernummer, die mit dem neuen Codebeitrag verknüpft ist. Du musst Besprich deine bug gemeinsam mit dem zuständigen Google-Prüfer. Wenn Sie zur Aufrechterhaltung der Stabilität Ihres eigenen AOSP-Spiegels, können Sie Ihre Fehler-Tracking-Nummer oder <none> nutzen.

  3. Speichern Sie die Datei und beenden Sie den Editor.

Build einrichten

Nachdem Sie Ihr Flag deklariert haben, richten Sie den Build so ein, dass er den Parameter Bibliothekscode, der für den Zugriff auf den Wert des Flags verwendet wird.

  1. Fügen Sie in der Build-Datei Android.bp einen Abschnitt aconfig_declarations hinzu. etwa so:

    aconfig_declarations {
  name: "aconfig_demo_flags",
  package: "com.example.android.aconfig.demo.flags",
  srcs: [
    "my_new_aconfig_flag_declarations.aconfig"
  ],
}

    Dabei gilt:

    • name enthält den Namen der Deklaration, der nur Kleinbuchstaben, Unterstriche und Ziffern enthalten.
    • package enthält denselben Paketnamen wie in der Deklaration.
    • srcs enthält den Namen der .aconfig-Datei, in der das Flag deklariert ist.

  2. Speichern Sie die Datei und beenden Sie den Editor.

Deklarieren Sie das Flag „aconfig“ für C und C++

So deklarieren Sie ein aconfig-Flag für C und C++:

  1. Erstellen Sie in einem Verzeichnis, in dem sich der neue Code befindet, eine Datei mit der Erweiterung .aconfig, z. B. my_new_aconfig_flag_declarations.aconfig. Eine aconfig-Datei ist eine .proto-Textdatei, die einem Standardschema folgt.

  2. Fügen Sie eine Flag-Deklaration wie die folgende hinzu:

    package: "com.example.android.aconfig.demo.flags"
container: "system"

flag {
    name: "my_new_flag"
    namespace: "aconfig_demo_namespace"
    description: "This flag controls untested code"
    bug: "<none>"
}

    Dabei gilt:

    • In Kombination mit dem Flag-Namen liefert package einen eindeutigen Schlüssel. In Java führt das Festlegen von package auf foo.bar zu einer automatisch generierten Klasse namens foo.bar.Flags. In C++ würden Methoden zum Lesen von Flags foo::bar::"flagname" heißen. Flags in derselben Deklaration zum selben Paket gehören, mehrere Deklarationsdateien Flags zum selben Paket beisteuern.

    • container definiert eine Codesammlung, die zusammen erstellt und versendet wird als Binärcode. Gültige Container sind system, vendor, system_ext, product, name.of.apex und name.of.apk.

    • name enthält den Namen des Flags, der nur Kleinbuchstaben enthält. Unterstriche und Zahlen verwendet werden.

    • namespace enthält den Namespace für Beiträge. Sie müssen mit den zugewiesenen Google-Prüfer, um Ihren Namespace zu bestimmen. Wenn Sie um die Stabilität Ihres eigenen AOSP-Spiegels aufrechtzuerhalten, können Sie Sie können Namespace beliebig verwenden.

    • description enthält eine kurze Beschreibung der Funktion oder Änderung, die gekennzeichnet.

    • bug ist die Fehlernummer, die mit dem neuen Codebeitrag verknüpft ist. Du musst Besprich deine bug gemeinsam mit dem zuständigen Google-Prüfer. Wenn Sie zur Aufrechterhaltung der Stabilität Ihres eigenen AOSP-Spiegels, können Sie Ihre Fehler-Tracking-Nummer oder <none> nutzen.

  3. Speichern Sie die Datei und beenden Sie den Editor.

Build einrichten

Nachdem Sie Ihr Flag deklariert haben, richten Sie den Build so ein, dass er den Parameter Bibliothekscode, der für den Zugriff auf den Wert des Flags verwendet wird.

  1. Fügen Sie in Ihrer Android.bp-Builddatei einen Abschnitt aconfig_declarations hinzu, der in etwa so aussieht:

    aconfig_declarations {
  name: "aconfig_demo_flags",
  package: "com.example.android.aconfig.demo.flags",
  srcs: [
    "my_new_aconfig_flag_declarations.aconfig"
  ],
}

    Dabei gilt:

    • name enthält den Namen der Deklaration, der nur Kleinbuchstaben, Unterstriche und Ziffern enthalten.
    • package enthält den in der Deklaration verwendeten Paketnamen.
    • srcs enthält den Namen der aconfig-Datei, in der das Flag deklariert ist.

  2. Erstellen Sie in derselben Datei ein cc_aconfig_library-Ziel ähnlich dem Folgendes:

    cc_aconfig_library {
    name: "aconfig_demo_flags_c_lib",
    aconfig_declarations: "aconfig_demo_flags",
}

    Dabei gilt:

    • name enthält den Namen der Bibliothek, die nur Kleinbuchstaben, Unterstriche und Ziffern enthalten.
    • aconfig_declarations enthält denselben name wie in der Erklärung.

    Das Build-Ziel cc_aconfig_library ruft C- oder C++-Codegen auf, wodurch zum Zeitpunkt des Builds eine Bibliothek mit dem generierten Code erstellt wird.

    Die CC-Bibliothek „aconfig“ ähnelt dem Ziel einer CC-Bibliothek, Optionen wie vendor_available, product_available, host_supported und vndk. Wenn das von diesem cc_aconfig_library abhängige Build-Ziel erfordert, müssen Sie möglicherweise auch die entsprechende Einstellung im Ziel der CC-Bibliothek „aconfig“ ein. Wenn beispielsweise für das übergeordnete Build-Ziel vendor_available auf true festgelegt ist, sollten Sie vendor_available auch in diesem cc_aconfig_library-Ziel auf true festlegen.

    Nachdem Sie dieses Build-Ziel hinzugefügt haben, kann Ihr Code auf diese Bibliothek zugreifen. Sie können diese Bibliothek mit der Syntax static_lib oder shared_lib einbinden. Hinweis: Wenn Sie diese Bibliothek als static_lib hinzufügen möchten, Fügen Sie eine shared_lib-Abhängigkeit für server_configurable_flags hinzu. In Schritt 3 wird gezeigt, wie die mit dem Code generierte Flaggenbibliothek in libexample_cpp_lib eingefügt wird.

  3. Erstellen Sie ein Ziel, das die aconfig-Flags verwendet, wie im folgenden Beispiel: cc_library:

    cc_library {
    name: "libexample_cpp_lib",
    srcs: ["src/example_cpp_lib.cc"],
    double_loadable: true,
    cflags: [
        "-Wall",
        "-Werror",
        "-Wno-unused-function",
        "-Wno-unused-parameter",
    ],
    header_libs: [
        "jni_headers",
    ],
    shared_libs: [
        "server_configurable_flags",
    ],
    static_libs: [
        "aconfig_demo_flags_c_lib",
    ],
    export_include_dirs: ["src/include"],
}

    Dabei gilt:

    • shared_libs enthält zusätzliche Abhängigkeiten, die für aconfig-Flags erforderlich sind.
    • static_libs ist der Name der Bibliothek, die vom Build gemäß dem Feld cc_aconfig_library name in Schritt 2 erstellt wird. Durch Erstellen eines cc_library-Eintrags mit dem Namen der statischen Bibliothek verwenden, können Sie nun die aconfig-Flags in Ihrem Code verwenden.

Flag „aconfig“ für Rust deklarieren

So deklarieren Sie ein aconfig-Flag für Rust:

  1. Erstellen Sie in einem Verzeichnis, in dem sich der neue Code befindet, eine Datei mit der Erweiterung .aconfig, z. B. my_new_aconfig_flag_declarations.aconfig. Eine Aconfig-Datei ist eine Text-Proto-Datei, die einem Standardschema folgt.

  2. Fügen Sie eine Flag-Deklaration wie die folgende hinzu:

    package: "com.example.android.aconfig.demo.flags"
container: "system"

flag {
    name: "my_new_flag"
    namespace: "aconfig_demo_namespace"
    description: "This flag controls untested code"
    bug: "<none>"
}

    Dabei gilt:

    • In Kombination mit dem Flag-Namen liefert package einen eindeutigen Schlüssel. In Java führt das Festlegen von package auf foo.bar zu einer automatisch generierten Klasse namens foo.bar.Flags. In C++ würden Methoden zum Lesen von Flags foo::bar::"flagname" heißen. Flags in derselben Deklaration zum selben Paket gehören, mehrere Deklarationsdateien Flags zum selben Paket beisteuern.

    • container definiert eine Codesammlung, die zusammen erstellt und versendet wird als Binärcode. Gültige Container sind system, vendor, system_ext, product, name.of.apex und name.of.apk.

    • name enthält den Namen des Flags, der nur Kleinbuchstaben enthält. Unterstriche und Zahlen verwendet werden.

    • namespace enthält den Namespace für Beiträge. Sie müssen mit den zugewiesenen Google-Prüfer, um Ihren Namespace zu bestimmen. Wenn Sie um die Stabilität Ihres eigenen AOSP-Spiegels aufrechtzuerhalten, können Sie Sie können Namespace beliebig verwenden.

    • description enthält eine kurze Beschreibung der Funktion oder Änderung, die gekennzeichnet.

    • bug ist die Fehlernummer, die mit dem neuen Codebeitrag verknüpft ist. Du musst Besprich deine bug gemeinsam mit dem zuständigen Google-Prüfer. Wenn Sie zur Aufrechterhaltung der Stabilität Ihres eigenen AOSP-Spiegels, können Sie Ihre Fehler-Tracking-Nummer oder <none> nutzen.

  3. Speichern Sie die Datei und beenden Sie den Editor.

Build einrichten

Nachdem Sie das Flag deklariert haben, richten Sie den Build so ein, dass der Bibliothekskode generiert werden kann, der zum Zugriff auf den Wert des Flags verwendet wird.

  1. Fügen Sie in Ihrer Android.bp-Builddatei einen aconfig_declarations-Abschnitt hinzu, der in etwa so aussieht:

    aconfig_declarations {
  name: "aconfig_demo_flags",
  package: "com.example.android.aconfig.demo.flags",
  srcs: [
    "my_new_aconfig_flag_declarations.aconfig"
  ],
}

    Dabei gilt:

    • name enthält den Namen der Deklaration, der nur Kleinbuchstaben, Unterstriche und Ziffern enthalten.
    • package enthält den in der Deklaration verwendeten Paketnamen.
    • srcs enthält den Namen der aconfig-Datei, in der das Flag deklariert ist.

  2. Erstellen Sie ein rust_aconfig_library-Ziel ähnlich wie im nächsten Beispiel. Dieses Ziel ruft Rust Codegen auf und erstellt während der Buildzeit eine Rust-Bibliothek mit dem generierten Code.

    rust_aconfig_library {
  name: "libaconfig_demo_flags_rust",
  crate_name: "aconfig_demo_flags_rust",
  aconfig_declarations: "aconfig_demo_flags",
}

    Dabei gilt:

    • name enthält den Namen der Deklaration, der nur Kleinbuchstaben, Unterstriche und Ziffern enthalten.
    • crate_name enthält denselben Paketnamen wie in der Deklaration.
    • aconfig_declarations enthält denselben name wie in der Erklärung.

    Durch diese Änderung kann Ihr Code von dieser Rust-Bibliothek abhängen.

  3. Erstellen Sie in derselben Datei einen rust_library-Eintrag ähnlich dem folgenden:

    rust_library {
  name: "libexample_lib",
  rustlibs: [
      "libaconfig_demo_flags_rust",
  ]
}

    Mit diesem Beispiel können Sie die vom Code generierte Flags-Bibliothek in Ihre Quellcode-Buildziele libexample_demo_flags_rust einbinden.

  4. Speichern Sie die Datei und beenden Sie den Editor.