ใช้ API สคีมาไฟล์กำหนดค่า

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

ก่อนที่จะเป็น Android 10 แพลตฟอร์มไม่ได้มีกลไกในการกำหนดและใช้สคีมา XML หรือเพื่อป้องกันการเปลี่ยนแปลงที่เข้ากันไม่ได้ในสคีมา Android 10 มีกลไกนี้ที่เรียกว่า 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 ได้

API สคีมาไฟล์การกำหนดค่าบิลด์

ส่วนนี้จะอธิบายวิธีสร้าง 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 การตรวจสอบ 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 ในพร็อพเพอร์ตี้ Java srcs แพ็กเกจโค้ด 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 ชื่อองค์ประกอบและแอตทริบิวต์ทั้งหมดจะแปลงเป็นตัวอักษรพิมพ์เล็กและใหญ่ (เช่น ElementName) และใช้เป็นตัวแปร เมธอด และชื่อคลาสที่สอดคล้องกันเพื่อให้มีความสอดคล้องกัน รับคลาสขององค์ประกอบรูทที่แยกวิเคราะห์ได้โดยใช้ฟังก์ชัน read{class-name} หากมีองค์ประกอบรูทเพียงรายการเดียว ชื่อฟังก์ชันก็จะเป็น read รับค่าขององค์ประกอบย่อยหรือแอตทริบิวต์ที่แยกวิเคราะห์ได้โดยใช้ฟังก์ชัน get{variable-name}

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

ในกรณีส่วนใหญ่ คุณไม่จำเป็นต้องเรียกใช้ xsdc โดยตรง ให้ใช้กฎบิลด์ xsd_config แทนตามที่อธิบายไว้ในการกำหนดค่ากฎบิลด์ 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