MVVMFrame-master.zip

# MVVMFrame  [](https://raw.githubusercontent.com/jenly1314/MVVMFrame/master/app/release/app-release.apk) [](https://repo1.maven.org/maven2/com/github/jenly1314/mvvmframe) [](https://bintray.com/beta/#/jenly/maven/mvvmframe) [](https://jitpack.io/#jenly1314/MVVMFrame) [](https://circleci.com/gh/jenly1314/MVVMFrame) [](https://android-arsenal.com/api?level=21) [](https://opensource.org/licenses/mit-license.php) MVVMFrame for Android 是一个基于Google官方推出的Architecture Components dependencies（现在叫JetPack）构建的快速开发框架。有了 **MVVMFrame** 的加持，从此构建一个 **MVVM** 模式的项目变得快捷简单。 ## 架构  ## 引入 ### Gradle： 1. 在Project的 **build.gradle** 或 **setting.gradle** 中添加远程仓库 ```gradle repositories { //... mavenCentral() maven { url 'https://jitpack.io' } } ``` 2. 在Module的 **build.gradle** 里面添加引入依赖项 ```gradle // AndroidX implementation 'com.github.jenly1314:mvvmframe:3.0.0' ``` ### **Hilt** 和 **Room** 的相关注解处理器 因为 [mvvmframe](mvvmframe) 内部依赖了 **Hilt** 和 **Room**，所以你需要引入下面列出的编译时的注解处理器，用于自动生成相关代码。 > 以下配置为当前最新版本的，其它对应版本可查看版本说明，或对应的版本发布 [Versions](https://github.com/jenly1314/MVVMFrame/releases) > 如果你使用 **v2.x** 版本的话，请直接 [查看2.x分支版本](https://github.com/jenly1314/MVVMFrame/tree/2.x) 你需要在项目根目录的 **build.gradle** 文件中配置 **Hilt** 的插件： ```gradle plugins { //... id 'com.google.dagger.hilt.android' version '2.51' apply false } ``` 接下来，在 **app/build.gradle** 文件中，引入 **Hilt** 的插件和相关依赖： ```gradle plugins { //... id 'kotlin-kapt' id 'com.google.dagger.hilt.android' } dependencies{ //... // hilt implementation "com.google.dagger:hilt-android:2.51" kapt "com.google.dagger:hilt-compiler:2.51" // room kapt "androidx.room:room-compiler:2.6.1" } ``` > `kapt`适用于kotlin项目，如果你的项目使用的java，请使用`annotationProcessor` 替代 `kapt` ## 使用 ### 版本特别说明 * 3.x版本统一改为使用`kotlin`并进行了重构；之前2.x版本内部使用的`LiveData`相关代码已全部移除，3.x版本已全部改用kotlin独有的`Flow`进行实现。 * 3.x相比较于2.x版本更为精简，可定制性更高。（如果需要在`Compose`中进行使用，只需加上`Compose`的UI相关依赖，稍微封装下即可） > 建议在新项目中使用；如果你之前使用的是2.x旧版本，请谨慎升级。 > 如果你使用 **v2.x** 版本的话，请直接 [查看2.x分支版本](https://github.com/jenly1314/MVVMFrame/tree/2.x) --- > 从分割线此处开始，以下全部为3.x版本相关说明 ### 集成步骤代码示例 （完整示例，可直接查看[app](app)） **Step.1** 启用ViewDataBinding，在你项目中的build.gradle的android{}中添加配置： ```gradle buildFeatures{ dataBinding = true } ``` **Step.2** 使用JDK17编译，在你项目中的build.gradle的android{}中添加配置： ```gradle compileOptions { targetCompatibility JavaVersion.VERSION_17 sourceCompatibility JavaVersion.VERSION_17 } ``` **Step.3** 自定义全局配置(继承MVVMFrame中的FrameConfigModule)（提示：如果你没有自定义配置的需求，可以直接忽略此步骤） ```kotlin /** * 全局配置 */ class AppConfigModule : FrameConfigModule() { override fun applyOptions(context: Context, builder: ConfigModule.Builder) { // 通过第一种方式初始化BaseUrl builder.baseUrl(Constants.BASE_URL) // TODO 配置Retrofit中的baseUrl builder.retrofitOptions(object : RetrofitOptions { override fun applyOptions(builder: Retrofit.Builder) { // TODO 配置Retrofit } }) .okHttpClientOptions(object : OkHttpClientOptions { override fun applyOptions(builder: OkHttpClient.Builder) { // TODO 配置OkHttpClient } }) .gsonOptions(object : GsonOptions { override fun applyOptions(builder: GsonBuilder) { // TODO 配置Gson } }) .roomDatabaseOptions(object : RoomDatabaseOptions { override fun applyOptions(builder: RoomDatabase.Builder<out RoomDatabase>) { // TODO 配置RoomDatabase } }) .configOptions(object : AppliesOptions.ConfigOptions { override fun applyOptions(builder: Config.Builder) { // TODO 配置Config builder.httpLoggingLevel(HttpLoggingInterceptor.Level.BODY) } }) } } ``` 然后在你项目中的AndroidManifest.xml中通过配置meta-data来自定义全局配置（提示：如果你没有自定义配置的需求，可以直接忽略此步骤） ```xml <!-- MVVMFrame 全局配置 --> <meta-data android:name="com.king.mvvmframe.config.AppConfigModule" android:value="FrameConfigModule"/> ``` > 此处的`com.king.mvvmframe.config.AppConfigModule` 替换为你自定义的全局配置类 **Step.4** 配置Application ```kotlin @HiltAndroidApp class YourApplication : BaseApplication() { //... override fun onCreate() { super.onCreate() // 如果你没有使用FrameConfigModule中的第一中方式初始化BaseUrl，也可以通过第二种方式来设置BaseUrl（二选其一即可） // RetrofitHelper.getInstance().setBaseUrl(baseUrl) } } ``` > 如果由于某种原因，导致你不能继承`BaseApplication`；你也可以在你自定义的`Application`的`onCreate`函 数中通过调用`BaseApplication.initAppConfig`来进行初始化。 ### 其他 ### 关于使用 **Hilt** **Hilt** 是JetPack中新增的一个依赖注入库，其基于 **Dagger2** 研发（后面统称为Dagger），但它不同于Dagger。对于Android开发者来说，Hilt可以说专门为Android 打造。 之前使用的 **Dagger for Android** 虽然也是针对于Android打造，也能通过 **@ContributesAndroidInjector** 来通过生成简化一部分样板代码，但是感觉还不够彻底。因为 **Component** 层相关的桥接还是要自己写。**Hilt** 的诞生改善了这些问题。 **Hilt** 大幅简化了 **Dagger** 的用法，使得我们不用通过 **@Component** 注解去编写桥接层的逻辑，但是也因此限定了注入功能只能从几个 **Android** 固定的入口点开始。 #### **Hilt** 目前支持以下 **Android** 类： * Application（通过使用 @HiltAndroidApp） * ViewModel（通过使用 @HiltViewModel） * Activity * Fragment * View * Service * BroadcastReceiver **Application** 示例 (这里我们使用BaseApplication) ```kotlin @HiltAndroidApp class YourApplication : BaseApplication() { //... } ``` **ViewModel** 示例 (这里我们使用BaseViewModel) ```kotlin @HiltViewModel class YourViewModel : BaseViewModel() { //... } ``` 其他的入口点，都是用 **@AndroidEntryPoint** 注解来声明，示例如下 **Activity** 示例 (这里我们使用BaseActivity) ```kotlin @AndroidEntryPoin