การนำทางสำหรับโปรเจ็กต์แบบหลายโมดูล

กราฟการนําทางอาจประกอบด้วยชุดค่าผสมต่อไปนี้

  • ปลายทางเดียว เช่น ปลายทาง <fragment>
  • กราฟที่ฝังซึ่งรวมชุดปลายทางที่เกี่ยวข้องไว้ด้วยกัน
  • องค์ประกอบ <include> ซึ่งช่วยให้คุณฝังไฟล์กราฟการนําทางอื่นได้เหมือนกับว่าซ้อนกันอยู่

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

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

กราฟทรัพยากร Dependency สำหรับแอปพลิเคชันแบบหลายโมดูลตัวอย่าง
ปลายทางเริ่มต้นของแอปตัวอย่าง
รูปที่ 1 สถาปัตยกรรมแอปและปลายทางเริ่มต้น สำหรับแอปตัวอย่าง

โมดูลฟีเจอร์แต่ละโมดูลเป็นหน่วยที่สมบูรณ์ในตัวเองซึ่งมีกราฟการนำทางและปลายทางของตัวเอง โมดูล app จะขึ้นอยู่กับแต่ละโมดูล โดยเพิ่มเป็นรายละเอียดการติดตั้งใช้งานในไฟล์ build.gradle ดังที่แสดงต่อไปนี้

ดึงดูด

dependencies {
    ...
    implementation project(":feature:home")
    implementation project(":feature:favorites")
    implementation project(":feature:settings")

Kotlin

dependencies {
    ...
    implementation(project(":feature:home"))
    implementation(project(":feature:favorites"))
    implementation(project(":feature:settings"))

บทบาทของโมดูล app

โมดูล app มีหน้าที่จัดทำกราฟที่สมบูรณ์สำหรับแอปและเพิ่ม NavHost ลงใน UI ภายในกราฟการนำทางของโมดูล app คุณสามารถอ้างอิงกราฟไลบรารีได้โดยใช้ <include> แม้ว่าการใช้ <include> จะมีฟังก์ชันการทำงานเหมือนกับการใช้กราฟที่ฝัง แต่ <include> รองรับกราฟจากโมดูลโปรเจ็กต์อื่นๆ หรือจากโปรเจ็กต์ไลบรารี ดังที่แสดงในตัวอย่างต่อไปนี้

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/nav_graph"
    app:startDestination="@id/home_nav_graph">

    <include app:graph="@navigation/home_navigation" />
    <include app:graph="@navigation/favorites_navigation" />
    <include app:graph="@navigation/settings_navigation" />
</navigation>

เมื่อรวมไลบรารีไว้ในกราฟการนําทางระดับบนสุดแล้ว คุณจะไปยังกราฟไลบรารีได้ตามต้องการ ตัวอย่างเช่น คุณสามารถสร้างการดำเนินการเพื่อไปยังกราฟการตั้งค่าจากส่วนย่อยในกราฟการนำทาง ดังที่แสดงต่อไปนี้

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/nav_graph"
    app:startDestination="@id/home_nav_graph">

    <include app:graph="@navigation/home_navigation" />
    <include app:graph="@navigation/favorites_navigation" />
    <include app:graph="@navigation/settings_navigation" />

    <fragment
        android:id="@+id/random_fragment"
        android:name="com.example.android.RandomFragment"
        android:label="@string/fragment_random" >
        <!-- Launch into Settings Navigation Graph -->
        <action
            android:id="@+id/action_random_fragment_to_settings_nav_graph"
            app:destination="@id/settings_nav_graph" />
    </fragment>
</navigation>

เมื่อโมดูลฟีเจอร์หลายโมดูลต้องอ้างอิงชุดปลายทางที่ใช้ร่วมกัน เช่น กราฟการเข้าสู่ระบบ คุณไม่ควรรวมปลายทางที่ใช้ร่วมกันเหล่านั้นไว้ในกราฟการนำทางของโมดูลฟีเจอร์แต่ละโมดูล แต่ให้เพิ่มปลายทางที่พบบ่อยเหล่านั้นลงในกราฟการนําทางของโมดูล app แทน จากนั้นโมดูลฟีเจอร์แต่ละรายการจะไปยังส่วนต่างๆ ของโมดูลฟีเจอร์เพื่อไปยังปลายทางทั่วไปเหล่านั้นได้

ในตัวอย่างก่อนหน้านี้ การดำเนินการจะระบุปลายทางการนำทางเป็น @id/settings_nav_graph รหัสนี้อ้างอิงถึงปลายทางที่กำหนดไว้ภายในกราฟ @navigation/settings_navigation. ที่รวมอยู่

การนำทางระดับบนสุดในโมดูลแอป

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

ในรูปที่ 2 โมดูล app ตัวอย่างจะกำหนด BottomNavigationView ในกิจกรรมหลัก รหัสรายการเมนูในเมนูตรงกับรหัสกราฟการนําทางของกราฟไลบรารี ดังนี้

<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">

    <item
        android:id="@id/home_nav_graph"
        android:icon="@drawable/ic_home"
        android:title="Home"
        app:showAsAction="ifRoom"/>

    <item
        android:id="@id/favorites_nav_graph"
        android:icon="@drawable/ic_favorite"
        android:title="Favorites"
        app:showAsAction="ifRoom"/>

    <item
        android:id="@id/settings_nav_graph"
        android:icon="@drawable/ic_settings"
        android:title="Settings"
        app:showAsAction="ifRoom" />
</menu>

หากต้องการให้ NavigationUI จัดการแถบการไปยังส่วนต่างๆ ด้านล่าง ให้เรียก setupWithNavController จาก onCreate ในคลาสกิจกรรมหลัก ดังตัวอย่างต่อไปนี้

Kotlin

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
    val navHostFragment =
        supportFragmentManager.findFragmentById(R.id.nav_host_fragment) as NavHostFragment
    val navController = navHostFragment.navController

    findViewById<BottomNavigationView>(R.id.bottom_nav)
            .setupWithNavController(navController)
}

Java

@Override
protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.activity_main);
    NavHostFragment navHostFragment =
            (NavHostFragment) supportFragmentManager.findFragmentById(R.id.nav_host_fragment);
    NavController navController = navHostFragment.getNavController();
    BottomNavigationView bottomNav = findViewById(R.id.bottom_nav);

    NavigationUI.setupWithNavController(bottomNav, navController);
}

เมื่อมีโค้ดนี้ NavigationUI จะไปยังกราฟไลบรารีที่เหมาะสมเมื่อผู้ใช้คลิกรายการในแถบการไปยังส่วนต่างๆ ด้านล่าง

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

การไปยังส่วนต่างๆ ของโมดูลฟีเจอร์

ในเวลาคอมไพล์ โมดูลฟีเจอร์อิสระจะมองไม่เห็นกันและกัน คุณจึงใช้รหัสเพื่อไปยังปลายทางในโมดูลอื่นๆ ไม่ได้ แต่ให้ใช้ Deep Link เพื่อไปยังปลายทางที่เชื่อมโยงกับ Implicit Deep Link โดยตรงแทน

จากตัวอย่างก่อนหน้านี้ สมมติว่าคุณต้องไปยังส่วนต่างๆ จากปุ่มในโมดูล :feature:home ไปยังปลายทางที่ฝังอยู่ในโมดูล :feature:settings ซึ่งทำได้โดยเพิ่ม Deep Link ไปยังปลายทางในกราฟการนำทางของการตั้งค่า ดังที่แสดงต่อไปนี้

<?xml version="1.0" encoding="utf-8"?>
<navigation xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:id="@+id/settings_nav_graph"
    app:startDestination="@id/settings_fragment_one">

    ...

    <fragment
        android:id="@+id/settings_fragment_two"
        android:name="com.example.google.login.SettingsFragmentTwo"
        android:label="@string/settings_fragment_two" >

        <deepLink
            app:uri="android-app://example.google.app/settings_fragment_two" />
    </fragment>
</navigation>

จากนั้นเพิ่มโค้ดต่อไปนี้ลงใน onClickListener ของปุ่มในส่วนย่อยของหน้าแรก

Kotlin

button.setOnClickListener {
    val request = NavDeepLinkRequest.Builder
        .fromUri("android-app://example.google.app/settings_fragment_two".toUri())
        .build()
    findNavController().navigate(request)
}

Java

button.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {
        NavDeepLinkRequest request = NavDeepLinkRequest.Builder
            .fromUri(Uri.parse("android-app://example.google.app/settings_fragment_two"))
            .build();
        NavHostFragment.findNavController(this).navigate(request);
    }
});

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

เมื่อไปยังส่วนต่างๆ โดยใช้ URI ระบบจะไม่รีเซ็ต Back Stack ลักษณะการทำงานนี้แตกต่างจากการไปยังส่วนต่างๆ ของ Explicit Deep Link ซึ่งระบบจะแทนที่ Back Stack เมื่อไปยังส่วนต่างๆ