Dubbo使用Rest开发服务

使用场景

可以基于标准的Java REST API------JAX-RS 2.0(Java API for RESTful Web Services的简写),

也就是REST的api和注解,为dubbo提供调用支持。

Service示例

在Dubbo使用Rest时,Service接口,作用类似于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<List<User>> queryList(@QueryParam("id") Integer id);
    
    /**
     * 该接口通过 ip:端口号/user/list进行调用, 比如 localhost:8080/user/list?id=123
     * 
     */
    @POST
    @Path("/list")
    ResponseResult<User> queryList(UserQuery query);

    /**
     * 该接口通过 ip:端口号/user/detail 进行调用, 比如 localhost:8080/user/detail
     * 
     */
    @POST
    @Path("/detail")
    ResponseResult<User> 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
public class UserServiceImpl implements UserService {
    @Override
    public ResponseResult<Object> query(Integer id) {
        return null;
    }

    //...
}

配置服务

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

复制代码
<!-- 用rest协议在8080端口暴露服务 -->
<dubbo:protocol name="rest" port="8080"/>

<!-- <dubbo:service/>声明需要暴露的服务提供者接口,如果是消费者就用<dubbo:reference/>,interface指定接口路径,protocol指定协议,ref为接口实现类的bean的id -->
<dubbo:service interface="xxx.xxx.UserService" protocol="rest" ref="userServiceImpl"/>

如果是在服务消费者中调用,需要使用 dubbo:reference,配置服务提供者定义的接口,并指定id 。

复制代码
<dubbo:reference interface="xxx.xxx.UserService" id="userService"/>

关于dubbo:service 和 dubbo:reference的配置详情,参考官方文档:

https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-service/

https://dubbo.apache.org/en/docs/v2.7/user/references/xml/dubbo-reference/

SpringBoot2整合Dubbo

https://www.cnblogs.com/expiator/p/15837603.html

参考资料:

官方文档: https://dubbo.apache.org/zh/docs/references/protocols/rest/

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

相关推荐
都叫我大帅哥18 分钟前
🌊 Redis Stream深度探险:从秒杀系统到面试通关
java·redis
都叫我大帅哥18 分钟前
Redis持久化全解析:从健忘症患者到记忆大师的逆袭
java·redis
程序猿阿越37 分钟前
Kafka源码(一)Controller选举与创建Topic
java·后端·源码
程序员爱钓鱼38 分钟前
Go语言项目工程化 — 常见开发工具与 CI/CD 支持
开发语言·后端·golang·gin
程序无bug42 分钟前
Spring6 当中 Bean 的生命周期的详细解析:有五步,有七步,有十步
java
二川bro1 小时前
飞算智造JavaAI:智能编程革命——AI重构Java开发新范式
java·人工智能·重构
Jiude1 小时前
MinIO 社区版被故意阉割,Web管理功能全面移除。我来试试国产RustFS
后端·docker·架构
Q_970956391 小时前
java+vue+SpringBoo校园失物招领网站(程序+数据库+报告+部署教程+答辩指导)
java·数据库·vue.js
仰望星空@脚踏实地1 小时前
Spring Boot Web 服务单元测试设计指南
spring boot·后端·单元测试