3.Dagger2.38.1源码解析-ComponentProcessor注解规则续-优快云博客

本文深入解析Dagger2的ComponentProcessor中关于@Inject、@AssistedInject及其相关注解的使用规则，包括构造函数、变量、方法的校验，以及@AssistedFactory、@Assisted等注解的规则。文章详细阐述了注解的限制、依赖检查和成员注入等方面，旨在帮助开发者更好地理解和使用Dagger2。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

前言

可以加入575306647讨论dagger

这里是对Inject或InjectAssisted以及一些关联的注解进行规则校验，以及其他注解校验。

代码逻辑规则

具体代码体现出来的规则。

Inject和AssistedInject

整体了解

InjectProcessingStep类校验Inject和AssistedInject注解，InjectBindingRegistry对象是外部实例化后作为参数传递到当前InjectProcessingStep类。

InjectBindingRegistryImpl对象是用于实例化的InjectBindingRegistry，在InjectBindingRegistryImpl完成校验和Binding绑定对象的生成。

InjectProcessingStep类主要用于收集Inject或AssistedInject修饰的构造函数和Inject修饰的变量或普通方法：

Inject或AssistedInject修饰的构造函数，对该构造函数校验并且生成ProvisionBinding对象，并且继续校验该构造函数所在父节点是否存在被Inject修饰的变量或方法，如果存在对该父节点进行校验并且生成MembersInjectionBinding对象；
Inject修饰的变量或普通方法所在父节点校验，并且该父节点生成MembersInjectionBinding对象，并且对该父节点构造函数查看是否使用了Inject或AssistedInject注解，如果使用了，那么对该构造函数校验，并且生成ProvisionBinding对象。
注意以上的描述，我们需要知道，Inject既可以修饰变量或普通方法或构造函数，但是AssistedInject只可以用来修饰构造函数，详细情况下面具体规则。

Inject或AssistedInject修饰的构造函数

在validateConstructor类中校验，校验入口方法是validateConstructor；

对该构造函数校验，校验规则如下：

节点的构造函数不允许同时使用Inject注解和AssistedInject注解;
被Inject或AssistedInject修饰的构造函数不允许使用private修饰，也不能被Qualifier修饰的注解修饰；
被Inject或AssistedInject修饰的构造函数不能被Scope注解修饰的注解修饰；
Inject或AssistedInject修饰的构造函数的参数不能是Produced< T>和Producer< T>类型,并且对参数和参数类型做依赖校验，规则如下：

注：当前参数类型剥离RequestKind< T>类型得到T作为keyType（当然如果是RequestKind.INSTANCE，那么keyType就是参数类型）
（1）如果参数节点使用了@Assiste修饰，不进行下面的依赖校验；
（2）如果参数节点使用了Qualifier修饰的注解修饰，那么该类型注解不得超过1个；
（3）如果参数节点没有使用Qualifier修饰的注解修饰，那么keytype类型的构造函数不能使用AssistedInject修饰；
（4）如果参数节点没有使用Qualifier修饰的注解修饰，并且keyType节点使用了@AssistedFactory修饰，那么当前参数要么是T要么是Provider< T>，不能是Lazy< T>、Producer< T>或Produced< T>；
（5）keyType不能使用通配符；
（6）如果keyType是MembersInjector< T>（必须存在T）类型，那么对T进行成员注入校验:a.不能使用Qualifier注解修饰的注解修饰;b.T只能是类或接口，并且如果是泛型，那么泛型类型只能是类或接口或数组，数组只能是类或接口或数组，并且T不允许出现例如List类型（必须是List< T>类型）；

被Inject或AssistedInject修饰的构造函数如果throws异常，那么异常一定要是RuntimeException或Error或两者子类；
使用了Inject或AssistedInject修饰的构造函数所在父节点不可以被private类使用,该构造函数所在父节点也不能使用abstract修饰,并且如果构造函数所在父节点是一个内部类，那么该内部类必须使用static修饰；
一个类最多只能有一个构造函数被Inject或AssitedInject修饰；
使用AssistedInject修饰的构造函数所在的父节点不能被使用Scope注解修饰的注解修饰；
使用Inject修饰的构造函数所在父节点最多只能有一个使用Scope注解修饰的注解修饰；
对当前Inject或AssisteInject修饰的构造函数的父节点中，如果存在Inject修饰的普通方法或变量，那么对当前父节点校验，参考Inject修饰的变量或普通方法。

Inject修饰的变量或普通方法

在validateConstructor类中校验，校验入口方法是validateMembersInjectionType；

Inject修饰的变量或普通方法校验的是当前Inject修饰的节点所在的父节点，校验规则如下：

对使用Inject修饰变量校验：

（1）Inject修饰的变量节点不能使用final修饰；也不要使用private和static修饰（可能警告可能报错）；
（2）当前变量和变量类型做依赖校验：
注：当前变量类型剥离RequestKind< T>类型得到T作为keyType（当然如果是RequestKind.INSTANCE，那么keyType就是变量类型）
① 当前变量如果使用了Qulifiers注解修饰的注解，那么该类型的注解最多只能使用1个；
② 如果变量节点没有使用Qualifier修饰的注解修饰，那么keytype类型的构造函数不能使用AssistedInject修饰；
③ 如果变量节点没有使用Qualifier修饰的注解修饰，并且keyType节点使用了@AssistedFactory修饰，那么当前变量要么是T要么是Provider< T>，不能是Lazy< T>、Producer< T>或Produced< T>；
④ keyType不能使用通配符；
⑤ 如果keyType是MembersInjector< T>（必须存在T）类型，那么对T进行成员注入校验:a.T不能使用Qualifier注解修饰的注解修饰;b.T只能是类或接口，并且如果是泛型，那么泛型类型只能是类或接口或数组，数组只能是类或接口或数组，并且T不允许出现例如List类型（必须是List< T>类型）
⑥ Inject修饰的变量节点不能是Produced< T>或Producer< T>类型；

对使用Inject修饰的普通方法校验：

（1）Inject修饰的普通方法必须是实现类，不能是abstract修饰的抽象类或接口方法；
（2）Inject修饰的普通方法不要使用private和static修饰（可能报错可能警告）；
（3）Inject修饰的普通方法不能使用泛型类型,并且不能throws异常；
（4）Inject修饰的普通方法的参数合参数类型做依赖校验：
注1：当前参数类型剥离RequestKind< T>类型得到T作为keyType（当然如果是RequestKind.INSTANCE，那么keyType就是参数类型）；
注2：如果参数使用了@Assisted修饰，不进行下面的依赖校验；
① 当前参数如果使用了Qulifiers注解修饰的注解，那么该类型的注解最多只能使用1个；
② 如果参数节点没有使用Qualifier修饰的注解修饰，那么keytype类型的构造函数不能使用AssistedInject修饰；
③ 如果参数节点没有使用Qualifier修饰的注解修饰，并且keyType节点使用了@AssistedFactory修饰，那么当前参数要么是T要么是Provider< T>，不能是Lazy< T>、Producer< T>或Produced< T>；
④ keyType不能使用通配符；
⑤ 如果keyType是MembersInjector< T>（必须存在T）类型，那么对T进行成员注入校验:a.T不能使用Qualifier注解修饰的注解修饰;b.T只能是类或接口，并且如果是泛型，那么泛型类型只能是类或接口或数组，数组只能是类或接口或数组，并且T不允许出现例如List类型（必须是List< T>类型）
⑥ Inject修饰的普通方法的参数类型不能是Produced< T>或Producer< T>类型；

Inject修饰的节点所在父节点最好不要被private修饰（可能警告可能报错）；并且Inject修饰的节点所在父节点不能是Kotlin Object或Kotlin Companion Object对象；
对当前使用Inject修饰的节点所在的父节点的非Object父级节点进行类型校验：

（1）对该节点中Inject修饰的变量或普通方法校验，从步骤1开始；
（2）对该节点使用Inject或AssistedInject修饰的构造函数校验，自行查看Inject或AssistedInject修饰的构造函数规则。

AssistedFactory

AssistedFactory修饰的节点中的方法仅仅针对abstract（接口除外）、非static、非private修饰的方法校验，

AssistedFactory注解使用规则如下：

使用AssistedFactory修饰的节点仅仅支持抽象类或接口;
如果AssistedFactory修饰的节点是内部类，那么必须使用static修饰;
AssistedFactory修饰的节点必须有且仅有一个abstract、非static、非private的方法节点；
AssistedFactory修饰的节点中的方法返回类型的构造函数必须使用@AssistedInject修饰；
AssistedFactory修饰的节点中的方法不允许使用泛型；
AssistedFactory修饰的节点中的唯一方法传递的参数和该方法返回类型中的构造函数使用@Assisted注解修饰的参数保持一致。

Assisted

Assisted修饰的节点规则如下：

Assisted只能修饰方法参数，并且仅仅满足一下条件：

（1）@Assisted修饰的参数，位于一个被@AssistedInject修饰的构造函数中；
（2）@Assisted修饰的参数所在的方法节点是所在父节点中唯一的一个abstract、非static、非private修饰的方法，并且该方法节点所在父节点使用@AssistedFactory注解修饰；
（3）@Assisted修饰的参数所在的方法，该方法命名包含"copy" ，该方法所在类是一个data类型的kotlin文件；

@Assisted修饰的参数节点不能被Qualifier注解修饰的注解修饰；
@AssistedInject修饰的构造函数或@AssistedFactory修饰的节点中的普通方法都不允许出现重复的@Assisted修饰的参数类型。

规则总结

根据代码总结出来的大致规则。

Inject和AssistedInject使用总结

AssistedInject只能用于修饰构造函数，Inject可以用于修饰变量、构造函数或普通方法；
构造函数不能同时被Inject和AssistedInject修饰；
Inject或AssistedInject修饰的构造函数不能使用private修饰，也不能使用Qualifier注解修饰的注解修饰，一个节点中只允许一个构造函数使用Inject或AssistedInject修饰；
依赖和成员注入对象：

（1）Inject或AssistedInject修饰的构造方法中的参数和参数类型作为依赖，如果参数类型是MembersInjector< T>,那么T作为成员注入对象；
（2）Inject修饰的普通方法中的参数和参数类型作为依赖，如果参数类型是MembersInjector< T>,那么T作为成员注入对象；
（3）Inject修饰的变量和变量类型作为依赖，如果变量类型是MembersInjector< T>,那么T作为成员注入对象；

Inject修饰的变量不能使用final修饰，也不要使用private和static修饰；
Inject修饰的普通方法必须是具体实现类；

AssistedFactory、AssistedInject和Assisted使用总结

AssistedInject仅仅修饰构造函数；AssistedFactory只能修饰抽象类或接口；

（1）一个节点最多只能出现一个Inject或AssistedInject修饰的构造函数；
（2）AssistedFactory修饰的节点中有且仅有一个abstract、非private、非static修饰的方法;
（3）如果AssistedFactory修饰的是一个内部类，那么该内部类必须使用static修饰；

Assisted只支持修饰参数，并且该参数位于①@AssistedInject修饰的构造方法中的参数或 ②@AssistedFactory注解修饰的有且仅有的唯一方法的参数；并且同一个方法中不允许出现重复的Assisted修饰的参数；
AssistedFactory修饰的节点中的唯一方法传递的参数和该方法返回类型中的构造函数使用@Assisted注解修饰的参数保持一致。

其他注解

@IntoSet、@IntoMap和@ElementsIntoSet

以上三个注解在同一个方法上最多使用一个；
以上三个注解，必须在bindingMethod绑定方法上使用，并且只支持@Provides、@Produces或@Binds三种类型的bindingMethod方法；
如果使用了@ElementsIntoSet，那么当前bindingMethod方法返回类型必须是Set< T>；
@IntoMap 和@MapKey修饰的注解一定是成对出现的。

@BindsInstance

@BindsInstance只能用来修饰方法和方法参数，并且在creator节点中不能用于修饰factoryMethod和buildMethod方法；

对@BindsInstance修饰的方法参数校验：

（1）当前使用@BindsInstance修饰的方法参数：
①该参数不能使用FrameworkType架构类型：Provider,Lazy,MembersInjector,Produced,Producer；
②该参数在没有使用Qualifier修饰的注解修饰情况下，参数类型的构造函数不能使用AssistedInject修饰并且参数类型不能使用AssistedFactory注解修饰；
③参数类型只能是原始类型或数组或接口或类或变量类型；
（2）参数节点最多只能使用一个Qualifier修饰的注解修饰；
（3）参数节点不能使用Scope修饰的注解修饰；
（4）参数所在方法必须是abstract修饰的抽象方法或接口中的非default方法；
（5）@BindsInstance修饰的参数所在方法的返回类型，只能是一个类或接口（可以是泛型），不能是void、数组又或者原始类型。

对@BindsInstance修饰的方法进行校验：

（1）当前使用@BindsInstance修饰的方法校验：
注：@BindsInstance修饰的方法有且仅有一个参数
① 唯一参数的类型不能使用FrameworkType架构类型：Provider,Lazy,MembersInjector,Produced,Producer；
② 唯一参数的类型的构造函数不能使用AssistedInject修饰并且该参数节点不能使用AssistedFactory注解修饰；
③ 唯一的参数类型只能是原始类型或数组或接口或类或变量类型；
（2）@BindsInstance修饰的方法上最多只允许被一个Qualifier修饰的注解修饰；
（3）@BindsInstance修饰的方法不能使用Scope修饰的注解修饰；
（4）@BindsInstance修饰的方法必须使用abstract修饰或接口非default修饰的普通方法；
（5）@BindsInstance修饰的方法所在父节点不允许是module节点，也不允许是component节点，只能在creator节点中使用；

MapKey

@MapKey只能用于修饰注解，对其校验规则如下：

@MapKey修饰的注解必须有方法；
@MapKey修饰的注解在MapKey.unwrapValue() = true的情况下，被修饰的注解类方法有且仅有一个，并且该方法的返回类型不可以是TypeKind.ARRAY数组；
如果MapKey.unwrapValue() = false，被修饰的注解类方法可以有多个，并且当前项目必须引用com.google.auto.value.AutoAnnotation；
@MapKey修饰的注解最常用的是和@IntoMap作用于bindingMethod绑定方法，当前MapKey修饰的注解里面的方法值提供Map<K,V>中的K，bindingMethod上的绑定类型和返回类型决定V；

Qualifier

Qualifier修饰注解的注解，具体规则如下：

节点上只允许出现一个Qualifier修饰注解的注解；
componentMethod方法只有在返回类型是subcomponent节点或subcomponent.creator节点情况下才允许使用Qualifier修饰的注解修饰；
bindingMethod方法可以被Qualifier修饰的注解修饰；
MembersInjector的成员注入T类型不允许使用Qualifier修饰的注解修饰；
被Inject或AssistedInject修饰的构造方法不允许使用Qualifier修饰的注解修饰，但是构造函数的参数可以；
@Assisted修饰的参数节点不能被Qualifier注解修饰的注解修饰；
一个节点允许使用Qualifier修饰，那么当前节点类型（如果是方法，则表示方法返回类型）的构造函数可以使用AssistedInject修饰。

Scope

Scope修饰注解的注解，具体规则如下：

module节点不允许使用Scope注解修饰的注解修饰;
针对bindingMethod方法，只有@Binds和@Provides修饰的bindingMethod支持使用Scope注解修饰的注解修饰，并且该bindingMethod方法只允许出现一个使用Scope注解修饰的注解修饰;
被Inject或AssistedInject修饰的构造函数不能被Scope注解修饰的注解修饰;
使用AssistedInject修饰的构造函数所在的父节点不能被使用Scope注解修饰的注解修饰；使用Inject修饰的构造函数所在父节点最多只能有一个使用Scope注解修饰的注解修饰；
@BindsInstance修饰的方法或方法参数都不可以使用Scope修饰的注解修饰。

依赖总结

componentMethod方法无参并且返回类型不是subcomponent也不是subcomponent.creator，当前componentMethod方法节点和方法返回类型做依赖校验；
bindingMethod的方法参数节点和参数类型做依赖校验；
Inject或AssistedInject修饰的构造函数里面的参数节点和参数类型做依赖校验；
Inject修饰的变量节点和变量类型做依赖校验；
Inject修饰的普通方法的方法参数节点和参数类型做依赖校验；

MembersInjector成员注入总结

componentMethod方法无参并且返回类型不是subcomponent也不是subcomponent.creator，当前componentMethod方法作为依赖节点和方法返回类型做依赖校验后，如果方法返回类型是MembersInjector类型，对依赖节点和T做成员注入校验；
componentMethod方法返回类型不是subcomponent节点也不是subcomponent.creator节点，并且有且仅有一个参数，该方法节点和方法参数类型做成员注入校验;
bindingMethod的方法(方法参数节点作为依赖节点)参数做依赖校验，并且参数类型是MembersInjector< T>,对依赖节点和T做成员注入校验；
Inject或AssistedInject修饰的构造函数里面的参数(该参数作为依赖节点)作为依赖，需要做依赖校验，如果参数类型是MembersInjector< T>,对依赖节点和T做成员注入校验;
Inject修饰的变量作为依赖节点和变量类型做依赖校验,如果变量类型是MembersInjector< T>,对依赖节点和T做成员注入校验;
Inject修饰的普通方法的参数作为依赖节点和参数类型做依赖校验,如果参数类型是MembersInjector< T>,对依赖节点和T做成员注入校验;