Android Hilt的使用以及遇到的问题

目录
  • 简介
  • 导入Hilt
  • 组件层次
  • 组件默认绑定
  • 简单使用
  • @HiltAndroidApp
    • 介绍
    • 使用
  • @AndroidEntryPoint
    • 介绍
    • 使用
  • @Module 和 @InstallIn
    • 介绍
    • 使用
  • @Provides 和 @Binds
    • 介绍
    • 使用
  • @HiltViewModel
    • 介绍
    • 使用
  • @EntryPoint
    • 介绍
  • 小结

简介

Hilt 提供了一种将Dagger 依赖注入到Android 应用程序的标准方法。为Android 应用程序简化提供一组标准的、简化设置、可以读的组件;且为不同类型的构建(例如:测试、调试、发行)提供一种简单的方法。

可以理解为Google 为了统一依赖注入组件,但是Dagger 用起来比较复杂。就针对Android开发了一套适配库。

导入Hilt

apply plugin: 'com.android.application'
apply plugin: 'dagger.hilt.android.plugin'

android {
  // ...
}

dependencies {
  implementation 'com.google.dagger:hilt-android:2.34.1-beta'
  kapt 'com.google.dagger:hilt-compiler:2.34.1-beta'

  // For instrumentation tests
  androidTestImplementation  'com.google.dagger:hilt-android-testing:2.34.1-beta'
  kaptAndroidTest 'com.google.dagger:hilt-compiler:2.34.1-beta'

  // For local unit tests
  testImplementation 'com.google.dagger:hilt-android-testing:2.34.1-beta'
  kaptTest 'com.google.dagger:hilt-compiler:2.34.1-beta'
}

kapt {
 correctErrorTypes true
}

设置correctErrorTypes 为true ,将kapt配置为更正错误类型 。
这里遇到一个问题,当我的gradle 版本为 3.4.1 的时候

classpath 'com.android.tools.build:gradle:3.4.1'

apply plugin: 'dagger.hilt.android.plugin'插件一直安装失败,
提示找不到 "com/android/Version" 把gradle 改成 4.1.2 就没问题了
且注意 如果你是多module的项目,
apply plugin: 'dagger.hilt.android.plugin' 一定要plugin在主module下
(也就是跟 apply plugin: 'com.android.application' 一起),
若是只在子module下,主module的注入不会被实现。(问题1,后面会解释问题原因)

buildscript {
  repositories {
    // other repositories...
    mavenCentral()
  }
  dependencies {
    // other plugins...
    classpath 'com.google.dagger:hilt-android-gradle-plugin:2.34.1-beta'
  }
}

组件层次

Hilt把Dagger 手动创建Component 改成了预定义的Component,且自动集成到Android应用程序的各个生命周期中。通过注解的方式@InstallIn(xxxComponent.class)进行绑定。
下图显示了标准的Hilt组件层次结构。每个组件上方的注释是作用域注释,用于将绑定范围限制为该组件的生存期。组件下方的箭头指向任何子组件。通常,子组件中的绑定可以依赖于祖先组件中的任何绑定。

组件默认绑定

每个Hilt 组件都带有一组默认绑定,这些默认绑定可以作为依赖注入到你自定义绑定中

Component Default Bindings
SingletonComponent Application
ActivityRetainedComponent Application
ViewModelComponent SavedStateHandle
ActivityComponent Application, Acitvity
FragmentComponent Application, Acitvity, Fragment
ViewComponent Application, Acitvity, View
ViewWithFragmentComponent Application, Acitvity, Fragment, View
ServiceComponent Application, Service

简单使用

下面我为大家介绍以下一些注解的使用:

  • @HiltAndroidApp
  • @AndroidEntryPoint
  • @InstallIn
  • @Module
  • @Provides
  • @Binds
  • @HiltViewModel
  • @EntryPoint

想要了解更多的建议直接查看官方文档

@HiltAndroidApp

介绍

所有使用Hilt的App 必须包含一个被@HiltAndroidApp 注释的Appliction 类。
@HiltAndroidApp 会生成一个Hilt_MyApplication 的基类,并且继承与@HiltAndroidApp 注释的类的基类,然后将@HiltAndroidApp 注释的类的基类替换成Hilt_MyApplication。例如:
这是我们应用的 MyApplication

@HiltAndroidApp
class MyApplication extends BaseApplication{
}

使用@HiltAndroidApp Hilt 将会生成 Hilt_MyApplication

public abstract class Hilt_MyApplication extends BaseApplication implements GeneratedComponentManagerHolder {
  private final ApplicationComponentManager componentManager = new ApplicationComponentManager(new ComponentSupplier() {
    @Override
    public Object get() {
      return DaggerMyApplication_HiltComponents_SingletonC.builder()
          .applicationContextModule(new ApplicationContextModule(Hilt_MyApplication.this))
          .build();
    }
  });

  @Override
  public final ApplicationComponentManager componentManager() {
    return componentManager;
  }

  @Override
  public final Object generatedComponent() {
    return this.componentManager().generatedComponent();
  }

  @CallSuper
  @Override
  public void onCreate() {
    // This is a known unsafe cast, but is safe in the only correct use case:
    // MyApplication extends Hilt_MyApplication
    ((MyApplication_GeneratedInjector) generatedComponent()).injectMyApplication(UnsafeCasts.<MyApplication>unsafeCast(this));
    super.onCreate();
  }
}

并且使我们的 MyApplication 继承 Hilt_MyApplication,通过这种方式将modules 注入到我们的应用中。
可以看到具体的注入方法就是Hilt_MyApplication onCreate() 函数中的
((MyApplication_GeneratedInjector) generatedComponent()).injectMyApplication(UnsafeCasts.unsafeCast(this));
这句代码,generatedComponent() 返回的是 MyApplication_HiltComponents.SingletonC 对象,这个对象中就是我们所有module 的代码实现。有兴趣的同学可以自己去看一下,我这里就不贴代码了

使用

使用分为两种情况,添加和没有添加 Hilt Gradle插件

//没有添加插件
@HiltAndroidApp(BaseApplication.class)
class MyApplication extends Hilt_MyApplication{}

//添加插件
@HiltAndroidApp
class MyApplication extends BaseApplication{}

建议添加插件,使用起来会更简单。本文以下的示例都假定以使用插件。
这里需要注意的是如果要在MyApplication 中使用注入的对象,需要在 super.onCreate() 之后才能使用。 原因且看介绍中的 Hilt_MyApplication 源码。
这里解释一下问题1出现的原因,是因为我没有添加插件但@HiltAndroidApp 使用的时候用的却是添加了插件的用法。所以会出现module 注入不被实现的情况。

@AndroidEntryPoint

介绍

安卓成员注入,使用@AndroidEntryPoint 注解后就可以在该类中使用module注入的成员变量。但@AndroidEntryPoint 有类型限制,只能在以下的类上使用:

  1. Activity
  2. Fragment
  3. View
  4. Service
  5. BroadcastReceiver

使用

@AndroidEntryPoint
public final class MyActivity extends MyBaseActivity {
  // Bindings in SingletonComponent or ActivityComponent
  @Inject Bar bar;

  @Override
  public void onCreate(Bundle savedInstanceState) {
    // Injection happens in super.onCreate().
    super.onCreate();

    // Do something with bar ...
  }
}

同样要注意是是需要在 super.onCreate() 后使用注入的成员变量

@Module 和 @InstallIn

介绍

@Module 跟Dagger 里的是同一个,没什么好说的。
@InstallIn 通过使用@InstallIn(xxxComponent.class) 将module 安装到指定的组件中,在Hilt 中所以module 都必须添加这个注释,如果组件中就找不到这个module ,可能引起编译错误。
当然一个module 也可安装到多个组件上如:@InstallIn({ViewComponent.class, ViewWithFragmentComponent.class})

使用

@Module
@InstallIn(SingletonComponent.class)
public final class FooModule {
  // @InstallIn(SingletonComponent.class) module providers have access to
  // the Application binding.
  @Provides
  static Bar provideBar(Application app) {...}
}

每个组件都带有作用域注释,该注释可用于记住对组件生存期的绑定。例如,要将范围绑定到 SingletonComponent组件,请使用@Singleton批注:

@Module
@InstallIn(SingletonComponent.class)
public final class FooModule {
  // @Singleton providers are only called once per SingletonComponent instance.
  @Provides
  @Singleton
  static Bar provideBar() {...}
}

此外,每个组件都有默认情况下可用的绑定。例如,该SingletonComponent组件提供了Application 绑定:

@Module
@InstallIn(SingletonComponent.class)
public final class FooModule {
  // @InstallIn(SingletonComponent.class) module providers have access to
  // the Application binding.
  @Provides
  static Bar provideBar(Application app) {...}
}

@Provides 和 @Binds

介绍

@Provides 注释Module 中的方法以创建提供者方法绑定。该方法的返回类型绑定到其返回值。
@Binds 注释Module 中的抽象方法,一般方法的返回是一个接口,参数是实现接口的子类,在调用是会调用参数的子类中的方法实现。

使用

@Module
@InstallIn(SingletonComponent.class)
public final class FooModule {
  @Provides
  @Singleton
  static Bar provideBar() {...}
}

@Module
@InstallIn(SingletonComponent.class)
public abstract class BindModule {
  @Binds
  @Singleton
  abstract Random bindRandom(SecureRandom secureRandom);
}

@HiltViewModel

介绍

使用 @HiltViewModel 注释ViewModel,ViewModel 在创建的时候就会走Hilt 创建的HiltViewModelFactory 进行创建。就可以使用在创建的时候使用Module 中提供的实例

使用

@HiltViewModel
public final class FooViewModel extends ViewModel {

  @Inject
  FooViewModel(SavedStateHandle handle, Foo foo) {
    // ...
  }
}

然后就可以在带有@AndroidEntryPoint 注解的activity、fragment 中使用了

@AndroidEntryPoint
public final class MyActivity extends AppCompatActivity {

  private FooViewModel fooViewModel;

  @Override
  protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    fooViewModel = new ViewModelProvider(this).get(FooViewModel.class);
  }
}

@EntryPoint

介绍

为不能使用注解的地方提供注入的对象。因为@AndroidEntryPoint 使用范围有限,在这范围之外要使用Hilt 注入的实例就可以使用@EntryPoint 来实现。
这个像是Hilt 把Component标准化后,使用者不能再里面添加方法,导致不能为使用不了注解的地方提供依赖而做出的解决方案。

@EntryPoint
@InstallIn(SingletonComponent.class)
public interface FooBarInterface {
  Bar getBar();
}

如果使用上面的定义

Bar bar = EntryPoints.get(applicationContext, FooBarInterface.class).getBar();

小结

一开始使用的时候我看到是 安卓开发平台“Hilt 和 Jetpack 集成”这个文档,真坑,文档不及时更新也不把官方链接放一下。吐槽一下。然后几经周转找到了官方文档才能有幸为大家介绍一下Hilt。
使用起来确实要比Dagger 舒服的多,少了很多模板代码,范围和生命周期的绑定也更好理解。不多bb 学它

以上就是Android Hilt的使用以及遇到的问题的详细内容,更多关于Android Hilt的资料请关注我们其它相关文章!

(0)

相关推荐

  • Android应用开发SharedPreferences存储数据的使用方法

    SharedPreferences是Android中最容易理解的数据存储技术,实际上SharedPreferences处理的就是一个key-value(键值对).SharedPreferences常用来存储一些轻量级的数据. 复制代码 代码如下: //实例化SharedPreferences对象(第一步) SharedPreferences mySharedPreferences= getSharedPreferences("test", Activity.MODE_PRIVATE);

  • android压力测试命令monkey详解

    一.Monkey 是什么?Monkey 就是SDK中附带的一个工具. 二.Monkey 测试的目的?:该工具用于进行压力测试. 然后开发人员结合monkey 打印的日志 和系统打印的日志,结局测试中出现的问题. 三.Monkey 测试的特点?Monkey 测试,所有的事件都是随机产生的,不带任何人的主观性. 四.Monkey 命令详解 1).标准的monkey 命令[adb shell] monkey [options] <eventcount> , 例如:adb shell monkey -

  • Android按钮单击事件的四种常用写法总结

    很多学习Android程序设计的人都会发现每个人对代码的写法都有不同的偏好,比较明显的就是对控件响应事件的写法的不同.因此本文就把这些写法总结一下,比较下各种写法的优劣,希望对大家灵活地选择编码方式可以有一定的参考借鉴价值. xml文件代码如下: <Button android:id="@+id/button1" android:layout_width="wrap_content" android:layout_height="wrap_conte

  • android TextView设置中文字体加粗实现方法

    英文设置加粗可以在xml里面设置: 复制代码 代码如下: <SPAN style="FONT-SIZE: 18px">android:textStyle="bold"</SPAN> 英文还可以直接在String文件里面直接这样填写: 复制代码 代码如下: <string name="styled_text">Plain, <b>bold</b>, <i>italic</

  • 六款值得推荐的android(安卓)开源框架简介

    1.volley 项目地址 https://github.com/smanikandan14/Volley-demo (1)  JSON,图像等的异步下载: (2)  网络请求的排序(scheduling) (3)  网络请求的优先级处理 (4)  缓存 (5)  多级别取消请求 (6)  和Activity和生命周期的联动(Activity结束时同时取消所有网络请求) 2.android-async-http 项目地址:https://github.com/loopj/android-asyn

  • android调试工具DDMS的使用详解

    具体可见http://developer.android.com/tools/debugging/ddms.html. DDMS为IDE和emultor.真正的android设备架起来了一座桥梁.开发人员可以通过DDMS看到目标机器上运行的进程/现成状态,可以 android的屏幕到开发机上,可以看进程的heap信息,可以查看logcat信息,可以查看进程分配内存情况,可以像目标机发送短信以及打电话,可 以像android开发发送地理位置信息.可以像gdb一样attach某一个进程调试. SDK

  • Android 动画之TranslateAnimation应用详解

    android中提供了4中动画: AlphaAnimation 透明度动画效果 ScaleAnimation 缩放动画效果 TranslateAnimation 位移动画效果 RotateAnimation 旋转动画效果 本节讲解TranslateAnimation动画,TranslateAnimation比较常用,比如QQ,网易新闻菜单条的动画,就可以用TranslateAnimation实现, 通过TranslateAnimation(float fromXDelta, float toXD

  • Android基础之使用Fragment控制切换多个页面

    今天讲解一下Fragment的控制,主要是切换View和页面替换等操作.还有就是如何获取Fragment的管理对象,以及与Activity的通信方式.1.管理Fragment要在activity中管理fragment,需要使用FragmentManager. 通过调用activity的getFragmentManager()取得它的实例. •可以通过FragmentManager做一些事情, 包括: 使用findFragmentById()(用于在activity layout中提供一个UI的f

  • Android 动画之ScaleAnimation应用详解

    android中提供了4中动画: AlphaAnimation 透明度动画效果 ScaleAnimation 缩放动画效果 TranslateAnimation 位移动画效果 RotateAnimation 旋转动画效果 本节讲解ScaleAnimation 动画, ScaleAnimation(float fromX, float toX, float fromY, float toY,int pivotXType, float pivotXValue, int pivotYType, flo

  • Android Hilt的使用以及遇到的问题

    目录 简介 导入Hilt 组件层次 组件默认绑定 简单使用 @HiltAndroidApp 介绍 使用 @AndroidEntryPoint 介绍 使用 @Module 和 @InstallIn 介绍 使用 @Provides 和 @Binds 介绍 使用 @HiltViewModel 介绍 使用 @EntryPoint 介绍 小结 简介 Hilt 提供了一种将Dagger 依赖注入到Android 应用程序的标准方法.为Android 应用程序简化提供一组标准的.简化设置.可以读的组件:且为不

  • Android Hilt依赖注入的使用讲解

    目录 什么是依赖注入 使用依赖注入的好处 Hilt中常用的预定义限定符 @HiltAndroidApp @AndroidEntryPoint @Module @InstallIn @Provides @Inject @HiltViewModel Hilt的使用 依赖 建立实体类 添加Hilt入口 提供对象 获取对象 应用与ViewModel中 使用 总结 什么是依赖注入 首先,某个类的成员变量称为依赖,如若此变量想要实例化引用其类的方法,可以通过构造函数传参或者通过某个方法获取对象,此等通过外部

  • Android统一依赖管理的三种方式总结

    目录 简述 传统apply from的方式(也是我以前项目中使用) buildSrc方式 什么是buildSrc 小结 Composing builds 什么是Composing builds 小结 Composing builds项目实战 在项目中新建一个model,用于管理配置信息 新建一个ConfigPlugin的类,不用具体的实现 编辑configPluginmodel中的build.gradle文件 修改根目录的settings.gradle文件 项目目录引入插件 在configPlu

  • Android开发之Fragment懒加载的几种方式及性能对比

    目录 1. Support时代的懒加载 2. AndrodX时代的懒加载 3. ViewPager2时代的懒加载 4. ViewPage和ViewPager2的性能对比 Android开发中ViewPager+Fragment的懒加载 TabLayout+ViewPager+Fragment是我们开发常用的组合.ViewPager的默认机制就是把全部的Fragment都加载出来,而为了保障一些用户体验,我们使用懒加载的Fragment,就是让我们再用户可见这个Fragment之后才处理业务逻辑.

  • 哔哩哔哩在Hilt组件化的使用技术探索

    目录 前言 接入Hilt Hilt在组件化 出现了点小问题 总结 前言 DI(Dependency Injection),即“依赖注入”:组件之间依赖关系由容器在运行期决定,形象的说,即由容器动态的将某个依赖关系注入到组件之中.依赖注入的目的并非为软件系统带来更多功能,而是为了提升组件重用的频率,并为系统搭建一个灵活.可扩展的平台.通过依赖注入机制,我们只需要通过简单的配置,而无需任何代码就可指定目标需要的资源,完成自身的业务逻辑,而不需要关心具体的资源来自何处,由谁实现. 最近业务同学需要接入

  • Android Jetpack架构中ViewModel接口暴露的不合理探究

    目录 暴露 Mutable 状态 暴露 Suspend 方法 在 Jetpack 架构规范中, ViewModel 与 View 之间应该遵循单向数据流的通信方式,Events 永远从 View 流向 VM ,而 State 从 VM 流向 View. 如果 ViewModel 对 View 暴露了不适当的接口类型,则会破坏单向数据流的形成.不适当的接口类型常见于以下两点: 暴露 Mutable 状态 暴露 Suspend 方法 暴露 Mutable 状态 ViewModel 对外暴露的数据状态

  • Android开发框架MVC-MVP-MVVM-MVI的演变Demo

    目录 Android框架的历史演变 一. MVC框架 二. MVP框架 三. MVVM框架 3.1 半MVVM框架 3.2 带DataBinding的MVVM框架 四. MVI框架 Android框架的历史演变 记得最开始入门Android的时候,还未流行MVP,都是MVC一把梭,后面工作了就是使用了MVP,当时学习的时候好难理解它的回调. 到目前主流的MVVM,其实就是MVP的升级版,再到最新的MVI使用意图传输,隔离各层级的直接调用.我算是经历了Android框架变迁的全过程. 这里记录一下

  • 移动端开发之Jetpack Hilt技术实现解耦

    目录 Hilt是什么 Hilt使用地方 依赖注入(DI)概念 Hilt使用 导入 Hilt是什么 Hilt 是基于 Dagger2 的针对 Android场景定制化 的框架. 这有点像什么? RxAndroid 是 RxJava 的Android平台定制化扩展.Andorid虽然由Java.Kotlin构成,但是它有很多平台的特性,比如它有 Java开发 所不知道的 Context 等. Dagger框架虽然很出名,在国外也很流行,但是在国内使用其的App少之又少,列举一些缺点: 上手难,众多A

  • 一文吃透Hilt自定义与跨壁垒

    目录 前言 跨越 IOC容器的壁垒 使用EntryPoint跨越IOC容器壁垒 自定义Scope.Component Scope.Component.Module的真实含义 自定义 定义Scope 定义Component 使用Manager管理Component 在生命周期范围更小的Component中使用 解决独立library的依赖初始化问题 使用hilt的聚合能力解决问题 聚合能力+EntryPoint 问题衍生 末 前言 本文隶属于我归纳整理的Android知识体系的第四部分,属于DI中

随机推荐