Apache CXF实战之四 构建RESTful Web Service

Apache CXF实战之一 Hello World Web Service

Apache CXF实战之二 集成Sping与Web容器

Apache CXF实战之三 传输Java对象

这篇文章介绍一下怎么通过CXF来发布RESTful的Web Service.

1. 首先是实体类，注意其中的@XmlRootElement注解

1. package com.googlecode.garbagecan.cxfstudy.jaxrs;
2. import java.util.Date;
3. import javax.xml.bind.annotation.XmlRootElement;
4. @XmlRootElement(name="Customer")
5. public class Customer {
6. private String id;
7. private String name;
8. private Date birthday;
9. public String getId() {
10. return id;
11. }
12. public void setId(String id) {
13. this.id = id;
14. }
15. public String getName() {
16. return name;
17. }
18. public void setName(String name) {
19. this.name = name;
20. }
21. public Date getBirthday() {
22. return birthday;
23. }
24. public void setBirthday(Date birthday) {
25. this.birthday = birthday;
26. }
27. @Override
28. public String toString() {
29. return org.apache.commons.lang.builder.ToStringBuilder.reflectionToString(this);
30. }
31. }

package com.googlecode.garbagecan.cxfstudy.jaxrs;

import java.util.Date;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name="Customer")
public class Customer {
    private String id;
    private String name;
    private Date birthday;
    public String getId() {
        return id;
    }
    public void setId(String id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Date getBirthday() {
        return birthday;
    }
    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }
    @Override
    public String toString() {
        return org.apache.commons.lang.builder.ToStringBuilder.reflectionToString(this);
    }
}

2. RESTful Web Service接口类，可以通过修改@Produces注解来声明暴露接口返回的json还是xml数据格式

1. package com.googlecode.garbagecan.cxfstudy.jaxrs;
2. import javax.ws.rs.GET;
3. import javax.ws.rs.Path;
4. import javax.ws.rs.PathParam;
5. import javax.ws.rs.Produces;
6. import javax.ws.rs.QueryParam;
7. @Path(value = "/customer")
8. @Produces("*/*")
9. //@Produces("application/xml")
10. //@Produces("application/json")
11. public interface CustomerService {
12. @GET
13. @Path(value = "/{id}/info")
14. Customer findCustomerById(@PathParam("id")String id);
15. @GET
16. @Path(value = "/search")
17. Customer findCustomerByName(@QueryParam("name")String name);
18. }

package com.googlecode.garbagecan.cxfstudy.jaxrs;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;

@Path(value = "/customer")
@Produces("*/*")
//@Produces("application/xml")
//@Produces("application/json")
public interface CustomerService {
    @GET
    @Path(value = "/{id}/info")
    Customer findCustomerById(@PathParam("id")String id);

    @GET
    @Path(value = "/search")
    Customer findCustomerByName(@QueryParam("name")String name);
}

3. RESTful Web Service接口实现类

1. package com.googlecode.garbagecan.cxfstudy.jaxrs;
2. import java.util.Calendar;
3. public class CustomerServiceImpl implements CustomerService {
4. public Customer findCustomerById(String id) {
5. Customer customer = new Customer();
6. customer.setId(id);
7. customer.setName(id);
8. customer.setBirthday(Calendar.getInstance().getTime());
9. return customer;
10. }
11. public Customer findCustomerByName(String name) {
12. Customer customer = new Customer();
13. customer.setId(name);
14. customer.setName(name);
15. customer.setBirthday(Calendar.getInstance().getTime());
16. return customer;
17. }
18. }

package com.googlecode.garbagecan.cxfstudy.jaxrs;

import java.util.Calendar;

public class CustomerServiceImpl implements CustomerService {

    public Customer findCustomerById(String id) {
        Customer customer = new Customer();
        customer.setId(id);
        customer.setName(id);
        customer.setBirthday(Calendar.getInstance().getTime());
        return customer;
    }

    public Customer findCustomerByName(String name) {
        Customer customer = new Customer();
        customer.setId(name);
        customer.setName(name);
        customer.setBirthday(Calendar.getInstance().getTime());
        return customer;
    }
}

4. Server端代码

1. package com.googlecode.garbagecan.cxfstudy.jaxrs;
2. import org.apache.cxf.interceptor.LoggingInInterceptor;
3. import org.apache.cxf.interceptor.LoggingOutInterceptor;
4. import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
5. public class MyServer {
6. public static void main(String[] args) throws Exception {
7. JAXRSServerFactoryBean factoryBean = new JAXRSServerFactoryBean();
8. factoryBean.getInInterceptors().add(new LoggingInInterceptor());
9. factoryBean.getOutInterceptors().add(new LoggingOutInterceptor());
10. factoryBean.setResourceClasses(CustomerServiceImpl.class);
11. factoryBean.setAddress("http://localhost:9000/ws/jaxrs");
12. factoryBean.create();
13. }
14. }

package com.googlecode.garbagecan.cxfstudy.jaxrs;

import org.apache.cxf.interceptor.LoggingInInterceptor;
import org.apache.cxf.interceptor.LoggingOutInterceptor;
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;

public class MyServer {
    public static void main(String[] args) throws Exception {
        JAXRSServerFactoryBean factoryBean = new JAXRSServerFactoryBean();
        factoryBean.getInInterceptors().add(new LoggingInInterceptor());
        factoryBean.getOutInterceptors().add(new LoggingOutInterceptor());
        factoryBean.setResourceClasses(CustomerServiceImpl.class);
        factoryBean.setAddress("http://localhost:9000/ws/jaxrs");
        factoryBean.create();
    }
}

5. Client端代码

1. package com.googlecode.garbagecan.cxfstudy.jaxrs;
2. import org.apache.commons.httpclient.HttpClient;
3. import org.apache.commons.httpclient.HttpStatus;
4. import org.apache.commons.httpclient.methods.GetMethod;
5. public class MyClient {
6. public static void main(String[] args) throws Exception {
7. go("http://localhost:9000/ws/jaxrs/customer/1/info");
8. go("http://localhost:9000/ws/jaxrs/customer/search?name=abc");
9. }
10. private static void go(String url) throws Exception {
11. HttpClient client = new HttpClient();
12. GetMethod method = new GetMethod(url);
13. int statusCode = client.executeMethod(method);
14. if (statusCode != HttpStatus.SC_OK) {
15. System.err.println("Method failed: " + method.getStatusLine());
16. }
17. byte[] responseBody = method.getResponseBody();
18. System.out.println(new String(responseBody));
19. }
20. }

package com.googlecode.garbagecan.cxfstudy.jaxrs;

import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.HttpStatus;
import org.apache.commons.httpclient.methods.GetMethod;

public class MyClient {

    public static void main(String[] args) throws Exception {
        go("http://localhost:9000/ws/jaxrs/customer/1/info");
        go("http://localhost:9000/ws/jaxrs/customer/search?name=abc");
    }

    private static void go(String url) throws Exception {
        HttpClient client = new HttpClient();
        GetMethod method = new GetMethod(url);
        int statusCode = client.executeMethod(method);
        if (statusCode != HttpStatus.SC_OK) {
            System.err.println("Method failed: " + method.getStatusLine());
        }
        byte[] responseBody = method.getResponseBody();
        System.out.println(new String(responseBody));
    }
}

6.测试

首先运行MyServer类，然后运行MyClient类来验证Web Service。

http://blog.csdn.net/kongxx/article/details/7527115