Java EE CDI程序化依赖关系消歧示例–注入点检查
在本教程中,我们将看到在注入Java EE CDI bean时如何避免程序依赖消除歧义。 我们已经在Jave EE依赖关系消除歧义示例中展示了如何避免CDI Bean中的依赖关系歧义消除。 在这里,我们将向您展示如何以动态方式避免依赖消除歧义。 我们将通过检查注入另一个bean的实现的bean的注入点来实现这一点。
通过创建具有两种实现方式的简单服务,将检查注入点检查的程序歧义消除。 然后,我们将创建一个Producer
方法来生成和注入应用程序中的两个实现。
我们首选的开发环境是Eclipse 。 我们正在使用Eclipse Juno(4.2)版本以及Maven Integration插件版本3.1.0。 您可以从Eclipse的这里从和Maven Eclipse插件这里 。 用于Eclipse的Maven插件的安装不在本教程的讨论范围内,因此将不予讨论。 Tomcat 7是使用的应用程序服务器。
让我们开始,
1.创建一个新的Maven项目
转到文件->项目-> Maven-> Maven项目。
在向导的“选择项目名称和位置”页面中,确保未选中 “创建简单项目(跳过原型选择)”选项,单击“下一步”以继续使用默认值。
在这里,必须添加用于创建Web应用程序的Maven原型。 单击“添加原型”并添加原型。 将“ Archetype组ID”变量设置为"org.apache.maven.archetypes"
,将“ Archetype构件ID”变量设置为"maven-archetype-webapp"
,并将“ Archetype版本”设置为"1.0"
。 点击“确定”继续。
在向导的“输入工件ID”页面中,您可以定义项目的名称和主程序包。 将“ Group Id”变量设置为"com.javacodegeeks.snippets.enterprise"
,将“ Artifact Id”变量设置为"cdibeans"
。 上述选择组成主体工程包作为"com.javacodegeeks.snippets.enterprise.cdibeans"
和项目名称为"cdibeans"
。 将“ Package”变量设置为"war"
,以便创建一个war文件以部署到tomcat服务器。 点击“完成”退出向导并创建您的项目。
Maven项目结构如下所示:
-
它包含以下文件夹:
- / src / main / java文件夹,其中包含应用程序动态内容的源文件,
- / src / test / java文件夹包含用于单元测试的所有源文件,
- / src / main / resources文件夹包含配置文件,
- / target文件夹包含已编译和打包的可交付成果,
- / src / main / resources / webapp / WEB-INF文件夹包含Web应用程序的部署描述符,
- pom.xml是项目对象模型(POM)文件。 包含所有项目相关配置的单个文件。
2.添加所有必要的依赖项
您可以通过在POM编辑器的“ Pom.xml”页面上对其进行编辑,来在Maven的pom.xml
文件中添加依赖项,如下所示:
pom.xml:
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.javacodegeeks.snippets.enterprise.cdi</groupId> <artifactId>cdibeans</artifactId> <packaging>war</packaging> <version>0.0.1-SNAPSHOT</version> <name>cdibeans Maven Webapp</name> <url>http://maven.apache.org</url> <dependencies> <dependency> <groupId>org.jboss.weld.servlet</groupId> <artifactId>weld-servlet</artifactId> <version>1.1.10.Final</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>jstl</artifactId> <version>1.2</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.0.1</version> <scope>provided</scope> </dependency> <dependency> <groupId>org.glassfish</groupId> <artifactId>javax.faces</artifactId> <version>2.1.7</version> </dependency> </dependencies> <build> <finalName>cdibeans</finalName> </build> </project>
如您所见,Maven以声明方式管理库依赖关系。 创建本地存储库(默认情况下,位于{user_home} /。m2文件夹下),所有必需的库都从公共存储库下载并放置在该库中。 此外,库内的依赖关系会自动解决和处理。
3.创建一个简单的服务
GreetingCard.java
一个简单的服务,可以为使用它的应用程序创建问候消息。 它是带有产生问候消息的方法的接口。
GreetingCard.java
package com.javacodegeeks.snippets.enterprise.cdibeans; public interface GreetingCard { void sayHello(); }
该服务的实现如下所示:
GreetingCardImpl.java
package com.javacodegeeks.snippets.enterprise.cdibeans.impl; import com.javacodegeeks.snippets.enterprise.cdibeans.GreetingCard; public class GreetingCardImpl implements GreetingCard { public void sayHello() { System.out.println("Hello!!!"); } }
AnotherGreetingCardImpl.java
package com.javacodegeeks.snippets.enterprise.cdibeans.impl; import com.javacodegeeks.snippets.enterprise.cdibeans.GreetingCard; public class AnotherGreetingCardImpl implements GreetingCard { public void sayHello() { System.out.println("Have a nice day!!!"); } }
4.创建一个Producer方法来注入bean
为了将服务注入另一个bean,我们创建了自己的注释。 CDI允许我们创建自己的Java批注,即GreetingType.java
,然后在应用程序的注入点中使用它,以根据bean的GreetingType
获得正确的GreetingCard
实现。
Greetings
是使用服务的实现参数化的枚举,如下所示:
GreetingType.java
package com.javacodegeeks.snippets.enterprise.cdibeans; import static java.lang.annotation.ElementType.FIELD; import static java.lang.annotation.ElementType.METHOD; import static java.lang.annotation.ElementType.TYPE; import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.Retention; import java.lang.annotation.Target; import com.javacodegeeks.snippets.enterprise.cdibeans.impl.AnotherGreetingCardImpl; import com.javacodegeeks.snippets.enterprise.cdibeans.impl.GreetingCardImpl; @Retention(RUNTIME) @Target({ FIELD, TYPE, METHOD }) public @interface GreetingType { Greetings value(); public enum Greetings { HELLO(GreetingCardImpl.class), HI(AnotherGreetingCardImpl.class); Class<? extends GreetingCard> clazz; private Greetings(Class<? extends GreetingCard> clazz){ this.clazz = clazz; } public Class<? extends GreetingCard> getClazz() { return clazz; } } }
现在,我们可以创建一个Producer
来提供GreetingCard
服务实现的应用程序实例。 GreetingCardFactory.java
类是具有方法getGreetingCard
的Producer
。 该方法有两个参数。 第一个参数是使用所需的bean类型参数化的javax.enterprise.inject.Instance
,在这里是GreetingCard
。 它使用@Any
注释进行注释,该注释允许注入点引用所有bean或特定bean类型的所有事件。 第二个参数是javax.enterprise.inject.spi.InjectionPoint
,这是客户端应用程序中将使用@Inject
批注注入Bean的字段。 因此,该方法将根据服务类型和注入点中的注释返回正确的服务实现。
GreetingCardFactory.java
package com.javacodegeeks.snippets.enterprise.cdibeans; import javax.enterprise.inject.Any; import javax.enterprise.inject.Instance; import javax.enterprise.inject.Produces; import javax.enterprise.inject.spi.Annotated; import javax.enterprise.inject.spi.InjectionPoint; public class GreetingCardFactory { @Produces @GreetingsProducer public GreetingCard getGreetingCard(@Any Instance<GreetingCard> instance, InjectionPoint ip){ Annotated gtAnnotated = ip.getAnnotated(); GreetingType gtAnnotation = gtAnnotated.getAnnotation(GreetingType.class); Class<? extends GreetingCard> greetingCard = gtAnnotation.value().getClazz(); return instance.select(greetingCard).get(); } }
请注意,除了将方法定义为Producer
的@Produces
注释之外,该方法还带有额外的注释。 @GreetingsProducer
批注用于注入点,以定义它使用指定的Producer
方法注入bean实例。 它实际上是一个CDI限定符,如下所示:
GreetingsProducer.java
package com.javacodegeeks.snippets.enterprise.cdibeans; import static java.lang.annotation.ElementType.FIELD; import static java.lang.annotation.ElementType.METHOD; import static java.lang.annotation.ElementType.TYPE; import static java.lang.annotation.RetentionPolicy.RUNTIME; import java.lang.annotation.Retention; import java.lang.annotation.Target; import javax.inject.Qualifier; @Qualifier @Retention(RUNTIME) @Target({ FIELD, TYPE, METHOD }) public @interface GreetingsProducer { }
5.运行应用程序
为了运行该应用程序,我们创建了一个简单的servlet。
在下面的servlet中,注入了两种实现。 Servlet中的每个注入点都是一个使用@Inject
批注的字段。 它也用@GreetingsProducer
注释进行注释,以指定将要使用的Producer
,以及@GreetingType
注释,该注释指定将由Producer
产生的实现。
GreetingServlet.java
package com.javacodegeeks.snippets.enterprise.cdibeans.servlet; import java.io.IOException; import java.io.PrintWriter; import javax.inject.Inject; import javax.servlet.ServletException; import javax.servlet.annotation.WebServlet; import javax.servlet.http.HttpServlet; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; import com.javacodegeeks.snippets.enterprise.cdibeans.GreetingCard; import com.javacodegeeks.snippets.enterprise.cdibeans.GreetingType; import com.javacodegeeks.snippets.enterprise.cdibeans.GreetingType.Greetings; import com.javacodegeeks.snippets.enterprise.cdibeans.GreetingsProducer; @WebServlet(name = "greetingServlet", urlPatterns = {"/sayHello"}) public class GreetingServlet extends HttpServlet { private static final long serialVersionUID = 2280890757609124481L; @Inject @GreetingsProducer @GreetingType(Greetings.HELLO) private GreetingCard greetingCard; @Inject @GreetingsProducer @GreetingType(Greetings.HI) private GreetingCard anotherGreetingCard; public void init() throws ServletException { } public void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { response.setContentType("text/html"); PrintWriter out = response.getWriter(); out.println("<h1>" + greetingCard.sayHello() + "</h1>"); out.println("<h1>" + anotherGreetingCard.sayHello() + "</h1>"); } public void destroy(){ } }
要运行该示例,我们必须使用Maven构建项目,然后将生成的war
文件放置在tomcat的webbaps
文件夹中。 然后,我们可以继续:
http://localhost/8080/cdibeans/sayHello
结果是如下所示:
这是有关使用注入点检查对Java EE CDI程序性依赖项进行歧义消除的教程。
下载本教程的源代码: CDIDependencyDisambiguationIPInspection.zip