JAX-RS入门 二 ：运行

时间：2023-03-09 18:32:40
JAX-RS入门 二 ：运行

上一节，已经成功的定义了一个REST服务，并且提供了具体的实现，不过我们还需要把它运行起来。

在上一节的装备部分，列举了必须的jar（在tomcat中运行）和可选的jar（作为一个独立的应用程序运行）。这一节将分别介绍如何做为一个独立的应用程序运行和如何在tomcat里运行。

Tomcat（或者其他Web容器）中运行

要在tomcat之类的容器里运行，首先需要定义一个Application类：

  1. import java.util.HashSet;
  2. import java.util.Set;
  3. import javax.ws.rs.core.Application;
  4. public class CustomerApplication extends Application {
  5. private Set<Object> singletons = new HashSet<Object>();
  6. private Set<Class<?>> empty = new HashSet<Class<?>>();
  7. public CustomerApplication() {
  8. singletons.add(new CustomerResourceService());
  9. }
  10. @Override
  11. public Set<Class<?>> getClasses() {
  12. return empty;
  13. }
  14. @Override
  15. public Set<Object> getSingletons() {
  16. return singletons;
  17. }
  18. }

简单说明：

  1. getClasses()：返回所有定义的服务类的类；每次请求都生成新的服务对象
  2. getSingletons()：返回所有定义的服务类的实例；每次请求都会重用已经存在对象

因为我们的数据需要被重用，因为getClasses()返回空；getSingletons()返回创建的一个对象实现。

有了这个application类后，就需要一个特定的servlet类去处理具体的调用，其中application类做为这个servlet类的一个init-param参数指定。

不同的JAX-RS的实现者会有不同的对应的servlet的实现，这里我选择的Apache CXF的实现，它对应的servlet类为：

org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet

所以我们需要在web.xml中如下样声明一个servlet：

  1. <servlet>
  2. <servlet-name>rest</servlet-name>
  3. <servlet-class><strong>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</strong></servlet-class>
  4. <init-param>
  5. <param-name><strong>javax.ws.rs.Application</strong></param-name>
  6. <param-value><strong>com.restfully.shop.services.CustomerApplication</strong></param-value>
  7. </init-param>
  8. </servlet>
  9. <servlet-mapping>
  10. <servlet-name>rest</servlet-name>
  11. <url-pattern>/*</url-pattern>
  12. </servlet-mapping>

最后的web.xml文件内容如下：

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  4. xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
  5. id="WebApp_ID" version="2.5">
  6. <display-name>JaxrsService</display-name>
  7. <welcome-file-list>
  8. <welcome-file>index.html</welcome-file>
  9. <welcome-file>index.htm</welcome-file>
  10. <welcome-file>index.jsp</welcome-file>
  11. <welcome-file>default.html</welcome-file>
  12. <welcome-file>default.htm</welcome-file>
  13. <welcome-file>default.jsp</welcome-file>
  14. </welcome-file-list>
  15. <display-name>Archetype Created Web Application</display-name>
  16. <servlet>
  17. <servlet-name>rest</servlet-name>
  18. <servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class>
  19. <init-param>
  20. <param-name>javax.ws.rs.Application</param-name>
  21. <param-value>com.restfully.shop.services.CustomerApplication</param-value>
  22. </init-param>
  23. </servlet>
  24. <servlet-mapping>
  25. <servlet-name>rest</servlet-name>
  26. <url-pattern>/*</url-pattern>
  27. </servlet-mapping>
  28. </web-app>

这个REST服务已经实现完成，接下来就可以运行了，在工程上点右键： Run As -> Run on server

如果没有配server，这里需要配一个web server，配置完成后，工程就会自动在这个server上运行。最后就可以测试了，这里推荐用SoapUI测试。

假设选定是tomcat，tomcat的上下文路径是http://localhost:8080/，并且假设工程名是 JaxrsDemo，那么这个REST服务的根路径就是： http://localhost:8080/JaxrsDemo/customers ；它会对应提供一个wadl文件，路径为：http://localhost:8080/JaxrsDemo/customers/?_wadl 。

直接导入 http://localhost:8080/JaxrsDemo/customers/?_wadl  到SoapUI中，对应的请求方法和结构就会自动生成，只需要填入测试内容即可。

独立的应用程序

与web容器有几点不同之处：

  1. 需要提供自己的上下文路径，即上面的http://localhost:8080/JaxrsDemo部分
  2. 需要自己控制启动和停止

如果看看org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet的源码就会发现，其中的关键类是：org.apache.cxf.jaxrs.JAXRSServerFactoryBean。

我们需要得到一个org.apache.cxf.jaxrs.JAXRSServerFactoryBean对象，然后通过它来得到一个org.apache.cxf.endpoint.Server对象，这个org.apache.cxf.endpoint.Server对象就可以理解成是一个tomcat。

参考org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet的实现，如下：

  1. JAXRSServerFactoryBean bean = ResourceUtils.createApplication(
  2. new CustomerApplication(), false);
  3. String address = "http://localhost:8008/";
  4. bean.setAddress(address);
  5. Server server = bean.create();
  6. server.start();
  7. try {
  8. Thread.sleep(100000000);
  9. } catch (InterruptedException e) {
  10. e.printStackTrace();
  11. }
  12. server.stop();

其中 http://localhost:8008/ 就相当于http://localhost:8080/JaxrsDemo部分，所以这个REST服务的路径为：http://localhost:8008/customers ， 对应的服务定义文件为： http://localhost:8008/customers/?_wadl .

剩下的测试过程同上。

相关文章