将系统属性实现为 API

系统属性提供了一种方便的方式来共享信息（通常是配置），在整个系统中通用。每个分区可以在内部使用自己的系统属性。当跨分区访问属性时，可能会出现问题，例如 `/vendor` 访问 `/system` 定义的属性。自 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;
}

一个 Sysprop 描述文件包含一个 properties 消息，该消息描述一组属性。其字段的含义如下。

字段 含义
所有者 设置为拥有属性的分区：`Platform`、`Vendor` 或 `Odm`。
模块 用于创建命名空间 (C++) 或静态 final 类 (Java)，其中放置生成的 API。例如，`com.android.sysprop.BuildProperties` 在 C++ 中将是命名空间 `com::android::sysprop::BuildProperties`，在 Java 的 `com.android.sysprop` 包中将是 `BuildProperties` 类。
prop 属性列表。

`Property` 消息字段的含义如下。

字段 含义
api_name 生成的 API 的名称。
类型 此属性的类型。
访问权限 `Readonly`：仅生成 getter API
`Writeonce`、`ReadWrite`：生成 getter 和 setter API
注意：带有前缀 `ro.` 的属性可能不使用 `ReadWrite` 访问权限。
作用域 Internal: 仅所有者可以访问。
Public: 所有人都可以访问，NDK 模块除外。
prop_name 底层系统属性的名称，例如 ro.build.date。
enum_values (仅限 Enum、EnumList) 一个由可能的枚举值组成的竖线 (|) 分隔的字符串。例如，value1|value2。
integer_as_bool (仅限 Boolean、BooleanList) 使 setter 使用 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
Boolean std::optional<bool> Optional<Boolean> bool
Integer std::optional<std::int32_t> Optional<Integer> i32
UInt std::optional<std::uint32_t> Optional<Integer> u32
Long std::optional<std::int64_t> Optional<Long> i64
ULong std::optional<std::uint64_t> Optional<Long> u64
Double std::optional<double> Optional<Double> f64
String std::optional<std::string> Optional<String> String
Enum std::optional<{api_name}_values> Optional<{api_name}_values> {ApiName}Values
T List 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 库名称是通过将 sysprop_library 名称转换为小写，将 . 和 - 替换为 _，然后在前面加上 lib 并在后面附加 _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);
    }
    …
}
…