CXF系列之JAX-RS:CXF发布与调用REST服务

今天我们将视角集中在 REST 上，它是继 SOAP 以后，另一种广泛使用的 Web 服务。与 SOAP 不同，REST 并没有 WSDL 的概念，也没有叫做“信封”的东西，因为 REST 主张用一种简单粗暴的方式来表达数据，传递的数据格式可以是 JSON 格式，也可以是 XML 格式，这完全由您来决定。

REST 全称是 Representational State Transfer（表述性状态转移），它是 Roy Fielding 博士在 2000 年写的一篇关于软件架构风格的论文，此文一出，威震四方！许多知名互联网公司开始采用这种轻量级 Web 服务，大家习惯将其称为 RESTful Web Services，或简称 REST 服务。

那么 REST 到底是什么呢？

REST 本质上是使用 URL 来访问资源的一种方式。总所周知，URL 就是我们平常使用的请求地址了，其中包括两部分：请求方式 与 请求路径，比较常见的请求方式是 GET 与 POST，但在 REST 中又提出了几种其它类型的请求方式，汇总起来有六种：GET、POST、PUT、DELETE、HEAD、OPTIONS。尤其是前四种，正好与 CRUD（增删改查）四种操作相对应：GET（查）、POST（增）、PUT（改）、DELETE（删），这正是 REST 的奥妙所在！

实际上，REST 是一个“无状态”的架构模式，因为在任何时候都可以由客户端发出请求到服务端，最终返回自己想要的数据。也就是说，服务端将内部资源发布 REST 服务，客户端通过 URL 来访问这些资源，这不就是 SOA 所提倡的“面向服务”的思想吗？所以，REST 也被人们看做是一种轻量级的 SOA 实现技术，因此在企业级应用与互联网应用中都得到了广泛使用。

在 Java 的世界里，有一个名为 JAX-RS 的规范，它就是用来实现 REST 服务的，目前已经发展到了 2.0 版本，也就是 JSR-339 规范，如果您想深入研究 REST，请深入阅读此规范。

JAX-RS 规范目前有以下几种比较流行的实现技术：

• Jersey：https://jersey.java.net/
• Restlet：http://restlet.com/
• RESTEasy：http://resteasy.jboss.org/
• CXF：http://cxf.apache.org/

第一步、添加相关jar包

 
        
        
            org.apache.cxf
            cxf-rt-frontend-jaxrs
            ${cxf.version}
        
        
            org.apache.cxf
            cxf-rt-transports-http-jetty
            ${cxf.version}
        
        
        
            com.fasterxml.jackson.jaxrs
            jackson-jaxrs-json-provider
            ${jackson.version}
        
    

以上添加了 CXF 关于 REST 的依赖包，并使用了 Jackson 来实现 JSON 数据的转换。

第二步、定义REEST服务接口以及具体实现类

package com.test.rest.service.inter;

import java.util.List;
import java.util.Map;

import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
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.MediaType;

import com.test.rest.bean.Product;

public interface ProductService {

	@GET
	@Path("/products")
	@Produces(MediaType.APPLICATION_JSON)
	List retrieveAllProducts();
	
	@GET
	@Path("/product/{id}")
	@Produces(MediaType.APPLICATION_JSON)
	Product retrieveProductById(@PathParam("id")long id);
	
	/**
	 * 参数查询
	 * @param name
	 * @return
	 */
	@GET
	@Path("/products/name")
	@Produces(MediaType.APPLICATION_JSON)
	List retrieveProductsByName_param(@QueryParam("name")String name);
	
	/**
	 * 提交表单查询
	 * @param name
	 * @return
	 */
	@POST
	@Path("/products/form/name")
	@Consumes(MediaType.APPLICATION_FORM_URLENCODED)
	@Produces(MediaType.APPLICATION_JSON)
	List retrieveProductsByName_form(@FormParam("name")String name);

	
	@POST
	@Path("/product")
	@Consumes(MediaType.APPLICATION_JSON)
	@Produces(MediaType.APPLICATION_JSON)
	Product createProduct(Product product);
	
	@PUT
	@Path("/product/{id}")
	@Consumes(MediaType.APPLICATION_JSON)
	@Produces(MediaType.APPLICATION_JSON)
	Product updateProductById(@PathParam("id")long id,Map fieldMap);
	
	@PUT
	@Path("/product")
	@Consumes(MediaType.APPLICATION_JSON)
	@Produces(MediaType.APPLICATION_JSON)
	Product updateProduct(Product product);
	
	@DELETE
	@Path("/product/{id}")
	@Produces(MediaType.APPLICATION_JSON)
	Product deleteProductById(@PathParam("id")long id);
	
	@DELETE
	@Path("/product")
	@Produces(MediaType.APPLICATION_JSON)
	Product deleteProductById_param(@QueryParam("id")long id);
}

以上 ProductService 接口中提供了一系列的方法，在每个方法上都使用了 JAX-RS 提供的注解，主要包括以下三类：

1. 请求方式注解，包括：@GET、@POST、@PUT、@DELETE
   
2. 请求路径注解，包括：@Path，其中包括一个路径参数
   
3. 数据格式注解，包括：@Consumes（输入）、@Produces（输出），可使用 MediaType 常量
   
4. 相关参数注解，包括：@PathParam（路径参数）、@FormParam（表单参数），此外还有 @QueryParam（请求参数）
   

针对 updateProductById 方法，简单解释一下：
该方法将被 PUT:/product/{id} 请求来调用，请求路径中的 id 参数将映射到 long id 参数上，请求体中的数据将自动转换为 JSON 格式并映射到 Map fieldMap 参数上，返回的 Product 类型的数据将自动转换为 JSON 格式并返回到客户端。

具体实现类：

package com.test.rest.service.impl;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.Date;
import java.util.Iterator;
import java.util.List;
import java.util.Map;

import com.test.rest.bean.Product;
import com.test.rest.service.inter.ProductService;

public class ProductServiceImpl implements ProductService {

	private static final List productList = new ArrayList();
	static {
		productList.add(new Product(1, "iphone63", 5000));
		productList.add(new Product(2, "ipad mini", 2500));
	}

	@Override
	public List retrieveAllProducts() {

		Collections.sort(productList, new Comparator() {

			@Override
			public int compare(Product p1, Product p2) {
				return (p1.getId() > p2.getId()) ? -1 : 1;
			}
		});
		return productList;
	}

	@Override
	public Product retrieveProductById(long id) {
		Product targetProduct = null;
		for (Product product : productList) {
			if (product.getId() == id) {
				targetProduct = product;
				break;
			}
		}
		return targetProduct;
	}
	
	@Override
	public List retrieveProductsByName_param(String name){
		List targetList = new ArrayList();
		for (Product product : productList) {
			if (product.getName().equals(name)) {
				targetList.add(product);
			}
		}
		return targetList;
	}
	@Override
	public List retrieveProductsByName_form(String name) {
		List targetList = new ArrayList();
		for (Product product : productList) {
			if (product.getName().equals(name)) {
				targetList.add(product);
			}
		}
		return targetList;
	}

	@Override
	public Product createProduct(Product product) {
		product.setId(new Date().getTime());
		productList.add(product);
		return product;
	}

	@Override
	public Product updateProductById(long id, Map fieldMap) {
		Product product = retrieveProductById(id);
		if (product != null) {
			try {
				for (Map.Entry fieldEntry : fieldMap.entrySet()) {
					Field field = Product.class.getDeclaredField(fieldEntry
							.getKey());
					field.setAccessible(true);
					field.set(product, fieldEntry.getValue());

				}
			} catch (Exception e) {
				e.printStackTrace();
			}
		}
		return product;
	}
	
	@Override
	public Product updateProduct(Product product){
		if(product != null){
			Product targetProduct = retrieveProductById(product.getId());
			if(targetProduct != null){
				targetProduct.setName(product.getName());
				targetProduct.setPrice(product.getPrice());
			}
			
			return targetProduct;
		}
		
		return null;
	}

	@Override
	public Product deleteProductById(long id) {
		Product targetProduct = null;
		Iterator it = productList.iterator();
		while (it.hasNext()) {
			Product product = it.next();
			if (product.getId() == id) {
				targetProduct = product;
				it.remove();
				break;
			}
		}
		return targetProduct;
	}
	
	@Override
	public Product deleteProductById_param(long id){
		Product targetProduct = null;
		Iterator it = productList.iterator();
		while (it.hasNext()) {
			Product product = it.next();
			if (product.getId() == id) {
				targetProduct = product;
				it.remove();
				break;
			}
		}
		return targetProduct;
	}

}

第三步、使用CXF发布REST服务

package com.test.rest.server;

import java.util.ArrayList;
import java.util.List;

import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
import org.apache.cxf.jaxrs.lifecycle.ResourceProvider;
import org.apache.cxf.jaxrs.lifecycle.SingletonResourceProvider;
import org.codehaus.jackson.jaxrs.JacksonJsonProvider;

import com.test.rest.service.impl.ProductServiceImpl;

public class Server {

	public static void main(String[] args) {
		// 添加ResourceClass
		List> resourceClassList = new ArrayList>();
		resourceClassList.add(ProductServiceImpl.class);

		// 添加ResourceProvider
		List resourceProviderList = new ArrayList();
		resourceProviderList.add(new SingletonResourceProvider(
				new ProductServiceImpl()));
		
		//添加provider
		List