از نسخه ۱.۲.۰، «ناوبری ۳» از پیوند عمیق به
مقصدهای درون برنامه شما بااستفاده از کلاسهای DeepLinkRequest و
DeepLinkMatcher پشتیبانی میکند.
برای پشتیبانی از پیوندهای عمیق در برنامهتان، مراحل زیر را تکمیل کنید:
- فیلترهای قصد را در
AndroidManifest.xmlتعریف کنید تا مشخص شود برنامهتان کدام URI را میتواند مدیریت کند. - نمونههای
DeepLinkMatcherرا ایجاد کنید تا درخواستهای ورودی را به کلیدهای پیمایش خود نگاشت کنید. - درخواستهای ورودی را در روش
onCreateیاonNewIntentفعالیتتان مطابقت دهید و پشته قبلیها را براساس آن بهروز کنید.
ایجاد DeepLinkRequest
DeepLinkRequest نشاندهنده پیوند عمیق ورودی است. این شامل یک
DeepLinkUri و RequestExtras اختیاری با اطلاعات
اضافی، مانند اقدام هدف یا نوع MIME است.
// Create a request with a String URI val request = DeepLinkRequest(uri = "https://www.example.com/home") // Create a request from a DeepLinkUri val deepLinkUri = DeepLinkUri("https://www.example.com/home") val requestFromUri = DeepLinkRequest(uri = deepLinkUri) // Create a request with a URI and action val requestWithAction = DeepLinkRequest( uri = "https://www.example.com/home", extras = DeepLinkRequest.actionExtra("android.intent.action.VIEW") ) // Create a request with URI, action and mimeType val requestWithMimeType = DeepLinkRequest( uri = "https://www.example.com/image", extras = requestExtras { put(DeepLinkRequest.ActionExtrasKey, "android.intent.action.VIEW") put(DeepLinkRequest.Companion.MimeTypeExtrasKey, "image/png") } )
ارائه DeepLinkRequest مورد اضافی
برای ذخیره کردن اطلاعات تکمیلی مربوط به لینک عمیق، از کلاس
RequestExtras استفاده کنید. برای اینکه تعریف و نمونهسازی موارد اضافی ازنظر نوع ایمن باشد،
کتابخانه میانای RequestExtrasKey و
requestExtras DSL را ارائه میدهد.
علاوهبراین، کتابخانه دو کلید اضافی و کمکافزارهای مرتبط ارائه میدهد:
MimeTypeExtrasKey: برای ذخیره نوع MIMEStringاستفاده میشود.ActionExtrasKey(فقط Android): برای ذخیره کردن کنشIntentStringاستفاده میشود.
val extras: RequestExtras = requestExtras { put(DeepLinkRequest.Companion.MimeTypeExtrasKey, "application/json") put(DeepLinkRequest.ActionExtrasKey, Intent.ACTION_VIEW) } // Access typed values using the get operator val mimeType: String? = extras[DeepLinkRequest.Companion.MimeTypeExtrasKey] val action: String? = extras[DeepLinkRequest.ActionExtrasKey] // Create extras using helper functions and combine them val mimeTypeExtras: RequestExtras = DeepLinkRequest.mimeTypeExtra("application/json") val combinedExtras: RequestExtras = extras + DeepLinkRequest.actionExtra(Intent.ACTION_VIEW)
برای تعریف کردن موارد اضافی سفارشی خودتان، میانای RequestExtrasKey را با نوع عمومی پیادهسازی کنید:
// Define a custom typed key: object CampaignIdExtrasKey : RequestExtrasKey<String> val customExtras: RequestExtras = requestExtras { put(CampaignIdExtrasKey, "123") } val campaignId: String? = customExtras[CampaignIdExtrasKey]
همچنین میتوانید از emptyRequestExtras() برای ساختن نمونه خالی استفاده کنید، یا
بااستفاده از عملگرهای + (plus) و - (minus)، موارد اضافی را ترکیب کنید.
ایجاد DeepLinkRequest از Intent
در Android، میتوانید مستقیماً از Intent، DeepLinkRequest ایجاد کنید. وقتی
به این روش ساخته شود، DeepLinkRequest بهصورت زیر ساخته میشود:
-
uriاز فیلدdataقصد کپی میشود. - اگر تهی نباشد، نوع MIME و موارد اضافی کنش از فیلدهای هدف مربوطه تنظیم میشود.
- همه
intent.extrasبا مقادیر غیرتهی بهعنوانSavedStateدرDeepLinkRequest.IntentExtrasKeyذخیره میشوند. - هرگونه موارد اضافی که بااستفاده از پارامتر
extrasارائه شده باشد اضافه میشود.
object CampaignIdExtrasKey : RequestExtrasKey<String> val intent = Intent(Intent.ACTION_VIEW).apply { data = Uri.parse("https://www.example.com/item/42") type = "application/json" putExtra("user_id", "123") } val request = DeepLinkRequest( intent = intent, extras = requestExtras { put(CampaignIdExtrasKey, "spring_promo") } ) // The resulting DeepLinkRequest contains: val uri = request.uri // "https://www.example.com/item/42" val action = request.extras[DeepLinkRequest.ActionExtrasKey] // "android.intent.action.VIEW" val mimeType = request.extras[DeepLinkRequest.Companion.MimeTypeExtrasKey] // "application/json" val intentExtras: SavedState? = request.extras[DeepLinkRequest.IntentExtrasKey] val userId: String? = intentExtras?.read { getStringOrNull("user_id") } // "123" val campaignId: String? = request.extras[CampaignIdExtrasKey] // "spring_promo"
ایجاد کردن DeepLinkMatcher نمونه
DeepLinkMatcher نمونههای ورودی DeepLinkRequest را به کلیدهای پیمایش که میتوانند به پشته قبلیها برنامه شما اضافه شوند نگاشت میکند. Navigation 3
سه تطبیقدهنده داخلی ارائه میدهد: UriDeepLinkMatcher برای
تطبیق URI مبتنی بر الگو، StaticKeyDeepLinkMatcher برای پیوندهای پایه، و
BackStackMatcher برای ساخت پشتههای قبلیها مصنوعی. این کتابخانه همچنین از تطبیقدهندههای سفارشی برای موارد استفادهای که تطبیقدهندههای داخلی پوشش نمیدهند پشتیبانی میکند.
برای اطلاعات بیشتر، ایجاد DeepLinkMatchers را ببینید.
افزودن فیلترهای قصد
برای فعال کردن پیوند عمیق برای شروع فعالیتتان، باید عناصر <intent-filter> منطبق را در AndroidManifest.xml برنامهتان تعریف کنید. برای اطلاعات بیشتر،
افزودن فیلترهای قصد برای پیوندهای ورودی را ببینید.
مطابقت دادن درخواست ورودی
پساز ایجاد نمونههای DeepLinkMatcher، میتوانید درخواستهای ورودی را در فعالیتتان مطابقت دهید.
برای مطابقت دادن درخواست ورودی، مراحل زیر را تکمیل کنید:
- نمونههای
DeepLinkMatcherخود را نمونهسازی کنید. - همه نمونههای
DeepLinkMatcherرا بهطور صریح یا بااستفاده از اتصال چندگانه مقایسه کنید. - ایجاد
DeepLinkRequestازIntentورودی. - درخواست را با همه مطابقتدهندهها مطابقت میدهد و بهترین مطابقت را پیدا میکند.
- پشته قبلیها را از نتیجه مطابقت ایجاد کنید.
// 1. Instantiate your DeepLinkMatcher instances. val homeMatcher = StaticKeyDeepLinkMatcher(HomeKey, listOf(DeepLinkMatcher.actionFilter(Intent.ACTION_VIEW))) val userProfileMatcher = UriDeepLinkMatcher( DeepLinkUri("www.example.com/users/{id}"), serializer<UserProfileKey>() ).withBackStack { matchResult -> listOf(HomeKey, matchResult.key) } val telMatcher = TelDeepLinkMatcher() // 2. Collate all of your DeepLinkMatcher instances. // Note: Collating matchers with different generic types requires wildcards, // erasing the specific generic types. val deepLinkMatchers: List<DeepLinkMatcher<*, *>> = listOf( homeMatcher, userProfileMatcher, telMatcher ) class MainActivity : ComponentActivity() { override fun onCreate(savedInstanceState: Bundle?) { super.onCreate(savedInstanceState) // ... // 3. Create a DeepLinkRequest from the incoming Intent val request = DeepLinkRequest(intent = intent) // 4. Match the request against all matchers and find the best match. // Because DeepLinkMatcher.MatchResult implements Comparable, you can // use maxOrNull() to find the best match. val matchResult = deepLinkMatchers .mapNotNull { it.match(request) } // List<DeepLinkMatcher.MatchResult<*>> .maxOrNull() // DeepLinkMatcher.MatchResult<*>? // 5. Create the back stack from the match result (or fall back to a default). val backStack: List<NavKey> = when (matchResult) { // If no match is found, use the default back stack (e.g., HomeKey) null -> listOf(HomeKey) // If a BackStackMatchResult is found, use the back stack from the result is BackStackMatchResult<*, *> -> { // Because star-projected matchers erase the key type, cast the back stack to List<NavKey>. @Suppress("UNCHECKED_CAST") matchResult.backStack as List<NavKey> } // Otherwise, use the key from the match result to make a single-item back stack else -> listOf(matchResult.key as NavKey) } } }