dubbox实现REST服务

一、dubbox的由来

　　　dubbox是当当网基于dubbo的基础上开发的扩展版，也可以认为是dubbo的升级版，根据当前互联网的应用需求，增加了很多扩展的功能。

　　　dubbox并没有发布到maven中央仓库的包，目前代码在github上，需要自己down下来编译，基于maven开发的。

　　　项目GitHub地址：https://github.com/dangdangdotcom/dubbox

　　　在根目录下执行 mvn install -Dmaven.test.skip=true，等待编译完成 ，注：在jdk8环境下编译dubbox不成功，会出现一些class的方法过时无法编译的问题，切换到jdk7正常。

二、dubbox当前的主要功能

　　摘录官方的说明：

• 支持REST风格远程调用（HTTP + JSON/XML)：基于非常成熟的JBoss RestEasy框架，在dubbo中实现了REST风格（HTTP + JSON/XML）的远程调用，以显著简化企业内部的跨语言交互，同时显著简化企业对外的Open API、无线API甚至AJAX服务端等等的开发。事实上，这个REST调用也使得Dubbo可以对当今特别流行的“微服务”架构提供基础性支持。 另外，REST调用也达到了比较高的性能，在基准测试下，HTTP + JSON与Dubbo 2.x默认的RPC协议（即TCP + Hessian2二进制序列化）之间只有1.5倍左右的差距，详见文档中的基准测试报告。

• 支持基于Kryo和FST的Java高效序列化实现：基于当今比较知名的Kryo和FST高性能序列化库，为Dubbo默认的RPC协议添加新的序列化实现，并优化调整了其序列化体系，比较显著的提高了Dubbo RPC的性能，详见文档中的基准测试报告。

• 支持基于Jackson的JSON序列化：基于业界应用最广泛的Jackson序列化库，为Dubbo默认的RPC协议添加新的JSON序列化实现。

• 支持基于嵌入式Tomcat的HTTP remoting体系：基于嵌入式tomcat实现dubbo的HTTP remoting体系（即dubbo-remoting-http），用以逐步取代Dubbo中旧版本的嵌入式Jetty，可以显著的提高REST等的远程调用性能，并将Servlet API的支持从2.5升级到3.1。（注：除了REST，dubbo中的WebServices、Hessian、HTTP Invoker等协议都基于这个HTTP remoting体系）。

• 升级Spring：将dubbo中Spring由2.x升级到目前最常用的3.x版本，减少版本冲突带来的麻烦。

• 升级ZooKeeper客户端：将dubbo中的zookeeper客户端升级到最新的版本，以修正老版本中包含的bug。

• 支持完全基于Java代码的Dubbo配置：基于Spring的Java Config，实现完全无XML的纯Java代码方式来配置dubbo

• 调整Demo应用：暂时将dubbo的demo应用调整并改写以主要演示REST功能、Dubbo协议的新序列化方式、基于Java代码的Spring配置等等。

• 修正了dubbo的bug 包括配置、序列化、管理界面等等的bug。

注：dubbox和dubbo 2.x是兼容的，没有改变dubbo的任何已有的功能和配置方式（除了升级了spring之类的版本）

　　

三、搭建rest服务应用

　　搭建dubbox和dubbox应用是一样的，这里依旧使用Spring+maven。

　　项目的pom.xml文件如下：

　　

 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.bigbang</groupId>
     <artifactId>service-provider</artifactId>
     <packaging>war</packaging>
     <version>0.0.1-SNAPSHOT</version>
     <name>service-provider</name>
     <properties>
         <spring.version>3.2.4.RELEASE</spring.version>
     </properties>
     <dependencies>
         <dependency>
             <groupId>junit</groupId>
             <artifactId>junit</artifactId>
             <version>3.8.1</version>
             <scope>test</scope>
         </dependency>
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-context</artifactId>
             <version>${spring.version}</version>
         </dependency>
 
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-core</artifactId>
             <version>${spring.version}</version>
         </dependency>
 
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-beans</artifactId>
             <version>${spring.version}</version>
         </dependency>
 
         <dependency>
             <groupId>org.springframework</groupId>
             <artifactId>spring-webmvc</artifactId>
             <version>${spring.version}</version>
         </dependency>
 
         <dependency>
             <groupId>com.alibaba</groupId>
             <artifactId>dubbo</artifactId>
             <version>2.8.4</version>
         </dependency>
 
         <dependency>
             <groupId>org.jboss.resteasy</groupId>
             <artifactId>resteasy-jaxrs</artifactId>
             <version>3.0.7.Final</version>
         </dependency>
         <dependency>
             <groupId>org.jboss.resteasy</groupId>
             <artifactId>resteasy-client</artifactId>
             <version>3.0.7.Final</version>
         </dependency>
         <dependency>
             <groupId>javax.validation</groupId>
             <artifactId>validation-api</artifactId>
             <version>1.0.0.GA</version>
         </dependency>
 
         <dependency>
             <groupId>org.jboss.resteasy</groupId>
             <artifactId>resteasy-jackson-provider</artifactId>
             <version>3.0.7.Final</version>
         </dependency>
 
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-core</artifactId>
             <version>2.3.3</version>
         </dependency>
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
             <version>2.3.3</version>
         </dependency>
 
         <dependency>
             <groupId>org.mortbay.jetty</groupId>
             <artifactId>jetty</artifactId>
             <version>6.1.26</version>
         </dependency>
 
     </dependencies>
     <build>
         <plugins>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <configuration>
                     <source>1.7</source>
                     <target>1.7</target>
                 </configuration>
             </plugin>
         </plugins>
         <finalName>service-provider</finalName>
     </build>
 </project>

pom.xml

　　主要引用了dubbo的2.8.4版本的包，以及restful和jackson依赖的包。

　　dubbox的restful是使用标准java rest api:JAX-RS。一般使用它的几个注解就可以了。

　　那么现在来编写一个服务的接口，以一个用户管理的模块为例，需要一个接口UserService.java：

　　

 public interface UserService {
 　　//注册
     String regist(User user);
 　　//查询
     User queryById(Long id);
 }

　　接口实现类UserServiceImpl.java:

　　

 import javax.servlet.http.HttpServletRequest;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.POST;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
 import javax.ws.rs.core.MediaType;
 
 import com.alibaba.dubbo.rpc.RpcContext;
 import com.bigbang.domain.User;
 import com.bigbang.service.UserService;
 
 @Path("user")
 public class UserServiceImpl implements UserService {
 
     @POST
     @Path("regist")
     @Consumes({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
     @Produces({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
     @Override
     public String regist(User user) {
         System.out.println(user);
         HttpServletRequest request = (HttpServletRequest) RpcContext.getContext().getRequest();
         String host = request.getLocalAddr();
         return "regist success!, ur host is:" + host;
     }
 
     @POST
     @Path("{id:\\d+}")
     @Produces({ MediaType.APPLICATION_JSON })
     @Override
     public User queryById(@PathParam("id") Long uid) {
         User user = new User();
         user.setId(uid);
         user.setName("jetty");
         user.setAge(25);
         return user;
     }
 
 }

　　注解代码说明：

　　@Path：代表服务的访问路径，如“user”,则访问路径为domain:port/context/user，在方法上注解是相对类上面的。依次展开路径即可。

　　@POST：服务请求的方式，支持POST、GET等。

　　@Consumes：表示将接收到的数据自动转换为什么格式的，支持json和xml。

　　@Produces：表示将结果返回时候输出为什么格式的，支持json和xml。

　　@PathParm：用来修饰方法参数的。配合@Path中的指定变量名使用。

　　在dubbo的spring配置文件中添加以下的配置：

　　

 <dubbo:application name="service-provider" />
 
     <dubbo:registry address="multicast://224.5.6.7:1234" />
 
     <!-- 指定服务使用rest协议并且暴露在8080端口 -->
     <dubbo:protocol name="rest" port="8080" />
 
     <dubbo:service interface="com.bigbang.service.UserService"
         ref="userService" />
     <bean id="userService" class="com.bigbang.service.impl.UserServiceImpl" />

　　在这里不再默认使用dubbo的协议，而是改用rest，并且启用8080端口暴露服务。

　　因为restful特有的原因，不再限制客户端为什么语言，甚至通过ajax也能访问，这里选用Postman作为客户端访问，测试效果。

　　访问第一个接口的注册用户服务效果如下：

　　

　　访问接口的查询用户服务效果如下：

　　

四、一些问题

　　官方说出的一些点可以参考。

• 　　注解写在接口还是实现类上

　　　　　建议写在实现类上，避免污染接口，保持接口的纯净和广泛使用性。如果接口和实现类都写了注解，则会忽略接口上的注解。

• 　　上下Context的获取方法

　　　　　　  获取上下文Context有很多种方法，可以在方法参数上增加注解@Context获取servlet的request和response对象，或者使用dubbo提供的RpcContext类获取。两种方法                  各有利弊，第一种方法会污染接口，第二种方法会对代码有入侵。

• 　　是否透明化发布rest服务

　　　　　　因为dubbo的rest调用在代码上使用了注解，实际是业务处理的service上。如果你认为这样做污染了代码，那么可以使用Facade和DTO，在Facade和DTO上面添加注                 解，然后再调用响应的业务处理类。而事实上，把注解添加到实现类上基本没有什么问题，因为它是遵循java标准的。