轻松搭建基于JetPack组件的MVVM框架

作者: 木木玩Android | 来源:发表于2020-08-13 20:52 被阅读0次

轻松搭建基于JetPack组件的MVVM框架
基于MVVM、Jetpack封装的小项目
BasicLibrary——基于kotlin+jetpack+m
MVVM框架的搭建（三）——网络请求
MVVM的数据持久化（一）——ROOM的集成
MVVM的数据持久化（二）——ROOM的使用
Android LiveData和viewModel结合入门
从0搭建一个实用的MVVM框架
从0搭建一个实用的MVVM框架
Android MVVM (kotlin 版本）coroutin

Brick

github gitee

介绍

辅助android开发者搭建基于JetPack组件构建MVVM框架的注解处理框架。通过注解自动生成ViewModel的Factory类、lazy方法等；支持在项目的任意位置注入ROOM的dao层接口与Retrofit库中的api接口。

特点

android开发者可以将brick理解为一个轻量级的注入框架，使用非常简单，使用4-6个注解即可工作。brick主要在编译期工作， 不会在App运行时产生任何额外的性能消耗 ，并且只有1个注解库会打包到你的android工程中，不用担心体积增大的问题。

适用范围

使用androidx而非support库。
使用JetPack的ViewModel组件。
使用Retrofit作为网络请求库。
使用ROOM数据库框架。（可选）
服务端为多端口、多IP的项目。(可选)

引入

在你的android工程的根目录下的build.gradle文件中的适当的位置添加以下代码：

buildscript {
    ...
    ext {
        brick_version = '0.2.0'
    }
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
    dependencies {
        classpath "com.gitee.numeron.brick:plugin:$brick_version"
    }
}

allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
复制代码

在你的android工程中要启用brick的android模块的build.gradle文件中的适当位置添加以下代码：

...
apply plugin: 'kotlin-kapt'
apply plugin: 'brick'
...
dependencies {
    ...
    implementation "com.gitee.numeron.brick:annotation:$brick_version"
    kapt "com.gitee.numeron.brick:compiler:$brick_version"
}
复制代码

使用

一、 @Provide注解的使用方法：

在你编写好的ViewModel子类上添加@Provide注解

@Provide
class WxAuthorViewModel: ViewModel() {
    ...
}
复制代码

有3种方式让brick注解处理器开始工作：

在Terminal终端上输入gradlew :[ModuleName]:kaptDebugKotlin运行脚本；
在AndroidStudio右侧Gradle扩展栏中依次找到[PrjectName] -> [ModuneName] -> Tasks -> other -> kaptDebugKotlin并双击运行脚本；
Ctrl + F9编译整个项目。
以上三种方式任选其一即可运行brick注解处理器。

脚本运行结束后，会生成两个包级方法：

lazyWxAuthorViewModel()扩展方法，在Activity或Fragment中直接调用即可。
get()方法，在不方便使用lazy方法时，可使用此方法获取ViewModel的实例。
注：lazyWxAuthorViewModel方法就是对get()方法的包装。
直接使用生成的方法，即可创建对应的ViewModel实例：

private val wxAuthorViewModel by lazyWxAuthorViewModel()
复制代码

或在onCreate()之后，通过get创建：

private lateinit var wxAuthorViewModel: WxAuthorViewModel

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    wxAuthorViewModel = get(this)
}
复制代码

二、 @Inject注解的使用方法

-2. (必需) 在获取Retrofit实例的方法上添加@RetrofitInstance，如：

@RetrofitInstance
val retrofit: Retrofit by lazy(LazyThreadSafetyMode.SYNCHRONIZED) {
    Retrofit.Builder()
        .client(okHttpClient)
        .baseUrl(WANDROID_BASE_URL)
        .addConverterFactory(MoshiConverterFactory.create())
        .build()
}

val okHttpClient: OkHttpClient by lazy(LazyThreadSafetyMode.SYNCHRONIZED) {
    val logInterceptor = HttpLoggingInterceptor()
    logInterceptor.level = HttpLoggingInterceptor.Level.BODY
    OkHttpClient.Builder()
        .addInterceptor(logInterceptor)
        .callTimeout(15, TimeUnit.SECONDS)
        .readTimeout(60, TimeUnit.SECONDS)
        .writeTimeout(60, TimeUnit.SECONDS)
        .connectTimeout(15, TimeUnit.SECONDS)
        .build()
}
复制代码

注：@RetrofitInstance注解只能标记在public修饰的val属性上或方法上，val属性上或方法可以在object 单例或companion object中，也可以是包级属性/方法。

-1. (可选) 在获取RoomDatabase实例的属性或方法上标记@RoomInstance，如：

@RoomInstance
val wandroidDatabase: WandroidDatabase by lazy(LazyThreadSafetyMode.SYNCHRONIZED) {
    Room.databaseBuilder(CONTEXT, WandroidDatabase::class.java, "wandroid.db")
        .build()
}
复制代码

注：@RoomInstance注解只能标记在public修饰的val属性上或方法上，val属性上或方法可以在object 单例或companion object中，也可以是包级属性/方法。

假设已有Retrofit Api接口和WxAuthorRepo类

interface WxAuthorApi {
    @GET("wxarticle/chapters/json  ")
    suspend fun getWxAuthorList(): List<WxAuthor>
}

class WxAuthorRepo {
    ...
}

复制代码

在WxAuthorRepo中添加lateinit var修饰的WxAuthorApi字段，并用@Inject标记：

class WxAuthorRepo {

    @Inject
    lateinit var wxAuthorApi: WxAuthorApi

}
复制代码

在ViewModel中创建lateinit var修饰的WxAuthorRepo字段，并用@Inject标记：

@Provide
class WxAuthorViewModel: ViewModel() {
    @Inject
    private lateinit var wxAuthorRepo: WxAuthorRepo
}
复制代码

标记后，继续编写业务代码即可，所有被@Inject标记的字段，都会在编译期自动获取或创建实例，无需担心它们在何时被赋值。
注：虽然是lateinit var修饰的字段，但是不要尝试为它们赋值，这会导致致命的错误。
注：@Inject可以注入的类型只有Retrofit的api接口和ROOM的dao接口、以及有无参构造的类。

三、多服务器或多端口的处理方法：

假设有另一个Retrofit api接口，它的访问地址或端口与baseUrl中的不一样，此时，可以在Retrofit的api接口上添加@Port和@Url注解来设置它们的url或port。

@Port的使用：

@Port(1080)
interface ArticleApi {

    @GET("wxarticle/list/{chapterId}/{page}/json")
    suspend fun getArticleList(@Path("chapterId") chapterId: Int, @Path("page") page: Int): Paged<Article>

}
复制代码

添加此注解后，brick会在编译期根据@RetrofitInstance注解标记的Retrofit实例和@Port的端口号，重新创建一个Retrofit实例，并使用新的Retrofit实例创建ArticleApi的实例。

@Url的使用：

@Url("http://www.wanandroid.com:1080/")
interface ArticleApi {
    @GET("wxarticle/list/{chapterId}/{page}/json")
    suspend fun getArticleList(@Path("chapterId") chapterId: Int, @Path("page") page: Int): Paged<Article>
}
复制代码

与@Port的使用基本一致，实现的原理也是一样的。

附录1

生成的WxAuthorViewModels.kt文件：

//kotlin 扩展方法，在Activity/Fragment中通过by调用
fun ViewModelStoreOwner.lazyWxAuthorViewModel(): Lazy<WxAuthorViewModel> =
    LazyWeChatAuthorViewModel(this)

//包级方法，在Activity/Fragment的onCreate方法之后调用
fun get(owner: ViewModelStoreOwner): WxAuthorViewModel {
  val factory = WxAuthorViewModelFactory()
  return ViewModelProvider(owner, factory).get(WxAuthorViewModel::class.java)
}

private class WxAuthorViewModelFactory : ViewModelProvider.Factory {
  @Suppress("UNCHECKED_CAST")
  override fun <VM : ViewModel> create(clazz: Class<VM>): VM = WxAuthorViewModel() as VM
}

private class LazyWxAuthorViewModel(
  private val owner: ViewModelStoreOwner
) : Lazy<WxAuthorViewModel> {
  private var _value: WxAuthorViewModel? = null

  override val value: WxAuthorViewModel
    get() {
      if(_value == null) {
        _value = get(owner)
      }
      return _value!!
    }

  override fun isInitialized(): Boolean = _value != null
}
复制代码

附录2

反编译后的WxAuthorViewModel.class:

class WxAuthorViewModel extends ViewModel {

    private final WxAuthorRepo wxAuthorRepo = new WxAuthorRepo();

}
复制代码

附录3

反编译后的WxAuthorRepo.class:

class WxAuthorRepo {

    private final WxAuthorApi wxAuthorApi = RuntimeKt.getRetrofit().create(WxAuthorApi.class);

    public final WxAuthorApi getWxAuthorApi() {
        ...
        return wxAuthorApi;
    }

}
复制代码

附录4

WxAuthorApi添加@Port注解后的WxAuthorRepo.class:

class WxAuthorRepo {

    private final WxAuthorApi wxAuthorApi = newRetrofit(RuntimeKt.getRetrofit(), 1080, null).create(WxAuthorApi.class);

    public final WxAuthorApi getWxAuthorApi() {
        ...
        return wxAuthorApi;
    }

    private final Retrofit newRetrofit(Retrofit retrofit, int port, String url) {
      if (port > 0) {
         HttpUrl httpUrl = retrofit.baseUrl().newBuilder().port(port).build();
         return retrofit.newBuilder().baseUrl(httpUrl).build();
      } else if(url != null && url.length() != 0) {
         return retrofit.newBuilder().baseUrl(url).build();
      }
       return retrofit;
   }

}
复制代码

总结

通过反编译class后的代码以及整篇文章后可以得出一个大概的结论：brick就是在java编译成class后，class编译成dex之前，对class的字节码进行修改，给@Inject标记的字段赋值，实现的注入框架。目前对ViewModel的注入还需要手动调用生成的方法来初始化，这在编译代码之前，AS上都会有红色的错误标记，接下来，让@Inject支持ViewModel的创建就是主要工作啦，等完成后，再发文章吧。## 写在最后

我意识到有很多经验和知识值得分享给大家，也可以通过我们的能力和经验解答大家在IT学习中的很多困惑，所以在工作繁忙的情况下还是坚持各种整理和分享。但苦于知识传播途径有限，很多程序员朋友无法获得正确的资料得到学习提升，故此将并将重要的Android进阶资料包括自定义view、性能优化、MVC与MVP与MVVM三大框架的区别、NDK技术、阿里面试题精编汇总、常见源码分析等学习资料免费分享出来。

知识不体系？这里还有整理出来的Android进阶学习的思维脑图，给大家参考一个方向。包含知识脉络 + 诸多细节，由于篇幅有限，下面只是以图片的形式给大家展示一部分。

【Android学习PDF+学习视频+面试文档+知识点笔记】

【Android高级架构视频学习资源】

Android部分精讲视频领取学习后更加是如虎添翼！进军BATJ大厂等（备战）！现在都说互联网寒冬，其实无非就是你上错了车，且穿的少（技能），要是你上对车，自身技术能力够强，公司换掉的代价大，怎么可能会被裁掉，都是淘汰末端的业务Curd而已！现如今市场上初级程序员泛滥，这套教程针对Android开发工程师1-6年的人员、正处于瓶颈期，想要年后突破自己涨薪的，进阶Android中高级、架构师对你更是如鱼得水，赶快领取吧！

【Android进阶学习视频】、【全套Android面试秘籍】可以简信我【学习】查看免费领取方式！

轻松搭建基于JetPack组件的MVVM框架
Brick github gitee 介绍辅助android开发者搭建基于JetPack组件构建MVVM框架的注...
基于MVVM、Jetpack封装的小项目
CGHelper 基于MVVM架构集成Google推荐的Jetpack组件库： LiveData、ViewMode...
BasicLibrary——基于kotlin+jetpack+m
BasicLibrary BasicLibrary是基于kotlin+jetpack+mvvm封装的一套框架,提高...
MVVM框架的搭建（三）——网络请求
mvvm的网络框架的搭建 MVVM框架的搭建（一）——背景MVVM框架的搭建（二）——项目搭建MVVM框架的搭建（...
MVVM的数据持久化（一）——ROOM的集成
MVVM框架的搭建（一）——背景MVVM框架的搭建（二）——项目搭建MVVM框架的搭建（三）——网络请求MVVM的...
MVVM的数据持久化（二）——ROOM的使用
MVVM框架的搭建（一）——背景MVVM框架的搭建（二）——项目搭建MVVM框架的搭建（三）——网络请求MVVM的...
Android LiveData和viewModel结合入门
LiveData和viewModel是Google大佬新推出的开发框架jetpack中的两个组件，对应的是MVVM...
从0搭建一个实用的MVVM框架
结合Jetpack，构建快速开发的MVVM框架。项目使用Jetpack：LiveData、ViewModel、L...
从0搭建一个实用的MVVM框架
结合Jetpack，构建快速开发的MVVM框架。项目使用Jetpack：LiveData、ViewModel、L...
Android MVVM (kotlin 版本）coroutin
基于 google 的 jetpack 重写 MVVM 框架来实现一个查看天气的应用，先要感谢老外的分享。今天用 ...