เลือกคลังอย่างชาญฉลาด

หากต้องการเปิดใช้การเพิ่มประสิทธิภาพแอป คุณต้องใช้ไลบรารีที่เข้ากันได้กับการเพิ่มประสิทธิภาพ Android หากไลบรารีไม่ได้กำหนดค่าสำหรับการเพิ่มประสิทธิภาพ Android เช่น หากใช้การสะท้อนโดยไม่รวมกฎการเก็บรักษาที่เกี่ยวข้อง ก็อาจไม่เหมาะกับแอป Android หน้านี้จะอธิบายว่าทำไมไลบรารีบางรายการจึงเหมาะกับการเพิ่มประสิทธิภาพแอปมากกว่า และให้เคล็ดลับทั่วไปเพื่อช่วยคุณเลือก

เคล็ดลับทั่วไปเมื่อเลือกไลบรารี

ใช้เคล็ดลับเหล่านี้เพื่อช่วยให้มั่นใจว่าไลบรารีของคุณเข้ากันได้กับการเพิ่มประสิทธิภาพแอป

ใช้ Codegen แทนการสะท้อน

เลือกไลบรารีที่ใช้การสร้างโค้ด (codegen) แทนการใช้รีเฟลกชัน เมื่อใช้ Codegen เครื่องมือเพิ่มประสิทธิภาพจะระบุได้ว่าโค้ดใดที่ใช้จริงในรันไทม์และโค้ดใดที่นำออกได้ การระบุว่าไลบรารีใช้ Codegen หรือการสะท้อนอาจเป็นเรื่องยาก แต่ก็มีสัญญาณบางอย่าง โปรดดูเคล็ดลับเพื่อรับความช่วยเหลือ

ดูข้อมูลเพิ่มเติมเกี่ยวกับ Codegen เทียบกับ Reflection ได้ที่การเพิ่มประสิทธิภาพสำหรับผู้เขียนไลบรารี

ตรวจสอบการใช้การสะท้อน (ขั้นสูง)

คุณสามารถดูว่าไลบรารีใช้การสะท้อนหรือไม่โดยตรวจสอบโค้ดของไลบรารี หากไลบรารีใช้การสะท้อน ให้ตรวจสอบว่าไลบรารีมีกฎการเก็บรักษาที่เกี่ยวข้อง ไลบรารีมีแนวโน้มที่จะใช้การสะท้อนหากทำสิ่งต่อไปนี้

  • ใช้คลาสหรือเมธอดจากแพ็กเกจ kotlin.reflect หรือ java.lang.reflect
  • ใช้ฟังก์ชัน Class.forName หรือ classLoader.getClass
  • อ่านคำอธิบายประกอบที่รันไทม์ เช่น หากจัดเก็บค่าคำอธิบายประกอบโดยใช้ val value = myClass.getAnnotation() หรือ val value = myMethod.getAnnotation() แล้วดำเนินการบางอย่างกับ value
  • เรียกใช้เมธอดโดยใช้ชื่อเมธอดเป็นสตริง ดังตัวอย่างต่อไปนี้

    // Calls the private `processData` API with reflection
    myObject.javaClass.getMethod("processData", DataType::class.java)
    ?.invoke(myObject, data)
    

ตรวจสอบปัญหาการเพิ่มประสิทธิภาพ

เมื่อพิจารณาไลบรารีใหม่ ให้ดู Issue Tracker และการสนทนาออนไลน์ของไลบรารีเพื่อตรวจสอบว่ามีปัญหาที่เกี่ยวข้องกับการลดขนาดหรือการกำหนดค่าการเพิ่มประสิทธิภาพแอปหรือไม่ หากมี คุณควรลองมองหาทางเลือกอื่นแทนไลบรารีนั้น โปรดทราบว่า

  • ไลบรารี AndroidX และไลบรารีต่างๆ เช่น Hilt ทำงานได้ดีกับการเพิ่มประสิทธิภาพแอปเนื่องจากส่วนใหญ่ใช้ Codegen แทนการสะท้อน เมื่อใช้การสะท้อน SDK จะมีกฎการเก็บรักษาขั้นต่ำเพื่อเก็บเฉพาะโค้ดที่จำเป็นเท่านั้น
  • ไลบรารีการจัดเรียงข้อมูลมักใช้การสะท้อนเพื่อหลีกเลี่ยงโค้ด Boilerplate เมื่อสร้างอินสแตนซ์หรือจัดเรียงข้อมูลออบเจ็กต์ แทนที่จะใช้แนวทางที่อิงตามการสะท้อน (เช่น Gson สำหรับ JSON) ให้มองหาไลบรารีที่ใช้ Codegen เพื่อหลีกเลี่ยงปัญหาเหล่านี้ เช่น การใช้ Kotlin Serialization หรือ Moshi ที่มี Codegen
  • หากเป็นไปได้ ให้หลีกเลี่ยงไลบรารีที่มีกฎการเก็บรักษาทั้งแพ็กเกจ กฎการเก็บรักษาทั้งแพ็กเกจช่วยแก้ไขข้อผิดพลาดได้ แต่สุดท้ายแล้วคุณควรปรับแต่งกฎการเก็บรักษาแบบกว้างเพื่อเก็บเฉพาะโค้ดที่จำเป็นเท่านั้น ดูข้อมูลเพิ่มเติมได้ที่ใช้การเพิ่มประสิทธิภาพทีละขั้น
  • ก่อนเผยแพร่แอปที่ใช้ไลบรารีของบุคคลที่สาม ให้ใช้เครื่องมือวิเคราะห์การกำหนดค่า R8 เพื่อตรวจสอบกฎการเก็บรักษาที่ระบุไว้ การตรวจสอบรายงานจะช่วยให้คุณยืนยันได้ว่ากฎการเก็บรักษาของไลบรารีนั้นกว้างเกินไปหรือไม่ ซึ่งจะป้องกันไม่ให้ R8 ทำการเพิ่มประสิทธิภาพที่สำคัญในฐานของโค้ด การตรวจสอบนี้ช่วยให้มั่นใจว่าไลบรารีที่คุณเลือกสอดคล้องกับเป้าหมายด้านประสิทธิภาพของแอป และไม่ทำให้เกิดการกำหนดค่าที่มากเกินความจำเป็น
  • ไลบรารีไม่ควรบังคับให้คุณคัดลอกและวางกฎการเก็บรักษาจากเอกสารประกอบลงในไฟล์ในโปรเจ็กต์ โดยเฉพาะอย่างยิ่งกฎการเก็บรักษาทั้งแพ็กเกจ กฎเหล่านี้จะกลายเป็นภาระในการบำรุงรักษาสำหรับนักพัฒนาแอปในระยะยาว และยากต่อการเพิ่มประสิทธิภาพและเปลี่ยนแปลงเมื่อเวลาผ่านไป

เปิดใช้การเพิ่มประสิทธิภาพหลังจากเพิ่มคลังใหม่

เมื่อเพิ่มไลบรารีใหม่ ให้เปิดใช้การเพิ่มประสิทธิภาพในภายหลังและตรวจสอบว่ามีข้อผิดพลาดหรือไม่ หากมีข้อผิดพลาด ให้มองหาทางเลือกอื่นสำหรับไลบรารีนั้นหรือเขียนกฎการเก็บรักษา หากไลบรารีไม่เข้ากันกับการเพิ่มประสิทธิภาพ ให้รายงานข้อบกพร่องเกี่ยวกับไลบรารีนั้น

กรองกฎการเก็บรักษาที่ไม่ถูกต้องออก (ขั้นสูง)

กฎการเก็บรักษาเป็นส่วนเสริม ซึ่งหมายความว่ากฎบางอย่างที่ไลบรารีที่ต้องพึ่งพามีอยู่จะนำออกไม่ได้ และอาจส่งผลต่อการคอมไพล์ส่วนอื่นๆ ของแอป เช่น หากไลบรารีมีกฎให้ปิดใช้การเพิ่มประสิทธิภาพโค้ด กฎนั้นจะปิดใช้การเพิ่มประสิทธิภาพสำหรับทั้งโปรเจ็กต์

คุณควรหลีกเลี่ยงไลบรารีที่มีกฎการเก็บรักษาซึ่งเก็บโค้ดที่ควรนำออกจริงๆ แต่หากจำเป็นต้องใช้ คุณสามารถกรองกฎออกได้ดังที่แสดงในโค้ดต่อไปนี้

// If you're using AGP 8.4 and higher
buildTypes {
    release {
        optimization.keepRules {
          it.ignoreFrom("com.somelibrary:somelibrary")
        }
    }
}

// If you're using AGP 7.3-8.3
buildTypes {
    release {
        optimization.keepRules {
          it.ignoreExternalDependencies("com.somelibrary:somelibrary")
        }
    }
}

เวิร์กโฟลว์ที่แนะนำสำหรับกฎคลังแบบกว้าง

หาก R8 Configuration Analyzer แสดงให้เห็นว่าไลบรารีรวมกฎการเก็บรักษาที่กว้างเกินไป ให้กรองกฎเหล่านั้นเฉพาะในบิลด์ภายในเครื่อง ไม่ใช่ในบิลด์เวอร์ชันที่ใช้งานจริง หากต้องการทดสอบว่ากฎส่งผลต่อแอปมากน้อยเพียงใด ให้ทำตามขั้นตอนต่อไปนี้

  1. อัปเดตไลบรารี: ตรวจสอบว่าคุณใช้ไลบรารีเวอร์ชันล่าสุดที่เครื่องมือวิเคราะห์การกำหนดค่า R8 แจ้งว่ามีปัญหา เนื่องจากเวอร์ชันใหม่อาจมีกฎการเก็บรักษาของผู้บริโภคที่แคบลง หากต้องการดูเวอร์ชันล่าสุด ให้ตรวจสอบเอกสารประกอบของไลบรารีหรือที่เก็บ Maven นอกจากนี้ Android Studio ยังแจ้งว่าทรัพยากร Dependency จำนวนมากมีเวอร์ชันใหม่กว่า หลังจากอัปเดตแล้ว ให้เรียกใช้เครื่องมือวิเคราะห์การกำหนดค่า R8 อีกครั้งเพื่อตรวจสอบว่ากฎการเก็บรักษาแบบกว้างยังคงอยู่หรือไม่
  2. ตรวจสอบการปรับปรุงที่เป็นไปได้ในเครื่อง: คัดลอกกฎผู้ใช้ที่รวมมาของไลบรารีลงในไฟล์กฎการเก็บรักษาในเครื่อง กรองกฎที่รวมมาออกตามที่แสดงในกรองกฎการเก็บรักษาที่ไม่ดีออก และจำกัดกฎที่คัดลอกให้แคบลง เรียกใช้เครื่องมือวิเคราะห์การกำหนดค่า R8 ก่อนและหลังการจำกัดกฎให้แคบลงเพื่อเปรียบเทียบคะแนนการลดขนาด การเพิ่มประสิทธิภาพ และการสร้างความสับสนของแอป
  3. รายงานสิ่งที่พบ: ส่งรายงานข้อบกพร่องไปยังผู้ดูแลไลบรารีพร้อมข้อมูลเชิงประจักษ์จากรายงาน R8 Configuration Analyzer (เช่น แสดงจำนวนคลาสหรือเมธอดที่ไม่มีการอ้างอิงซึ่งเก็บไว้โดยกฎไวลด์การ์ด)

กรณีศึกษา: เหตุใด Gson จึงขัดข้องเมื่อมีการเพิ่มประสิทธิภาพ

Gson เป็นไลบรารีการจัดเรียงข้อมูลที่มักทำให้เกิดปัญหาเกี่ยวกับการเพิ่มประสิทธิภาพแอปเนื่องจากใช้การสะท้อนอย่างหนัก ข้อมูลโค้ดต่อไปนี้แสดงวิธีใช้ Gson โดยทั่วไป ซึ่งอาจทำให้แอปขัดข้องขณะรันไทม์ โปรดทราบว่าเมื่อคุณใช้ Gson เพื่อรับรายการออบเจ็กต์ User คุณจะไม่เรียกใช้คอนสตรัคเตอร์หรือส่งแฟกทอรีไปยังฟังก์ชัน fromJson() การสร้างหรือใช้คลาสที่แอปกำหนดโดยไม่มีสิ่งต่อไปนี้เป็นสัญญาณว่าไลบรารีอาจใช้การสะท้อนแบบปลายเปิด

  • คลาสแอปที่ใช้ไลบรารี หรืออินเทอร์เฟซหรือคลาสมาตรฐาน
  • ปลั๊กอินการสร้างโค้ด เช่น KSP
class User(val name: String)
class UserList(val users: List<User>)

// This code runs in debug mode, but crashes when optimizations are enabled
Gson().fromJson("""[{"name":"myname"}]""", User::class.java).toString()

หากต้องการทำความเข้าใจวิธีการทำงานของ R8 ใน Gson โปรดดูกฎผู้บริโภคของ Gson เมื่อ R8 วิเคราะห์โค้ดนี้และไม่เห็น UserList หรือ User ที่สร้างอินสแตนซ์ไว้ที่ใดเลย ก็อาจเปลี่ยนชื่อฟิลด์หรือนำคอนสตรัคเตอร์ที่ดูเหมือนจะไม่ได้ใช้ออก ซึ่งจะทำให้แอปขัดข้อง หากคุณใช้ไลบรารีอื่นๆ ในลักษณะที่คล้ายกัน คุณควรตรวจสอบว่าไลบรารีเหล่านั้นจะไม่รบกวนการเพิ่มประสิทธิภาพแอป และหากรบกวน ให้หลีกเลี่ยงการใช้ไลบรารีเหล่านั้น

ใช้ @SerializedName กับ Gson เวอร์ชันที่ใหม่กว่า

หากต้องการกำหนดโมเดลข้อมูลในลักษณะที่เข้ากันได้กับกฎผู้บริโภคของ Gson ให้ใส่คำอธิบายประกอบฟิลด์ด้วย @SerializedName ดังที่แสดงในข้อมูลโค้ดต่อไปนี้

import com.google.gson.annotations.SerializedName

class User(@SerializedName("name") val name: String)
class UserList(@SerializedName("users") val users: List<User>)

การใช้คำอธิบายประกอบ @SerializedName จะช่วยให้ R8 จับคู่คลาสโมเดลกับกฎการเก็บรักษาที่รวมอยู่ใน Gson เวอร์ชัน 2.11.0 ขึ้นไปได้ R8 จะเก็บรักษาฟิลด์ที่มีคำอธิบายประกอบและคอนสตรัคเตอร์ที่จำเป็นไว้โดยอัตโนมัติ ซึ่งช่วยให้คุณใช้กฎที่รวมมากับไลบรารีได้โดยไม่ต้องดูแลรักษาการกำหนดค่า ProGuard ด้วยตนเองในโปรเจ็กต์

โปรดทราบว่า Room, Hilt และ Moshi ที่มี Codegen จะสร้างประเภทที่แอปกำหนด แต่ใช้ Codegen เพื่อหลีกเลี่ยงความจำเป็นในการใช้การสะท้อน