本頁面由 Cloud Translation API 翻譯而成。

將系統屬性實現為 API

系統屬性提供了一種在系統範圍內共享信息（通常是配置）的便捷方式。每個分區都可以在內部使用自己的系統屬性。當跨分區訪問屬性時可能會出現問題，例如/vendor訪問/system定義的屬性。從 Android 8.0 開始，一些分區，例如/system可以升級，而/vendor保持不變。因為系統屬性只是一個沒有模式的字符串鍵/值對的全局字典，所以很難穩定屬性。 /system分區可以更改或刪除/vendor分區所依賴的屬性，恕不另行通知。

從 Android 10 版本開始，跨分區訪問的系統屬性被模式化為 Sysprop 描述文件，並且用於訪問屬性的 API 生成為 C++ 的具體函數和 Java 的類。這些 API 使用起來更方便，因為訪問不需要魔法字符串（例如ro.build.date ），而且它們可以是靜態類型的。 ABI 穩定性也在構建時進行檢查，如果發生不兼容的更改，則構建會中斷。此檢查充當分區之間明確定義的接口。這些 API 還可以提供 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 描述文件包含一個屬性消息，它描述了一組屬性。其字段含義如下。

場地	意義
`owner`	設置為擁有以下屬性的分區： `Platform` 、 `Vendor`或`Odm` 。
`module`	用於創建放置生成的 API 的命名空間 (C++) 或靜態最終類 (Java)。例如， `com.android.sysprop.BuildProperties`在 C++ 中為命名空間`com::android::sysprop::BuildProperties` ，在 Java 中為`com.android.sysprop`包中的`BuildProperties`類。
`prop`	屬性列表。

Property消息字段的含義如下。

場地	意義
`api_name`	生成的 API 的名稱。
`type`	此屬性的類型。
`access`	`Readonly` ：僅生成 getter API `Writeonce` , `ReadWrite` : 生成 getter 和 setter API 注意：帶有前綴`ro.`不得使用`ReadWrite`訪問。
`scope`	`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 中的以下類型。

類型	C++	爪哇
布爾值	`std::optional<bool>`	`Optional<Boolean>`
整數	`std::optional<std::int32_t>`	`Optional<Integer>`
UInt	`std::optional<std::uint32_t>`	`Optional<Integer>`
長	`std::optional<std::int64_t>`	`Optional<Long>`
超長	`std::optional<std::uint64_t>`	`Optional<Long>`
雙倍的	`std::optional<double>`	`Optional<Double>`
細繩	`std::optional<std::string>`	`Optional<String>`
枚舉	`std::optional<{api_name}_values>`	`Optional<{api_name}_values>`
列表	`std::vector<std::optional<T>>`	`List<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 的 API。構建系統在內部為每個sysprop_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

Java 和 C++ 客戶端模塊都可以鏈接到sysprop_library以使用生成的 API。構建系統創建從客戶端到生成的 C++ 和 Java 庫的鏈接，從而使客戶端能夠訪問生成的 API。

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

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

在上面的示例中，您可以訪問定義的屬性，如下所示。

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