android组件浮动在activity上_Jetpack Hilt 依赖注入框架上手指南
code小生 一个专注大前端领域的技术平台公众号回复Android
加入安卓技术群
作者:LvKang-insist
链接:https://juejin.im/post/5efdff9d6fb9a07eb7357ac9
声明:本文已获LvKang-insist
授权发表,转发等请联系原作者授权
依赖注入是什么
个人理解:把有依赖关系的类放在容器中,解析这些类的实例,并在运行时注入到对应的字段中,就是依赖注入,目的是为了类的解耦
例子:A 类 中用到了 B 类,一般情况下需要在 A 类中 new B() 的实例对象
采用依赖注入后,在 A 类中 定义一个私有的 B 类 字段。并在运行的时候通过从相关的容器中获取出来 B 的对象并注入到 A 类中的 字段中。
这样做的好处是什么?
如果有很多个类需要使用 B 类。难道都要在各自的类中进行 new B() 吗。这样对后期的维护和管理都是不方便的。使用 依赖注入则就变得很简单了。
Hilt 是什么
Hilt 是 Android 的依赖注入库,其实是基于 Dagger 。可以说 Hilt 是专门为 Andorid 打造的。
Hilt 创建了一组标准的 组件和作用域。这些组件会自动集成到 Android 程序中的生命周期中。在使用的时候可以指定使用的范围,事情作用在对应的生命周期当中。
Hilt 常用的注解的含义
- @HiltAndroidApp @HiltAndroidApp 将会触发 Hilt 的代码生成,作为程序依赖项容器的基类 生成的 Hilt 依附于 Application 的生命周期,他是 App 的父组件,提供访问其他组件的依赖
在 Application 中配置好后,就可以使用 Hilt 提供的组件了;组件包含 Application,Activity,Fragment,View,Service 等。
@HiltAndroidApp 创建一个依赖容器,该容器遵循 Android 的生命周期类,目前支持的类型是: Activity, Fragment, View, Service, BroadcastReceiver.
@Inject 使用 @Inject 来告诉 Hilt 如何提供该类的实例,常用于构造方法,非私有字段,方法中。
Hilt 有关如何提供不同类型的实例信息也称之为绑定
- @Module module 是用来提供一些无法用 构造@Inject 的依赖,如第三方库,接口,build 模式的构造等。
使用 @Module 注解的类,需要使用 @InstallIn 注解指定 module 的范围 增加了 @Module 注解的类,其实代表的就是一个模块,并通过指定的组件来告诉在那个容器中可以使用绑定安装。
@InstallIn 使用 @Module 注入的类,需要使用 @InstallIn 注解指定 module 的范围。例如使用 @InstallIn(ActivityComponent::class) 注解的 module 会绑定到 activity 的生命周期上。
@Provides 常用于被 @Module 注解标记类的内部方法上。并提供依赖项对象。
@EntryPoint
Hilt 支持最常见的 Android 类 Application、Activity、Fragment、View、Service、BroadcastReceiver 等等,但是您可能需要在Hilt 不支持的类中执行依赖注入,在这种情况下可以使用 @EntryPoint 注解进行创建,Hilt 会提供相应的依赖。
Hilt 中的组件(Compenent)
使用 @Module 注解的类,需要使用 @Installin 注解来指定 module 的范围。
例如 @InstallIn(ApplicationComponent::class) 注解的 Module 就会绑定到 Application 的生命周期上。
Hilt 提供了以下组件来绑定依赖与对应 Android 类的活动范围
Hilt 没有为 broadcast receivers 提供组件,因为 Hilt 直接进从 ApplicationComponent 中注入 broadcast receivers。
Hilt 中组件的生命周期
Hilt 会根据相应的 Android 类生命周期自动创建和销毁组件的实例,对应关系如下:
如何使用 Hilt
buildscript { dependencies { //hilt classpath 'com.google.dagger:hilt-android-gradle-plugin:2.28-alpha' }}
apply plugin: 'kotlin-kapt'apply plugin: 'com.xiaojinzi.component.plugin'
//hiltapi "com.google.dagger:hilt-android:2.28-alpha"kapt "com.google.dagger:hilt-android-compiler:2.28-alpha"
@HiltAndroidAppclass BaseApplication : Application() {
override fun onCreate() { super.onCreate() }}
到这里准备工作就做完了
使用 Hilt 进行依赖注入
class HiltTest @Inject constructor() {
fun hiltTest() { Log.e("----------->", "hiltTest: ") }}
@HiltAndroidAppclass BaseApplication : Application() {
@Inject lateinit var hiltTest: HiltTest
override fun onCreate() { super.onCreate() hiltTest.hiltTest() }}
Hilt 在 Android 组件中的使用
如果使用 @AndroidEntryPoint 注解 Android 类,还必须注解依赖他的 Android 类;
例如:给 fragment 使用 @AndroidEntryPoint 后,则还需要给 fragmet 依赖的 Activity 依赖 @AndroidEntryPoint ,否则会出现异常
@AndroidEntryPoint 不能以写在抽象类上
@AndroidEntryPoint 注解 仅仅支持 ComponentActivity 的子类,例如 Fragment,AppCompatActivity 等等。
@AndroidEntryPointclass HomeNavigationActivity : BaseLayoutActivity<TestViewModel>() {
override fun setViewModel(): Class =TestViewModel::class.javaoverride fun layout(): Int {return R.layout.home_navigation }override fun bindView() { }}
// fragment 中使用,需要本身所依赖的 activity 添加注解@AndroidEntryPointclass FragmentOne : BaseLayoutFragment<FragOneViewModel>() {
//使用 @Inject 从组件中获取依赖进行注入 @Inject lateinit var hiltTest: HiltTest
override fun layout(): Int { return R.layout.frag_one } override fun bindView(rootView: View) { //对象已经注入,直接调用即可 one.text = hiltTest.hiltTest() }}
Hilt 和第三方组件的使用
如果需要在项目中注入第三方依赖,可以使用 @Module 注解。使用 @Module 在注解的普通类,在其中创建第三方依赖的对象即可。
@Module 模块用于向 Hilt 添加绑定,告诉 Hilt 如果提供不同类型的实例。使用了 @Module 的类,相当于是一个模块,常用于创建依赖对象(如,Okhttp,Retrofit 等)。
使用 @Module 的类,需要使用 #InstallIn 指定此 module 的范围,会绑定到对应 Android 类的生命周期上
@Providers,常用于被 @Module 注解标记类的内部方法,并提供依赖项对象。
//对应的生命周期为 application@Module@InstallIn(ApplicationComponent::class)object TestModule {
/** * 每次都是新的实例 */ @Provides fun bindHiltTest(): HiltTest { XLog.e("--------bindHiltTest----") return HiltTest() }
/** * 全局复用同一个实例 */ @Provides @Singleton fun bindSingTest(): Test { XLog.e("--------bindSingTest----") return Test() }
}
使用如下:
@Injectlateinit var hiltTest: HiltTest
@Injectlateinit var hiltTest1: HiltTest
@Injectlateinit var test1: Test
@Injectlateinit var test2: Test
其中 bindSingTest 只会被调用一次,@SingLeton 相当于是一个单例
Hilt 和 ViewModel 的使用
使用之前需要在 app.build 下添加一下对 viewModel的支持
implementation 'androidx.hilt:hilt-lifecycle-viewmodel:1.0.0-alpha01'kapt 'androidx.hilt:hilt-compiler:1.0.0-alpha01'
- 通过 @ViewModelInject 注解进行构造注入。
- SavedStateHandle 使用 @Asssisted 注解
class HomeContentViewModel @ViewModelInject constructor( private val response: HomeContentRepository, @Assisted val state: SavedStateHandle) : ViewModel() {
private val liveData by lazy { MutableLiveData() }val testLiveData: LiveData by lazy { liveData }fun requestBaiDu() { launchVmHttp { liveData.postValue(response.requestBaidu()) } }}
- 通过 @Inject 进行注入,在 viewModel 中不需要手动的创建其对象
@ActivityScopedclass HomeContentRepository @Inject constructor() : BaseRepository() {
suspend fun requestBaidu(): String { return LvHttp.createApi(ApiServices::class.java).baidu() }}
- 获取 viewModel 的实例
@AndroidEntryPointclass HomeContentActivity : AppCompatActivity(){
//生成 ViewModel 的实例 private val viewModel by viewModels()override fun onCreate(savedInstanceState: Bundle?) {super.onCreate(savedInstanceState) setContentView(R.layout.activity_home_content) viewModel.requestBaiDu() viewModel.testLiveData.observe(this, Observer { ToastUtils.show(it) })}
Hilt 和 Room 的使用
这里需要用到 @Module 注解,使用 @Module 注解的普通类,在其中提供 Room 的实例。并且使用 @InstallIn 来声明 作用范围。
@Module@InstallIn(ApplicationComponent::class)object RoomModel {
/** * @Provides:常用于被 @Module 标记类的内部方法,并提供依赖对象 * @Singleton:提供单例 */ @Provides @Singleton fun provideAppDataBase(application: Application): AppDataBase { return Room .databaseBuilder(application, AppDataBase::class.java, "knif.db") .fallbackToDestructiveMigration() .allowMainThreadQueries() .build() }
@Provides @Singleton fun providerUserDao(appDataBase: AppDataBase): UserDao { return appDataBase.getUserDao() }}
我们给 providerUserDao 使用了 @Provides 注解 和 @Singleton 注解,是为了告诉 Hilt,当使用 UserDao 时需要执行 appDataBase.getUserDao() 。
而在调用 appDataBase.getUserDao() 时需要传入 AppDataBase,这时就会调用上面的方法 provideAppDataBase 了,因为这个方法也是用了 @Provides 注解。
并且这两个方法都是单例,只会调用一次。
使用如下:
class FragmentTwo : BaseLayoutFragment<FragTwoViewModel>() {
@Inject lateinit var userDao: UserDao}
到现在为止,就可以在任意地方获取到 UserDao,并且不用手动的创建实例。
使用 @Binds 进行接口注入
Binds:必须注释一个抽象函数,抽象函数的返回值是实现的接口。通过添加具有接口实现类型的唯一参数来指定实现。
首先需要一个接口,和一个实现类
interface User { fun getName(): String}
class UserImpl @Inject constructor() : User { override fun getName(): String { return "345" }}
接着就需要新建一个 Module。用来实现接口的注入
@Module@InstallIn(ApplicationComponent::class)abstract class UserModule { @Binds abstract fun getUser(userImpl: UserImpl): User}
注意:这个 Module 是抽象的。
使用如下:
@AndroidEntryPointclass FragmentOne : BaseLayoutFragment<FragOneViewModel>() {
@Inject lateinit var user: User}
使用 @Qualifier 提供同一接口,不同的实现
还是上面的 User 接口,有两个不同的实现,如下:
class UserAImpl @Inject constructor() : User { override fun getName(): String { return "345" }}
class UserBImpl @Inject constructor() : User { override fun getName(): String { return "Lv" }}
接着定义两个注解
@Qualifierannotation class A
@Qualifierannotation class B
然后修改 Module ,在 module 中用来标记相应的依赖。
@Module@InstallIn(ApplicationComponent::class)abstract class UserAModule { @A @Singleton @Binds abstract fun getUserA(userImpl: UserAImpl): User}
@Module@InstallIn(ActivityComponent::class)abstract class UserBModule { @B @ActivityScoped @Binds abstract fun getUserB(userImpl: UserBImpl): User}
这里用了两个不同的 mdule,并且对应两个不同的 component,一个是 application,另一个是 activity
最后使用如下:
@AndroidEntryPointclass FragmentOne : BaseLayoutFragment<FragOneViewModel>() {
@A @Inject lateinit var userA: User
@B @Inject lateinit var userB: User}
遇到的问题
在使用 @AndroidEntryPoint 注解的时候。需要在 fragment 和 actvity 都使用这个注解。
但是如果 activity 和 fragment 没在同一个module中,就会报错。
对于组件化的项目来说,这种情况就比较难受了。。。。
查找了一些资料:
主要问题之一是,通过在 Hilt 中发现模块的方式,无法区分哪些模块属于应用中的组件(如果他们确实使用过 Hilt) 已经库或其他库中的组件
另一个问题是,他将预先构建的组件层次结构变得复杂和混乱。就将你的库中所有活动一样,使父级成为 ApplicationComponent 也没有意义,因为您没有将组件放入 Application 。同样,如果一个仅包含片段库并托管在应用程序的活动中,那可能会遇到类似的情况,您希望库片段是独立的,单让 FragmentComponent 对象作为 ActivityComponent 并没有意义。
Hilt 好处
- 降低 Android 开发者使用依赖注入框架的上手成本
- 内部有一套标准的组件和作用域,对范围进行声明后,只能使用在指定的作用域中使用这个类,并且提供声明周期的管理,会自动释放不在使用的对象,减少资源的过度使用,提供代码的可重用性。
- 使用起来简单,告别繁琐的 new。。。这种流程,只需要添加注解即可。提高了代码的可读性,构建简单,耦合变低,容易测试
- 我感觉最大的好处就是管理他们的生命周期,只能在对应的范围内进行使用。感觉非常好。
参考自:Jetpack 新成员
Hilt-依赖注入框架上手指南
官方文档
如有问题,还请指出,谢谢!!
相关阅读
1 JetPack系列 Paging 3.0学习
2 JetPack + 单 Activity 的一些思路
3 Android Jetpack 最佳开发姿势
4 JetpackNote---基于Jetpack的学习笔记APP
5 245+篇,已分类整理
如果你有写博客的好习惯欢迎投稿点个在看,小生感恩❤️
android组件浮动在activity上_Jetpack Hilt 依赖注入框架上手指南相关推荐
- Android hilt 依赖注入使用详解
转载请标明出处:http://blog.csdn.net/zhaoyanjun6/article/details/128424833 本文出自[赵彦军的博客] 文章目录 官方文档 作用域于树图 添加依 ...
- 简述依赖注入框架 Hilt 的实现原理
目录 结论 1.Application 注解 @HiltAndroidApp 注解生成的文件 代码的执行流程 2.对象的创建流程 build 一下,看一下生成的类: 对象初始化流程 ActivityC ...
- Android神匕首—Dagger2依赖注入框架详解
简介 Dagger-匕首,鼎鼎大名的Square公司旗下又一把利刃(没错!还有一把黄油刀,唤作ButterKnife) Dagger2 是一个Android依赖注入框架,由谷歌开发,最早的版本Dagg ...
- Koin--适用于Kotlin的超好用依赖注入框架,Dagger替代者,Koin史上最详细解说,一篇就够了,妈妈再也不用担心我不会依赖注入了
今年呆在家中实在无聊,外面太危险了,还是在家学习比较安全可持续. 过年期间,我又复习了几遍依赖注入框架Dagger. 诶,什么是依赖注入? 说白了就是降低跟类对象之间的耦合,当需要修改类对象的时候,能 ...
- Android 依赖注入框架 Dagger2使用
前言 Dagger 2这个匕首确实很难上手,上手后又比较难瞬间掌握,可以这么说,刚开始使用就是用来尝(zhuang)鲜(X)的,但相信随着使用的加深,会不断体会到它对于整个项目架构的极强辅助作用,能使 ...
- Android:dagger2让你爱不释手-基础依赖注入框架篇
前言 dagger2的大名我想大家都已经很熟了,它是解决Android或java中依赖注入的一个类库(DI类库).当我看到一些开源的项目在使用dagger2时,我也有种匆匆欲动的感觉,因此就立马想一探 ...
- Kotlin替换Dagger2/Hilt的依赖注入框架--Koin。
Koin.Dagger2.Hilt 目前都是非常流行的库,面对这么多层出不穷的新技术,我们该做如何选择,是一直困扰我们的一个问题. Hilt 与 Dagger2 区别并不大,Hilt就是对Dagger ...
- android dagger2 懒加载,Android Dagger依赖注入框架浅析
今天接触了Dagger这套android的依赖注入框架(DI框架),感觉跟Spring 的IOC差不多吧.这个框架它的好处是它没有采用反射技术(Spring是用反射的),而是用预编译技术,因为基于反射 ...
- android peopleactivity.java,Android面试基础篇---Activity(上)
** 前言: ** 一.生命周期 1.七个方法: 1.1:onCreate() 在这里创建界面,做一些数据的初始化工作 1.2:onStart() 可见不可交互 1.3:onResume() 可见可交 ...
最新文章
- 《水泥公司信息管理系统》Access学习心得
- Git笔记(二)——[diff, reset]
- ASP.Net 管道模型 VS Asp.Net Core 管道 总结
- C#算法设计排序篇之07-希尔排序(附带动画演示程序)
- 实现Mybatis接口模式下的数据库调用分离
- Atitit IT办公场所以及度假村以及网点以及租房点建设之道 attilax总结
- oracle下载安装教程
- 推荐两款轻量级股票看盘工具
- 共谋发展:软件孵化器与软件开发云
- 关于人工智能研究思路的一点设想
- 中国标准时间转换成DateTime
- opencv 裁剪 java_OpenCV3 Java图像裁剪(Trimming Rect)
- 【乐理学习笔记】音符时值和拍号
- 使用腾讯云轻量应用服务器搭建网络质量拨测工具 SmokePing
- JS 变量保存为本地json文件,读取本地json文件为变量
- PMP续证费用和流程
- iOS 9 Storyboard 教程(一上)
- A direct formulation for sparse PCA using semidefinite programming
- 11月云短信报告出炉,腾讯云再次蝉联到达率冠军
- 太阳的光和灯光有什么区别_太阳光跟星光是一样的吗?两者有什么差异?
热门文章
- R语言ggplot2可视化包抑制数据轴使用科学计数法实战
- R语言创建自定义颜色(分类变量与颜色形成稳定映射)实战:设置因子变量(分类变量)到可视化颜色的稳定映射
- 医学影像阅读/分析软件FSLeyes安装避坑+核磁共振影像数据处理
- 使用pickle保存机器学习模型详解及实战(pickle、joblib)
- luci网页shell_openwrt luci web分析
- linux进程间通讯-无名管道
- Input.GetTouch 获取触摸
- 弱监督语义分割--Object Region Mining with Adversarial Erasing
- 手机CNN网络模型--MobileNets: Efficient Convolutional Neural Networks for Mobile Vision Applications
- 一次失败的尝试:Ubuntu 故障修复