Начиная с версии 1.2.0 Navigation 3 поддерживает ссылки на контент в приложении с помощью классов DeepLinkRequest и DeepLinkMatcher.
Чтобы добавить в приложение поддержку ссылок на контент, выполните следующие действия:
- Определите фильтры интентов в файле
AndroidManifest.xml, чтобы указать, какие URI может обрабатывать ваше приложение. - Создайте экземпляры
DeepLinkMatcher, чтобы сопоставить входящие запросы с ключами навигации. - Сопоставляйте входящие запросы в методе
onCreateилиonNewIntentобъекта activity и обновляйте обратный стек.
Создать 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 и DSL requestExtras.
Кроме того, библиотека предоставляет два дополнительных ключа и связанные с ними вспомогательные функции:
MimeTypeExtrasKey– используется для хранения MIME-типаString.ActionExtrasKey(только для Android) – используется для хранения действияStringIntent.
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 вы можете создать DeepLinkRequest прямо из Intent. В этом случае DeepLinkRequest создается следующим образом:
- Значение
uriкопируется из поляdataнамерения. - Если значение не равно null, 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 для создания синтетических обратных стеков. Библиотека также поддерживает пользовательские сопоставители для случаев, не охваченных встроенными сопоставителями.
Подробнее о том, как создать DeepLinkMatcher…
Добавьте фильтры интентов
Чтобы ссылка на контент запускала действие, необходимо определить соответствующие элементы <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) } } }