代表性传输(Representational State Transfer,REST)在Web领域已经得到了广泛的应用。REST不是一种协议,而是一种体系风格。
REST的具体实现应该遵循四个基本原则:
- 显示的使用Http 方法
- 无状态
- 公开目录结构式的URI
- 传输XML,JSON 或同时传输这两者
目前CXF框架有三种不同的方式支持REST风格的WebService.分别是JAX-RS,JAX-WS Provider& Dispatch和Http绑定方式。
下面使用的是JAX-RS 实现RESTful webservice
首先创建一个SEI
写道
import javax.ws.rs.DELETE;
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.core.Response;
import com.test.project.Project;
@Path("/ProjectManager/")
public interface ProjectManager {
@GET
@Path("/getProjectName/")
public Response getProjectName();
@GET
@Path("/getProjectNameById/{projectID}/")
public Response getProjectNameById(@PathParam("projectID") String projectId);
@GET
@Path("/greeting/")
public Response greeting();
@PUT
@Path("/setDefaultProject/")
public Response setDefaultProject(Project project);
@POST
@Path("/registerProject/")
public Response registerProject(Project project);
@DELETE
@Path("/removeProject/{id}/")
public Response removeProject(@PathParam("id") String id);
}
实现这个接口
写道
import java.util.HashMap;
import java.util.Map;
import javax.ws.rs.Path;
import javax.ws.rs.core.Response;
import org.apache.log4j.Logger;
import restful.cxf.demo.webservice.ProjectManager;
import com.test.project.Project;
@Path("/ProjectManager/")
public class ProjectManagerImpl implements ProjectManager {
private static final Logger logger = Logger
.getLogger(ProjectManagerImpl.class);
private Map<String, Project> projectMap;
private Project project;
public ProjectManagerImpl() {
if (logger.isInfoEnabled()) {
logger.info("-------ProjectManagerImpl Construct------------");
}
initProject();
}
private void initProject() {
projectMap = new HashMap<String, Project>();
project = new Project();
project.setProjectID("default projectID");
project.setProjectName("default projectName");
project.setProjectDescribe("default projectDescribe");
Project prt = new Project();
prt.setProjectDescribe("projectDescibe2");
prt.setProjectID("project2");
prt.setProjectName("projectName2");
projectMap.put("1", project);
projectMap.put("2", prt);
}
public Response getProjectName() {
if (logger.isInfoEnabled()) {
logger.info("------invoking getProjectName----");
}
Response response;
if (project.getProjectName() == null) {
response = Response.notModified().build();
} else {
response = Response.ok(project.getProjectName()).build();
}
return response;
}
public Response getProjectNameById(String projectId) {
if (logger.isInfoEnabled()) {
logger.info("-----invoking getProjectNameById----------");
}
Response response = null;
if (projectId == null || !projectMap.containsKey(projectId)) {
response = Response.notModified().build();
} else {
response = Response.ok(projectMap.get(projectId).getProjectName())
.build();
}
return response;
}
public Response greeting() {
if (logger.isInfoEnabled()) {
logger.info("----- invoking greeting-------");
}
return Response.ok("Hello,This is ProjectManager.").build();
}
public Response setDefaultProject(Project project) {
if (logger.isInfoEnabled()) {
logger.info("---------invoking setDefaultProject------------");
}
Response response = null;
if (project == null) {
response = Response.notModified().build();
} else {
this.project = project;
response = Response.ok(this.project.getProjectName()).build();
}
return response;
}
public Response registerProject(Project project) {
if (logger.isInfoEnabled()) {
logger.info("-------- invoking registerProject----------");
}
Response response = null;
if (project == null || projectMap.containsKey(project.getProjectID())) {
response = Response.notModified().build();
} else {
projectMap.put(project.getProjectID(), project);
response = Response.ok(project.getProjectName()).build();
}
return response;
}
public Response removeProject(String id) {
if (logger.isInfoEnabled()) {
logger.info("---------invoking removeProject--------");
}
Response response;
if (id == null || !projectMap.containsKey(id)) {
response = Response.notModified().build();
} else {
projectMap.remove(id);
response = Response.ok("delete is ok.").build();
}
return response;
}
}
import java.util.Map;
import javax.ws.rs.Path;
import javax.ws.rs.core.Response;
import org.apache.log4j.Logger;
import restful.cxf.demo.webservice.ProjectManager;
import com.test.project.Project;
@Path("/ProjectManager/")
public class ProjectManagerImpl implements ProjectManager {
private static final Logger logger = Logger
.getLogger(ProjectManagerImpl.class);
private Map<String, Project> projectMap;
private Project project;
public ProjectManagerImpl() {
if (logger.isInfoEnabled()) {
logger.info("-------ProjectManagerImpl Construct------------");
}
initProject();
}
private void initProject() {
projectMap = new HashMap<String, Project>();
project = new Project();
project.setProjectID("default projectID");
project.setProjectName("default projectName");
project.setProjectDescribe("default projectDescribe");
Project prt = new Project();
prt.setProjectDescribe("projectDescibe2");
prt.setProjectID("project2");
prt.setProjectName("projectName2");
projectMap.put("1", project);
projectMap.put("2", prt);
}
public Response getProjectName() {
if (logger.isInfoEnabled()) {
logger.info("------invoking getProjectName----");
}
Response response;
if (project.getProjectName() == null) {
response = Response.notModified().build();
} else {
response = Response.ok(project.getProjectName()).build();
}
return response;
}
public Response getProjectNameById(String projectId) {
if (logger.isInfoEnabled()) {
logger.info("-----invoking getProjectNameById----------");
}
Response response = null;
if (projectId == null || !projectMap.containsKey(projectId)) {
response = Response.notModified().build();
} else {
response = Response.ok(projectMap.get(projectId).getProjectName())
.build();
}
return response;
}
public Response greeting() {
if (logger.isInfoEnabled()) {
logger.info("----- invoking greeting-------");
}
return Response.ok("Hello,This is ProjectManager.").build();
}
public Response setDefaultProject(Project project) {
if (logger.isInfoEnabled()) {
logger.info("---------invoking setDefaultProject------------");
}
Response response = null;
if (project == null) {
response = Response.notModified().build();
} else {
this.project = project;
response = Response.ok(this.project.getProjectName()).build();
}
return response;
}
public Response registerProject(Project project) {
if (logger.isInfoEnabled()) {
logger.info("-------- invoking registerProject----------");
}
Response response = null;
if (project == null || projectMap.containsKey(project.getProjectID())) {
response = Response.notModified().build();
} else {
projectMap.put(project.getProjectID(), project);
response = Response.ok(project.getProjectName()).build();
}
return response;
}
public Response removeProject(String id) {
if (logger.isInfoEnabled()) {
logger.info("---------invoking removeProject--------");
}
Response response;
if (id == null || !projectMap.containsKey(id)) {
response = Response.notModified().build();
} else {
projectMap.remove(id);
response = Response.ok("delete is ok.").build();
}
return response;
}
}
发布服务
写道
public static void main(String[] args) throws InterruptedException {
testStart();
}
public static void testStart() throws InterruptedException {
ProjectManager projectManager = new ProjectManagerImpl();
JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
sf.setResourceClasses(ProjectManager.class);
sf.setResourceProvider(ProjectManager.class,
new SingletonResourceProvider(projectManager));
sf.setAddress("http://localhost:9000/");
sf.create();
TimeUnit.MINUTES.sleep(15);
}
testStart();
}
public static void testStart() throws InterruptedException {
ProjectManager projectManager = new ProjectManagerImpl();
JAXRSServerFactoryBean sf = new JAXRSServerFactoryBean();
sf.setResourceClasses(ProjectManager.class);
sf.setResourceProvider(ProjectManager.class,
new SingletonResourceProvider(projectManager));
sf.setAddress("http://localhost:9000/");
sf.create();
TimeUnit.MINUTES.sleep(15);
}
调用服务
http://localhost:9000/ProjectManager/getProjectNameById/2
如果使用Servlet 方式又该如何发布呢?
<?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"
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>CXFServletDemo</display-name>
<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>
WEB-INF/weather-servlet.xml
WEB-INF/restfulServer-beans.xml
</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>
<servlet>
<servlet-name>cxf</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
<load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
<servlet-name>cxf</servlet-name>
<url-pattern>/*</url-pattern>
</servlet-mapping>
<welcome-file-list>
<welcome-file>index.html</welcome-file>
</welcome-file-list>
</web-app>
写道
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxrs="http://cxf.apache.org/jaxrs"
xmlns:cxf="http://cxf.apache.org/core"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://cxf.apache.org/core
http://cxf.apache.org/schemas/core.xsd
http://cxf.apache.org/jaxrs
http://cxf.apache.org/schemas/jaxrs.xsd">
<import resource="classpath:META-INF/cxf/cxf.xml" />
<import resource="classpath:META-INF/cxf/cxf-extension-jaxrs-binding.xml" />
<import resource="classpath:META-INF/cxf/cxf-servlet.xml" />
<jaxrs:server id="projectManagerRestful"
serviceClass="restful.cxf.demo.webservice.impl.ProjectManagerImpl"
address="/" />
</beans>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:jaxrs="http://cxf.apache.org/jaxrs"
xmlns:cxf="http://cxf.apache.org/core"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://cxf.apache.org/core
http://cxf.apache.org/schemas/core.xsd
http://cxf.apache.org/jaxrs
http://cxf.apache.org/schemas/jaxrs.xsd">
<import resource="classpath:META-INF/cxf/cxf.xml" />
<import resource="classpath:META-INF/cxf/cxf-extension-jaxrs-binding.xml" />
<import resource="classpath:META-INF/cxf/cxf-servlet.xml" />
<jaxrs:server id="projectManagerRestful"
serviceClass="restful.cxf.demo.webservice.impl.ProjectManagerImpl"
address="/" />
</beans>
这样将项目放在Tomcat 中启动后即可以发布一个RESTful 风格的webservice
http://localhost:8080/cxf/ProjectManager/greeting