使用Google Guice在上下文中绑定两个不同的接口实现

时间:2013-02-20 15:27:39

标签: java servlets guice

让我假装我有一个名为IValidator的界面,如下所示:

public interface IValidator {
    /**
     * Returns true if the specified strings are valid.
     */
    public boolean validate(List<String> someStrings);
}

现在让我们说我有两个IValidator的实现:

public class StrictValidator implements IValidator {
    public boolean validate(List<String> someStrings) {
        //some strict validation code
        return false;
    }
}

public class LaissezFaireValidator implements IValidator {
    public boolean validate(List<String> someStrings) {
        //some easy-going validation code
        return true;
    }
}

现在让我们添加一个使用注入的IValidator实例的servlet:

@Service
@At("/rest")
public class MyServlet extends AbstractServlet {

    private final IValidator validator;

    @Inject
    public MyServlet(final IValidator validator) {
        this.validator = validator;
    }

    @Post
    @At("/validate")
    @LaissezFaire
    public Reply<?> validate(Request request) {
        //get the strings to validate out of the request object
        List<String> strings = (List<String>) restUtil.parseRequest(request, List.class);

        //validate the request
        if (!this.validator.validate(strings)) {
            return Reply.saying().status(409);
        } else {
            return Reply.saying().noContent();
        }
    }
}

当然,我们还需要在模块中将IValidator绑定到StrictValidator

public class ValidatorModule implements Module {
    @Override
    protected void configure() {
        bind(IValiator.class).to(StrictValidator.class);
    }
}

但是如果我想在一种情况下有条件地将IValidator绑定到StrictValidator会发生什么情况,而是在其他情况下将其绑定到LaissezFaireValidator

您是否注意到@LaissezFaire上面的MyServlet.validate注释?这是一个看起来像这样的拦截器:

@BindingAnnotation
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LaissezFaire { }

public class LaissezFaireInterceptor implements MethodInterceptor {
    private boolean debug;
    private IValidator validator;

    @Inject
    public void setDebug(@Named("debug.enabled") boolean debugEnabled) {
        this.debug = debugEnabled;
    }

    @Inject
    public void setValidator(final IValidator validator) {
        this.validator = validator;
    }

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        if (debug) {
            if (!this.validator.validate(strings)) {
                return Reply.saying().status(409);
            } else {
                return Reply.saying().noContent();
            }
        } else {
            return invocation.proceed();
        }
    }
}

我们需要一些绑定来设置拦截器:

public class InterceptorModule implements Module {
    @Override
    protected void configure() {
        final MethodInterceptor lfInterceptor = new LaissezFaireInterceptor();
        requestInjection(lfInterceptor);
        bindInterceptor(Matchers.subclassesOf(AbstractServlet.class), Matchers.AnnotatedWith(LaissezFaire.class), lfInterceptor);
    }
}

根据ValidatorModule,当LaissezFaireInterceptor调用StrictValidator时,InterceptorModule类将获得requestInjection(lfInterceptor);的实例。

相反,我希望MyServlet获取StrictValidatorLaissezFaireInterceptor的实例以获取LaissezFaireValidator的实例。

根据the Google Guice docs,我可以在请求注入时使用命名注释。 MyServlet的构造函数将被修改为如下所示:

    @Inject
    public MyServlet(@Named("strict") final IValidator validator) {
        this.validator = validator;
    }

并且setValidator的{​​{1}}方法将被修改为如下所示:

LaissezFaireInterceptor

最后 @Inject public void setValidator(@Named("laissezfaire") final IValidator validator) { this.validator = validator; } 将被修改为如下所示:

ValidatorModule

这一切都很好,除了文档特别说要避免这种方法,因为编译器无法检查字符串名称。此外,这意味着我必须在代码中通过注入请求public class ValidatorModule implements Module { @Override protected void configure() { bind(IValiator.class).annotatedWith(Names.named("strict")).to(StrictValidator.class); bind(IValidator.class).annotatedWith(Names.named("laissezfaire")).to(LaissezFaireValidator.class); } } 的每个位置添加@Named注释,否则绑定将失败。

我真的希望Provider Bindings可以为我解决这个问题,但他们似乎并不了解正在进行绑定的上下文。由于他们不知道请求绑定的类的类型,因此我无法选择从IValidator方法返回哪种类型的IValidator

有没有更好的方法来解决这个问题?

1 个答案:

答案 0 :(得分:1)

虽然Condit提供了一些很好的建议,但我们选择使用更简单的解决方案来解决这个问题。

如上所述,我们创建了IValidator接口,以及StrictValidatorLaissezFaireValidator类。在默认情况下,我们使用ValidatorModuleIValidator绑定到StrictValidator。提醒一下,它看起来像这样:

public class ValidatorModule implements Module {
    @Override
    protected void configure() {
        //in the default case, inject an instance of StrictValidator
        bind(IValiator.class).to(StrictValidator.class);
    }
}

在绝大多数情况下,StrictValidator是必需的实现,因为LaissezFaireInterceptor是用于测试的作弊。

我们想要StrictValidator的任何地方(就像我们在MyServlet中所做的那样),我们注入了IValidator的实例:

public class MyServlet extends AbstractServlet {

    private final IValidator validator;

    @Inject
    public MyServlet(final IValidator validator) {
        this.validator = validator;
    }

    //... there's more code here (look above) ...
}

无论我们想要一个LaissezFaireValidator的实例,我们都要求注入其具体实现来代替IValidator

public class LaissezFaireInterceptor implements MethodInterceptor {

    private final IValidator validator;

    //... a bunch of other code goes here (see above) ...

    @Inject
    public void setValidator(final LaissezFaireValidator validator) {
        this.validator = validator;
    }

    //... and a bunch more code goes here (again, see above) ...
}

通过这种方式,我们能够根据注入的上下文有条件地注入所需的实现,而不会引入任何额外的注释或工厂。

当然,它不像它可能是 Guicy ,但它确实有效。