ตั้งค่าผู้จัดส่ง

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

ประกาศ NavigationEventDispatcher

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

คุณควรระบุอินสแตนซ์ NavigationEventDispatcher ผ่าน NavigationEventDispatcherOwner วิธีนี้ช่วยให้ส่วนต่างๆ ของแอปเข้าถึงโปรแกรมจ่ายงานเดียวกันและสังเกตเหตุการณ์การนําทางได้อย่างสอดคล้องและสอดประสานกัน

class MyComponent: NavigationEventDispatcherOwner {
    override val navigationEventDispatcher: NavigationEventDispatcher =
        NavigationEventDispatcher()
}

หากคุณอยู่ใน ComponentActivity คุณสามารถเรียกข้อมูลที่จัดเตรียมไว้ให้คุณแทนการใช้ตัวจ่ายของคุณเอง

class MyCustomActivity : ComponentActivity() {
    fun addMyHandler() {
        // navigationEventDispatcher provided by the ComponentActivity
        navigationEventDispatcher.addHandler(myNavigationEventHandler)
    }
}

เพิ่ม NavigationEventInput

เมื่อลงทะเบียนเครื่องจัดการแล้ว คุณก็พร้อมรับเหตุการณ์ อย่างไรก็ตาม คุณต้องระบุแหล่งที่มาที่สร้างเหตุการณ์ด้วย NavigationEventInput

NavigationEventInput เป็นคอมโพเนนต์เฉพาะแพลตฟอร์มที่รับอินพุตระบบดิบและแปลเป็น NavigationEvent มาตรฐานเพื่อส่งไปยัง NavigationEventDispatcher

ตัวอย่างต่อไปนี้เป็นการติดตั้งใช้งาน NavigationEventInput ที่กำหนดเอง

public class MyInput : NavigationEventInput() {
    @MainThread
    public fun backStarted(event: NavigationEvent) {
        dispatchOnBackStarted(event)
    }

    @MainThread
    public fun backProgressed(event: NavigationEvent) {
        dispatchOnBackProgressed(event)
    }

    @MainThread
    public fun backCancelled() {
        dispatchOnBackCancelled()
    }

    @MainThread
    public fun backCompleted() {
        dispatchOnBackCompleted()
    }
}

จากนั้นระบุข้อมูลดังกล่าวให้กับผู้มอบหมายงาน ดังนี้

navigationEventDispatcher.addInput(MyInput())

ล้างทรัพยากรด้วย dispose()

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

navigationEventDispatcher.dispose()

เมธอด dispose() ช่วยให้มั่นใจได้ว่าจะมีการล้างข้อมูลแบบเรียงซ้อนโดยการนำผู้จัดส่งและผู้สืบทอดทั้งหมด (รายการย่อยและรายการย่อยของรายการย่อย) ออกซ้ำๆ เพื่อรับประกันว่าระบบจะยกเลิกการลงทะเบียนแฮนเดิลที่เกี่ยวข้องทั้งหมดจากระบบที่ใช้ร่วมกัน

ลำดับชั้นและการควบคุมของ Dispatcher

NavigationEventDispatcher รองรับลำดับชั้นแบบหลัก-ย่อย ซึ่งช่วยให้คอมโพเนนต์ที่ฝังอยู่ลึกภายใน UI (เช่น NavHost หรือกล่องโต้ตอบที่ฝังอยู่) มีส่วนร่วมในการจัดการเหตุการณ์การนำทางได้

สร้างผู้มอบหมายงานย่อย

ระบบจะสร้างผู้จัดส่งย่อยโดยส่งการอ้างอิงไปยังผู้จัดส่งหลักในระหว่างการสร้าง ผู้จัดส่งทั้งหมดในลำดับชั้นจะใช้ NavigationEventProcessor เดียวกันเพื่อรักษาการจัดลำดับเหตุการณ์แบบ Last-In, First-Out (LIFO) ทั่วโลกตามลำดับความสำคัญ

การเปิดใช้แบบลำดับชั้น

ผู้มอบหมายงานมีพร็อพเพอร์ตี้ isEnabled ที่ช่วยให้นักพัฒนาแอปเปิดหรือปิดใช้โครงสร้างย่อยทั้งหมดของแฮนเดิลได้พร้อมกัน

เมื่อปิดใช้ผู้มอบหมายงานหลัก (isEnabled = false) ระบบจะไม่สนใจแฮนเดิลทั้งหมดที่เชื่อมโยงกับหลักนั้นและรายการย่อยใดๆ โดยไม่คำนึงถึงสถานะที่เปิดใช้แต่ละรายการ