Dubbo 使用rest协议发布http服务

Posted

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Dubbo 使用rest协议发布http服务相关的知识,希望对你有一定的参考价值。

演示用GitHub地址:https://github.com/suyin58/dubbo-rest-example

1       Dubbo_rest介绍

Dubbo2.6.0版本后,合并了dubboxrestful风格的接口暴露方式,其restful的处理采用的是jboss.resteasy框架。使用该功能可以简便的将dubbo服务直接通过http的方式发布,不需要再使用中转的http应用暴露服务。

 

如上图,原有结构中,HTTP访问需要通过API应用中转服务,RPC访问调用dubbo应用,使用dubbo_rest之后,HTTPRPC访问都直接调用dubbo应用即可。

2       使用方法

    参考demo项目 https://github.com/suyin58/dubbo-rest-example

由于dubbo 2.6依赖jarjavax.json.bind-apiJDK1.8版本,因此建议使用JDK1.8版本,但是使用JDK1.7版本也可以,不影响以下介绍的功能点。

2.1    POM依赖

2.1.1      Dubbo依赖

    

 


2.1.2      Resteasy依赖

    

     

     

 


2.2    接口暴露

2.2.1      服务协议配置

dubbo_service.xml中增加dubbo:protocol name="rest"显式申明提供rest服务。

    

 


2.2.2      接口服务配置

同原有Dubbo服务一样,将Dubbo服务发布出来,需要使用<dubbo:service显式申明。

 


2.3    服务注解

所有在<dubbo:service显式申明提供服务的接口实现类(也可以加载接口中,设计原则建议放在实现类做具体操作)中,需要增加@Path注解。

 


 


如果某个dubbo服务显式进行了申明,但是没有增加@Path注解,否则会应用无法启动,并报错【RESTEASY003130: Class is not a root resource.  It, or one of its interfaces must be annotated with @Path

其原因是在于resteasy中定义扫描并加载哪些类,是由dubbo提供的,dubbo将所有显式申明的<dubbo:service都被扫描,如果某个类没有@Path则会报错

参考:https://blog.csdn.net/wtopps/article/details/76919008

2.4    方法注解

    

 


    

 


2.5    参数注解

    

 


l   @PathParam  -->url路径问号前的参数

    请求路径:http://www.wjs.com/product/111/detail

    Path路径:@Path(“product/{productCode}/detail”)

    参数注解:detail(@PathParam(“productCode”) code){

l   @QueryParam -->url路径问号后中的参数

    请求路径:http://www.wjs.com/product/detail?productCode=111

    Path路径:@Path(“product/detail”)

    参数注解:detail(@QueryParam(“productCode”) code)

l   @FormParam  -->x-www.form-urlencoded参数

描述

application/x-www-form-urlencoded

在发送前编码所有字符(默认)

multipart/form-data

不对字符编码。

在使用包含文件上传控件的表单时,必须使用该值。

  通过Form表单提交的请求,需要区分是普通form表单(enctype=application/x-www-form-urlencoded),还是文件上传表单(enctype=multipart/form-data)。

  普通表单可以在方法体中使用@FormParam注解,也可以在类的属性中使用@FormParam注解。文件表单,由于服务端获取到的是个文件六,不能在方法体中使用@FormParam注解,但是可以在MultipartForm注解的类中使用@FormParam注解。

l   @BeanParam – 对象属性赋值

  如果接收参数处理是个对象的话,可以使用@BeanParam注解对象获取参数

  参数注解:pageListTemplate(@BeanParam DeductTplQry qry)

  对象属性注解:

  

 


l   @MultipartForm -- multipart/form-data表单参数

  如果是文件上传,那么需要通过@MultipartForm注解获取对象参数

  参数注解:upload(@MultipartForm DiskFile diskFile,

  对象属性注解:

  

 


  在这里需要注意的是,文件上传由于resteasy框架的缺陷,无法自动获取流中的文件名称,需要通过前端的form表单提供并传给后台。

l   @Context

如果需要部分HTTP上下环境参数的话,例如request或者response的话,可以通过@Context注解获取。

参数注解:httparg(@Context HttpServletRequest request, @Context HttpServletResponse){

2.6    文件上传/下载

2.6.1      单个文件上传

    单个文件上传,参考@ MultipartForm注解说明

2.6.2      多个文件上传

    @MultipartForm不支持,使用MultipartFormDataInput的方式处理。

    示例代码:

@POST

    @Path("/uploadmulti")

    @Consumes(MediaType.MULTIPART_FORM_DATA)

    @Override

    public Object uploadmulti(MultipartFormDataInput input) {

        System.out.println("进入业务逻辑");

//      MultipartFormDataReader

 

        Map<String, List<InputPart>> uploadForm = input.getFormDataMap();

 

        InputStream inputStream = null;

        OutputStream outStream = null;

        final String DIRCTORY = "D:/temp/datainputmulti/";

        //取得文件表单名

        try {

            for (Iterator<Entry<String, List<InputPart>>> it = uploadForm.entrySet().iterator() ; it.hasNext() ;) {

                Entry<String, List<InputPart>> entry = it.next();

                List<InputPart> inputParts = entry.getValue();

 

                initDirectory(DIRCTORY);

                for (InputPart inputPart : inputParts) {

                        // 文件名称 

                        String fileName = getFileName(inputPart.getHeaders());

                        inputStream = inputPart.getBody(InputStream.cl

以上是关于Dubbo 使用rest协议发布http服务的主要内容,如果未能解决你的问题,请参考以下文章

Dubbo多协议支持

dubbo协议层 jsonrpc协议迁移到http协议

dubbo

CXF 发布rest服务

Dubbo 入门

Dubbo中的那些坑(四)HTTP调用