commit | fcf76b3241844f18106d6e850004952046d4bfb6 | [log] [tgz] |
---|---|---|
author | Leland Richardson <lelandr@google.com> | Wed May 13 16:58:59 2020 -0700 |
committer | Leland Richardson <lelandr@google.com> | Thu May 14 18:32:33 2020 +0000 |
tree | 23b1ee6c363ff7f109bed19ecbd58045bfc204e8 | |
parent | f929cf4dd2e8e56c8ecc921228d57279b933f19c [diff] |
Deprecate @Model Relnote: “ @Model annotation is now deprecated. Use state and mutableStateOf as alternatives. This deprecation decision was reached after much careful discussion. Justification ============= Rationale includes but is not limited to: - Reduces API surface area and concepts we need to teach - More closely aligns with other comparable toolkits (Swift UI, React, Flutter) - Reversible decision. We can always bring @Model back later. - Removes corner-case usage and difficult to answer questions about configuring @Model as things we need to handle - @Model data classes, equals, hashcode, etc. - How do I have some properties “observed” and others not? - How do I specify structural vs. referential equality to be used in observation? - Reduces “magic” in the system. Would reduce the likelihood of someone assuming system was smarter than it is (ie, it knowing how to diff a list) - Makes the granularity of observation more intuitive. - Improves refactorability from variable -> property on class - Potentially opens up possibilities to do hand-crafted State-specific optimizations - More closely aligns with the rest of the ecosystem and reduces ambiguity towards immutable or us “embracing mutable state” Migration Notes =============== Almost all existing usages of @Model are fairly trivially transformed in one of two ways. The example below has a @Model class with two properties just for the sake of example, and has it being used in a composable. ``` @Model class Position( var x: Int, var y: Int ) @Composable fun Example() { var p = remember { Position(0, 0) } PositionChanger( position=p, p.x = it } p.y = it } ) } ``` Alternative 1: Use State<OriginalClass> and create copies. ---------------------------------------------------------- This approach is made easier with Kotlin’s data classes. Essentially, make all previously `var` properties into `val` properties of a data class, and then use `state` instead of `remember`, and assign the state value to cloned copies of the original using the data class `copy(...)` convenience method. It’s important to note that this approach only works when the only mutations to that class were done in the same scope that the `State` instance is created. If the class is internally mutating itself outside of the scope of usage, and you are relying on the observation of that, then the next approach is the one you will want to use. ``` data class Position( val x: Int, val y: Int ) @Composable fun Example() { var p by state { Position(0, 0) } PositionChanger( position=p, p = p.copy(x=it) } p = p.copy(y=it) } ) } ``` Alternative 2: Use mutableStateOf and property delegates -------------------------------------------------------- This approach is made easier with Kotlin’s property delegates and the `mutableStateOf` API which allows you to create MutableState instances outside of composition. Essentially, replace all `var` properties of the original class with `var` properties with `mutableStateOf` as their property delegate. This has the advantage that the usage of the class will not change at all, only the internal implementation of it. The behavior is not completely identical to the original example though, as each property is now observed/subscribed to individually, so the recompositions you see after this refactor could be more narrow (a good thing). ``` class Position(x: Int, y: Int) { var x by mutableStateOf(x) var y by mutableStateOf(y) } // source of Example is identical to original @Composable fun Example() { var p = remember { Position(0, 0) } PositionChanger( position=p, p.x = it } p.y = it } ) } ``` “ Bug: 156546430 Bug: 152993135 Bug: 152050010 Bug: 148866188 Bug: 148422703 Bug: 148394427 Bug: 146362815 Bug: 146342522 Bug: 143413369 Bug: 135715219 Bug: 126418732 Bug: 147088098 Bug: 143263925 Bug: 139653744 Change-Id: I409e8c158841eae1dd548b33f1ec80bb609cba31
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.
When contributing to Jetpack, follow the code review etiquette.
We are not currently accepting new modules.
NOTE: You will need to use Linux or Mac OS. Building under Windows is not currently supported.
repo
(Repo is a tool that makes it easier to work with Git in the context of Android. For more information about Repo, see the Repo Command Reference)mkdir ~/bin PATH=~/bin:$PATH curl https://storage.googleapis.com/git-repo-downloads/repo > ~/bin/repo chmod a+x ~/bin/repo
git config --global user.name "Your Name" git config --global user.email "you@example.com"
mkdir androidx-master-dev cd androidx-master-dev
repo
command to initialize the repository.repo init -u https://android.googlesource.com/platform/manifest -b androidx-master-dev
repo sync -j8 -c
You will use this command to sync your checkout in the future - it’s similar to git fetch
To open the project with the specific version of Android Studio recommended for developing:
cd path/to/checkout/frameworks/support/ ./studiow
and accept the license agreement when prompted. Now you're ready edit, run, and test!
If you get “Unregistered VCS root detected” click “Add root” to enable git integration for Android Studio.
If you see any warnings (red underlines) run Build > Clean Project
.
You can do most of your work from Android Studio, however you can also build the full AndroidX library from command line:
cd path/to/checkout/frameworks/support/ ./gradlew createArchive
You can build maven artifacts locally, and test them directly in your app:
./gradlew createArchive
And put the following at the top of your ‘repositories’ property in your project build.gradle
file:
maven { url '/path/to/checkout/out/androidx/build/support_repo/' }
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.
Run FooBarTest
Run androidx.foobar
The AndroidX repository has a set of Android applications that exercise AndroidX code. These applications can be useful when you want to debug a real running application, or reproduce a problem interactively, before writing test code.
These applications are named either <libraryname>-integration-tests-testapp
, or support-\*-demos
(e.g. support-4v-demos
or support-leanback-demos
). You can run them by clicking Run > Run ...
and choosing the desired application.
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
cd path/to/checkout/frameworks/support/ repo start my_branch_name . # make needed modifications... git commit -a repo upload --current-branch .
If you see the following prompt, choose always
:
Run hook scripts from https://android.googlesource.com/platform/manifest (yes/always/NO)?
If the upload succeeds, you'll see output like:
remote: remote: New Changes: remote: https://android-review.googlesource.com/c/platform/frameworks/support/+/720062 Further README updates remote:
To edit your change, use git commit --amend
, and re-upload.
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()
, jcenter()
, or mavenCentral()
. We store copies of these dependencies to have hermetic builds. You can pull in a new dependency using our importMaven tool.