如何使用 Guice 将@Inject到现有的对象层次结构中?

我有一个现有的对象层次结构,其中某些对象具有需要注入的字段。此外,还有一些其他对象是使用Google Guice构造的,需要注入对先前描述的对象层次结构中的某些对象的引用。我如何用Guice进行这种注射?

问题在于,现有层次结构中的对象不是使用 Guice 构造的,因此默认情况下不受注入进程的影响。当然,有一种方法可以注入到现有的对象实例中,但它不适用于对象层次结构。injector.injectMembers()

对于那些想知道为什么我不能使用Guice构建提到的对象层次结构的人。此层次结构表示 GUI 对象,并由 GUI 框架 (Apache Pivot) 根据声明性 GUI 描述构建(实际上,此过程可以描述为对象反序列化)。这样,接口构造就相当简单,我只想将某些服务引用注入接口对象,反之亦然(对于回调)。

我目前将要采取的方法如下所述。

要注入到预先存在的对象层次结构中,只需让所有对注入感兴趣的对象实现某些接口,例如:

public interface Injectable {
  void injectAll(Injector injector);
}

然后,这些对象将实现此接口,如下所示:

public void injectAll(Injector injector) {
  injector.injectMembers(this);
  for (Injectable child : children)
    child.injectAll(injector);
}

然后,我只调用层次结构中的根对象,并注入所有感兴趣的对象。mainWindow.injectAll(injector)

不是很好的解决方案,但可以在一方面完成工作。另一方面,我需要从此层次结构中注入对象。我想这可以通过为这些对象实现自定义提供程序来完成。

有没有更好的解决方案来解决我的问题?也许我的方法也有问题?


答案 1

这个解决方案会起作用,但我想向你提出一个稍微不同的解决方案。

具体来说,由于您将遍历一个深层对象结构,因此这实际上看起来像是Viser模式的工作。此外,你所描述的似乎调用了一个两阶段注入器:一个“bootstrap”阶段,可以注入透视创建的层次结构所需的内容(但不能注入任何透视创建的元素)和第二个阶段,它是你的应用程序使用的真正注入器(可以注入任何东西)。

我建议的是这个基本模式:让一个遍历层次结构的访问者,然后,它会注入那些需要它的东西,并记录那些需要注入其他地方的东西。然后,当它完成访问所有内容时,它用于制作一个新的,可以从原始内容和从透视创建的层次结构中注入内容。Injector.createChildInjectorInjectorInjector

首先定义一个可以访问此层次结构中所有内容的访问者:

public interface InjectionVisitor {
  void needsInjection(Object obj);
  <T> void makeInjectable(Key<T> key, T instance);
}

然后为所有透视创建的元素定义一个接口:

public interface InjectionVisitable {
  void acceptInjectionVisitor(InjectionVisitor visitor);
}

您将在透视创建的类中实现此接口,如下所示(假设类中的此代码):FooContainer

public void acceptInjectionVisitor(InjectionVisitor visitor) {
  visitor.needsInjection(this);
  visitor.makeInjectable(Key.get(FooContainer.class), this);
  for (InjectionVisitable child : children) {
    child.acceptInjectionVisitor(visitor);
  }
}

请注意,前两个语句是可选的 - 可能是透视层次结构中的某些对象不需要注入,也可能是其中一些对象以后不希望可注入。另外,请注意 - 的用法,这意味着如果您希望某些类可以与特定的注释一起注入,则可以执行如下操作:Key

visitor.makeInjectable(Key.get(Foo.class, Names.named(this.getName())), this);

现在,您如何实现?操作方法如下:InjectionVisitor

public class InjectionVisitorImpl implements InjectionVisitor {
  private static class BindRecord<T> {
    Key<T> key;
    T value;
  }

  private final List<BindRecord<?>> bindings = new ArrayList<BindRecord<?>>();
  private final Injector injector;

  public InjectionVisitorImpl(Injector injector) {
    this.injector = injector;
  }

  public void needsInjection(Object obj) {
    injector.injectMemebers(obj);
  }

  public <T> void makeInjectable(Key<T> key, T instance) {
    BindRecord<T> record = new BindRecord<T>();
    record.key = key;
    record.value = instance;
    bindings.add(record);
  }

  public Injector createFullInjector(final Module otherModules...) {
    return injector.createChildInjector(new AbstractModule() {
      protected void configure() {
        for (Module m : otherModules) { install(m); }
        for (BindRecord<?> record : bindings) { handleBinding(record); }
      }
      private <T> handleBinding(BindRecord<T> record) {
        bind(record.key).toInstance(record.value);
      }
    });
  }
}

然后,在方法中将其用作:main

PivotHierarchyTopElement top = ...; // whatever you need to do to make that
Injector firstStageInjector = Guice.createInjector(
   // here put all the modules needed to define bindings for stuff injected into the
   // pivot hierarchy.  However, don't put anything for stuff that needs pivot
   // created things injected into it.
);
InjectionVisitorImpl visitor = new InjectionVisitorImpl(firstStageInjector);
top.acceptInjectionVisitor(visitor);
Injector fullInjector = visitor.createFullInjector(
  // here put all your other modules, including stuff that needs pivot-created things
  // injected into it.
);
RealMainClass realMain = fullInjector.getInstance(RealMainClass.class);
realMain.doWhatever();

请注意,工作方式可确保,如果您将任何东西绑定到注入到透视层次结构中,您将获得由真实注入器注入的相同实例 - 只要能够处理注入,就会将注入委托给。createChildInjector@SingletonfullInjectorfirstStageInjectorfirstStageInjector

编辑以添加:一个有趣的扩展(如果你想深入研究深层的Guice魔法)是修改,以便它记录在你的源代码中调用.然后,当您的代码意外地告诉访问者绑定到同一键的两个不同内容时,您可以从Guice获得更好的错误消息。为此,您需要添加 to ,记录方法内部的结果,然后更改为:InjectionImplmakeInjectableStackTraceElementBindRecordnew RuntimeException().getStackTrace()[1]makeInjectablehandleBinding

private <T> handleBinding(BindRecord<T> record) {
  binder().withSource(record.stackTraceElem).bind(record.key).toInstance(record.value);
}

答案 2

您可以注入成员注入器来注入嵌套字段。例如,这将深度注入现有的 Car 实例:

public class Car {
  Radio radio;
  List<Seat> seats;
  Engine engine;

  public Car(...) {...}

  @Inject void inject(RadioStation radioStation,
      MembersInjector<Seat> seatInjector,
      MembersInjector<Engine> engineInjector) {
    this.radio.setStation(radioStation);
    for (Seat seat : seats) {
      seatInjector.injectMembers(seat);
    }
    engineInjector.injectMembers(engine);
  }
}

public class Engine {
  SparkPlug sparkPlug;
  Turbo turbo

  public Engine(...) {...}

  @Inject void inject(SparkPlug sparkplug,
      MembersInjector<Turbo> turboInjector) {
    this.sparkPlug = sparkPlug;
    turboInjector.injectMembers(turbo);
  }
}

推荐