如何使用Weld轻松注入弦常数?

2022-09-03 06:09:16

我们遇到过这样一种情况,即我们以 Map 的形式向正在运行的程序提供外部配置。我发现 JSR-330 依赖注入提供了一种更清晰的方式,可以在代码中使用该配置映射,而不是传递映射或使用 JNDI 来获取它。

@Inject @Named("server.username") String username;

让 JSR-330 实现自动填写此字段。

使用Guice,我可以设置值

bindConstant().annotatedWith(Names.named(key)).to(value);

我希望能够在Weld中做同样的事情(将“server.username”绑定到例如“foobar”),并且我知道该机制最有可能是bean.xml,但我更喜欢简单的“请将此映射提供给Weel,请”代码替代方案。这样做的好方法是什么?


EDIT 2013-10-16:在研究了在编译时而不是运行时工作的Dagger之后,我发现我们通常每个程序有10-20个,我们可以接受每个配置字符串的方法,然后在配置图中查找。这允许特定于方法的行为(包括默认值),提供javadoc的能力以及将所有这些方法放在同一类中的能力。此外,它与开箱即用的Weld配合得很好。我正在考虑在博客文章中写一个更完整的解释。@Provider


答案 1

我现在想要这个赏金。弄清楚这一点教会了我很多关于WELD的内部知识,这是最有趣的一课:@Named是一个限定词,如果你要与它匹配,必须这样对待它。

我确实有一个警告:如果你的应用中缺少任何值,它将在部署或加载时失败。这对您来说可能是可取的,但这确实意味着“默认值”是不可能的。

注入点的指定方式与上面完全相同,下面是使其正常工作所需的扩展代码:

@ApplicationScoped
public class PerformSetup implements Extension {

    Map<String, String> configMap;

    public PerformSetup() {
        configMap = new HashMap<String, String>();
        // This is a dummy initialization, do something constructive here
        configMap.put("string.value", "This is a test value");
    }

    // Add the ConfigMap values to the global bean scope
    void afterBeanDiscovery(@Observes AfterBeanDiscovery abd, BeanManager bm) {
        // Loop through each entry registering the strings.
        for (Entry<String, String> configEntry : configMap.entrySet()) {
            final String configKey = configEntry.getKey();
            final String configValue = configEntry.getValue();

            AnnotatedType<String> at = bm.createAnnotatedType(String.class);
            final InjectionTarget<String> it = bm.createInjectionTarget(at);

            /**
             * All of this is necessary so WELD knows where to find the string,
             * what it's named, and what scope (singleton) it is.
             */ 
            Bean<String> si = new Bean<String>() {

                public Set<Type> getTypes() {
                    Set<Type> types = new HashSet<Type>();
                    types.add(String.class);
                    types.add(Object.class);
                    return types;
                }

                public Set<Annotation> getQualifiers() {
                    Set<Annotation> qualifiers = new HashSet<Annotation>();
                    qualifiers.add(new NamedAnnotationImpl(configKey));
                    return qualifiers;

                }

                public Class<? extends Annotation> getScope() {
                    return Singleton.class;
                }

                public String getName() {
                    return configKey;
                }

                public Set<Class<? extends Annotation>> getStereotypes() {
                    return Collections.EMPTY_SET;
                }

                public Class<?> getBeanClass() {
                    return String.class;
                }

                public boolean isAlternative() {
                    return false;
                }

                public boolean isNullable() {
                    return false;
                }

                public Set<InjectionPoint> getInjectionPoints() {
                    return it.getInjectionPoints();
                }

                @Override
                public String create(CreationalContext<String> ctx) {
                    return configValue;

                }

                @Override
                public void destroy(String instance,
                        CreationalContext<String> ctx) {
                    // Strings can't be destroyed, so don't do anything
                }
            };
            abd.addBean(si);
        }
    }

    /**
     * This is just so we can create a @Named annotation at runtime.
     */
    class NamedAnnotationImpl extends AnnotationLiteral<Named> implements Named {
        final String nameValue;

        NamedAnnotationImpl(String nameValue) {
            this.nameValue = nameValue;
        }

        public String value() {
            return nameValue;
        }

    }
}

我通过制作一个WELD-SE应用程序测试了这一点:

@ApplicationScoped
public class App {

    @Inject
    @Parameters
    List<String> parameters;

    @Inject
    @Named("string.value")
    String stringValue;

    public void printHello(@Observes ContainerInitialized event) {
        System.out.println("String Value is " + stringValue);
    }

}

最后,不要忘记 /META-INF/services/javax.enterprise.inject.spi.Extension,用你使用的类路径替换 weldtest:

weldtest.PerformSetup

这应该使所有这些工作。如果您遇到任何困难,请告诉我,我会将我的测试项目发送给您。


答案 2

并不是那么对赏金感兴趣,但如果它仍然在桌子上,我会接受它。这与我在$DAYJOB中使用的一些代码非常相似,所以这不是理论,这是我在生产代码中使用的代码,而是经过修改以保护有罪的人。我还没有尝试过编译修改后的代码,所以请注意,我在更改名称等方面可能会犯一些错误,但这里涉及的原则都已经过测试和工作。

首先,您需要一个价值持有者限定符。使用@Nonbinding可防止 WELD 仅与具有相同值的限定符匹配,因为我们希望此特定限定符的所有值都与单个注入点匹配。通过将限定符和值保留在同一注释中,您不能只是意外地“忘记”其中一个。(亲吻原理)

@Qualifier
@Retention(RUNTIME)
@Target({METHOD, FIELD, PARAMETER, TYPE})
public @interface ConfigValue {
    // Excludes this value from being considered for injection point matching
    @Nonbinding 
    // Avoid specifying a default value, since it can encourage programmer error.
    // We WANT a value every time.
    String value();
}

接下来,您需要一个知道如何获取地图的生产者方法。您可能应该有一个保存生产者方法的命名 Bean,因此您可以使用 getters/setter 显式初始化值,或者让 Bean 为您初始化它。

我们必须为生产者方法上的限定符指定一个空白值,以避免编译时错误,但在实践中从未使用过它。

@Named
public class ConfigProducer {
    //@Inject // Initialize this parameter somehow
    Map<String,String> configurationMap;

    @PostConstructor
    public void doInit() {
         // TODO: Get the configuration map here if it needs explicit initialization
    }

    // In general, I would discourage using this method, since it can be difficult to control exactly the order in which beans initialize at runtime.
    public void setConfigurationMap(Map<String,String> configurationMap) {
        this.configurationMap = configurationMap;
    }

    @Produces
    @ConfigValue("")
    @Dependent
    public String configValueProducer(InjectionPoint ip) {
        // We know this annotation WILL be present as WELD won't call us otherwise, so no null checking is required.
        ConfigValue configValue = ip.getAnnotated().getAnnotation(ConfigValue.class);
        // This could potentially return a null, so the function is annotated @Dependent to avoid a WELD error.
        return configurationMap.get(configValue.value());
    }
}

用法很简单:

@Inject
@ConfigValue("some.map.key.here")
String someConfigValue;

推荐