在几周前刚刚发布Apache CXF 3.0时 ,该项目又迈出了满足JAX-RS 2.0规范要求的又一个重要步骤:与CDI 1.1集成。 在此博客文章中,我们将看几个有关Apache CXF 3.0和Apache CXF 3.0如何协同工作的示例。
从3.0版开始, Apache CXF包含一个名为cxf-integration-cdi的新模块,可以轻松将其添加到您的Apache Maven POM文件中:
<dependency><groupId>org.apache.cxf</groupId><artifactId>cxf-integration-cdi</artifactId><version>3.0.0</version>
</dependency>
这个新模块仅包含两个组件(实际上,其中包含一些组件,但它们是关键组件):
- CXFCdiServlet :用于引导Apache CXF应用程序的servlet,其作用与CXFServlet和CXFNonSpringJaxrsServlet相同,…
- JAXRSCdiResourceExtension :可移植的CDI 1.1扩展,其中发生了所有魔术
在启用CDI 1.1的环境中运行时,便携式扩展由CDI 1.1容器发现,并使用生命周期事件进行初始化。 这实际上就是您所需要的! 让我们看一下实际的应用程序。
我们将构建一个非常简单的JAX-RS 2.0应用程序,以使用Apache CXF 3.0和CDI 1.1参考实现JBoss Weld 2.1来管理人员。 我们将用于人物表示的Person类只是一个简单的Java bean:
package com.example.model;public class Person {private String email;private String firstName;private String lastName;public Person() {}public Person( final String email, final String firstName, final String lastName ) {this.email = email;this.firstName = firstName;this.lastName = lastName;}// Getters and setters are ommited// ...
}
现在非常普遍,我们将在嵌入式Jetty 9.1容器中运行应用程序,而Starter类正是这样做的:
package com.example;import org.apache.cxf.cdi.CXFCdiServlet;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHolder;
import org.jboss.weld.environment.servlet.BeanManagerResourceBindingListener;
import org.jboss.weld.environment.servlet.Listener;public class Starter { public static void main( final String[] args ) throws Exception {final Server server = new Server( 8080 );// Register and map the dispatcher servletfinal ServletHolder servletHolder = new ServletHolder( new CXFCdiServlet() );final ServletContextHandler context = new ServletContextHandler(); context.setContextPath( "/" ); context.addEventListener( new Listener() ); context.addEventListener( new BeanManagerResourceBindingListener() );context.addServlet( servletHolder, "/rest/*" );server.setHandler( context );server.start(); server.join(); }
}
请注意, CXFCdiServlet和两个强制侦听器已添加到上下文中:
- org.jboss.weld.environment.servlet.Listener负责CDI注入
- org.jboss.weld.environment.servlet.BeanManagerResourceBindingListener将对BeanManager的引用绑定到JNDI位置java:comp / env / BeanManager ,以使其可以从应用程序的任何位置访问
这样,您就可以使用CDI 1.1的全部功能。 让我们介绍使用@Named注释注释的PeopleService类,以及使用@PostConstruct声明和注释的初始化方法来创建一个人。
@Named
public class PeopleService {private final ConcurrentMap< String, Person > persons = new ConcurrentHashMap< String, Person >(); @PostConstructpublic void init() { persons.put( "a@b.com", new Person( "a@b.com", "Tom", "Bombadilt" ) );}// Additional methods // ...
}
到目前为止,我们还没有谈到在CDI 1.1环境中配置JAX-RS 2.0应用程序和资源。 原因很简单:根据应用程序的不同,您可以采用零努力配置或完全可定制的配置。 让我们经历两种方法。
使用零努力配置,您可以定义一个空的JAX-RS 2.0应用程序和任意数量的JAX-RS 2.0资源: Apache CXF 3.0隐式地通过将每个资源类与该应用程序相关联来将它们连接在一起。 这是JAX-RS 2.0应用程序的示例:
package com.example.rs;import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;@ApplicationPath( "api" )
public class JaxRsApiApplication extends Application {
}
这里是一个JAX-RS 2.0资源PeopleRestService中注入了PeopleService托管bean:
package com.example.rs;import java.util.Collection;import javax.inject.Inject;
import javax.ws.rs.DELETE;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriInfo;import com.example.model.Person;
import com.example.services.PeopleService;@Path( "/people" )
public class PeopleRestService {@Inject private PeopleService peopleService;@Produces( { MediaType.APPLICATION_JSON } )@GETpublic Collection< Person > getPeople( @QueryParam( "page") @DefaultValue( "1" ) final int page ) {// ...}@Produces( { MediaType.APPLICATION_JSON } )@Path( "/{email}" )@GETpublic Person getPerson( @PathParam( "email" ) final String email ) {// ...}@Produces( { MediaType.APPLICATION_JSON } )@POSTpublic Response addPerson( @Context final UriInfo uriInfo,@FormParam( "email" ) final String email, @FormParam( "firstName" ) final String firstName, @FormParam( "lastName" ) final String lastName ) {// ...}// More HTTP methods here // ...
}
不需要任何其他操作: Apache CXF 3.0应用程序可以像这样运行并具有完整的功能。 GitHub上提供了示例项目的完整源代码。 请记住,如果遵循此样式,则仅应声明一个空的JAX-RS 2.0应用程序。
通过可定制的方法,可以使用更多选项,但是还需要做更多的工作。 每个JAX-RS 2.0应用程序都应提供非空的getClasses()或/和getSingletons()集合实现。 但是,JAX-RS 2.0资源类保持不变。 这是一个示例(基本上导致了我们之前所见的相同应用程序配置):
package com.example.rs;import java.util.Arrays;
import java.util.HashSet;
import java.util.Set;import javax.enterprise.inject.Produces;
import javax.inject.Inject;
import javax.ws.rs.ApplicationPath;
import javax.ws.rs.core.Application;import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;@ApplicationPath( "api" )
public class JaxRsApiApplication extends Application {@Inject private PeopleRestService peopleRestService;@Produces private JacksonJsonProvider jacksonJsonProvider = new JacksonJsonProvider(); @Overridepublic Set< Object > getSingletons() {return new HashSet<>(Arrays.asList( peopleRestService, jacksonJsonProvider ));}
}
请注意, JAXRSCdiResourceExtension便携式CDI 1.1扩展会自动为每个JAX-RS 2.0应用程序(扩展Application的应用程序 )和资源(以@Path注释)创建托管bean。 这样,它们立即可用于注入(例如,上面的代码段中的PeopleRestService )。 类JacksonJsonProvider用@Provider注释进行注释,因此将被视为JAX-RS 2.0提供程序。 以这种方式定义的JAX-RS 2.0应用程序没有限制。 使用此应用程序的示例项目的完整源代码可在GitHub上获得 。
无论您选择哪种方法,我们的示例应用程序都可以正常工作。 让我们构建它并运行:
> mvn clean package
> java -jar target/jax-rs-2.0-cdi-0.0.1-SNAPSHOT.jar
调用已实现的REST API对可确认应用程序正常运行和配置。 让我们发出GET命令,以确保在创建托管bean时调用了以@PostConstruct注释的PeopleService方法。
> curl http://localhost:8080/rest/api/peopleHTTP/1.1 200 OK
Content-Type: application/json
Date: Thu, 29 May 2014 22:39:35 GMT
Transfer-Encoding: chunked
Server: Jetty(9.1.z-SNAPSHOT)[{"email":"a@b.com","firstName":"Tom","lastName":"Bombadilt"}]
这是POST命令的示例:
> curl -i http://localhost:8080/rest/api/people -X POST -d "email=a@c.com&firstName=Tom&lastName=Knocker"HTTP/1.1 201 Created
Content-Type: application/json
Date: Thu, 29 May 2014 22:40:08 GMT
Location: http://localhost:8080/rest/api/people/a@c.com
Transfer-Encoding: chunked
Server: Jetty(9.1.z-SNAPSHOT){"email":"a@c.com","firstName":"Tom","lastName":"Knocker"}
在此博客文章中,我们仅介绍了Apache CXF和CDI 1.1集成现在可以实现的功能。 只需提及,在大多数JEE应用程序服务器和Servlet容器上都可以进行嵌入式Apache Tomcat 7.x / 8.x以及基于WAR的带有CDI 1.1的Apache CXF部署。
请查看官方文档并尝试一下!
- 完整的源代码可在GitHub上获得 。
翻译自: https://www.javacodegeeks.com/2014/06/apache-cxf-3-0-cdi-1-1-support-as-alternative-to-spring.html