API翻译之javax.inject包

Inject

标记可注入的构造函数、方法和字段。可以应用于静态成员和实例成员。可注入成员可以具有任何访问修饰符(privatepackage-privateprotectedpublic)。首先注入构造函数,然后是字段,最后是方法。超类中的字段和方法在子类中的字段和方法之前被注入。没有指定同一类中的字段和方法之间的注入顺序。

可注入的构造函数用@Inject注释,并且接受零个或多个依赖项作为参数。每个类最多只能应用@Inject在一个构造函数上。

@Inject对于没有其他构造函数的公共无参数构造函数是可选的。这使得注入器能够调用默认构造函数。

@Inject
ConstructorModifiers opt
SimpleTypeName(FormalParameterList opt)
Throws opt
ConstructorBody opt

可注入字段:
-- 使用@Inject注释。
-- 不是final的。
-- 可以有任何其他有效的名称。

可注入方法:
-- 使用@Inject注释。
-- 不是抽象的。
-- 不要声明自己的类型参数。
-- 可以返回一个结果。
-- 可以有任何其他有效的名称。
-- 接受零个或多个依赖项作为参数。

@Inject
MethodModifiers opt
ResultType
Identifier(FormalParameterList opt)
Throws opt
MethodBody

注入器忽略注入方法的结果,但是允许空void返回类型支持在其他上下文中使用该方法(例如,构建器风格的方法链接)。
例如:

public class Car {
    //可注入的构造函数
    @Inject
    public Car(Engine) {...}

    //可注入的字段
    @Inject
    private Provider<Seat> seatProvider;

    //可注入包级私有方法
    @Inject
    void install(Windshield windshield, Trunk trunk) {...}
}

@Inject注解的方法覆盖了用@Inject注解的方法,对于每个实例的每个注入请求只注入一次。如果一个方法没有@Inject注解,但是覆盖了一个@Inject注解的方法,那么这个方法将不会被注入。

需要注入带有@Inject注解的成员。虽然可注入成员可以使用任何可访问性修饰符(包括private),但平台或注入器限制(如安全性限制或缺少反射支持)可能会阻止非公共成员的注入。

Qualifiers(限定符)

@Qualifier可以注解可注入的字段或参数,并结合类型标识要注入的实现。限定符是可选的,当在独立于注入器的类中与@Inject一起使用时,不应该有多个限定符注解单个字段或参数。在下面的例子中,限定符是粗体的:

public class Car {
    @Inject
    private @Leather Provider<Seat> seatProvider;

    @Inject
    void install(@Tinted Windshield windshield, @Big Trunk trunk) {...}
}

如果一个可注入方法覆盖另一个方法,则覆盖方法的参数不会自动从覆盖方法的参数继承限定符。

Injectable Values(可注入值)

对于给定类型T和可选限定符,注入器必须能够注入用户指定的类:
-- 赋值是否与T和相容.
-- 具有可注入构造函数。

例如,用户可以使用外部配置来选择T的实现,除此之外,注入的值取决于注入器实现及其配置。

Circular Dependencies(循环依赖)

检测和解析循环依赖关系是留给注入器实现的练习。两个构造函数之间的循环依赖关系是一个明显的问题,但是您也可以在可注入字段或方法之间有循环依赖关系:

class A {
    @Inject B b;
}
class B {
    @Inject A a;
}

构造A的一个实例时,不明智的注入器实现可能会进入一个无限循环构造的实例,B引用A,A的第二个实例引用B,B的第二个实例上引用第二个实例的A,等等。

保守的注入器可能在构建时检测到循环依赖项并生成错误,此时程序员可以通过注入Provider<A>Provider<B>来打破循环依赖项,而不是分别注入AB。直接从注入的构造函数或方法调用提供程序上的get(),会破坏提供程序跳出循环依赖项的能力。在方法或字段注入的情况下,确定依赖项的作用域(例如使用Singleton 作用域)也可以启用有效的循环关系。

Provider

提供T的实例。通常由注入器实现。对于可以注入的任何类型T,您也可以注入Provider<T>。与直接注入T相比,注入Provider<T>可以:
-- 获取多个实例。
-- 延后或者可选地获取一个实例。
-- 跳出循环依赖。
-- 抽象作用域,以便您可以从包含作用域中的实例查找较小作用域中的实例。

例如:

public class Car {
    public Car(Provider<Seat> seatProvider) {
        Seat driver = seatProvider.get();
        Seat passenger = seatProvider.get();
        ...
    }
}

Qualifier

限定符标记注解。任何人都可以定义一个新的限定符。一个限定符注释:
-- 是用@Qualifier、@Retention(RUNTIME)和@Documentation注解的。
-- 可以包含属性
-- 可能是公共API的一部分,很像依赖项类型,但不像实现类型不需要是公共API的一部分。
-- 如果使用@Target注解,可能会限制使用。虽然该规范只涉及对字段和参数应用限定符,但一些注入器配置可能会在其他地方(例如在方法或类上)使用限定符注解。
例如:

@java.lang.annotation.Documented
@java.lang.annotation.Retention(RUNTIME)
@javax.inject.Qualifier
public @interface Leather {
    Color color() default Color.TAN;
    public enum Color {RED, BLACK, TAN}
}

Named

基于字符串的Qualifier
使用实例:

public class Car {
    @Inject @Named("driver") Seat driverSeat;
    @Inject @Named("passenger") Seat passengerSeat;
    ...
 }

Scope

标记作用域注解。作用域注解应用于包含可注入构造函数的类,并控制注入器如何重用该类型的实例。默认情况下,如果没有作用域注解,注入器将创建一个实例(通过注入类型的构造函数),使用该实例进行一次注入,然后忘记它。如果存在作用域注解,则注入器可以保留实例,以便在以后的注入中重用。如果多个线程可以访问一个作用域实例,那么它的实现应该是线程安全的。作用域本身的实现由注入器决定。

接下来的例子中,作用域注解@Singleton确保我们只有一个Log实例:

@Singleton
class Log {
    void log(String message) { ... }
 }

如果注入器在同一类上遇到多个作用域注解或不支持的作用域注解,则会生成错误。

一个作用域注解:
-- 是用@Scope、@Retention(RUNTIME)和@Documentation注释的。
-- 没有属性。
-- 通常不是@inheritance,所以作用域与实现继承是正交的。
-- 如果使用@Target注释,可能会限制使用。虽然该规范只涵盖将作用域应用于类,但一些注入器配置可能会在其他地方(例如工厂方法结果)使用作用域注解。

例如:

@java.lang.annotation.Documented
@java.lang.annotation.Retention(RUNTIME)
@javax.inject.Scope
public @interface RequestScoped {}

使用@Scope注解于作用域注解,可以帮助注入器检测:程序员在类上使用作用域注解但忘记在注入器中配置作用域的情况。保守的注入器将生成错误,而不是不应用于作用域。

Singleton

标识注入器只实例化一次的类型。不继承。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,569评论 4 363
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,499评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,271评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,087评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,474评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,670评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,911评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,636评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,397评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,607评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,093评论 1 261
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,418评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,074评论 3 237
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,092评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,865评论 0 196
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,726评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,627评论 2 270

推荐阅读更多精彩内容