Java EE CDI Producer方法教程

这是CDI Producer方法的教程。在CDI中，生产者方法生成一个可以注入的对象。当我们要注入本身不是bean的对象，要注入的对象的具体类型在运行时可能有所不同，或者当对象需要一些bean构造函数不执行的自定义初始化时，可以使用生产者方法。生产者方法允许我们将任何JDK类公开为bean，并为同一实现类定义具有不同范围或初始化的多个bean。他们还让我们将运行时多态与CDI结合使用。

在这里，我们将创建一个具有两个实现的简单服务，然后将创建一个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" 。点击“确定”继续。

Maven的原型Web应用程序

在向导的“输入工件ID”页面中，您可以定义项目的名称和主程序包。将“ Group Id”变量设置为"com.javacodegeeks.snippets.enterprise" ，将“ Artifact Id”变量设置为"cdibeans" 。上述选择组成主体工程包作为"com.javacodegeeks.snippets.enterprise.cdibeans"和项目名称为"cdibeans" 。将“ Package”变量设置为"war" ，以便创建一个war文件以部署到tomcat服务器。点击“完成”退出向导并创建您的项目。

newcdiproject1

Maven项目结构如下所示：

newcdiproject2

它包含以下文件夹：
/ 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.创建一个简单的服务

在此示例中， Producer将使用的服务是一个简单的服务，它为使用该服务的应用程序创建问候消息。 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!!!");}}

为了显示多态性在CDI中的工作方式，我们将创建该服务的另一个实现，如下所示：

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.在托管Bean中使用生产者

在下面的托管bean中，我们利用了上面创建的Producer 。特别是，在GreetingCardFactory.java类中，我们创建了一个方法getGreetingCard() ，该方法带有@Produces批注。该方法根据bean的GreetingType返回GreetingCard的正确实现。这样就支持了多态性。

GreetingCardFactory.java

package com.javacodegeeks.snippets.enterprise.cdibeans;import java.io.Serializable;import javax.enterprise.context.SessionScoped;
import javax.enterprise.inject.Produces;import com.javacodegeeks.snippets.enterprise.cdibeans.impl.AnotherGreetingCardImpl;
import com.javacodegeeks.snippets.enterprise.cdibeans.impl.GreetingCardImpl;@SessionScoped
public class GreetingCardFactory implements Serializable {private static final long serialVersionUID = -44416514616012281L;private GreetingType greetingType;@Producespublic GreetingCard getGreetingCard() {switch (greetingType) {case HELLO:return new GreetingCardImpl();case ANOTHER_HI:return new AnotherGreetingCardImpl();default:return new GreetingCardImpl();}}
}

GreetingType.java是一个枚举，如下所示：

GreetingType.java

package com.javacodegeeks.snippets.enterprise.cdibeans;public enum GreetingType {HELLO, HI;
}

在CDI中使用多态的另一种方法是通过@Qualifier 。我们可以在CDI中创建自己的注释，然后在Producer方法中使用它来获取正确的实现。

Greetings.java

package com.javacodegeeks.snippets.enterprise.cdibeans;import static java.lang.annotation.ElementType.FIELD;
import static java.lang.annotation.ElementType.TYPE;
import static java.lang.annotation.ElementType.METHOD;
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 Greetings {GreetingType value();}

现在， GreetingCardFactory可以为每个实现使用不同的Producer方法。我们创建的注释在@Produces注释之后使用。

GreetingCardFactory.java

package com.javacodegeeks.snippets.enterprise.cdibeans;import java.io.Serializable;import javax.enterprise.context.SessionScoped;
import javax.enterprise.inject.Produces;import com.javacodegeeks.snippets.enterprise.cdibeans.impl.AnotherGreetingCardImpl;
import com.javacodegeeks.snippets.enterprise.cdibeans.impl.GreetingCardImpl;@SessionScoped
public class GreetingCardFactory implements Serializable {private static final long serialVersionUID = -44416514616012281L;private GreetingType greetingType;@Produces@Greetings(GreetingType.HELLO)public GreetingCard getGreetingCard() {return new GreetingCardImpl();}@Produces@Greetings(GreetingType.HI)public GreetingCard getAnotherGreetingCard() {return new AnotherGreetingCardImpl();}}

5.生产者范围

创建一个通知时，一个重要的事情Producer方法是范围Producer 。默认情况下， Producer的范围设置为“ Dependent 。但是Producer根据其用途也可以具有任何其他范围。问题是，如果Producer生产范围不同的托管bean，可能会发生什么。例如，我们可以使用标注为@SessionScoped的Producer创建一个@RequestScoped bean并将其注入另一个bean。在这种情况下，HTTP请求完成后， Producer返回的@RequestScoped bean实例将被销毁，并且注入该bean的行为可能是意外的。为了避免引用不再存在的bean，在使用Producer方法时，可以使用@New批注。这样，将通过Producer注入一个新的Dependent实例，如下面的代码片段所示：

GreetingCardFactory.java

package com.javacodegeeks.snippets.enterprise.cdibeans;import java.io.Serializable;import javax.enterprise.context.SessionScoped;
import javax.enterprise.inject.New;
import javax.enterprise.inject.Produces;import com.javacodegeeks.snippets.enterprise.cdibeans.impl.GreetingCardImpl;@SessionScoped
public class GreetingCardFactory implements Serializable {private static final long serialVersionUID = -44416514616012281L;private GreetingCardImpl greetingCard;@Producespublic GreetingCardImpl getGreetingCard(@New GreetingCardImpl greetingCard) {return greetingCard;}}

6.运行应用程序

为了运行该应用程序，我们创建了一个简单的servlet，如下所示：

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.Greetings;@WebServlet(name = "greetingServlet", urlPatterns = {"/sayHello"})
public class GreetingServlet extends HttpServlet {private static final long serialVersionUID = 2280890757609124481L;@Inject@Greetings(GreetingType.HELLO)private GreetingCard greetingCard;@Inject@Greetings(GreetingType.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(){}}

在上面的servlet中，注入了两种实现。要运行该示例，我们必须使用Maven构建项目，然后将生成的war文件放置在tomcat的webbaps文件夹中。然后，我们可以继续：

http://localhost/8080/cdibeans/sayHello

结果是如下所示：