java - 如何使用 Dagger 2 将服务注入(inject) JavaFX Controller

Question

JavaFX 本身有一些 DI 方法允许在 XML 描述的 UI 和 Controller 之间进行绑定(bind):

<Pane fx:controller="foo.bar.MyController">
  <children>
    <Label fx:id="myLabel" furtherAttribute="..." />
  </children>
</Pane>

Java 端看起来像这样:

public class MyController implements Initializable {

    @FXML private Label myLabel;

    @Override
    public void initialize(URL url, ResourceBundle resourceBundle) {
        // FXML-fields have been injected at this point of time:
        myLabel.setText("Hello world!");
    }

}

要实现这一点，我不能只创建一个 MyController 的实例。相反，我必须要求 JavaFX 为我做一些事情:

FXMLLoader loader = new FXMLLoader(MyApp.class.getResource("/fxml/myFxmlFile.fxml"), rb);
loader.load();
MyController ctrl = (MyController) loader.getController();

到目前为止，还不错

但是，如果我想使用 Dagger 2 将一些非 FXML 依赖项注入(inject)到这个 Controller 类的构造函数中，我就会遇到问题，因为如果我使用 JavaFX，我无法控制实例化过程。

public class MyController implements Initializable {

    @FXML private Label myLabel;

    /*
    How do I make this work?

    private final SomeService myService;

    @Inject
    public MyController(SomeService myService) {
        this.myService = myService;
    }
    */

    @Override
    public void initialize(URL url, ResourceBundle resourceBundle) {
        // FXML-fields have been injected at this point of time:
        myLabel.setText("Hello world!");
    }

}

有一个 API 看起来很有前途:loader.setControllerFactory(...); 也许这是一个很好的起点。但是我对这些库没有足够的经验，不知道如何解决这个问题。

Answer 1

自定义 ControllerFactory 需要构造仅在运行时已知的某些类型的 Controller 。这可能类似于以下内容:

T t = clazz.newInstance();
injector.inject(t);
return t;

对于像 Guice 这样的大多数其他 DI 库来说，这完全没问题，因为它们只需要在它们的依赖关系图中查找 t 类型的依赖关系。

Dagger 2 在编译时解析依赖关系。它最大的特点同时也是最大的问题:如果一个类型只在运行时已知，编译器就无法区分 inject(t) 的调用。它可以是 inject(Foo foo) 或 inject(Bar bar)。

(这也不适用于 final 字段，因为 newInstance() 调用默认构造函数)。

---

好的，没有通用类型。让我们看看第二种方法:首先从 Dagger 获取 Controller 实例，然后将其传递给 FXMLLoader。

我使用了 Dagger 中的 CoffeeShop 示例并对其进行了修改以构建 JavaFX Controller :

@Singleton
@Component(modules = DripCoffeeModule.class)
interface CoffeeShop {
    Provider<CoffeeMakerController> coffeeMakerController();
}

如果我得到一个 CoffeeMakerController，它的所有字段都已经注入(inject)，所以我可以轻松地在 setController(...) 中使用它:

CoffeeShop coffeeShop = DaggerCoffeeShop.create();
CoffeeMakerController ctrl = coffeeShop.coffeeMakerController().get();

/* ... */

FXMLLoader loader = new FXMLLoader(fxmlUrl, rb);
loader.setController(ctrl);
Parent root = loader.load();
Stage stage = new Stage();
stage.setScene(new Scene(root));
stage.show();

我的 FXML 文件不能包含 fx:controller 属性，因为加载器会尝试构建一个 Controller ，这当然会与我们的 Dagger 提供的 Controller 发生冲突。

完整示例可在 GitHub 上找到