ใช้ Config File Schema API

แพลตฟอร์ม Android มีไฟล์ XML จำนวนมากสำหรับจัดเก็บข้อมูลการกำหนดค่า (เช่น การกำหนดค่าเสียง) ไฟล์ XML หลายไฟล์อยู่ในพาร์ติชัน vendor แต่จะอ่านในพาร์ติชัน system ในกรณีนี้ สคีมา ของไฟล์ XML จะทำหน้าที่เป็นอินเทอร์เฟซในพาร์ติชันทั้ง 2 รายการ ดังนั้น จึงต้องระบุสคีมาอย่างชัดเจนและต้องพัฒนาในลักษณะที่เข้ากันได้แบบย้อนหลัง

ก่อน Android 10 แพลตฟอร์มไม่มีกลไกที่กำหนดให้ระบุและใช้สคีมา XML หรือเพื่อป้องกันการเปลี่ยนแปลงที่ไม่เข้ากันในสคีมา Android 10 มีกลไกนี้ซึ่งเรียกว่า Config File Schema API กลไกนี้ประกอบด้วยเครื่องมือที่ชื่อ xsdc และกฎการสร้างที่ชื่อ xsd_config

xsdc เป็นคอมไพเลอร์เอกสารสคีมา XML (XSD) โดยจะแยกวิเคราะห์ไฟล์ XSD ที่อธิบายสคีมาของไฟล์ XML และสร้างโค้ด Java และ C++ โค้ดที่สร้างขึ้นจะแยกวิเคราะห์ไฟล์ XML ที่เป็นไปตามสคีมา XSD เป็นโครงสร้างออบเจ็กต์ ซึ่งแต่ละออบเจ็กต์จะจำลองแท็ก XML แอตทริบิวต์ XML จะได้รับการจำลองเป็นฟิลด์ ของออบเจ็กต์

xsd_config กฎการสร้างจะผสานรวมเครื่องมือ xsdc เข้ากับระบบการสร้าง สำหรับไฟล์อินพุต XSD ที่ระบุ กฎการสร้างจะสร้างไลบรารี Java และ C++ คุณ สามารถลิงก์ไลบรารีกับโมดูลที่อ่านและใช้ไฟล์ XML ที่เป็นไปตาม XSD คุณสามารถใช้กฎการสร้างสำหรับไฟล์ XML ของคุณเองที่ใช้ในพาร์ติชัน system และ vendor

Build Config File Schema API

ส่วนนี้จะอธิบายวิธีสร้าง Config File Schema API

กำหนดค่ากฎการบิลด์ xsd_config ใน Android.bp

xsd_configกฎการสร้างจะสร้างโค้ดตัวแยกวิเคราะห์ด้วยเครื่องมือ xsdc พร็อพเพอร์ตี้ package_name ของ xsd_config กฎการสร้างจะกำหนดชื่อแพ็กเกจของ โค้ด Java ที่สร้างขึ้น

ตัวอย่างxsd_configกฎการสร้างในAndroid.bp

xsd_config {
    name: "hal_manifest",
    srcs: ["hal_manifest.xsd"],
    package_name: "hal.manifest",
}

ตัวอย่างโครงสร้างไดเรกทอรี

├── Android.bp
├── api
│   ├── current.txt
│   ├── last_current.txt
│   ├── last_removed.txt
│   └── removed.txt
└── hal_manifest.xsd

ระบบบิลด์จะสร้างรายการ API โดยใช้โค้ด Java ที่สร้างขึ้นและตรวจสอบ API กับรายการดังกล่าว เราได้เพิ่มการตรวจสอบ API นี้ลงใน DroidCore และจะดำเนินการที่ m -j

สร้างไฟล์รายการ API

การตรวจสอบ API ต้องใช้ไฟล์รายการ API ในซอร์สโค้ด

รายการไฟล์ที่ API แสดงมีดังนี้

• current.txt และ removed.txt จะตรวจสอบว่า API มีการเปลี่ยนแปลงหรือไม่โดย เปรียบเทียบกับไฟล์ API ที่สร้างขึ้นในเวลาบิลด์
• last_current.txt และ last_removed.txt ตรวจสอบว่า API มี ความเข้ากันได้แบบย้อนหลังหรือไม่โดยเปรียบเทียบกับไฟล์ API

วิธีสร้างไฟล์รายการ API

1. สร้างไฟล์รายการว่าง
2. เรียกใช้คำสั่ง make update-api

ใช้โค้ดตัวแยกวิเคราะห์ที่สร้างขึ้น

หากต้องการใช้โค้ด Java ที่สร้างขึ้น ให้เพิ่ม : เป็นคำนำหน้าของชื่อโมดูล xsd_config ในพร็อพเพอร์ตี้ srcs ของ Java แพ็กเกจของโค้ด Java ที่สร้างขึ้นจะเหมือนกับpackage_nameพร็อพเพอร์ตี้

java_library {
    name: "vintf_test_java",
    srcs: [
        "srcs/**/*.java"
        ":hal_manifest"
    ],
}

หากต้องการใช้โค้ด C++ ที่สร้างขึ้น ให้เพิ่มxsd_configชื่อโมดูลลงในพร็อพเพอร์ตี้ generated_sourcesและgenerated_headers และเพิ่ม libxml2 ลงใน static_libs หรือ shared_libs เนื่องจากต้องใช้ libxml2 ในโค้ดตัวแยกวิเคราะห์ที่สร้างขึ้น เนมสเปซของโค้ด C++ ที่สร้างขึ้นจะเหมือนกับพร็อพเพอร์ตี้ package_name เช่น หากชื่อโมดูล xsd_config คือ hal.manifest เนมสเปซจะเป็น hal::manifest

cc_library{
    name: "vintf_test_cpp",
    srcs: ["main.cpp"],
    generated_sources: ["hal_manifest"],
    generated_headers: ["hal_manifest"],
    shared_libs: ["libxml2"],
}

ใช้ตัวแยกวิเคราะห์

หากต้องการใช้โค้ดตัวแยกวิเคราะห์ Java ให้ใช้วิธี XmlParser#read หรือ read{class-name} เพื่อแสดงผลคลาสขององค์ประกอบราก การแยกวิเคราะห์จะเกิดขึ้นในเวลานี้

import hal.manifest.*;

…

class HalInfo {
    public String name;
    public String format;
    public String optional;
    …
}

void readHalManifestFromXml(File file) {
    …
    try (InputStream str = new BufferedInputStream(new FileInputStream(file))) {
        Manifest manifest = XmlParser.read(str);
        for (Hal hal : manifest.getHal()) {
            HalInfo halinfo;
            HalInfo.name = hal.getName();
            HalInfo.format = hal.getFormat();
            HalInfo.optional = hal.getOptional();
            …
        }
    }
    …
}

หากต้องการใช้โค้ดตัวแยกวิเคราะห์ C++ ให้รวมไฟล์ส่วนหัวก่อน ชื่อของไฟล์ส่วนหัวคือชื่อแพ็กเกจที่มีจุด (.) แปลงเป็นขีดล่าง (_) จากนั้นใช้วิธี read หรือ read{class-name} เพื่อส่งคืน คลาสขององค์ประกอบราก การแยกวิเคราะห์จะเกิดขึ้นในเวลานี้ ค่าที่ส่งคืนคือ std::optional<>

include "hal_manifest.h"

…
using namespace hal::manifest

struct HalInfo {
    public std::string name;
    public std::string format;
    public std::string optional;
    …
};

void readHalManifestFromXml(std::string file_name) {
    …
    Manifest manifest = *read(file_name.c_str());
    for (Hal hal : manifest.getHal()) {
        struct HalInfo halinfo;
        HalInfo.name = hal.getName();
        HalInfo.format = hal.getFormat();
        HalInfo.optional = hal.getOptional();
        …
    }
    …
}

API ทั้งหมดที่ให้ไว้เพื่อใช้ตัวแยกวิเคราะห์อยู่ใน api/current.txt เพื่อความสม่ำเสมอ ระบบจะแปลงชื่อองค์ประกอบและแอตทริบิวต์ทั้งหมดเป็นรูปแบบ Camel Case (เช่น ElementName) และใช้เป็นตัวแปร เมธอด และชื่อคลาสที่เกี่ยวข้อง คุณรับคลาสขององค์ประกอบรูทที่แยกวิเคราะห์แล้วได้โดยใช้ฟังก์ชัน read{class-name} หากมีองค์ประกอบรูทเพียงรายการเดียว ชื่อฟังก์ชันจะเป็น read คุณรับค่าขององค์ประกอบย่อยหรือแอตทริบิวต์ที่แยกวิเคราะห์แล้วได้โดยใช้ฟังก์ชัน get{variable-name}

สร้างโค้ดตัวแยกวิเคราะห์

ในกรณีส่วนใหญ่ คุณไม่จำเป็นต้องเรียกใช้ xsdc โดยตรง ให้ใช้ xsd_config build rule แทนตามที่อธิบายไว้ใน การกำหนดค่ากฎบิลด์ xsd_config ใน Android.bp ส่วนนี้จะอธิบายอินเทอร์เฟซบรรทัดคำสั่ง xsdc เพื่อให้ข้อมูลครบถ้วน ซึ่งอาจเป็นประโยชน์ในการแก้ไขข้อบกพร่อง

คุณต้องระบุเส้นทางไปยังไฟล์ XSD และแพ็กเกจให้กับxsdcเครื่องมือ แพ็กเกจคือชื่อแพ็กเกจในโค้ด Java และเนมสเปซในโค้ด C++ ตัวเลือก ในการพิจารณาว่าโค้ดที่สร้างขึ้นเป็น Java หรือ C คือ -j หรือ -c ตามลำดับ ตัวเลือก -o คือเส้นทางของไดเรกทอรีเอาต์พุต

usage: xsdc path/to/xsd_file.xsd [-c] [-j] [-o <arg>] [-p]
 -c,--cpp           Generate C++ code.
 -j,--java          Generate Java code.
 -o,--outDir <arg>  Out Directory
 -p,--package       Package name of the generated java file. file name of
                    generated C++ file and header

ตัวอย่างคำสั่ง

$ xsdc audio_policy_configuration.xsd -p audio.policy -j