เกี่ยวกับกฎการเก็บ

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

สถานการณ์ที่พบบ่อยซึ่งต้องใช้กฎการเก็บรักษา

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

  • โค้ดที่เข้าถึงโดยการสะท้อน: R8 ไม่สามารถระบุได้ว่ามีการเข้าถึงคลาส ฟิลด์ หรือเมธอดด้วยการสะท้อนเมื่อใด ตัวอย่างเช่น R8 ไม่สามารถระบุเมธอดที่ค้นหาตามชื่อโดยใช้ Class.getDeclaredMethod() หรือคำอธิบายประกอบที่ดึงมาด้วย Class.getAnnotation() ในกรณีเหล่านี้ R8 อาจเปลี่ยนชื่อเมธอดและคำอธิบายประกอบเหล่านี้หรือนำออกทั้งหมด ซึ่งจะทำให้เกิด ClassNotFoundException หรือ NoSuchMethodException ขณะรันไทม์
  • โค้ดที่เรียกจาก Java Native Interface (JNI): เมื่อโค้ดแบบเนทีฟ (C หรือ C++) เรียกใช้เมธอด Java หรือ Kotlin หรือโค้ด Java หรือ Kotlin เรียกใช้โค้ด C++ ด้วย JNI การเรียกใช้จะอิงตามการค้นหาสตริงแบบไดนามิกของชื่อเมธอด R8 ไม่เห็นการเรียกใช้เมธอดที่อิงตามสตริงแบบไดนามิก ดังนั้นการเพิ่มประสิทธิภาพจึงอาจทำให้โค้ดเสียหาย

สถานการณ์เหล่านี้เป็นเพียงตัวอย่างบางส่วนที่ต้องใช้กฎการเก็บรักษา แต่ก็ครอบคลุมกรณีส่วนใหญ่ที่คุณอาจต้องใช้กฎการเก็บรักษา

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

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

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

กฎการเก็บรักษาแสดงถึงคำสั่งที่ชัดเจนในการจำกัดการเพิ่มประสิทธิภาพ กฎ Keep แต่ละข้อที่คุณประกาศจะจำกัดความสามารถของ R8 ในการเปลี่ยนรูปแบบส่วนนั้นของฐานของโค้ด คุณค่าของกฎการเก็บรักษาที่สร้างขึ้นมาอย่างดีอยู่ที่ความเฉพาะเจาะจง ดังนี้

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

  • กฎการเก็บแบบกว้างจะป้องกันการเพิ่มประสิทธิภาพ: การประกาศกฎทั่วทั้งแพ็กเกจหรือไวลด์การ์ดแบบกว้างจะป้องกันไม่ให้ R8 เพิ่มประสิทธิภาพทั้งคลาสและสมาชิกทั้งหมด R8 จะนำโค้ดดังกล่าวออก ทำการอินไลน์ ผสาน หรือสร้างความสับสนไม่ได้

กฎการเก็บรักษาที่กว้างเกินไปจะทำให้ไบนารี DEX มีขนาดใหญ่เกินไปโดยตรง ซึ่งจะเพิ่มหน่วยความจำที่แอปใช้ เวลาเริ่มต้นทำงานช้าลง (TTID และ TTFD) และอัตรา ANR สูงขึ้น เป้าหมายของคุณไม่ควรเป็นการเก็บคลาสไว้ "เผื่อไว้ก่อน" แต่เป็นการกำหนดสัญญาขั้นต่ำที่จำเป็นสำหรับการดำเนินการแบบไดนามิก

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

วิธีเพิ่มกฎการเก็บรักษาลงในแอป

การกำหนดค่ากฎการเก็บรักษาจะขึ้นอยู่กับเวอร์ชันของ AGP ที่คุณใช้

โดยทั่วไปแล้วแอปขนาดใหญ่จะมีโค้ดในโมดูลไลบรารีหลายโมดูล ในกรณีเช่นนี้ การใส่กฎการเก็บรักษาไว้ข้างโค้ดที่ใช้ภายในโมดูลไลบรารีที่เฉพาะเจาะจงมักจะดีกว่า ความแตกต่างที่สำคัญในการคงกฎการเก็บรักษาไว้สำหรับไลบรารีอยู่ที่วิธีประกาศกฎเหล่านี้ภายในไฟล์ build.gradle.kts (หรือ build.gradle) ของโมดูลไลบรารี ดูข้อมูลเพิ่มเติมได้ที่การเพิ่มประสิทธิภาพสำหรับผู้เขียนไลบรารี

สำหรับ AGP เวอร์ชัน 9.3 ขึ้นไป

เพิ่มกฎลงในไฟล์ที่มีคำต่อท้าย .keep ในไดเรกทอรี src/<variant>/keepRules เช่น src/main/keepRules/custom-rules.keep โปรดทราบว่าการใช้ DSL ที่อัปเดตสำหรับ AGP 9.3 ขึ้นไปจะเปิดใช้ทั้งการเพิ่มประสิทธิภาพโค้ดและทรัพยากร และไม่กำหนดให้คุณต้องระบุไฟล์กฎการเก็บรักษาเริ่มต้นของ Android (proguard-android-optimize.txt) อย่างชัดเจน เนื่องจากไฟล์ดังกล่าวรวมอยู่โดยค่าเริ่มต้น เว้นแต่จะละเว้นไว้อย่างชัดเจน

Kotlin

android {
    buildTypes {
        release {
            optimization {
                enable = true // Enables code and resource optimizations.
            }
        }
    }
}

ดึงดูด

android {
    buildTypes {
        release {
            optimization {
                enable = true // Enables code and resource optimizations.
            }
        }
    }
}

ละเว้นกฎการเก็บรักษาเริ่มต้นของแพลตฟอร์ม Android (ขั้นสูง)

AGP มีชุดกฎแพลตฟอร์ม Android เริ่มต้น หากต้องการละเว้นกฎเหล่านี้จากการกำหนดค่าของโปรเจ็กต์และจัดการกฎการเก็บรักษาทั้งหมดด้วยตนเอง ให้ตั้งค่า optimization.keepRules.includeDefault เป็น false

Kotlin

android {
    buildTypes {
        release {
            optimization {
                enable = true // Enables code and resource optimizations.
                keepRules {
                    includeDefault = false // The file with optimization
                    // rules for the Android platform is included by
                    // default. To omit this file, set this option to false.
                }
            }
        }
    }
}

ดึงดูด

android {
    buildTypes {
        release {
            optimization {
                enable = true // Enables code and resource optimizations.
                keepRules {
                    includeDefault = false // The file with optimization
                    // rules for the Android platform is included by
                    // default. To omit this file, set this option to false.
                }
            }
        }
    }
}

DSL เดิมสำหรับ AGP เวอร์ชันต่ำกว่า 9.3

เพิ่มกฎลงในไฟล์ proguard-rules.pro ที่อยู่ในไดเรกทอรีรากของโมดูลแอป ไฟล์อาจมีอยู่แล้ว แต่หากไม่มี ให้สร้างขึ้น หากต้องการใช้กฎในไฟล์ คุณต้องประกาศไฟล์ในไฟล์ build.gradle.kts (หรือ build.gradle) ระดับโมดูล

โดยค่าเริ่มต้น ไฟล์บิลด์จะมีไฟล์ proguard-android-optimize.txt ด้วย ไฟล์นี้มีกฎที่จำเป็นสำหรับโปรเจ็กต์ Android ส่วนใหญ่ ดังนั้นคุณควรปล่อยให้อยู่ในไฟล์บิลด์ ไฟล์นี้อิงตามและแชร์เนื้อหากับไฟล์ proguard-common.txt

DSL เดิม (Kotlin)

android {
    buildTypes {
        release {
            isMinifyEnabled = true
            isShrinkResources = true

            proguardFiles(
                // Default file with default optimization rules.
                getDefaultProguardFile("proguard-android-optimize.txt"),
                ...
            )
        }
    }
}

DSL เดิม (Groovy)

android {
    buildTypes {
        release {
            minifyEnabled = true
            shrinkResources = true

            // Default file with default optimization rules.
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt')
            ...
        }
    }
}

เพิ่มกฎการเก็บรักษา

เมื่อเพิ่มกฎการเก็บรักษา คุณสามารถรวมตัวเลือกส่วนกลางและกำหนดกฎการเก็บรักษาของคุณเองได้

  • ตัวเลือกส่วนกลาง: ตัวเลือกส่วนกลางคือคำสั่งทั่วไปที่ส่งผลต่อวิธีที่ R8 ทำงานกับฐานของโค้ดทั้งหมด ดูข้อมูลเพิ่มเติมได้ที่ตัวเลือกส่วนกลาง

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

กฎการเก็บรักษาสำหรับผู้เขียนไลบรารี

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