MVVMFrame

MVVMFrame for Android 是一个基于Google官方推出的Architecture Components dependencies（现在称为JetPack）构建的快速开发框架。有了 MVVMFrame 的加持，从此构建一个 MVVM 模式的项目变得快捷简单。

架构

引入

Gradle：

在Project的 build.gradle 或 setting.gradle 中添加远程仓库

 repositories {
     //...
     mavenCentral()
     maven { url 'https://jitpack.io' }
 }

在Module的 build.gradle 里面添加引入依赖项

// AndroidX
implementation 'com.github.jenly1314:mvvmframe:3.0.0'

Hilt 和 Room 的相关注解处理器

因为 mvvmframe 内部依赖了 Hilt 和 Room，所以你需要引入下面列出的编译时的注解处理器，用于自动生成相关代码。

以下配置为当前最新版本的，其它对应版本可查看版本说明，或对应的版本发布 Versions

如果你使用 v2.x 版本的话，请直接查看2.x分支版本

你需要在项目根目录的 build.gradle 文件中配置 Hilt 的插件：

plugins {
    //...
    id 'com.google.dagger.hilt.android' version '2.51' apply false
}

接下来，在 app/build.gradle 文件中，引入 Hilt 的插件和相关依赖：

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分支版本

从分割线此处开始，以下全部为3.x版本相关说明

集成步骤代码示例（完整示例，可直接查看app）

步骤1 启用ViewDataBinding，在你项目中的build.gradle的android{}中添加配置：

buildFeatures{
    dataBinding = true
}

步骤2 使用JDK17编译，在你项目中的build.gradle的android{}中添加配置：

compileOptions {
    targetCompatibility JavaVersion.VERSION_17
    sourceCompatibility JavaVersion.VERSION_17
}

步骤3 自定义全局配置(继承MVVMFrame中的FrameConfigModule)（提示：如果你没有自定义配置的需求，可以直接忽略此步骤）

/**
 * 全局配置
 */
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来自定义全局配置（提示：如果你没有自定义配置的需求，可以直接忽略此步骤）

<!-- MVVMFrame 全局配置 -->
<meta-data android:name="com.king.mvvmframe.config.AppConfigModule"
           android:value="FrameConfigModule"/>

此处的com.king.mvvmframe.config.AppConfigModule 替换为你自定义的全局配置类

步骤4 配置Application

@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)

@HiltAndroidApp
class YourApplication : BaseApplication() {
    //...
}

ViewModel 示例 (这里我们使用BaseViewModel)

@HiltViewModel
class YourViewModel : BaseViewModel() {
    //...
}

其他的入口点，都是用 @AndroidEntryPoint 注解来声明，示例如下

Activity 示例 (这里我们使用BaseActivity)

@AndroidEntryPoint
class YourActivity: BaseActivity() {
    //...
}

Fragment 示例 (这里我们使用BaseFragment)

@AndroidEntryPoint
class YourFragment: BaseFragment() {
    //...
}

其他入口点都基本类似，不再一一列举了。更多有关 Hilt 的使用说明，可以查看官方的Hilt使用指南。

关于设置 BaseUrl

目前通过设置 BaseUrl 的入口主要有两种：

1.一种是通过在 Manifest 中配置 meta-data 的来自定义 FrameConfigModule,在里面通过 {@link ConfigModule.Builder#baseUrl(String)}来配置 BaseUrl。（一次设置，全局配置）

2.一种就是通过RetrofitHelper {@link RetrofitHelper#setBaseUrl(String)} 或 {@link RetrofitHelper#setBaseUrl(HttpUrl)} 来配置 BaseUrl。（可多次设置，动态全局配置，有前提条件）

以上两种配置 BaseUrl 的方式都可以达到目的。但是你可以根据不同的场景选择不同的配置方式。

主要场景与选择如下：
一般场景：对于只使用单个不变的 BaseUrl的
场景1:如果本库的默认已满足你的需求，无需额外自定义配置的。
     选择：建议你直接使用 {@link RetrofitHelper#setBaseUrl(String)} 或 {@link RetrofitHelper#setBaseUrl(HttpUrl)} 来初始化 BaseUrl，切记在框架配置初始化 BaseUrl之前，建议在你自定义的 {@link Application#onCreate()}中初始化。
场景2:如果本库的默认配置不满足你的需求，你需要自定义一些配置的。（比如需要使用 RxJava相关）
     选择：建议你在自定义配置中通过 {@link ConfigModule.Builder#baseUrl(String)} 来初始化 BaseUrl。
二般场景：对于只使用单个 BaseUrl 但是，BaseUrl中途会变动的。
场景3：和一般场景一样，也能分两种，所以选择也和一般场景也可以是一样的。
     选择：两种选择都行，但当 BaseUrl需要中途变动时，还需将 {@link RetrofitHelper#setDynamicDomain(boolean)} 设置为 {@code true} 才能支持动态改变 BaseUrl。
特殊场景：对于支持多个 BaseUrl 且支持动态可变的。
   选择：这个场景的选择，主要涉及到另外的方法，请查看 {@link RetrofitHelper#putDomain(String, String)} 和 {@link RetrofitHelper#putDomain(String, HttpUrl)}相关详情