带你读《Apache Dubbo微服务开发从入门到精通》—— 四、 Rest协议(1)

本文涉及的产品
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
简介: 带你读《Apache Dubbo微服务开发从入门到精通》—— 四、 Rest协议(1)


四、 Rest协议

 

基于标准的Java REST API——JAX-RS 2.0(Java API for RESTful Web Services的简写)实现的REST调用支持

 

1. 特性说明

 

此协议提供通过web访问服务的简单方式,将服务与其他基于web的应用程序集成。

 

支持JSON、XML和Text格式的请求和响应,发布和使用服务的便捷方式,也提供了服务版本控制、服务过滤、服务元数据和服务参数实现Dubbo框架的灵活性和可伸缩性。

 

2. 使用场景

 

适用的场景包括发布基于HTTP协议的REST服务、TCP&HTTP多协议发布、与原有HTTP协议微服务体系互通等。适用的场景包括发布基于HTTP协议的REST服务、TCP&HTTP多协议发布、与原有HTTP协议微服务体系互通等。

 

3. 使用方式

 

1) 快速入门

 

在dubbo中开发一个REST风格的服务会比较简单,下面以一个注册用户的简单服务为例说明。

 

这个服务要实现的功能是提供如下URL(注:这个URL不是完全符合REST的风格,但是更简单实用)

 

image.png 

 

而任何客户端都可以将包含用户信息的JSON字符串POST到以上URL来完成用户注册。

 

首先,开发服务的接口

 

image.png

 

然后,开发服务的实现

 

image.png

 

上面的实现非常简单,但是由于该REST服务是要发布到指定URL上,供任意语言的客户端甚至浏览器来访问,所以这里额外添加了几个JAX-RS的标准annotation来做相关的配置。

 

@Path("users"):指定访问UserService的URL相对路径是/users,即http://localhost:8080/users

 

@Path("register"):指定访问registerUser()方法的URL相对路径是/register,再结合上一个@Path为UserService指定的路径,则调用UserService.register()的完整路径为http://localhost:8080/users/register

 

@POST:指定访问 registerUser()用HTTP POST方法

 

@Consumes({MediaType.APPLICATION_JSON}):指定registerUser()接收JSON格式的数据。REST框架会自动将JSON数据反序列化为User对象

 

最后,在spring配置文件中添加此服务,即完成所有服务开发工作

 

image.png

 

2) REST服务提供端

 

下面我们扩充“快速入门”中的UserService,进一步展示在dubbo中REST服务提供端的开发要点。

 

3) HTTP POST/GET的实现

 

REST服务中虽然建议使用HTTP协议中四种标准方法POST、DELETE、PUT、GET来分别实现常见的“增删改查”,但实际中,我们一般情况直接用POST来实现“增改”,GET来实现“删查”即可(DELETE和PUT甚至会被一些防火墙阻挡)。

 

前面已经简单演示了POST的实现,在此,我们为UserService添加一个获取注册用户资料的功能,来演示GET的实现。

 

这个功能就是要实现客户端通过访问如下不同URL来获取不同ID的用户资料

 

image.png

 

当然,也可以通过其他形式的URL来访问不同ID的用户资料,例如

 

image.png

 

JAX-RS本身可以支持所有这些形式。但是上面那种在URL路径中包含查询参数的形式(http://localhost:8080/users/1001)更符合REST的一般习惯,所以更推荐大家来使用。下面我们就为UserService添加一个getUser()方法来实现这种形式的URL访问

 

image.png

 

@GET:指定用HTTP GET方法访问

 

@Path("{id : \\d+}"):根据上面的功能需求,访问getUser()的URL应当是“http://localhost:8080/users/ + 任意数字",并且这个数字要被做为参数传入getUser()方法。这里的annotation配置中,@Path中间的{id: xxx}指定URL相对路径中包含了名为id参数,而它的值也将被自动传递给下面用@PathParam("id")修饰的方法参数id。{id:后面紧跟的\\d+是一个正则表达式,指定了id参数必须是数字。

 

@Produces({MediaType.APPLICATION_JSON}):指定getUser()输出JSON格式的数据。框架会自动将User对象序列化为JSON数据。

 


 


 

 《Apache Dubbo微服务开发从入门到精通》——通信协议—— 四、 Rest协议(2): https://developer.aliyun.com/article/1224568


 


 


 

 




 


相关文章
|
1月前
|
Cloud Native Dubbo 应用服务中间件
Apache Dubbo 下一代云原生微服务挑战赛启动报名!五大赛题 50 万奖金池
Apache Dubbo 下一代云原生微服务挑战赛启动报名!五大赛题 50 万奖金池
|
2月前
|
负载均衡 Dubbo 应用服务中间件
阿里微服务架构到底多牛逼:深入解析Apache Dubbo与实战
在Apache Dubbo (以下简称Dubbo)重新开源之前,Dubbo已经被很多公司广泛用于生产环境并获得了良好的反馈,很多公司内部也会建立私有分支自己维护,其中Dubbox 就是基于Dubbo分支进行扩展并二次维护的。重新开源后,社区维护的Dubbo版本进行了大量“bug fix" .和特性支持,收到了大量Dubbo用户的支持和参与。编写本书的想法是在开源后提出来的,因此本书取名《深入理解Apache Dubbo与实战》。
|
2月前
|
Dubbo 应用服务中间件 Apache
电子好书发您分享《Apache Dubbo 微服务开发从入门到精通》
电子好书发您分享《Apache Dubbo 微服务开发从入门到精通》
130 1
|
4月前
|
JSON 自然语言处理 Go
Golang 微服务为什么选择使用 gRPC 作为通信协议?
Golang 微服务为什么选择使用 gRPC 作为通信协议?
36 0
|
5月前
|
消息中间件 Kafka Apache
在微服务中使用Apache Kafka进行异步通信
在微服务中使用Apache Kafka进行异步通信
92 0
|
6月前
|
Dubbo 前端开发 网络协议
微服务最佳实践,零改造实现 Spring Cloud & Apache Dubbo 互通
微服务最佳实践,零改造实现 Spring Cloud & Apache Dubbo 互通
47543 55
|
7月前
|
JSON Dubbo JavaScript
Dubbo Triple 协议重磅升级:支持通过 HTTP 连通 Web 与后端微服务
Dubbo Triple 协议重磅升级:支持通过 HTTP 连通 Web 与后端微服务
|
7月前
|
监控 负载均衡 Dubbo
Dubbo通信协议的原因以及运行原理
Dubbo通信协议的原因以及运行原理
107 0
|
9月前
|
人工智能 Apache
Huggingface榜首开源模型惹争议:魔改Apache协议,达到一定门槛要收钱
Huggingface榜首开源模型惹争议:魔改Apache协议,达到一定门槛要收钱
117 0
|
9月前
|
消息中间件 存储 负载均衡
「事件驱动架构」Apache Kafka再平衡协议:再平衡协议101
「事件驱动架构」Apache Kafka再平衡协议:再平衡协议101
「事件驱动架构」Apache Kafka再平衡协议:再平衡协议101

相关产品

  • 云消息队列 MQ
  • 云消息队列 Kafka 版
  • 微服务引擎
  • 推荐镜像

    更多