java - 子模块的故障安全注入(inject)器。 google guice 中的可选绑定(bind)

Question

我有一个名为 ChildPlugin 的子模块，我从主模块注入(inject)类，如下所示:

public class ChildPlugin {
    private ExampleClass demo;

    @Inject
    public void setDemo(ExampleClass demo) { 
        this.demo = demo;
    }
}

问题是不知道主模块是否绑定(bind)ExampleClass如果不是，Guice 在创建注入(inject)器时会抛出异常。我想做的就是让Guice通行证null或Optional.empty如果ExampleClass没有绑定(bind)。

我无权访问主模块，因此无法更改 ExampleClass 的 Binder 至OptionalBinder ，我试过@Nullable和Optional<ExampleClass>在ChildPlugin.setDemo方法，但没有成功。

Answer 1

有两种方法可以做到这一点。

可选注入(inject)

使用 com.google.inject.Inject 注释。这允许您在注释上指定可选。请参阅此示例:

public class GuiceInjectOptional extends AbstractModule {

    @Override
    protected void configure() {

        // method 1: 
        bind(B.class).in(Singleton.class);

    }

    public static class A {

        private String name;
        // non null constructor so that A can't be instantiated automatically by guice
        public A(String name) {
            this.name = name;
        }

        @Override
        public String toString() {
            return "I am: " + name;
        }
    }

    public static class B {

        @Inject(optional=true)
        A obj;

        void run() {
            System.out.println("Object is: " + obj);
        }
    }

    public static void main(String[] args) {
        Injector injector = Guice.createInjector(new GuiceInjectOptional());
        injector.getInstance(B.class).run();;
    }

}

类 B 上的注释表明 A 是可选的。它不会被注入(inject)。运行片段打印:

Object is: null

方法 2(这是在 guice 4+ 之后执行此操作的方法)。您可以指定可选的绑定(bind)。如果您愿意，这些绑定(bind)甚至允许您定义默认值。然后，您可以注入(inject)一个可选值，如我编写的这段代码:

public class GuiceInjectOptional extends AbstractModule {

    @Override
    protected void configure() {
        // set up optional binding for A.
        OptionalBinder.newOptionalBinder(binder(), A.class);

        bind(B.class).in(Singleton.class);
    }

    public static class A {

        private String name;
        // non null constructor so that A can't be instantiated automatically by guice
        public A(String name) {
            this.name = name;
        }

        @Override
        public String toString() {
            return "I am: " + name;
        }
    }

    public static class B {

        @Inject
        Optional<A> obj;

        void run() {
            System.out.println("Object is present: " + obj.isPresent());
            System.out.println("Object is: " + obj);
        }
    }

    public static void main(String[] args) {
        Injector injector = Guice.createInjector(new GuiceInjectOptional());
        injector.getInstance(B.class).run();;
    }

}

Inject 注释现在是非可选的，但 guice 知道类 A 可能已绑定(bind)，也可能未绑定(bind)。 运行代码片段将打印:

Object is present: false
Object is: Optional.empty

最后，您可以正常绑定(bind) A，guice 将注入(inject)它:

public class GuiceInjectOptional extends AbstractModule {

    @Override
    protected void configure() {
        // set up optional binding for A.
        OptionalBinder.newOptionalBinder(binder(), A.class);

        bind(A.class).toInstance(new A("Pandaa!"));
        bind(B.class).in(Singleton.class);
    }

    public static class A {

        private String name;
        // non null constructor so that A can't be instantiated automatically by guice
        public A(String name) {
            this.name = name;
        }

        @Override
        public String toString() {
            return "I am: " + name;
        }
    }

    public static class B {

        @Inject
        Optional<A> obj;

        void run() {
            System.out.println("Object is present: " + obj.isPresent());
            System.out.println("Object is: " + obj);
        }
    }

    public static void main(String[] args) {
        Injector injector = Guice.createInjector(new GuiceInjectOptional());
        injector.getInstance(B.class).run();;
    }

}

上面将打印:

Object is present: true
Object is: Optional[I am: Pandaa!]

这就是如何使用 guice 进行故障安全可选绑定(bind):) 我希望这会有所帮助。

编辑:我刚刚看到了 guice-3 标签，因此您需要使用可选的注释方法而不是可选的 Binder 。使用可选注释，它将保持为 null 而不是可选值。

阿图尔