dubbox實現REST服務

本文轉載自查看原文 2017-06-27 16:49 11110 Java/ dubbox

一、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文件如下：

  1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  2     xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
  3     <modelVersion>4.0.0</modelVersion>
  4     <groupId>com.bigbang</groupId>
  5     <artifactId>service-provider</artifactId>
  6     <packaging>war</packaging>
  7     <version>0.0.1-SNAPSHOT</version>
  8     <name>service-provider</name>
  9     <properties>
 10         <spring.version>3.2.4.RELEASE</spring.version>
 11     </properties>
 12     <dependencies>
 13         <dependency>
 14             <groupId>junit</groupId>
 15             <artifactId>junit</artifactId>
 16             <version>3.8.1</version>
 17             <scope>test</scope>
 18         </dependency>
 19         <dependency>
 20             <groupId>org.springframework</groupId>
 21             <artifactId>spring-context</artifactId>
 22             <version>${spring.version}</version>
 23         </dependency>
 24 
 25         <dependency>
 26             <groupId>org.springframework</groupId>
 27             <artifactId>spring-core</artifactId>
 28             <version>${spring.version}</version>
 29         </dependency>
 30 
 31         <dependency>
 32             <groupId>org.springframework</groupId>
 33             <artifactId>spring-beans</artifactId>
 34             <version>${spring.version}</version>
 35         </dependency>
 36 
 37         <dependency>
 38             <groupId>org.springframework</groupId>
 39             <artifactId>spring-webmvc</artifactId>
 40             <version>${spring.version}</version>
 41         </dependency>
 42 
 43         <dependency>
 44             <groupId>com.alibaba</groupId>
 45             <artifactId>dubbo</artifactId>
 46             <version>2.8.4</version>
 47         </dependency>
 48 
 49         <dependency>
 50             <groupId>org.jboss.resteasy</groupId>
 51             <artifactId>resteasy-jaxrs</artifactId>
 52             <version>3.0.7.Final</version>
 53         </dependency>
 54         <dependency>
 55             <groupId>org.jboss.resteasy</groupId>
 56             <artifactId>resteasy-client</artifactId>
 57             <version>3.0.7.Final</version>
 58         </dependency>
 59         <dependency>
 60             <groupId>javax.validation</groupId>
 61             <artifactId>validation-api</artifactId>
 62             <version>1.0.0.GA</version>
 63         </dependency>
 64 
 65         <dependency>
 66             <groupId>org.jboss.resteasy</groupId>
 67             <artifactId>resteasy-jackson-provider</artifactId>
 68             <version>3.0.7.Final</version>
 69         </dependency>
 70 
 71         <dependency>
 72             <groupId>com.fasterxml.jackson.core</groupId>
 73             <artifactId>jackson-core</artifactId>
 74             <version>2.3.3</version>
 75         </dependency>
 76         <dependency>
 77             <groupId>com.fasterxml.jackson.core</groupId>
 78             <artifactId>jackson-databind</artifactId>
 79             <version>2.3.3</version>
 80         </dependency>
 81 
 82         <dependency>
 83             <groupId>org.mortbay.jetty</groupId>
 84             <artifactId>jetty</artifactId>
 85             <version>6.1.26</version>
 86         </dependency>
 87 
 88     </dependencies>
 89     <build>
 90         <plugins>
 91             <plugin>
 92                 <groupId>org.apache.maven.plugins</groupId>
 93                 <artifactId>maven-compiler-plugin</artifactId>
 94                 <configuration>
 95                     <source>1.7</source>
 96                     <target>1.7</target>
 97                 </configuration>
 98             </plugin>
 99         </plugins>
100         <finalName>service-provider</finalName>
101     </build>
102 </project>

pom.xml

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

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

　　那么現在來編寫一個服務的接口，以一個用戶管理的模塊為例，需要一個接口UserService.java：

1 public interface UserService {
2 　　//注冊
3     String regist(User user);
4 　　//查詢
5     User queryById(Long id);
6 }

　　接口實現類UserServiceImpl.java:

 1 import javax.servlet.http.HttpServletRequest;
 2 import javax.ws.rs.Consumes;
 3 import javax.ws.rs.POST;
 4 import javax.ws.rs.Path;
 5 import javax.ws.rs.PathParam;
 6 import javax.ws.rs.Produces;
 7 import javax.ws.rs.core.MediaType;
 8 
 9 import com.alibaba.dubbo.rpc.RpcContext;
10 import com.bigbang.domain.User;
11 import com.bigbang.service.UserService;
12 
13 @Path("user")
14 public class UserServiceImpl implements UserService {
15 
16     @POST
17     @Path("regist")
18     @Consumes({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
19     @Produces({ MediaType.APPLICATION_JSON, MediaType.TEXT_XML })
20     @Override
21     public String regist(User user) {
22         System.out.println(user);
23         HttpServletRequest request = (HttpServletRequest) RpcContext.getContext().getRequest();
24         String host = request.getLocalAddr();
25         return "regist success!, ur host is:" + host;
26     }
27 
28     @POST
29     @Path("{id:\\d+}")
30     @Produces({ MediaType.APPLICATION_JSON })
31     @Override
32     public User queryById(@PathParam("id") Long uid) {
33         User user = new User();
34         user.setId(uid);
35         user.setName("jetty");
36         user.setAge(25);
37         return user;
38     }
39 
40 }

　　注解代碼說明：

　　@Path：代表服務的訪問路徑，如“user”,則訪問路徑為domain:port/context/user，在方法上注解是相對類上面的。依次展開路徑即可。

　　@POST：服務請求的方式，支持POST、GET等。

　　@Consumes：表示將接收到的數據自動轉換為什么格式的，支持json和xml。

　　@Produces：表示將結果返回時候輸出為什么格式的，支持json和xml。

　　@PathParm：用來修飾方法參數的。配合@Path中的指定變量名使用。

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

 1 <dubbo:application name="service-provider" />
 2 
 3     <dubbo:registry address="multicast://224.5.6.7:1234" />
 4     
 5     <!-- 指定服務使用rest協議並且暴露在8080端口 -->
 6     <dubbo:protocol name="rest" port="8080" />
 7     
 8     <dubbo:service interface="com.bigbang.service.UserService"
 9         ref="userService" />
10     <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標准的。

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 dubbox rest服務 dubbox REST服務使用fastjson替換jackson dubbox開發rest+json指南【轉】 (一） go 實現的基於REST的Web服務基於Rest服務實現的RPC dubbox 本地HTML訪問REST服務的實現 dubbo和dubboX與微服務架構（dubbo一） dubbox微服務實例及引發的“血案” Dubbox監控在服務器中的安裝