qingmei2/mvvm-architecture

The practice of MVVM + Jetpack architecture in Android.

MVVM-Architecture

Android端 MVVM + Jetpack 架构组件的Github客户端。

• English Document | 中文文档

通知

这个项目采用了数种 MVVM 的实现方式，你可以参考任意感兴趣的进行了解：

• Jetpack + Coroutine + Dagger-Hilt

• Jetpack + Coroutine + Kodein

• Jetpack + RxJava + Kodein

• 我为什么放弃了DataBinding，以及我个人对MVVM`的 理解 。

• 我对这个项目的 定位 。

屏幕截图

三方组件

Android Jetpack 组件

• Lifecycle: Create a UI that automatically responds to lifecycle events.

• LiveData: Build data objects that notify views when the underlying database changes.

• ViewModel: Store UI-related data that isn't destroyed on app rotations. Easily schedule asynchronous tasks for optimal execution.

• Room: Access your app's SQLite database with in-app objects and compile-time checks.

• Navigation: Handle everything needed for in-app navigation.

• Paging3: Makes it easier for you to load data gradually and gracefully within your app's RecyclerView.

• DataStore: A data storage solution that allows you to store key-value pairs or typed objects with protocol buffers.

网络请求

• Retrofit2: Type-safe HTTP client for Android and Java by Square, Inc.

• OkHttp: An HTTP+HTTP/2 client for Android and Java applications.

依赖注入

• Dagger-hilt: Dependency injection with Hilt

• Kodein-DI: Painless Kotlin Dependency Injection

其它

• Glide: An image loading and caching library for Android focused on smooth scrolling

• Timber: A logger with a small, extensible API which provides utility on top of Android's normal Log class.

开始使用

如果编译遇到如下图的错误：

出现这个问题的原因，最新版本的代码，需要开发者注册一个自己的OAuth Application，注册后，Github的API访问次数就能达到5000次/小时（之前的版本只有60次/小时），之前很多朋友反应在Debug过程中不够用，断点打了几次就被限制请求了，因此最新版本添加了这个配置的步骤，虽然麻烦了一小步，但是对于学习效率的提升，这点配置时间可以忽略不计。

• 1.直接通过git命令行进行clone:

$ git clone https://github.com/qingmei2/MVVM-Architecture.git

• 2.注册你的GitHub App

首先参考这个链接, 注册获取属于你的Access Token：

获取到AccessToken后，并配置到你的项目根目录的local.properties文件中：

USER_ACCESS_TOKEN="xxxxxxxxxxxxxxxxxxxxxxxxx"

大功告成，接下来点击编译并运行即可。:tada: :tada: :tada:

如何入手学习这个项目？

如何使用Android Jetpack？

• Android官方架构组件Lifecycle：生命周期组件详解&原理分析
• Android官方架构组件ViewModel:从前世今生到追本溯源
• Android官方架构组件Paging：分页库的设计美学
• Android官方架构组件Paging-Ex：为分页列表添加Header和Footer
• Android官方架构组件Paging-Ex：列表状态的响应式管理
• Android官方架构组件Navigation：大巧不工的Fragment管理框架
• Android官方架构组件LiveData: 观察者模式领域二三事（*）
• Android官方架构组件DataBinding-Ex:双向绑定篇（*）

一些有趣的项目推荐

• Net: 基于kt协程的网络请求库，简单易上手；
• BRV: 基于kt的列表库，快速构建MVVM下的UI列表

感谢

🎨 项目中的UI设计部分参考了 gitme.

⭐ 项目参考了 rx-mvvm-android 并对其部分代码进行了引用.

Contributor

• DaQinShgy
• GeorgCantor

License

The MVVM-Rhine: Apache License

Copyright (c) 2018 qingmei2

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.