Dubbo使用Rest协议


使用场景

Dubbo支持多种协议,Rest是其中一种。可以通过Rest协议暴露接口,进行远程调用。

Service示例

在Dubbo使用Rest协议时,UserService,作用类似于Spring的Controller

import javax.ws.rs.*;
import javax.ws.rs.core.MediaType;

@Path("user")
@Consumes({MediaType.APPLICATION_JSON, MediaType.TEXT_HTML, MediaType.TEXT_PLAIN, MediaType.TEXT_XML})
@Produces({MediaType.APPLICATION_JSON + "; " + MediaType.CHARSET_PARAMETER + "=UTF-8"
        , MediaType.TEXT_XML + "; " + MediaType.CHARSET_PARAMETER + "=UTF-8"})
public interface UserService {
    /**
     * 该接口通过 ip:端口号/user/query 进行调用, 比如 localhost:8080/user/query
     * 
     */
    @GET
    @Path("/query")
    ResponseResult> queryList(@QueryParam("id") Integer id);
    
    /**
     * 该接口通过 ip:端口号/user/list进行调用, 比如 localhost:8080/user/list?id=123
     * 
     */
    @POST
    @Path("/list")
    ResponseResult queryList(UserQuery query);

    /**
     * 该接口通过 ip:端口号/user/detail 进行调用, 比如 localhost:8080/user/detail
     * 
     */
    @POST
    @Path("/detail")
    ResponseResult queryDetail(@Context HttpServletRequest request,
                                    @Context HttpServletResponse response);
}

常用注解

@Path : 表示url的请求路径,在Service接口上方的@Path是父级路径,在方法上面的@Path是后续的路径。

@Consumes: 可以指定请求的MediaType格式, 比如 json,text等。

@Produces:可以指定响应的MediaType格式, MediaType.CHARSET_PARAMETER 表示字符编码。

@GET: GET请求。 @POST: POST请求。

@QueryParam: url路径问号后的参数。比如 localhost:8080/user/query?id=123

@PathParam: url路径中占位符的参数。比如 getUser(@PathParam("id") Long id); 对应 localhost:8080/user/123

@Context: 用于获取请求和上下文, 比如 @Context HttpServletRequest request

Service实现类:

跟普通的ServiceImpl类一样。

import org.springframework.stereotype.Service;

@Service("userService")
public class UserServiceImpl implements UserService {
    @Override
    public ResponseResult query(Integer id) {
        return null;
    }

    //...
}


配置服务

在spring配置文件中添加此服务:










参考资料:

https://dubbo.apache.org/zh/docs/references/protocols/rest/

https://blog.csdn.net/varyall/article/details/104078512