Google Git
Sign in
android / platform / frameworks / support / 57162ea74b646ef7ae43397251fd4cd32e2d80c3
commit57162ea74b646ef7ae43397251fd4cd32e2d80c3[log] [tgz]
authorKuan-Ying Chou <[email protected]>Thu Oct 17 19:10:05 2024 +0100
committerKuan-Ying Chou <[email protected]>Thu Oct 31 13:39:11 2024 +0000
tree407745a89b0b1f8a2364376bbc06dde6a0371c1b
parent73305d3cf9d9bfff42b1836ac0127032b7721496 [diff]
Add functions to encode serializable objects to and decode serializable objects from `SavedState`.

We do this by implementing an `Encoder` and a `Decoder` that writes and reads a `SavedState` output format for Kotlin Serialization (https://github.com/Kotlin/kotlinx.serialization). The format represents a Kotlin Serialization "primitive" as their corresponding `SavedState` supported type, and represents a "composite" in a `SavedState` with its property names as keys. Nested composites are represented by nested `SavedState`s.

Here are some other design choices we made:

1. We don't record size for collections and rely on the size of the `SavedState` in decoding so that collections and non-collections are treated the same.
2. To save space, we don't encode default values by default (it can be tweaked with `@EncodeDefault` with plugin-generated serializers).
3. To support nullable parameters with default arguments (e.g. `val a: String? = "foo"`) and for `SavedState` size to be correct for collections, we encode `null`s.
4. To keep things simple we don't support specifying custom `SerializersModule`s for now.

Please note that when using Kotlin Serialization and these functions as a `Parcelable` alternative on Android there's a performance overhead because of the extra serialization needed.

Also note that on Android we don't have built-in support for Android or Java specific types supported by `Bundle` or `Parcel` yet (e.g. `Exception`, `java.io.Serializable`, or `IBinder`).  We may consider adding these types in the future.

Relnote: Add encodeToSavedState() and decodeFromSavedState() functions
Test: SavedStateCodecTest.kt
Bug: 374102924
Change-Id: I6f59faffaa3777bf56132a67f41b867d7a9663e5
14 files changed
tree: 407745a89b0b1f8a2364376bbc06dde6a0371c1b
  1. .github/
  2. .idea/
  3. activity/
  4. annotation/
  5. appcompat/
  6. appintegration/
  7. appsearch/
  8. arch/
  9. asynclayoutinflater/
  10. autofill/
  11. benchmark/
  12. binarycompatibilityvalidator/
  13. biometric/
  14. bluetooth/
  15. browser/
  16. buildSrc/
  17. buildSrc-tests/
  18. busytown/
  19. camera/
  20. car/
  21. cardview/
  22. collection/
  23. compose/
  24. concurrent/
  25. constraintlayout/
  26. contentpager/
  27. coordinatorlayout/
  28. core/
  29. credentials/
  30. cursoradapter/
  31. customview/
  32. datastore/
  33. development/
  34. docs/
  35. docs-public/
  36. docs-tip-of-tree/
  37. documentfile/
  38. draganddrop/
  39. drawerlayout/
  40. dynamicanimation/
  41. emoji/
  42. emoji2/
  43. enterprise/
  44. exifinterface/
  45. external/
  46. fragment/
  47. glance/
  48. gradle/
  49. graphics/
  50. gridlayout/
  51. health/
  52. heifwriter/
  53. hilt/
  54. ink/
  55. input/
  56. inspection/
  57. interpolator/
  58. javascriptengine/
  59. kruth/
  60. leanback/
  61. lifecycle/
  62. lint/
  63. lint-checks/
  64. loader/
  65. media/
  66. mediarouter/
  67. metrics/
  68. navigation/
  69. paging/
  70. palette/
  71. pdf/
  72. percentlayout/
  73. performance/
  74. placeholder/
  75. placeholder-tests/
  76. playground-common/
  77. playground-projects/
  78. preference/
  79. print/
  80. privacysandbox/
  81. profileinstaller/
  82. recommendation/
  83. recyclerview/
  84. remotecallback/
  85. resourceinspection/
  86. room/
  87. safeparcel/
  88. samples/
  89. savedstate/
  90. security/
  91. sharetarget/
  92. slice/
  93. slidingpanelayout/
  94. sqlite/
  95. stableaidl/
  96. startup/
  97. swiperefreshlayout/
  98. test/
  99. testutils/
  100. tracing/
  101. transition/
  102. tv/
  103. tvprovider/
  104. vectordrawable/
  105. versionedparcelable/
  106. viewpager/
  107. viewpager2/
  108. wear/
  109. webkit/
  110. window/
  111. work/
  112. .gitignore
  113. build.gradle
  114. cleanBuild.sh
  115. code-review.md
  116. CONTRIBUTING.md
  117. gradle.properties
  118. gradlew
  119. libraryversions.toml
  120. license-baseline.txt
  121. LICENSE.txt
  122. OWNERS
  123. PREUPLOAD.cfg
  124. README.md
  125. settings.gradle
  126. studiow
  127. TEXT_OWNERS
README.md

Android Jetpack

Revved up by Develocity

Jetpack is a suite of libraries, tools, and guidance to help developers write high-quality apps easier. These components help you follow best practices, free you from writing boilerplate code, and simplify complex tasks, so you can focus on the code you care about.

Jetpack comprises the androidx.* package libraries, unbundled from the platform APIs. This means that it offers backward compatibility and is updated more frequently than the Android platform, making sure you always have access to the latest and greatest versions of the Jetpack components.

Our official AARs and JARs binaries are distributed through Google Maven.

You can learn more about using it from Android Jetpack landing page.

Contribution Guide

For contributions via GitHub, see the GitHub Contribution Guide.

Note: The contributions workflow via GitHub is currently experimental - only contributions to the following projects are being accepted at this time:

Code Review Etiquette

When contributing to Jetpack, follow the code review etiquette.

Accepted Types of Contributions

  • Bug fixes - needs a corresponding bug report in the Android Issue Tracker
  • Each bug fix is expected to come with tests
  • Fixing spelling errors
  • Updating documentation
  • Adding new tests to the area that is not currently covered by tests
  • New features to existing libraries if the feature request bug has been approved by an AndroidX team member.

We are not currently accepting new modules.

Checking Out the Code

Head over to the onboarding docs to learn more about getting set up and the development workflow!

Continuous integration

Our continuous integration system builds all in progress (and potentially unstable) libraries as new changes are merged. You can manually download these AARs and JARs for your experimentation.

Password and Contributor Agreement before making a change

Before uploading your first contribution, you will need setup a password and agree to the contribution agreement:

Generate a HTTPS password: https://android-review.googlesource.com/new-password

Agree to the Google Contributor Licenses Agreement: https://android-review.googlesource.com/settings/new-agreement

Getting reviewed

  • After you run repo upload, open r.android.com
  • Sign in into your account (or create one if you do not have one yet)
  • Add an appropriate reviewer (use git log to find who did most modifications on the file you are fixing or check the OWNERS file in the project's directory)

Handling binary dependencies

AndroidX uses git to store all the binary Gradle dependencies. They are stored in prebuilts/androidx/internal and prebuilts/androidx/external directories in your checkout. All the dependencies in these directories are also available from google(), or mavenCentral(). We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.