AI 助理
文档备案控制台
开发者社区 开发与运维 文章 正文

OpenFeign教程

2022-06-19 2079
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： 由浅入深拿下OpenFeign

1、OpenFeign是什么？

OpenFeign是一个Web声明式的Http客户端调用工具。是Spring Cloud官方对Feign的增强，它支持spring mvc的注解。在Spring Cloud中使用OpenFeign，可以做到使用HTTP请求访问远程服务，就像调用本地方法一样。

2、环境准备

本文基于Springboot 2.6.8，服务注册中心使用的Nacos 版本用的最新的2021.0.1.0。看一下相关的Pom依赖

<dependency><groupId>org.projectlombok</groupId><artifactId>lombok</artifactId><optional>true</optional></dependency><!--spring-cloud-starter-alibaba-nacos-config--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId><version>2021.0.1.0</version></dependency><!--spring-cloud-starter-alibaba-nacos-discovery--><dependency><groupId>com.alibaba.cloud</groupId><artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId><version>2021.0.1.0</version><!--不使用Ribbon进行客户端负载均衡--><exclusions><exclusion><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-netflix-ribbon</artifactId></exclusion></exclusions></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId><version>3.1.1</version></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-loadbalancer</artifactId><version>3.1.1</version></dependency><dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-bootstrap</artifactId><version>3.0.4</version></dependency>

这里简单讲解一下，不是本文重点：  

  1. 由于Ribbon停止维护，所以新版的SpringCloud已经不用它了，所以需要引入spring-cloud-starter-loadbalancer，并且在nacos依赖中排除掉ribbon。
  2. Springboot2.4+需要引入spring-cloud-starter-bootstrap

3、服务提供者

bootstrap.yml

server:
port: 8081spring:
cloud:
nacos:
discovery:
server-addr: ipservice: provider

新建接口

@RestController@RequestMapping("/provider")
publicclassProviderController {
@PostMapping("/getOrder")
OrdergetOrder(@RequestBodyOrderRequestrequest){
System.out.println(request.getId());
System.out.println(request.getClassify());
returnOrder.builder().code("JSON数据").build();
    }
@GetMapping("/findOrder/{id}")
OrderfindOrder(@PathVariable("id") Integerid){
returnOrder.builder().id(id).count(50).code("URL携带参数").build();
    }
@GetMapping("/findOrder")
OrderfindOrder(@SpringQueryMapOrderRequestrequest){
returnOrder.builder().code("POJO表单参数").build();
    }
@GetMapping("/findOrder2")
OrderqueryOrder(@RequestParam("id") Integerid,
@RequestParam("code") Stringcode){
System.out.println(id);
System.out.println(code);
returnOrder.builder().code("普通表单参数").build();
    }

订单实体类

@Data@BuilderpublicclassOrder {
privateIntegerid;
privateStringcode;
privateIntegeruserId;
privateIntegercount;
privateBigDecimalmoney;
}

查询参数类

@DatapublicclassOrderRequest {
privateIntegerid;
privateStringname;
privateStringclassify;
privateIntegernumber;
}

4、服务消费者

bootstrap.yml

server:
port: 8082spring:
cloud:
nacos:
discovery:
server-addr: ipservice: consumer
  • @EnableFeignClients  启用Feign客户端
  • @FeignClient 标记Feign客户端  

在主程序的上加上注解@EnableFeignClients

新建一个接口 name填服务提供者注册到nacos的服务名

@FeignClient(name="provider",path="provider")
publicinterfaceFeignProviderService {
@PostMapping("/getOrder")
OrdergetOrder(@RequestBodyOrderRequestrequest);
@GetMapping("/findOrder/{id}")
OrderfindOrder(@PathVariable("id") Integerid);
@GetMapping("/findOrder")
OrderfindOrder(@SpringQueryMapOrderRequestrequest);
@GetMapping("/findOrder2")
OrderqueryOrder(@RequestParam("id") Integerid,
@RequestParam("code") Stringcode);
}

这样就可以在消费者的Service中直接注入使用

@Service("consumerService")
publicclassConsumerServiceImplimplementsConsumerService {
@AutowiredFeignProviderServicefeignProviderService;
@OverridepublicOrderdealOne() {
OrderRequestorderRequest=newOrderRequest();
orderRequest.setId(1);
orderRequest.setClassify("777");
returnfeignProviderService.getOrder(orderRequest);
    }
@OverridepublicOrderdealTwo() {
returnfeignProviderService.findOrder(2);
    }
@OverridepublicOrderdealThree() {
OrderRequestorderRequest=newOrderRequest();
orderRequest.setId(3);
orderRequest.setNumber(555);
returnfeignProviderService.findOrder(orderRequest);
    }
@OverridepublicOrderdealFour() {
returnfeignProviderService.queryOrder(4,"ORDER-FOUR");
    }
}

5、传参问题

上文也看到我们在接口类中定义了不同传参方式的API

5.1 传递JSON数据

这个也是接口开发中常用的传参规则，在Spring Boot 中通过@RequestBody标识入参。openFeign默认的传参方式就是JSON传参（@RequestBody），因此定义接口的时候可以不用@RequestBody注解标注，不过为了规范，一般都填上。

5.2 POJO表单传参

openFeign提供了一个注解@SpringQueryMap完美解决POJO表单传参。

5.3 URL携带参数

此种方式针对restful方式中的GET请求，也是比较常用请求方式。

5.4 普通传参

这种不管调用方还是被调用方都加上@RequestParam注解

6、超时处理

如果连接或者读取时间超过了默认超时时间，消费者端就会报超时。

旧版本集成Ribbon如果不设置超时时间，默认超时时间为1s，新版不用Ribbon了。

在消费端的配置文件中配置超时时间

feign:
client:
config:
##default设置的全局超时时间，指定服务名称可以设置单个服务的超时时间default:
connectTimeout: 5000readTimeout: 5000

还可以给单个服务配置超时时间，单个配置的超时时间将会覆盖全局配置。

feign:
client:
config:
##default设置的全局超时时间，指定服务名称可以设置单个服务的超时时间default:
connectTimeout: 5000readTimeout: 5000##为serviceC这个服务单独配置超时时间serviceC:
connectTimeout: 30000readTimeout: 30000

7、开启日志增强

feign的日志级别

  • NONE： 默认的，不显示任何日志
  • BASIC： 仅记录请求方法、URL、响应状态码以及执行时间
  • HEADERS：除了BASIC 中自定义的信息外，还有请求和响应的信息头
  • FULL： 除了HEADERS中定义的信息外， 还有请求和响应的正文以及元数据。

前提条件需要在配置文件中，将日志级别设置为DEBUG。我们修改一下消费者的配置文件

feign:
client:
config:
##default设置的全局超时时间，指定服务名称可以设置单个服务的超时时间default:
connectTimeout: 5000readTimeout: 5000loggerLevel: basiclogging:
level:
#feign接口pathcom.example.consumer.client.FeignProviderService: debug

再次调用服务可以看到控制台有相关日志了

8、替换默认HttpClient

ApacheHttpClient和默认实现的比较

  • Feign在默认情况下使用的是JDK原生的URLConnection发送HTTP请求，没有连接池，但是对每个地址会保持一个长连接，即利用HTTP的persistence connection。
  • ApacheHttpClient实现了连接池，同时它封装了访问http的请求头，参数，内容体，响应等等，使客户端发送 HTTP 请求变得容易

添加依赖

<!--httpclient--><dependency><groupId>org.apache.httpcomponents</groupId><artifactId>httpclient</artifactId><version>4.5.13</version></dependency><!--feign-httpclient--><dependency><groupId>io.github.openfeign</groupId><artifactId>feign-httpclient</artifactId><version>10.10.1</version></dependency>

可以看到，默认就是开启的

9、工作原理

远程调用基本流程

其中 MethodHandler 的invoke(…)方法，主要职责是完成实际远程URL请求，然后返回解码后的远程URL的响应结果

文章标签：
日志服务
Java
前端开发
Nacos
Spring
API
数据格式
JSON
相关实践学习
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
【涂鸦即艺术】基于云应用开发平台CAP部署AI实时生图绘板
LoneWalker、
目录
相关文章
java技术爱好者
|
负载均衡 架构师 Java
详细讲解OpenFeign的使用姿势！
学会使用Feign最贱优雅地调用服务
java技术爱好者
23773 9
详细讲解OpenFeign的使用姿势！
java技术爱好者
|
前端开发 网络协议 Dubbo
超详细Netty入门，看这篇就够了！
本文主要讲述Netty框架的一些特性以及重要组件，希望看完之后能对Netty框架有一个比较直观的感受，希望能帮助读者快速入门Netty，减少一些弯路。
java技术爱好者
96185 33
超详细Netty入门，看这篇就够了！
聚优云惠
|
负载均衡 网络协议 前端开发
Nginx Linux详细安装部署教程（附带使用案例）
聚优云惠
30192 0
阿里云安全_
|
5月前
|
数据采集 人工智能 安全
阿里云Web应用防火墙市场份额和技术能力双第一
喜报～～
阿里云安全_
1697 11
LoneWalker、
|
开发工具 git
IDEA中如何使用Git 图文超详细
IDEA中Git使用，实战教程
LoneWalker、
11330 1
IDEA中如何使用Git 图文超详细
dzvamtizggqz6
|
SpringCloudAlibaba Java Nacos
尚硅谷SpringCloud教程 笔记
本文介绍了基于Spring Cloud Alibaba构建的cloud-demo工程创建步骤，包括父模块及子模块的配置。父模块采用pom打包方式，定义了Java 8、Spring Boot 2.4.2、Spring Cloud 2020.0.1及Spring Cloud Alibaba 2021.1版本。包含三个主要模块：services（依赖Nacos）、service-order和service-product（均依赖spring-boot-starter-web）。同时提供了discoveryClient的测试代码，展示服务发现功能的实现与验证过程。
dzvamtizggqz6
747 12
尚硅谷SpringCloud教程 笔记
nefelibata
|
机器学习/深度学习 自然语言处理 监控
智能客服系统集成技术解析和价值点梳理
在 2024 年的智能客服系统领域，合力亿捷等服务商凭借其卓越的技术实力引领潮流，它们均积极应用最新的大模型技术，推动智能客服的进步。
nefelibata
694 7
auqbllxiu
|
Java Maven
Maven国内镜像配置
Maven国内镜像配置
auqbllxiu
20999 1
威哥爱编程
|
XML JSON Java
OpenFeign深入学习笔记
OpenFeign 是 Spring Cloud 生态系统中的一个强大工具，它使得微服务之间的通信变得更加简单和高效。通过使用 OpenFeign，开发者可以专注于业务逻辑的实现，而不需要关心底层的 HTTP 通信细节。
威哥爱编程
505 0
郑小健
|
缓存 JSON JavaScript
深入理解RESTful API设计原则与最佳实践
- REST是一种基于HTTP的Web服务设计风格，强调资源、统一接口和无状态性。 - 设计原则：统一接口（资源标识、操作、自描述消息、无状态），资源中心，标准方法，分层系统和缓存。 - 最佳实践：版本控制、JSON格式、有意义的状态码、HATEOAS和安全性（HTTPS，认证，授权）。 - 示例：使用Node.js和Express实现用户管理API，包括GET、POST、PUT和DELETE操作，展示资源操作的基本实现。 代码示例展示了如何创建、读取、更新和删除用户资源，以及处理HTTP状态码和错误情况。实际应用时，需进一步完善安全和性能优化。
郑小健
2763 0

热门文章

最新文章

  • 1
    TCP连接建立的三次握手过程可以携带数据吗？
  • 2
    史上最全的支付宝二维码扫码优化技术方案
  • 3
    阿里云ecs实例如何添加IP白名单和安全组?
  • 4
    【最佳实践】实时计算 Flink 版在金融行业的实时数仓建设实践
  • 5
    vue3父子组件相互调用方法详解
  • 6
    阿里云 Serverless App Engine(SAE)助力升学在线从容应对流量高峰
  • 7
    百度网址安全中心怎么取消拦截的详细解决办法
  • 8
    阿里云上搭建webRTC 服务器——Licode
  • 9
    欢迎加入Spark中国社区
  • 10
    HTML5 网站大观：应用图片大背景的优秀 HTML5 网站作品
  • 1
    详解GEO优化的落地步骤和流程
    67
  • 2
    桥梁损伤目标检测数据集分享（适用于YOLO系列深度学习分类检测任务）
    41
  • 3
    南瓜叶片病害图像分类数据集分享（适用于YOLO系列深度学习分类检测任务）
    30
  • 4
    TraceML：用三行代码为训练循环加入 step 级诊断
    28
  • 5
    AI智能体协同实战：Hermes Agent+Claude Code接入阿里云百炼Token Plan完整教程
    68
  • 6
    Token到底是什么？AI最小货币单位全解析，从原理到省钱技巧一文吃透
    102
  • 7
    解锁智能体新纪元：Qwen3.7-Max 正式发布，开启长程自主执行新时代
    107
  • 8
    阿里云OSS静态页面托管实操｜附落地页搭建案例
    36
  • 9
    Claude Code还是Codex？老金告你怎么选！
    60
  • 10
    【日常小问】Spring Cloud Gateway 5.x 跨域和路由配置踩坑实录
    44

    • 相关电子书

    更多
  • 低代码开发师（初级）实战教程
  • 冬季实战营第三期：MySQL数据库进阶实战
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    阿里云正式发布 Agentic 代码安全：AI驱动的双Agent协同引擎