將系統屬性做為 API 實作

系統屬性 (sysprop) 提供便利的資訊分享方式，通常是系統全域的設定。每個分割區都可以在內部使用自己的系統屬性。如果跨分割區存取屬性 (例如存取 /system 定義的屬性)，可能會發生問題。/vendor自 Android 8.0 起，部分分割區 (例如 /system) 可以升級，但 /vendor 則維持不變。由於系統屬性只是沒有結構定義的字串鍵/值組合全域字典，因此很難穩定屬性。/system 分區可能會變更或移除 /vendor 分區所依附的屬性，且不會另行通知。

在 Android 10 以上版本中，跨分割區存取的系統屬性會以 sysprop 說明檔的形式架構化，而存取屬性的 API 則會產生 C++ 和 Rust 的具體函式，以及 Java 的類別。這些 API 更方便使用，因為存取時不需要任何魔法字串 (例如 ro.build.date)，而且可以靜態輸入。系統也會在建構時檢查 ABI 穩定性，如果發生不相容的變更，建構作業就會中斷。這項檢查會做為分區之間明確定義的介面。這些 API 也能確保 Rust、Java 和 C++ 之間的一致性。

將系統屬性定義為 API

使用 Sysprop 說明檔 (.sysprop) 將系統屬性定義為 API，這類檔案使用 protobuf 的 TextFormat，並採用下列結構定義：

// 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;
}

系統屬性說明檔案包含屬性訊息，說明一組屬性。各欄位的意義如下：

欄位 意義
owner 設為擁有屬性的分割區：platform、vendor 或 odm。
module 用於建立命名空間 (C++) 或靜態最終類別 (Java)，其中會放置產生的 API。舉例來說， com.android.sysprop.BuildProperties 是 C++ 中的 com::android::sysprop::BuildProperties 命名空間， 而 BuildProperties 類別是 Java 中 com.android.sysprop 的套件。
prop 屬性清單。

Property 訊息欄位的含義如下：

欄位 意義
api_name 產生的 API 名稱。
type 這個屬性的類型。
access Readonly：只會產生 getter API
Writeonce、ReadWrite：會產生 getter 和 setter API
scope Internal：只有擁有者可以存取。
Public：所有人都能存取，但 NDK 模組除外。
prop_name 基礎系統屬性的名稱，例如 ro.build.date。
enum_values (僅限 Enum、EnumList) 以直立線(|) 分隔的字串，由可能的列舉值組成。例如：value1|value2。
integer_as_bool (僅限 Boolean、BooleanList) 讓設定程式使用 0 和 1，而非 false 和 true。
legacy_prop_name (選用，僅限 Readonly 屬性) 基礎系統屬性的舊版名稱。呼叫 getter 時，getter API 會嘗試讀取 prop_name，如果 prop_name 不存在，則會使用 legacy_prop_name。如果想淘汰現有屬性並改用新屬性，請使用 legacy_prop_name。

每種屬性類型都會對應至 C++、Java 和 Rust 中的下列型別：

類型 C++ (可為空值) Java (可為空值) Rust (選用或可為空值)
布林 std::optional<bool> Optional<Boolean> Option<bool>
整數 std::optional<std::int32_t> Optional<Integer> Option<i32>
UInt std::optional<std::uint32_t> Optional<Integer> Option<u32>
長 std::optional<std::int64_t> Optional<Long> Option<i64>
ULong std::optional<std::uint64_t> Optional<Long> Option<u64>
Double std::optional<double> Optional<Double> Option<f64>
字串 std::optional<std::string> Optional<String> Option<String>
列舉 std::optional<{api\_name}\_values> Optional<{api\_name}\_values> Option<{ApiName}Values>
T 清單 std::vector<std::optional<T>> List<T> Vec<T>

以下是 Sysprop 說明檔範例，其中定義了三項屬性：

# 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
}

定義系統屬性程式庫

您可以使用 Sysprop 說明檔定義 sysprop_library 模組。sysprop_library 可做為 C++、Java 和 Rust 的 API。建構系統會在內部為每個 sysprop_library 執行個體產生一個 rust_library、一個 java_library 和一個 cc_library。

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

您必須在 API 檢查的來源中加入 API 清單檔案。如要這麼做，請建立 API 檔案和 api 目錄。將 api 目錄放在與 Android.bp 相同的目錄中。API 檔案名稱為 <module_name>-current.txt 和 <module_name>-latest.txt。<module_name>-current.txt 包含目前原始碼的 API 簽章，而 <module_name>-latest.txt 則包含最新的凍結 API 簽章。建構系統會比較這些 API 檔案與建構時產生的 API 檔案，檢查 API 是否有變更，並在 current.txt 與原始碼不符時發出錯誤訊息和更新 current.txt 檔案的指示。以下是目錄和檔案的組織範例：

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

Rust、Java 和 C++ 用戶端模組可以連結至 sysprop_library，使用產生的 API。建構系統會建立從用戶端到產生的 C++、Java 和 Rust 程式庫的連結，讓用戶端存取產生的 API。

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

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

rust_binary {
    name: "rust_client",
    srcs: ["src/main.rs"],
    rustlibs: ["libplatformproperties_rust"],
}

在上述範例中，您可以透過下列方式存取已定義的屬性。

Rust 範例：

use platformproperties::DeviceStatusValues;

fn foo() -> Result<(), Error> {
  // Read "ro.build.date_utc". default value is -1.
  let date_utc = platformproperties::date_utc()?.unwrap_or_else(-1);

  // set "device.status" to "unknown" if "ro.build.date" is not set.
  if platformproperties::build_date()?.is_none() {
    platformproperties::set_device_status(DeviceStatusValues::UNKNOWN);
  }

  …
}

Java 範例：

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

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