Improve the performance of NavGraph.equals()
When comparing two graphs, as few allocations should
be done as possible and the comparision should short
circuit as much as possible.
By adding if (this === other) checks, we can
short circuit the exact same objects.
By using NavDestination's private _arguments field
rather than the public, immutable copy provided by
arguments, we can avoid copying the arguments multiple
times. Since we check whether the size of the arguments
are the same, we can avoid iterating through both lists
since one list matching means they are identical.
We can use Kotlin's built in equals() for Lists to
compare deep links rather than using intersect() since
ordering *does* matter here when determining a matching
deep link.
NavGraph does not to create a copy of its children just
to remove them, we can instead just iterate through
each child and verify that the same child exists in the
other graph.
Relnote: "Greatly improved the performance (both in
terms of time and number of allocations) of comparing
two graph. This means that calls such as `setGraph`
which internally compare the new graph to the existing
one are much faster and result in fewer skipped frames."
Test: Benchmark improved (2k ns from 77k ns, 10 allocations from 1,324)
BUG: 307253895
(cherry picked from https://android-review.googlesource.com/q/commit:06f18f70d5bffa981332fee3ab0973d26c852828)
Merged-In: I6ad62bef1fb9bbbe8a91839a6e24e1f85a8982e2
Change-Id: I6ad62bef1fb9bbbe8a91839a6e24e1f85a8982e2
diff --git a/navigation/navigation-common/src/main/java/androidx/navigation/NavDestination.kt b/navigation/navigation-common/src/main/java/androidx/navigation/NavDestination.kt
index 73ebb3d..7409522 100644
--- a/navigation/navigation-common/src/main/java/androidx/navigation/NavDestination.kt
+++ b/navigation/navigation-common/src/main/java/androidx/navigation/NavDestination.kt
@@ -129,7 +129,7 @@
// the arguments must at least contain every argument stored in this deep link
if (!arguments.containsKey(key)) return false
- val type = destination.arguments[key]?.type
+ val type = destination._arguments[key]?.type
val matchingArgValue = type?.get(matchingArgs, key)
val entryArgValue = type?.get(arguments, key)
// fine if both argValues are null, i.e. arguments/params with nullable values
@@ -349,7 +349,7 @@
* @see NavController.navigate
*/
public fun addDeepLink(navDeepLink: NavDeepLink) {
- val missingRequiredArguments = arguments.missingRequiredArguments { key ->
+ val missingRequiredArguments = _arguments.missingRequiredArguments { key ->
key !in navDeepLink.argumentsNames
}
require(missingRequiredArguments.isEmpty()) {
@@ -395,7 +395,7 @@
val uri = navDeepLinkRequest.uri
// includes matching args for path, query, and fragment
val matchingArguments =
- if (uri != null) deepLink.getMatchingArguments(uri, arguments) else null
+ if (uri != null) deepLink.getMatchingArguments(uri, _arguments) else null
val matchingPathSegments = deepLink.calculateMatchingPathSegments(uri)
val requestAction = navDeepLinkRequest.action
val matchingAction = requestAction != null && requestAction ==
@@ -404,7 +404,7 @@
val mimeTypeMatchLevel =
if (mimeType != null) deepLink.getMimeTypeMatchRating(mimeType) else -1
if (matchingArguments != null || ((matchingAction || mimeTypeMatchLevel > -1) &&
- hasRequiredArguments(deepLink, uri, arguments))
+ hasRequiredArguments(deepLink, uri, _arguments))
) {
val newMatch = DeepLinkMatch(
this, matchingArguments,
@@ -636,7 +636,7 @@
val argName = matcher.group(1)
if (bundle != null && bundle.containsKey(argName)) {
matcher.appendReplacement(builder, "")
- val argType = argName?.let { arguments[argName]?.type }
+ val argType = argName?.let { _arguments[argName]?.type }
if (argType == NavType.ReferenceType) {
val value = context.getString(bundle.getInt(argName))
builder.append(value)
@@ -676,21 +676,18 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is NavDestination) return false
- val equalDeepLinks = deepLinks.intersect(other.deepLinks).size == deepLinks.size
+ val equalDeepLinks = deepLinks == other.deepLinks
val equalActions = actions.size() == other.actions.size() &&
actions.keyIterator().asSequence().all { actions.get(it) == other.actions.get(it) }
- val equalArguments = arguments.size == other.arguments.size &&
- arguments.asSequence().all {
- other.arguments.containsKey(it.key) &&
- other.arguments[it.key] == it.value
- } &&
- other.arguments.asSequence().all {
- arguments.containsKey(it.key) &&
- arguments[it.key] == it.value
+ val equalArguments = _arguments.size == other._arguments.size &&
+ _arguments.asSequence().all {
+ other._arguments.containsKey(it.key) &&
+ other._arguments[it.key] == it.value
}
return id == other.id &&
@@ -716,9 +713,9 @@
result = 31 * result + value.defaultArguments!!.get(it).hashCode()
}
}
- arguments.keys.forEach {
+ _arguments.keys.forEach {
result = 31 * result + it.hashCode()
- result = 31 * result + arguments[it].hashCode()
+ result = 31 * result + _arguments[it].hashCode()
}
return result
}
diff --git a/navigation/navigation-common/src/main/java/androidx/navigation/NavGraph.kt b/navigation/navigation-common/src/main/java/androidx/navigation/NavGraph.kt
index f05a46d..7e5c401 100644
--- a/navigation/navigation-common/src/main/java/androidx/navigation/NavGraph.kt
+++ b/navigation/navigation-common/src/main/java/androidx/navigation/NavGraph.kt
@@ -382,13 +382,12 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is NavGraph) return false
- val copy = nodes.valueIterator().asSequence().toMutableList()
- other.nodes.valueIterator().forEach { copy.remove(it) }
return super.equals(other) &&
nodes.size == other.nodes.size &&
startDestinationId == other.startDestinationId &&
- copy.isEmpty()
+ nodes.valueIterator().asSequence().all { it == nodes.get(it.id) }
}
override fun hashCode(): Int {
diff --git a/navigation/navigation-dynamic-features-fragment/src/main/java/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator.kt b/navigation/navigation-dynamic-features-fragment/src/main/java/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator.kt
index db035fe..8cb8658 100644
--- a/navigation/navigation-dynamic-features-fragment/src/main/java/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator.kt
+++ b/navigation/navigation-dynamic-features-fragment/src/main/java/androidx/navigation/dynamicfeatures/fragment/DynamicFragmentNavigator.kt
@@ -93,6 +93,7 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is Destination) return false
return super.equals(other) && moduleName == other.moduleName
}
diff --git a/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigator.kt b/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigator.kt
index 14dfb04..4a30617 100644
--- a/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigator.kt
+++ b/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicActivityNavigator.kt
@@ -101,6 +101,7 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is Destination) return false
return super.equals(other) && moduleName == other.moduleName
}
diff --git a/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicGraphNavigator.kt b/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicGraphNavigator.kt
index 77a154d..85627bc 100644
--- a/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicGraphNavigator.kt
+++ b/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicGraphNavigator.kt
@@ -230,6 +230,7 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is DynamicNavGraph) return false
return super.equals(other) &&
moduleName == other.moduleName &&
diff --git a/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.kt b/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.kt
index 36a1353..340b50f 100644
--- a/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.kt
+++ b/navigation/navigation-dynamic-features-runtime/src/main/java/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.kt
@@ -226,6 +226,7 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is DynamicIncludeNavGraph) return false
return super.equals(other) &&
graphResourceName == other.graphResourceName &&
diff --git a/navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/DialogFragmentNavigator.kt b/navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/DialogFragmentNavigator.kt
index 332e9bc3..107de6f 100644
--- a/navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/DialogFragmentNavigator.kt
+++ b/navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/DialogFragmentNavigator.kt
@@ -313,6 +313,7 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is Destination) return false
return super.equals(other) && _className == other._className
}
diff --git a/navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.kt b/navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.kt
index 951a437..81f0d8c 100644
--- a/navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.kt
+++ b/navigation/navigation-fragment/src/main/java/androidx/navigation/fragment/FragmentNavigator.kt
@@ -607,6 +607,7 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is Destination) return false
return super.equals(other) && _className == other._className
}
diff --git a/navigation/navigation-runtime/src/main/java/androidx/navigation/ActivityNavigator.kt b/navigation/navigation-runtime/src/main/java/androidx/navigation/ActivityNavigator.kt
index 4541c3a..b14059c 100644
--- a/navigation/navigation-runtime/src/main/java/androidx/navigation/ActivityNavigator.kt
+++ b/navigation/navigation-runtime/src/main/java/androidx/navigation/ActivityNavigator.kt
@@ -424,6 +424,7 @@
}
override fun equals(other: Any?): Boolean {
+ if (this === other) return true
if (other == null || other !is Destination) return false
return super.equals(other) &&
intent?.filterEquals(other.intent) ?: (other.intent == null) &&
