วิธีการ

จัดส่งกฎการเก็บรักษาที่ชาญฉลาดยิ่งขึ้น: วิธีที่ผู้ให้บริการไลบรารีสามารถเลิกบล็อกการเพิ่มประสิทธิภาพโค้ด DEX ระดับแอป

ใช้เวลาอ่าน 6 นาที
ดูโปรไฟล์ของ Breana Tate
Breana Tate วิศวกรนักพัฒนาซอฟต์แวร์สัมพันธ์

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

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

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

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

กฎการเก็บรักษาของผู้บริโภคคืออะไร

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

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

การรักษาสมดุลระหว่างความเสถียรและประสิทธิภาพ

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

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

1. การทดสอบและการเปิดตัวกฎแบบแคบ

โปรดพิจารณาแนวทางปฏิบัติแนะนำต่อไปนี้เพื่อช่วยให้คุณเผยแพร่กฎที่แคบได้อย่างมั่นใจ

  • ทดสอบในแอปตัวอย่าง: คำแนะนำในการทดสอบในเครื่องที่ทดสอบการเพิ่มประสิทธิภาพใช้กับแอปตัวอย่างได้ด้วย หลังจากเปิดใช้ R8 แล้ว ให้ทดสอบเส้นทางของผู้ใช้ที่สำคัญเพื่อให้แน่ใจว่าฟังก์ชันการทำงานเป็นไปตามที่คาดไว้
  • เรียกใช้เครื่องมือวิเคราะห์การกำหนดค่า R8 ในแอปตัวอย่างเพื่อดูสิ่งที่นักพัฒนาแอปเห็นเมื่อตรวจสอบการกำหนดค่า R8 ซึ่งจะช่วยให้คุณเห็นภาพผลกระทบของกฎการเก็บรักษาที่มีต่อแอปปลายทางได้อย่างง่ายดาย
  • ใช้คำสั่ง analyze จาก Android CLI เพื่อประเมินการเพิ่มประสิทธิภาพของ AAR หรือ JAR ซึ่งรวมถึงเมธอด คลาส และฟิลด์ที่เก็บไว้ คุณสามารถเปรียบเทียบตัวเลขเหล่านี้ในรุ่นต่างๆ เพื่อตรวจสอบการถดถอยได้
  • ตรวจสอบการใช้งานเวอร์ชันไลบรารีและข้อขัดข้องใน Google Play SDK Console
  • ดูคำแนะนำเกี่ยวกับการเพิ่มประสิทธิภาพสำหรับผู้เขียนไลบรารีและเอกสารประกอบ R8 เพื่อดูแนวทางปฏิบัติแนะนำ

2. การเก็บรักษาเป้าหมายการสะท้อนและ JNI โดยไม่มีกฎการเก็บแบบกว้าง

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

หาก SDK กำหนดเป้าหมายเป็นโค้ดแบบเนทีฟ เช่น โค้ดในเกมหรือโปรแกรมแก้ไขรูปภาพและวิดีโอ ให้ระบุกฎสำหรับคลาสทั้งหมดที่ใช้ JNI เกมส่วนใหญ่ทำงานบนเกมเอนจิน เช่น Unity และ Unreal ซึ่งจะคอมไพล์เกมเป็นโค้ดแบบเนทีฟ โค้ดแบบเนทีฟของเกมและปลั๊กอินจะสื่อสารกับเฟรมเวิร์ก Android ผ่านการเรียก JNI

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

พิจารณาการสร้างโค้ดแทนการใช้ Reflection

เพื่อหลีกเลี่ยงข้อขัดข้องที่เกิดจาก Reflection เคล็ดลับที่สำคัญที่สุดของเราคือการหลีกเลี่ยง Reflection และใช้ codegen หากเป็นไปได้ 

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

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

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

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

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

กำหนดขอบเขตของกฎการเก็บรักษาให้แคบลงสำหรับการขึ้นต่อกันของบุคคลที่สาม

รูปแบบที่พบได้บ่อยมีดังนี้

-keep public class com.google.android.gms.** { *; }

หากแอปที่ผสานรวม SDK ของคุณใช้ไลบรารี GMS อื่นด้วย และมีกฎ Keep เพื่อจำกัดจำนวนโค้ดที่เก็บไว้ กฎแบบกว้างนี้จะมีผลแทนกฎ Keep ซึ่งส่งผลให้แอปมีขนาดใหญ่เกินความจำเป็น 

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

พิจารณากฎการเก็บรักษาแบบมีเงื่อนไขสำหรับอะแดปเตอร์สื่อกลางโฆษณา 

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

จัดส่งกฎในกฎสำหรับผู้บริโภค ไม่ใช่เอกสารประกอบ

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

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

3. กำลังอ่านสแต็กเทรซของรุ่น

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

คุณไม่จำเป็นต้องป้องกันการเพิ่มประสิทธิภาพเพิ่มเติมเพื่อให้ได้สแต็กเทรซที่อ่านได้

Firebase Crashlytics, Play Console และ Logcat ใน Android Studio จะถอดรหัสสแต็กเทรซให้แก่นักพัฒนาแอป ซึ่งหมายความว่าหากนักพัฒนาแอปแชร์สแต็กเทรซกับคุณ คุณไม่จำเป็นต้องป้องกันการสร้างความสับสนเพื่อให้อ่านได้

หากอัปโหลดไฟล์การแมปไปยัง SDK Console คุณจะดูสแต็กเทรซที่ถอดรหัสซอร์สโค้ดที่สร้างความสับสนได้ใน SDK Console

หมดกังวลเรื่องการเพิ่มประสิทธิภาพ

การเพิ่มประสิทธิภาพคลังไม่ควรเป็นเรื่องที่ต้องลองผิดลองถูก

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

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

เขียนโดย
อ่านต่อ