แยกโค้ดการนำทางออกเป็นโมดูล

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

ภาพรวม

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

หากต้องการแยกโค้ดการนําทางเป็นโมดูล ให้ทําดังนี้

• สร้างโมดูลย่อย 2 โมดูล ได้แก่ api และ impl สำหรับแต่ละฟีเจอร์ในแอป
• วางคีย์การนำทางสำหรับแต่ละฟีเจอร์ลงในโมดูล api
• วาง entryProviders และเนื้อหาที่ไปยังส่วนต่างๆ ได้สำหรับแต่ละฟีเจอร์ลงในโมดูล impl ที่เกี่ยวข้อง
• ระบุ entryProviders ให้กับโมดูลแอปหลัก ไม่ว่าจะโดยตรงหรือใช้ Dependency Injection

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

แยกฟีเจอร์ออกเป็นโมดูลย่อย API และการติดตั้งใช้งาน

สำหรับแต่ละฟีเจอร์ในแอป ให้สร้างโมดูลย่อย 2 โมดูลชื่อ api และ impl (ย่อมาจาก "implementation") ใช้ตารางต่อไปนี้เพื่อตัดสินใจว่าจะวางโค้ดการนําทางไว้ที่ใด

ชื่อโมดูล	มี
api	แป้นนำทาง
impl	เนื้อหาสำหรับฟีเจอร์ดังกล่าว รวมถึงคำจำกัดความของ NavEntry และ entryProvider รวมถึงการจับคู่คีย์กับเนื้อหา

วิธีนี้ช่วยให้ฟีเจอร์หนึ่งไปยังอีกฟีเจอร์หนึ่งได้โดยอนุญาตให้เนื้อหาที่อยู่ในโมดูล impl ของฟีเจอร์นั้นขึ้นอยู่กับคีย์การนำทางของอีกโมดูลหนึ่งที่อยู่ในโมดูล api ของโมดูลนั้น

รูปที่ 1 แผนภาพทรัพยากร Dependency ของโมดูลฟีเจอร์ที่แสดงให้เห็นว่าโมดูลการติดตั้งใช้งานสามารถขึ้นอยู่กับโมดูล API ได้อย่างไร

แยกรายการการนำทางโดยใช้ฟังก์ชันส่วนขยาย

ใน Navigation 3 เนื้อหาที่ไปยังส่วนต่างๆ ได้จะกำหนดโดยใช้รายการการนำทาง หากต้องการแยกรายการเหล่านี้ออกเป็นโมดูลแยกต่างหาก ให้สร้างฟังก์ชันส่วนขยายใน EntryProviderScope แล้วย้ายไปยังโมดูล impl สำหรับฟีเจอร์นั้น ซึ่งเรียกว่าเครื่องมือสร้างรายการ

ตัวอย่างโค้ดต่อไปนี้แสดงเครื่องมือสร้างรายการที่สร้างรายการการนำทาง 2 รายการ

// import androidx.navigation3.runtime.EntryProviderScope
// import androidx.navigation3.runtime.NavKey

fun EntryProviderScope<NavKey>.featureAEntryBuilder() {
    entry<KeyA> {
        ContentRed("Screen A") {
            // Content for screen A
        }
    }
    entry<KeyA2> {
        ContentGreen("Screen A2") {
            // Content for screen A2
        }
    }
}
ModularizationSnippets.kt

เรียกใช้ฟังก์ชันดังกล่าวโดยใช้ entryProvider DSL เมื่อกำหนด entryProvider ในโมดูลแอปหลัก

// import androidx.navigation3.runtime.entryProvider
// import androidx.navigation3.ui.NavDisplay
NavDisplay(
    entryProvider = entryProvider {
        featureAEntryBuilder()
    },
    // ...
)
ModularizationSnippets.kt

ใช้การแทรกทรัพยากร Dependency เพื่อเพิ่มรายการลงในแอปหลัก

ในตัวอย่างโค้ดก่อนหน้านี้ แอปหลักจะเรียกใช้ Entry Builder แต่ละรายการโดยตรงโดยใช้ DSL entryProvider หากแอปมีหน้าจอหรือโมดูลฟีเจอร์จำนวนมาก รูปแบบนี้อาจปรับขนาดได้ไม่ดีนัก

วิธีแก้ปัญหานี้คือให้โมดูลฟีเจอร์แต่ละโมดูลส่งตัวสร้างรายการไปยังกิจกรรมของแอปโดยใช้การแทรกทรัพยากร Dependency

ตัวอย่างเช่น โค้ดต่อไปนี้ใช้ Dagger multibindings โดยเฉพาะ @IntoSet เพื่อแทรก Entry Builder ลงใน Set ที่ MainActivity เป็นเจ้าของ จากนั้นระบบจะเรียกใช้ฟังก์ชันเหล่านี้ซ้ำๆ ภายใน entryProvider ซึ่งช่วยลดความจำเป็นในการเรียกใช้ฟังก์ชัน Entry Builder จำนวนมากอย่างชัดเจน

โมดูลฟีเจอร์

// import dagger.Module
// import dagger.Provides
// import dagger.hilt.InstallIn
// import dagger.hilt.android.components.ActivityRetainedComponent
// import dagger.multibindings.IntoSet

@Module
@InstallIn(ActivityRetainedComponent::class)
object FeatureAModule {

    @IntoSet
    @Provides
    fun provideFeatureAEntryBuilder() : EntryProviderScope<NavKey>.() -> Unit = {
        featureAEntryBuilder()
    }
}
ModularizationSnippets.kt

โมดูลแอป

// import android.os.Bundle
// import androidx.activity.ComponentActivity
// import androidx.activity.compose.setContent
// import androidx.navigation3.runtime.EntryProviderScope
// import androidx.navigation3.runtime.NavKey
// import androidx.navigation3.runtime.entryProvider
// import androidx.navigation3.ui.NavDisplay
// import javax.inject.Inject

class MainActivity : ComponentActivity() {

    @Inject
    lateinit var entryBuilders: Set<@JvmSuppressWildcards EntryProviderScope<NavKey>.() -> Unit>

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContent {
            NavDisplay(
                entryProvider = entryProvider {
                    entryBuilders.forEach { builder -> this.builder() }
                },
                // ...
            )
        }
    }
}
ModularizationSnippets.kt

หากรายการการนำทางจำเป็นต้องนำทาง เช่น มีองค์ประกอบ UI ที่นำทางไปยังหน้าจอใหม่ ให้แทรกออบเจ็กต์ที่สามารถแก้ไขสถานะการนำทางของแอปลงในฟังก์ชัน Builder แต่ละรายการ

แยกโมดูลตัวจับคู่ Deep Link

หากแอปของคุณรองรับ Deep Link และเป็นแบบโมดูลาร์ โมดูลฟีเจอร์แต่ละโมดูลควรกำหนดอินสแตนซ์ DeepLinkMatcher สำหรับปลายทางที่เป็นเจ้าของ

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

โมดูลฟีเจอร์

@Module
@InstallIn(ActivityRetainedComponent::class)
object FeatureADeepLinkModule {
    @IntoSet
    @Provides
    fun provideUserMatcher(): DeepLinkMatcher<*, *> {
        return UriDeepLinkMatcher(
            DeepLinkUri("www.example.com/users/{id}"),
            serializer<UserProfileKey>()
        )
    }
}
ModularizationSnippets.kt

จากนั้นในโมดูลแอปหลัก เช่น ใน MainActivity คุณสามารถแทรกชุด Matcher และใช้เพื่อจับคู่คำขอที่เข้ามาได้ ดังนี้

โมดูลแอป

@AndroidEntryPoint
class MainActivityWithDI : ComponentActivity() {
    @Inject
    lateinit var deepLinkMatchers: Set<@JvmSuppressWildcards DeepLinkMatcher<*, *>>

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        val request = DeepLinkRequest(intent = intent)
        val matchResult = deepLinkMatchers
            .mapNotNull { it.match(request) }
            .maxOrNull()

        val backStack = when (matchResult) {
            null -> listOf(HomeKey)
            is BackStackMatchResult<*, *> -> {
                @Suppress("UNCHECKED_CAST")
                matchResult.backStack as List<NavKey>
            }
            else -> listOf(matchResult.key)
        }
    }
}
ModularizationSnippets.kt

ดูข้อมูลเพิ่มเติมเกี่ยวกับการกำหนดและการจัดการ Deep Link ได้ที่รองรับ Deep Link

แหล่งข้อมูล

ดูตัวอย่างโค้ดที่แสดงวิธีแยกโค้ด Navigation 3 ออกเป็นโมดูลได้ที่หัวข้อต่อไปนี้

• สูตรโค้ดสถาปัตยกรรม Navigation 3
• เส้นทางการเรียนรู้เกี่ยวกับการแยกโมดูลจากแอป Now in Android
• Androidify