nowinandroid 一个完全由 Kotlin 和 Jetpack Compose 构建的功能完整的 Android 应用程序。它遵循 Android 设计和开发的最佳实践,旨在为开发者提供有用的参考。
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
Jolanda Verhoef eefe378347
Remove unused imports
2 years ago
.github Only use gradle.properties to read warningsAsErrors 2 years ago
.google Adds packaging data for AS samples (#2) 3 years ago
.idea Add UserDataRepository 2 years ago
app Fix dark mode system icons 2 years ago
app-nia-catalog Improve design system usage and add lint checks 2 years ago
benchmark [NiA] Implement LazyVerticalGrid for Feed 2 years ago
build-logic Remove unused imports 2 years ago
core-common Catch exceptions in the flow.asResult method 3 years ago
core-data Persist user bookmarks 2 years ago
core-data-test Add UserDataRepository 2 years ago
core-database Merge pull request #56 from sud007/fix/nia-naming-convention 3 years ago
core-datastore Add TODO comment with bug 2 years ago
core-datastore-test Add common build convention for feature modules 3 years ago
core-designsystem Remove redundant NiaTopicChip and use previewNewsResource 2 years ago
core-model [NiA] Extract feed code into core ui so it can be reused for saved tab 2 years ago
core-navigation Remove redundant dependency 2 years ago
core-network Merge pull request #108 from yanzm/fix/serialize_of_NewsResourceTypeSerializer 2 years ago
core-testing Update Main dispatcher rule, assert on StateFlow's value property 2 years ago
core-ui Merge pull request #219 from android/bw/metricsUpdate 2 years ago
docs Fix : class name Typo 2 years ago
feature-author Enable bookmarks on authors page 2 years ago
feature-bookmarks [NiA] Implement LazyVerticalGrid for Feed 2 years ago
feature-foryou Merge pull request #107 from madroidmaq/rename-ui-state 2 years ago
feature-interests Merge pull request #203 from necatisozer/patch-1 2 years ago
feature-topic Merge pull request #186 from android/mv/state_holder 2 years ago
gradle Update protobuf to v3.21.5 2 years ago
kokoro Add demo and prod product flavors. Remove staging variant. 3 years ago
lint Improve design system usage and add lint checks 2 years ago
spotless Configure spotless for kts and xml files 3 years ago
sync Merge branch 'bw/initialMetrics' of github.com:android/nowinandroid into bw/initialMetrics 3 years ago
tools Make code style default for project (#67) 3 years ago
.gitignore Make code style default for project (#67) 3 years ago
CODE_OF_CONDUCT.md Add github-specific setup (#1) 3 years ago
CONTRIBUTING.md Fix markdown links in CONTRIBUTING.md 3 years ago
LICENSE Add initial app scaffolding 3 years ago
README.md Fixing wording 2 years ago
build.gradle.kts Adding local m2 repository for internal builds 2 years ago
build_android_release.sh Make build script executable in Git 2 years ago
gradle.properties Build faster? 3 years ago
gradlew Replace buildSrc with version catalog 3 years ago
gradlew.bat Add initial app scaffolding 3 years ago
renovate.json Add renovate.json 3 years ago
secrets.defaults.properties Add staging build variant, move staging URL out of source control 3 years ago
settings.gradle.kts [NiA] Add Saved functionality 2 years ago

README.md

Now in Android

Now in Android App [Work in progress 🚧]

This is the repository for the Now in Android app.

Now in Android is a fully functional Android app built entirely with Kotlin and Jetpack Compose. It follows Android design and development best practices and is intended to be a useful reference for developers. As a running app, it's intended to help developers keep up-to-date with the world of Android development by providing regular news updates.

The app is currently in early stage development and is not yet available on the Play Store.

Features

Now in Android displays content from the Now in Android series. Users can browse for links to recent videos, articles and other content. Users can also follow topics they are interested in or follow specific authors.

Screenshots

Screenshot showing For You screen Screenshot showing Interests screen Screenshot showing Topic detail screen

Development Environment

Now in Android uses the Gradle build system and can be imported directly into the latest stable version of Android Studio (available here). The debug build can be built and run using the default configuration.

Once you're up and running, you can refer to the learning journeys below to get a better understanding of which libraries and tools are being used, the reasoning behind the approaches to UI, testing, architecture and more, and how all of these different pieces of the project fit together to create a complete app.

NOTE: Building the app using an M1 Mac will require the use of Rosetta. See the following bug for more details.

Architecture

The Now in Android app follows the official architecture guidance and is described in detail in the architecture learning journey.

Modularization

The Now in Android app has been fully modularized and you can find the detailed guidance and description of the modularization strategy used in modularization learning journey.

Build

The app contains the usual debug and release build variants.

In addition, the benchmark variant of app is used to test startup performance and generate a baseline profile (see below for more information).

app-nia-catalog is a standalone app that displays the list of components that are stylized for Now in Android.

The app also uses product flavors to control where content for the app should be loaded from.

The demo flavor uses static local data to allow immediate building and exploring of the UI.

The prod flavor makes real network calls to a backend server, providing up-to-date content. At this time, there is not a public backend available.

For normal development use the demoDebug variant. For UI performance testing use the demoRelease variant.

Testing

To facilitate testing of components, Now in Android uses dependency injection with Hilt.

Most data layer components are defined as interfaces. Then, concrete implementations (with various dependencies) are bound to provide those interfaces to other components in the app. In tests, Now in Android notably does not use any mocking libraries. Instead, the production implementations can be replaced with test doubles using Hilt's testing APIs (or via manual constructor injection for ViewModel tests).

These test doubles implement the same interface as the production implementations and generally provide a simplified (but still realistic) implementation with additional testing hooks. This results in less brittle tests that may exercise more production code, instead of just verifying specific calls against mocks.

Examples:

  • In instrumentation tests, a temporary folder is used to store the user's preferences, which is wiped after each test. This allows using the real DataStore and exercising all related code, instead of mocking the flow of data updates.

  • There are Test implementations of each repository, which implement the normal, full repository interface and also provide test-only hooks. ViewModel tests use these Test repositories, and thus can use the test-only hooks to manipulate the state of the Test repository and verify the resulting behavior, instead of checking that specific repository methods were called.

UI

UI components are designed according to Material 3 guidelines and built entirely using Jetpack Compose.

The app has two themes:

  • Dynamic color - uses colors based on the user's current color theme (if supported)
  • Default theme - uses predefined colors when dynamic color is not supported

Each theme also supports dark mode.

The app uses adaptive layouts to support different screen sizes.

Find out more about the UI architecture here.

Baseline profiles

The baseline profile for this app is located at app/src/main/baseline-prof.txt. It contains rules that enable AOT compilation of the critical user path taken during app launch. For more information on baseline profiles, read this document.

Note: The baseline profile needs to be re-generated for release builds that touch code which changes app startup.

To generate the baseline profile, select the benchmark build variant and run the BaselineProfileGenerator benchmark test on an AOSP Android Emulator. Then copy the resulting baseline profile from the emulator to app/src/main/baseline-prof.txt.

License

Now in Android is distributed under the terms of the Apache License (Version 2.0). See the license for more information.