ประกาศแฟล็ก aconfig

คุณสามารถใช้ Flag aconfig ในโค้ด Java, C, C++ และ Rust ระบบบิลด์ AOSP จะเปิดเครื่องมือชื่อ aconfig ซึ่งใช้สร้างคลังเมธอดเฉพาะภาษาที่คุณสามารถใช้เข้าถึงค่าของ Flag แต่ละรายการ คุณต้องประกาศ Flag และเพิ่มลงในบิลด์ก่อนจึงจะสร้างไลบรารีได้

ประกาศ Flag aconfig สําหรับ Java

วิธีประกาศ Flag aconfig สำหรับ Java

1. ในไดเรกทอรีที่มีโค้ดใหม่อยู่ ให้สร้างไฟล์ที่มีนามสกุล .aconfig เช่น my_new_aconfig_flag_declarations.aconfig ไฟล์ aconfig คือไฟล์โปรโตคอลข้อความที่เป็นไปตามสคีมามาตรฐาน

2. เพิ่มการประกาศ Flag คล้ายกับข้อความต่อไปนี้

   package: "com.example.android.aconfig.demo.flags"
   container: "system"
   
   flag {
       name: "my_new_flag"
       namespace: "aconfig_demo_namespace"
       description: "This flag controls untested code"
       bug: "<none>"
   }
   

   สถานที่:

   • package เมื่อรวมกับชื่อ Flag จะให้คีย์ที่ไม่ซ้ำกัน ใน Java การกําหนด package เป็น foo.bar จะทําให้คลาสชื่อ foo.bar.Flags สร้างขึ้นโดยอัตโนมัติ ใน C++ เมธอดการเข้าถึง Flag จะตั้งชื่อว่า foo::bar::"flagname" แฟล็กในไฟล์ประกาศเดียวกันเป็นของแพ็กเกจเดียวกัน แต่ไฟล์ประกาศหลายไฟล์อาจมีส่วนร่วมในแพ็กเกจเดียวกัน

   • container กำหนดคอลเล็กชันโค้ดที่สร้างและจัดส่งร่วมกันในรูปแบบไบนารี คอนเทนเนอร์ที่ถูกต้องคือ system, vendor, system_ext, product, name.of.apex และ name.of.apk

   • name มีชื่อของแฟล็กที่มีเฉพาะตัวพิมพ์เล็ก ขีดล่าง และตัวเลขเท่านั้น

   • namespace มีเนมสเปซสำหรับการมีส่วนร่วม คุณต้องทำงานร่วมกับผู้ตรวจสอบของ Google ที่ได้รับมอบหมายให้กำหนดเนมสเปซ หากใช้แฟล็กการเปิดใช้งานฟีเจอร์เพื่อรักษาความเสถียรของมิเรอร์ AOSP ของคุณเอง คุณจะใช้เนมสเปซได้ตามที่ต้องการ

   • description มีคำอธิบายสั้นๆ เกี่ยวกับฟีเจอร์หรือการเปลี่ยนแปลงที่มีการแจ้งว่าไม่เหมาะสม

   • bug คือหมายเลขข้อบกพร่องที่เชื่อมโยงกับการสนับสนุนโค้ดใหม่ คุณต้องทำงานร่วมกับผู้ตรวจสอบของ Google ที่ได้รับมอบหมายเพื่อกำหนดbug หากคุณใช้ Flag การเปิดตัวฟีเจอร์เพื่อรักษาเสถียรภาพของมิเรอร์ AOSP ของคุณเอง ให้ใช้หมายเลขติดตามข้อบกพร่องหรือใช้ <none>

3. บันทึกไฟล์และออกจากเครื่องมือแก้ไข

ตั้งค่าบิลด์

หลังจากประกาศ Flag แล้ว ให้ตั้งค่าบิลด์เพื่อให้สร้างโค้ดไลบรารีที่ใช้เข้าถึงค่าของ Flag ได้

1. ในไฟล์บิลด์ Android.bp ให้เพิ่มส่วน aconfig_declarations คล้ายกับตัวอย่างต่อไปนี้

   aconfig_declarations {
     name: "aconfig_demo_flags",
     package: "com.example.android.aconfig.demo.flags",
     srcs: [
       "my_new_aconfig_flag_declarations.aconfig"
     ],
   }
   

   สถานที่:

   • name มีชื่อประกาศที่มีเฉพาะตัวอักษรพิมพ์เล็ก ขีดล่าง และตัวเลขเท่านั้น
   • package มีชื่อแพ็กเกจเดียวกับที่ใช้ในการประกาศ
   • srcs มีชื่อของไฟล์ .aconfig ที่มีการประกาศ Flag

2. บันทึกไฟล์และออกจากเครื่องมือแก้ไข

ประกาศ Flag aconfig สําหรับ C และ C++

หากต้องการประกาศแฟล็ก aconfig สำหรับ C และ C++ ให้ทำดังนี้

1. ในไดเรกทอรีที่มีโค้ดใหม่อยู่ ให้สร้างไฟล์ที่มีนามสกุล .aconfig เช่น my_new_aconfig_flag_declarations.aconfig ไฟล์ aconfig คือไฟล์โปรโตคอลข้อความที่เป็นไปตามสคีมามาตรฐาน

2. เพิ่มการประกาศ Flag คล้ายกับข้อความต่อไปนี้

   package: "com.example.android.aconfig.demo.flags"
   container: "system"
   
   flag {
       name: "my_new_flag"
       namespace: "aconfig_demo_namespace"
       description: "This flag controls untested code"
       bug: "<none>"
   }
   

   สถานที่:

   • package เมื่อรวมกับชื่อ Flag จะให้คีย์ที่ไม่ซ้ำกัน ใน Java การกําหนด package เป็น foo.bar จะทําให้คลาสชื่อ foo.bar.Flags สร้างขึ้นโดยอัตโนมัติ ใน C++ เมธอดการเข้าถึง Flag จะตั้งชื่อว่า foo::bar::"flagname" แฟล็กในไฟล์ประกาศเดียวกันเป็นของแพ็กเกจเดียวกัน แต่ไฟล์ประกาศหลายไฟล์อาจมีส่วนร่วมในแพ็กเกจเดียวกัน

   • container กำหนดคอลเล็กชันโค้ดที่สร้างและจัดส่งร่วมกันในรูปแบบไบนารี คอนเทนเนอร์ที่ถูกต้องคือ system, vendor, system_ext, product, name.of.apex และ name.of.apk

   • name มีชื่อของแฟล็กที่มีเฉพาะตัวพิมพ์เล็ก ขีดล่าง และตัวเลขเท่านั้น

   • namespace มีเนมสเปซสำหรับการมีส่วนร่วม คุณต้องทำงานร่วมกับผู้ตรวจสอบของ Google ที่ได้รับมอบหมายให้กำหนดเนมสเปซ หากใช้แฟล็กการเปิดใช้งานฟีเจอร์เพื่อรักษาความเสถียรของมิเรอร์ AOSP ของคุณเอง คุณจะใช้เนมสเปซได้ตามที่ต้องการ

   • description มีคำอธิบายสั้นๆ เกี่ยวกับฟีเจอร์หรือการเปลี่ยนแปลงที่มีการแจ้งว่าไม่เหมาะสม

   • bug คือหมายเลขข้อบกพร่องที่เชื่อมโยงกับการสนับสนุนโค้ดใหม่ คุณต้องทำงานร่วมกับผู้ตรวจสอบของ Google ที่ได้รับมอบหมายเพื่อกำหนดbug หากคุณใช้ Flag การเปิดตัวฟีเจอร์เพื่อรักษาเสถียรภาพของมิเรอร์ AOSP ของคุณเอง ให้ใช้หมายเลขติดตามข้อบกพร่องหรือใช้ <none>

3. บันทึกไฟล์และออกจากเครื่องมือแก้ไข

ตั้งค่าบิลด์

หลังจากประกาศ Flag แล้ว ให้ตั้งค่าบิลด์เพื่อให้สร้างโค้ดไลบรารีที่ใช้เข้าถึงค่าของ Flag ได้

1. ในไฟล์บิลด์ Android.bp ให้เพิ่มส่วน aconfig_declarations คล้ายกับตัวอย่างต่อไปนี้

   aconfig_declarations {
     name: "aconfig_demo_flags",
     package: "com.example.android.aconfig.demo.flags",
     srcs: [
       "my_new_aconfig_flag_declarations.aconfig"
     ],
   }
   

   สถานที่:

   • name มีชื่อประกาศที่มีเฉพาะตัวอักษรพิมพ์เล็ก ขีดล่าง และตัวเลขเท่านั้น
   • package มีชื่อแพ็กเกจเดียวกับที่ใช้ในการประกาศ
   • srcs มีชื่อของไฟล์ aconfig ที่มีการประกาศ Flag

2. ในไฟล์เดียวกัน ให้สร้างเป้าหมาย cc_aconfig_library ที่คล้ายกับตัวอย่างต่อไปนี้

   cc_aconfig_library {
       name: "aconfig_demo_flags_c_lib",
       aconfig_declarations: "aconfig_demo_flags",
   }
   

   สถานที่:

   • name มีชื่อไลบรารีที่มีเฉพาะตัวพิมพ์เล็ก ขีดล่าง และตัวเลขเท่านั้น
   • aconfig_declarations มี name เดียวกับที่ใช้ในการประกาศ

   เป้าหมายของบิลด์ cc_aconfig_library จะเรียกใช้โค้ดเจน C หรือ C++ ซึ่งจะสร้างไลบรารีด้วยโค้ดที่สร้างขึ้น ณ เวลาบิลด์

   ไลบรารี aconfig ของ CC คล้ายกับเป้าหมายไลบรารี CC แต่มีตัวเลือกต่างๆ เช่น vendor_available, product_available, host_supported และ vndk หากเป้าหมายของบิลด์ที่ใช้ cc_aconfig_library นี้ต้องใช้ตัวแปรบางประเภท คุณอาจต้องเพิ่มการตั้งค่าที่เกี่ยวข้องในเป้าหมายไลบรารี CC ด้วย เช่น หากเป้าหมายการสร้างระดับบนสุดมีการตั้งค่า vendor_available เป็น true คุณอาจต้องตั้งค่า vendor_available เป็น true ในเป้าหมาย cc_aconfig_library นี้ด้วย

   หลังจากเพิ่มเป้าหมายการสร้างนี้แล้ว โค้ดของคุณจะเข้าถึงไลบรารีนี้ได้ คุณรวมไลบรารีนี้ได้โดยใช้ไวยากรณ์ static_lib หรือ shared_lib โปรดทราบว่าหากต้องการเพิ่มไลบรารีนี้เป็น static_lib ให้เพิ่มทรัพยากร Dependency ของ shared_lib ใน server_configurable_flags ขั้นตอนที่ 3 แสดงวิธีรวมไลบรารี Flag ที่สร้างขึ้นจากโค้ดลงใน libexample_cpp_lib

3. สร้างเป้าหมายที่ใช้แฟล็ก aconfig ดังตัวอย่างต่อไปนี้ cc_library

   cc_library {
       name: "libexample_cpp_lib",
       srcs: ["src/example_cpp_lib.cc"],
       double_loadable: true,
       cflags: [
           "-Wall",
           "-Werror",
           "-Wno-unused-function",
           "-Wno-unused-parameter",
       ],
       header_libs: [
           "jni_headers",
       ],
       shared_libs: [
           "server_configurable_flags",
       ],
       static_libs: [
           "aconfig_demo_flags_c_lib",
       ],
       export_include_dirs: ["src/include"],
   }
   

   สถานที่:

   • shared_libs มีทรัพยากร Dependency เพิ่มเติมที่จำเป็นสำหรับแฟล็ก aconfig
   • static_libs คือชื่อของไลบรารีที่บิลด์สร้างขึ้นตามช่อง cc_aconfig_library name ในขั้นตอนที่ 2 การสร้างรายการ cc_library ที่มีชื่อไลบรารีแบบคงที่จะช่วยให้คุณใช้ Flag aconfig ในโค้ดได้

ประกาศแฟล็ก aconfig สำหรับ Rust

วิธีประกาศแฟล็ก aconfig สำหรับ Rust

1. ในไดเรกทอรีที่มีโค้ดใหม่อยู่ ให้สร้างไฟล์ที่มีนามสกุล .aconfig เช่น my_new_aconfig_flag_declarations.aconfig ไฟล์ aconfig คือไฟล์โปรโตคอลข้อความที่เป็นไปตามสคีมามาตรฐาน

2. เพิ่มการประกาศ Flag คล้ายกับข้อความต่อไปนี้

   package: "com.example.android.aconfig.demo.flags"
   container: "system"
   
   flag {
       name: "my_new_flag"
       namespace: "aconfig_demo_namespace"
       description: "This flag controls untested code"
       bug: "<none>"
   }
   

   สถานที่:

   • package เมื่อรวมกับชื่อ Flag จะให้คีย์ที่ไม่ซ้ำกัน ใน Java การกําหนด package เป็น foo.bar จะทําให้คลาสชื่อ foo.bar.Flags สร้างขึ้นโดยอัตโนมัติ ใน C++ เมธอดการเข้าถึง Flag จะตั้งชื่อว่า foo::bar::"flagname" แฟล็กในไฟล์ประกาศเดียวกันเป็นของแพ็กเกจเดียวกัน แต่ไฟล์ประกาศหลายไฟล์อาจมีส่วนร่วมในแพ็กเกจเดียวกัน

   • container กำหนดคอลเล็กชันโค้ดที่สร้างและจัดส่งร่วมกันในรูปแบบไบนารี คอนเทนเนอร์ที่ถูกต้องคือ system, vendor, system_ext, product, name.of.apex และ name.of.apk

   • name มีชื่อของแฟล็กที่มีเฉพาะตัวพิมพ์เล็ก ขีดล่าง และตัวเลขเท่านั้น

   • namespace มีเนมสเปซสำหรับการมีส่วนร่วม คุณต้องทำงานร่วมกับผู้ตรวจสอบของ Google ที่ได้รับมอบหมายให้กำหนดเนมสเปซ หากใช้แฟล็กการเปิดใช้งานฟีเจอร์เพื่อรักษาความเสถียรของมิเรอร์ AOSP ของคุณเอง คุณจะใช้เนมสเปซได้ตามที่ต้องการ

   • description มีคำอธิบายสั้นๆ เกี่ยวกับฟีเจอร์หรือการเปลี่ยนแปลงที่มีการแจ้งว่าไม่เหมาะสม

   • bug คือหมายเลขข้อบกพร่องที่เชื่อมโยงกับการสนับสนุนโค้ดใหม่ คุณต้องทำงานร่วมกับผู้ตรวจสอบของ Google ที่ได้รับมอบหมายเพื่อกำหนดbug หากคุณใช้ Flag การเปิดตัวฟีเจอร์เพื่อรักษาเสถียรภาพของมิเรอร์ AOSP ของคุณเอง ให้ใช้หมายเลขติดตามข้อบกพร่องหรือใช้ <none>

3. บันทึกไฟล์และออกจากเครื่องมือแก้ไข

ตั้งค่าบิลด์

หลังจากประกาศ Flag แล้ว ให้ตั้งค่าบิลด์เพื่อสร้างโค้ดไลบรารีที่ใช้เข้าถึงค่าของ Flag

1. ในไฟล์บิลด์ Android.bp ให้เพิ่มส่วน aconfig_declarations ที่คล้ายคลึงกับรายการต่อไปนี้

   aconfig_declarations {
     name: "aconfig_demo_flags",
     package: "com.example.android.aconfig.demo.flags",
     srcs: [
       "my_new_aconfig_flag_declarations.aconfig"
     ],
   }
   

   สถานที่:

   • name มีชื่อประกาศที่มีเฉพาะตัวอักษรพิมพ์เล็ก ขีดล่าง และตัวเลขเท่านั้น
   • package มีชื่อแพ็กเกจเดียวกับที่ใช้ในการประกาศ
   • srcs มีชื่อของไฟล์ aconfig ที่มีการประกาศ Flag

2. สร้างเป้าหมาย rust_aconfig_library ที่คล้ายกับตัวอย่างถัดไป เป้าหมายนี้เรียกใช้ Rust Codegen และสร้างไลบรารี Rust ที่มีโค้ดที่สร้างขึ้นระหว่างบิลด์

   rust_aconfig_library {
     name: "libaconfig_demo_flags_rust",
     crate_name: "aconfig_demo_flags_rust",
     aconfig_declarations: "aconfig_demo_flags",
   }
   

   สถานที่:

   • name มีชื่อของการประกาศที่ประกอบด้วยอักษรตัวพิมพ์เล็ก ขีดล่าง และตัวเลขเท่านั้น
   • crate_name มีชื่อแพ็กเกจเดียวกันกับที่ใช้ในการประกาศ
   • aconfig_declarations มี name เดียวกับที่ใช้ในการประกาศ

   การเปลี่ยนแปลงนี้จะช่วยให้โค้ดของคุณใช้คลัง Rust นี้ได้

3. สร้างรายการ rust_library ในไฟล์เดียวกันที่คล้ายคลึงกับรายการด้านล่าง

   rust_library {
     name: "libexample_lib",
     rustlibs: [
         "libaconfig_demo_flags_rust",
     ]
   }
   

   ตัวอย่างนี้ช่วยให้บิลด์ซอร์สโค้ดกำหนดเป้าหมายเป็น libexample_demo_flags_rust รวมไลบรารี Flag ที่สร้างขึ้นจากโค้ดได้

4. บันทึกไฟล์และออกจากเครื่องมือแก้ไข