JAX-RS入门 二 :运行
2014-02-24 13:06
351 查看
上一节,已经成功的定义了一个REST服务,并且提供了具体的实现,不过我们还需要把它运行起来。
在上一节的装备部分,列举了必须的jar(在tomcat中运行)和可选的jar(作为一个独立的应用程序运行)。这一节将分别介绍如何做为一个独立的应用程序运行和如何在tomcat里运行。
要在tomcat之类的容器里运行,首先需要定义一个Application类:
Java代码
import java.util.HashSet;
import java.util.Set;
import javax.ws.rs.core.Application;
public class CustomerApplication extends Application {
private Set<Object> singletons = new HashSet<Object>();
private Set<Class<?>> empty = new HashSet<Class<?>>();
public CustomerApplication() {
singletons.add(new CustomerResourceService());
}
@Override
public Set<Class<?>> getClasses() {
return empty;
}
@Override
public Set<Object> getSingletons() {
return singletons;
}
}
简单说明:
getClasses():返回所有定义的服务类的类;每次请求都生成新的服务对象
getSingletons():返回所有定义的服务类的实例;每次请求都会重用已经存在对象
因为我们的数据需要被重用,因为getClasses()返回空;getSingletons()返回创建的一个对象实现。
有了这个application类后,就需要一个特定的servlet类去处理具体的调用,其中application类做为这个servlet类的一个init-param参数指定。
不同的JAX-RS的实现者会有不同的对应的servlet的实现,这里我选择的Apache CXF的实现,它对应的servlet类为:
org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet
所以我们需要在web.xml中如下样声明一个servlet:
Java代码
<servlet>
<servlet-name>rest</servlet-name>
<servlet-class><strong>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</strong></servlet-class>
<init-param>
<param-name><strong>javax.ws.rs.Application</strong></param-name>
<param-value><strong>com.restfully.shop.services.CustomerApplication</strong></param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>rest</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
最后的web.xml文件内容如下:
Java代码
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
id="WebApp_ID" version="2.5">
<display-name>JaxrsService</display-name>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
<welcome-file>index.jsp</welcome-file>
<welcome-file>default.html</welcome-file>
<welcome-file>default.htm</welcome-file>
<welcome-file>default.jsp</welcome-file>
</welcome-file-list>
<display-name>Archetype Created Web Application</display-name>
<servlet>
<servlet-name>rest</servlet-name>
<servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class>
<init-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>com.restfully.shop.services.CustomerApplication</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>rest</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</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容器有几点不同之处:
需要提供自己的上下文路径,即上面的http://localhost:8080/JaxrsDemo部分
需要自己控制启动和停止
如果看看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的实现,如下:
Java代码
JAXRSServerFactoryBean bean = ResourceUtils.createApplication(
new CustomerApplication(), false);
String address = "http://localhost:8008/";
bean.setAddress(address);
Server server = bean.create();
server.start();
try {
Thread.sleep(100000000);
} catch (InterruptedException e) {
e.printStackTrace();
}
server.stop();
其中 http://localhost:8008/ 就相当于http://localhost:8080/JaxrsDemo部分,所以这个REST服务的路径为:http://localhost:8008/customers ,
对应的服务定义文件为: http://localhost:8008/customers/?_wadl .
剩下的测试过程同上。
在上一节的装备部分,列举了必须的jar(在tomcat中运行)和可选的jar(作为一个独立的应用程序运行)。这一节将分别介绍如何做为一个独立的应用程序运行和如何在tomcat里运行。
Tomcat(或者其他Web容器)中运行
要在tomcat之类的容器里运行,首先需要定义一个Application类:Java代码
import java.util.HashSet;
import java.util.Set;
import javax.ws.rs.core.Application;
public class CustomerApplication extends Application {
private Set<Object> singletons = new HashSet<Object>();
private Set<Class<?>> empty = new HashSet<Class<?>>();
public CustomerApplication() {
singletons.add(new CustomerResourceService());
}
@Override
public Set<Class<?>> getClasses() {
return empty;
}
@Override
public Set<Object> getSingletons() {
return singletons;
}
}
简单说明:
getClasses():返回所有定义的服务类的类;每次请求都生成新的服务对象
getSingletons():返回所有定义的服务类的实例;每次请求都会重用已经存在对象
因为我们的数据需要被重用,因为getClasses()返回空;getSingletons()返回创建的一个对象实现。
有了这个application类后,就需要一个特定的servlet类去处理具体的调用,其中application类做为这个servlet类的一个init-param参数指定。
不同的JAX-RS的实现者会有不同的对应的servlet的实现,这里我选择的Apache CXF的实现,它对应的servlet类为:
org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet
所以我们需要在web.xml中如下样声明一个servlet:
Java代码
<servlet>
<servlet-name>rest</servlet-name>
<servlet-class><strong>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</strong></servlet-class>
<init-param>
<param-name><strong>javax.ws.rs.Application</strong></param-name>
<param-value><strong>com.restfully.shop.services.CustomerApplication</strong></param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>rest</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
最后的web.xml文件内容如下:
Java代码
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
id="WebApp_ID" version="2.5">
<display-name>JaxrsService</display-name>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
<welcome-file>index.htm</welcome-file>
<welcome-file>index.jsp</welcome-file>
<welcome-file>default.html</welcome-file>
<welcome-file>default.htm</welcome-file>
<welcome-file>default.jsp</welcome-file>
</welcome-file-list>
<display-name>Archetype Created Web Application</display-name>
<servlet>
<servlet-name>rest</servlet-name>
<servlet-class>org.apache.cxf.jaxrs.servlet.CXFNonSpringJaxrsServlet</servlet-class>
<init-param>
<param-name>javax.ws.rs.Application</param-name>
<param-value>com.restfully.shop.services.CustomerApplication</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>rest</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
</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容器有几点不同之处:需要提供自己的上下文路径,即上面的http://localhost:8080/JaxrsDemo部分
需要自己控制启动和停止
如果看看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的实现,如下:
Java代码
JAXRSServerFactoryBean bean = ResourceUtils.createApplication(
new CustomerApplication(), false);
String address = "http://localhost:8008/";
bean.setAddress(address);
Server server = bean.create();
server.start();
try {
Thread.sleep(100000000);
} catch (InterruptedException e) {
e.printStackTrace();
}
server.stop();
其中 http://localhost:8008/ 就相当于http://localhost:8080/JaxrsDemo部分,所以这个REST服务的路径为:http://localhost:8008/customers ,
对应的服务定义文件为: http://localhost:8008/customers/?_wadl .
剩下的测试过程同上。
相关文章推荐
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 二 :运行
- JAX-RS入门 五: 自动类型转换
- JAX-RS入门 十二: 可伸缩的JAX-RS应用
- JAX-RS入门 九: 内容约定(1)
- JAX-RS入门 三 :细节
- JAX-RS入门 四: 注入
- JAX-RS入门 十一:HATEOAS
- JAX-RS入门 九: 内容约定(2)
- JAX-RS入门 四: 注入
- JAX-RS入门 五: 自动类型转换
- JAX-RS入门 三 :细节