Menerapkan Properti Sistem sebagai API

Properti sistem menyediakan cara yang nyaman untuk berbagi informasi, biasanya konfigurasi, di seluruh sistem. Setiap partisi dapat menggunakan properti sistemnya sendiri secara internal. Masalah dapat terjadi ketika properti diakses di seluruh partisi, seperti /vendor mengakses /system . Sejak Android 8.0, beberapa partisi, seperti /system , dapat ditingkatkan, sedangkan /vendor dibiarkan tidak berubah. Karena properti sistem hanyalah kamus global dari pasangan kunci/nilai string tanpa skema, sulit untuk menstabilkan properti. Partisi /system dapat mengubah atau menghapus properti yang menjadi sandaran partisi /vendor tanpa pemberitahuan.

Dimulai dengan rilis Android 10, properti sistem yang diakses di seluruh partisi dibuat skema ke dalam file Deskripsi Sysprop, dan API untuk mengakses properti dibuat sebagai fungsi konkret untuk C++ dan kelas untuk Java. API ini lebih nyaman digunakan karena tidak ada string ajaib (seperti ro.build.date ) yang diperlukan untuk akses, dan karena dapat diketik secara statis. Stabilitas ABI juga diperiksa pada waktu build, dan build akan rusak jika terjadi perubahan yang tidak kompatibel. Pemeriksaan ini bertindak sebagai antarmuka yang didefinisikan secara eksplisit antara partisi. API ini juga dapat memberikan konsistensi antara Java dan C++.

Mendefinisikan properti sistem sebagai API

Tentukan properti sistem sebagai API dengan file Deskripsi Sysprop ( .sysprop ), yang menggunakan TextFormat protobuf, dengan skema berikut:

// File: sysprop.proto

syntax = "proto3";

package sysprop;

enum Access {
  Readonly = 0;
  Writeonce = 1;
  ReadWrite = 2;
}

enum Owner {
  Platform = 0;
  Vendor = 1;
  Odm = 2;
}

enum Scope {
  Public = 0;
  Internal = 2;
}

enum Type {
  Boolean = 0;
  Integer = 1;
  Long = 2;
  Double = 3;
  String = 4;
  Enum = 5;
  UInt = 6;
  ULong = 7;

  BooleanList = 20;
  IntegerList = 21;
  LongList = 22;
  DoubleList = 23;
  StringList = 24;
  EnumList = 25;
  UIntList = 26;
  ULongList = 27;
}

message Property {
  string api_name = 1;
  Type type = 2;
  Access access = 3;
  Scope scope = 4;
  string prop_name = 5;
  string enum_values = 6;
  bool integer_as_bool = 7;
  string legacy_prop_name = 8;
}

message Properties {
  Owner owner = 1;
  string module = 2;
  repeated Property prop = 3;
}

Satu file Deskripsi Sysprop berisi satu pesan properti, yang menjelaskan sekumpulan properti. Arti dari bidangnya adalah sebagai berikut.

Arti dari bidang pesan Property adalah sebagai berikut.

Setiap tipe properti dipetakan ke tipe berikut di C++ dan Java.

Berikut adalah contoh file Deskripsi Sysprop yang mendefinisikan tiga properti:

# File: android/sysprop/PlatformProperties.sysprop

owner: Platform
module: "android.sysprop.PlatformProperties"
prop {
    api_name: "build_date"
    type: String
    prop_name: "ro.build.date"
    scope: Public
    access: Readonly
}
prop {
    api_name: "date_utc"
    type: Integer
    prop_name: "ro.build.date_utc"
    scope: Internal
    access: Readonly
}
prop {
    api_name: "device_status"
    type: Enum
    enum_values: "on|off|unknown"
    prop_name: "device.status"
    scope: Public
    access: ReadWrite
}

Mendefinisikan perpustakaan properti sistem

Anda sekarang dapat mendefinisikan modul sysprop_library dengan file Deskripsi Sysprop. sysprop_library berfungsi sebagai API untuk C++ dan Java. Sistem build secara internal menghasilkan satu java_library dan satu cc_library untuk setiap instance sysprop_library .

// File: Android.bp
sysprop_library {
    name: "PlatformProperties",
    srcs: ["android/sysprop/PlatformProperties.sysprop"],
    property_owner: "Platform",
    vendor_available: true,
}

Anda harus menyertakan file daftar API di sumber untuk pemeriksaan API. Untuk melakukan ini, buat file API dan direktori api . Letakkan direktori api di direktori yang sama dengan Android.bp . Nama file API adalah <module_name>-current.txt , <module_name>-latest.txt . <module_name>-current.txt menyimpan tanda tangan API dari kode sumber saat ini, dan <module_name>-latest.txt menyimpan tanda tangan API beku terbaru. Sistem build memeriksa apakah API diubah dengan membandingkan file API ini dengan file API yang dihasilkan pada waktu build dan mengeluarkan pesan kesalahan dan instruksi untuk memperbarui file current.txt jika current.txt tidak cocok dengan kode sumber. Berikut adalah contoh direktori dan organisasi file:

├── api
│   ├── PlatformProperties-current.txt
│   └── PlatformProperties-latest.txt
└── Android.bp

Modul klien Java dan C++ dapat ditautkan ke sysprop_library untuk menggunakan API yang dihasilkan. Sistem pembangunan membuat tautan dari klien ke pustaka C++ dan Java yang dihasilkan, sehingga memberi klien akses ke API yang dihasilkan.

java_library {
    name: "JavaClient",
    srcs: ["foo/bar.java"],
    libs: ["PlatformProperties"],
}

cc_binary {
    name: "cc_client",
    srcs: ["baz.cpp"],
    shared_libs: ["PlatformProperties"],
}

Dalam contoh di atas, Anda dapat mengakses properti yang ditentukan sebagai berikut.

Contoh Jawa:

import android.sysprop.PlatformProperties;

…

static void foo() {
    …
    // read "ro.build.date_utc". default value is -1
    Integer dateUtc = PlatformProperties.date_utc().orElse(-1);

    // set "device.status" to "unknown" if "ro.build.date" is not set
    if (!PlatformProperties.build_date().isPresent()) {
        PlatformProperties.device_status(
            PlatformProperties.device_status_values.UNKNOWN
        );
    }
    …
}
…

Contoh C++:

#include <android/sysprop/PlatformProperties.sysprop.h>
using namespace android::sysprop;

…

void bar() {
    …
    // read "ro.build.date". default value is "(unknown)"
    std::string build_date = PlatformProperties::build_date().value_or("(unknown)");

    // set "device.status" to "on" if it's "unknown" or not set
    using PlatformProperties::device_status_values;
    auto status = PlatformProperties::device_status();
    if (!status.has_value() || status.value() == device_status_values::UNKNOWN) {
        PlatformProperties::device_status(device_status_values::ON);
    }
    …
}
…