禁用@Alternative类

时间:2017-02-15 13:22:51

标签: java java-ee cdi java-ee-7

在我的Java EE 7程序中,我想使用@Alternative注入不同的实现,具体取决于上下文,生产或测试。我所做的是在我的beans.xml文件中声明我的类使用@Alternative注释。它工作得很好,我的替代课程被注入到我想要的地方,而不是默认的。但我不知道是否有一种方法可以跳过此行为并注入默认类,而不是删除beans.xml文件中的声明。打包应用程序时,这是不可能的。如果我可以选择是否要在配置文件中使用默认类或备用类,例如在我的WildFly服务器的standalone.xml文件中,那将是很好的。这可能吗?

3 个答案:

答案 0 :(得分:1)

阐述我的评论,您可以执行以下操作。

定义单个限定符

@Inherited
@Qualifier
@Retention(RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER})
public @interface BeanSelector {

    @NonBinding
    private String environment;

}

定义注释文字

public class BeanSelectorImpl extends AnnotationLiteral<BeanSelector> implements BeanSelector {

    private final String environment;

    public BeanSelectorImpl(final String environment) {
        this.environment = environment;
    }

    public String environment() {
        return this.environment;
    }
}

创建一个从环境中读取的生产者

@ApplicationScoped
public class BeanSelectorProducer {

   @Any
   @Inject
   private Instance<MyBeanService> myBeanServices;

   @Produces
   @BeanSelector(environment = "")
   public MyBeanService produceService() {
      final String env = System.getProperty("env.property");
      final BeanSelector beanSelector = new BeanSelectorImpl(env);

      //You may wish to handle exceptions.
      return myBeanServices.select(beanSelector).get();
   }
}

此实现的负面影响是所有bean都将在服务中。 为每个环境定义不同beans.xml的另一个选择可能是更好的选择。

答案 1 :(得分:0)

我担心使用普通@Alternative注释无法实现。请参阅以下几种可以尝试的方法:

使用不同的beans.xml个文件

您可以考虑为每个环境设置不同的beans.xml文件,然后根据例如Maven profile打包正确的文件。

编写自己的替代构造型

您可以定义自己的替代构造型并使用CDI扩展管理注射。

这种方法在NightSpawN的post中提到。我在WildFly 10上进行了测试,它按预期工作。找到以下步骤:

使用您的环境类型定义枚举:

public enum EnvironmentType {
    DEVELOPMENT, TESTING, STAGING, PRODUCTION;
}

创建您自己的@Alternative刻板印象以保存有关环境的元信息:

@Stereotype
@Alternative
@Target(TYPE)
@Retention(RUNTIME)
public @interface EnvironmentAlternative  {
    EnvironmentType[] value();
}

并在beans.xml

中声明替代构造型
<beans xmlns="http://java.sun.com/xml/ns/javaee"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/beans_1_0.xsd">

    <alternatives>
        <stereotype>com.example.EnvironmentAlternative</stereotype>
    </alternatives>

</beans>

例如,让我们定义一个示例服务:

public interface GreetingService {
    String sayGreeting();
}

定义默认实现:

@Default
public class DefaultGreetingService implements GreetingService {

    @Override
    public String sayGreeting() {
        return "Hey!";
    }
}

还使用@EnvironmentAlternative构造型定义一些替代实现:

@EnvironmentAlternative(DEVELOPMENT)
public class DevelopmentGreetingService implements GreetingService {

    @Override
    public String sayGreeting() {
        return "Hey from a development environment!";
    }
}
@EnvironmentAlternative(PRODUCTION)
public class ProductionGreetingService implements GreetingService {

    @Override
    public String sayGreeting() {
        return "Hey from a production environment!";
    }
}

@EnvironmentAlternative注释还支持具有多种环境类型的数组:

@EnvironmentAlternative({ TESTING, STAGING })

这就是魔术发生的地方!

创建CDI Extension以观察CDI生命周期事件。为容器处理的每个带注释的类型调用processAnotated()方法,如果用@EnvironmentAlternative注释并且当前的environemnt不在指定的环境中,则调用事件的veto()方法,以防止进一步处理的类型:

public class EnvironmentAlternativesExtension implements Extension {

    private EnvironmentType currentEnvironment = PRODUCTION;

    public <T> void processAnotated(@Observes ProcessAnnotatedType<T> event) {
        EnvironmentAlternative alternative = 
            event.getAnnotatedType().getJavaClass()
                 .getAnnotation(EnvironmentAlternative.class);
        if (alternative != null && !containsCurrentEnvironment(alternative.value())) {
            event.veto();
        }
    }

    private boolean containsCurrentEnvironment(EnvironmentType[] environments) {
        for (EnvironmentType environment : environments) {
            if (environment == currentEnvironment) {
                return true;
            }
        }
        return false;
    }
}

当找不到合适的替代品时,将使用默认实施。

接下来,通过在javax.enterprise.inject.spi.Extension文件夹下创建名为META-INF/services的文件,将CDI扩展名注册为服务提供商。该文件的内容将只是扩展类的规范名称:

com.example.EnvironmentAlternativesExtension

最后注入并使用上面定义的服务:

@Inject
private GreetingService service;
String greeting = service.sayGreeting();

在实际应用程序中,您不会硬编码currentEnvironment字段的值。例如,您可以使用系统属性来确定运行应用程序的环境。

要在standalone.xml中设置系统属性,请使用<system-properties>标记下的<server>标记:

<server xmlns="urn:jboss:domain:4.2">

    ...

    <system-properties>
        <property name="environment" value="PRODUCTION"/>
    </system-properties>

    ...

</server>

然后使用以下代码获取environemnt变量的值并设置currentEnvironment字段的值:

String environment = System.getProperty("environment");
currentEnvironment = EnvironmentType.valueOf(environment);

答案 2 :(得分:0)

在我看来,最简单的解决方案是创建一个maven配置文件,就像在一些评论中提到的那样。

在我的pom.xml文件中,我添加了资源过滤部分和配置文件:

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <filtering>true</filtering>
            <includes>
                <include>**/*.*</include>
            </includes>
       </resource>
   </resources>
</build>

<profiles>
    <profile>
        <id>default</id>
        <properties>
            <MyBean></MyBean>
        </properties>
    </profile>
    <profile>
        <id>alternative</id>
        <properties>
            <MyBean><![CDATA[<class>com.MyBean</class>]]></MyBean>
        </properties>
    </profile>
</profiles>

beans.xml文件现在是这样的:

<beans ...>
    <alternatives>
        ${MyBean}
    </alternatives>
</beans>

最后,我只需要使用有用的profil执行maven命令:mvn package -P alternative