【SpringCloud】OpenFeign远程调用的基本使用

news2024/9/22 19:23:13

一、OpenFeign替代RestTemplate

RestTemplate 存在的问题

我们以前利用RestTemplate发起远程调用的代码

public Order queryOrderById(Long orderId) {
    // 1.查询订单
    Order order = orderMapper.findById(orderId);

    // 2.利用restTemplate发起http请求
    // 为了负载均衡使用服务名称
    String url = "http://userservice/user/" + order.getUserId();
    // 得到的结果是json风格,getForObject()可以将json反序列化!
    User user = restTemplate.getForObject(url, User.class);

    // 3.封装user到Order
    order.setUser(user);
    // 4.返回
    return order;
}

但是这样子写,是有一定缺陷的:

  • 代码可读性差,编程体验不统一

  • 参数复杂URL难以维护

OpenFeign是一个声明式的http客户端

其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。

1.引入依赖

我们在order-service服务的pom文件中引入OpenFeign的依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

2.添加注解

在order-service的启动类添加注解开启OpenFeign的功能

3.编写Feign的客户端

定义一个接口,使用@FeignClient注解,并指明服务名称

@FeignClient("userservice")
public interface UserClient {

    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:

服务名称:userservice
请求方式:GET
请求路径:/user/{id}
请求参数:Long id
返回值类型:User

OpenFeign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。

4.测试方法

public Order queryOrderById(Long orderId) {
    // 查询订单
    Order order = orderMapper.findById(orderId);
    // 用OpenFegin远程调用
    User user = userClient.findById(order.getUserId());
    order.setUser(user);
    return order;
}

这样子我们避免了代码量大的时候,会出现一堆的URL路径。

调API一样的进行远程调用

5.小结-使用Feign的步骤

① 引入依赖
② 添加 @EnableFeignClients注解
③ 编写 FeignClient接口
使用FeignClient中定义的方法代替RestTemplate

Feign 和 OpenFeign 两者的异同点

相信很多人在这一方面有很多疑问!

具体可以看这一篇文章:【SpringCloud】Feign 和 OpenFeign 两者的异同点

对于这两者,我们可以简单的理解为:OpenFeign是Fegin的升级版!

1.官网地址差异

https://github.com/Netflix/feign 和 https://github.com/OpenFeign/feign。

不过现在访问https://github.com/Netflix/feign 已经被重定向到了后者上

2. 发布历史

Netflix Feign:1.0.0发布于2013.6,于2016.7月发布其最后一个版本8.18.0

Open Feign:首个版本便是9.0.0版,于2016.7月发布,然后一直持续发布到现在(未停止)

也就是说,Netflix Feign仅仅只是改名成为了Open Feign而已,然后Open Feign项目在其基础上继续发展至今。

9.0版本之前它叫Netflix Feign,自9.0版本起它改名叫 Open Feign了。

3. SpringCloud的1.x与2.x版本差别

spring-cloud-starter-openfeign是为Spring Cloud2.x准备的,只不过维持了一段时间的对1.x的兼容。

而spring-cloud-starter-feign专为Spring Cloud1.x服务

1.x版本包名是 org.springframework.cloud.netflix.feign.FeignClient,所在Jar是 spring-cloud-netflix-core
说明:这里的1.x不仅仅指的feign,还包括openfeign的1.4.x版本哦
2.x版本包名是 org.springframework.cloud.openfeign.FeignClient,所在Jar是 spring-cloud-openfeign-core

二、自定义配置

Feign可以支持很多的自定义配置,配置信息如下:

一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。

下面以日志为例来演示如何自定义配置的!总结下来大致有2种方式:

    • 配置文件方式

使用application.yml配置文件来修改feign的日志级别可以针对单个服务、也可以是所有服务(全局)

单个服务配置

feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

全局配置

feign:  
  client:
    config: 
      default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别 

fegin的日志级别(四种)

  • NONE:不记录任何日志信息,这是默认值。

  • BASIC:仅记录请求的方法,URL以及响应状态码和执行时间

  • HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息

  • FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。

    • Java代码方式

也可以基于Java代码来修改日志级别

(1)先声明一个类,再声明Logger.Level的对象

// 声明一个类
public class DefaultFeignConfiguration {
    @Bean
    // 声明一个Logger.Level的对象
    public Logger.Level logLevel() {
        return Logger.Level.BASIC;
    }
}

(2)修改相应注解中的参数

使用上一步声明配置类,修改@FeignClient、@EnableFeignClients注解中的参数配置

单个服务配置

如果是局部生效,则把它放到对应的@FeignClient这个注解中

@FeignClient(value = "userservice",
        configuration = FeignClientsConfiguration.class)
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

全局配置

如果要全局生效,将其放到启动类@EnableFeignClients这个注解中

...
@EnableFeignClients(clients = UserClient.class, 
        defaultConfiguration = DefaultFeignConfiguration.class)
public class OrderApplication {
    ...
}

三、OpenFeign使用优化

Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:

  • URLConnection:默认实现,不支持连接池

  • Apache HttpClient :支持连接池

  • OKHttp:支持连接池

因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection!

    • 引入依赖

order-servicepom文件中引入Apache的HttpClient依赖

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>
    • 配置连接池

order-service的application.yml中添加配置

feign:
  # 配置日志
  client:   
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
  # 配置连接池
  httpclient:  
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

Feign的连接池中配置的连接数的大小是不一定的,需要我们用压测工具去计算!

优化小结

日志级别尽量用basic或者none,尽量不要使用更高基本的日志!

使用HttpClient或OKHttp代替URLConnection,尽量使用连接池的方式

四、最佳实践

所谓最佳实践,就是使用过程中总结的经验,最好的一种使用方式!

我们对于Feign来说,大致是有两套方案——继承方式抽取方式

1.继承方式

我们可以参考一下之前的代码。

feign客户端

UserController

这两者的代码看起来很相似,有没有办法简化???

有,可以使用继承的方式!

(1)定义一个 API接口,利用定义方法,并基于 SpringMVC注解做声明。
(2)Feign客户端和Controller 都集成该接口

如图:

优点

  • 简单

  • 实现了代码共享

缺点

  • 服务提供方、服务消费方紧耦合

  • 参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解

因此,这种方式99.99%没人用!

2. 抽取方式

将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。

UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。

抽取后的项目结构图

cloud-demo模块间结构图

抽取过程中的步骤以及可能出现的问题

(1)抽取模块

首先创建一个module,命名为feign-api

feign-api中然后引入feign的starter依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

然后,order-service中编写的UserClient、User、DefaultFeignConfiguration复制到feign-api项目中

(2)在order-service中使用feign-api

首先,删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口(都移动到新模块中了)

order-service的pom文件中中引入feign-api的依赖

<dependency>
    <groupId>cn.itcast.demo</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

修改order-service中的所有与上述三个组件有关的导包部分,改成导入feign-api中的包

(3)BUG描述

将项目重启,发现报错了!!!

这是因为UserClient现在在cn.itcast.feign.clients包下,

而order-service的@EnableFeignClients注解是在cn.itcast.order包下,不在同一个包,无法扫描到UserClient

(4)解决方案

给OrderApplication之前的注解添加属性——basePackages、clients

方式一

指定Feign应该扫描的包

@EnableFeignClients(basePackages="cn.itcast.feign.clients")

方式二

指定需要加载的Client接口

@EnableFeignClients(clients= {UserClient.class})

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/181979.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

跨境电商行业如何做好社交媒体营销?

随着互联网的快速发展,跨境电商行业也得到了快速的发展,跨境电商更是成为了当下最热门的话题之一,很多商家都想通过跨境电商平台来销售产品,但随着竞争越来越激烈,想要在众多卖家中脱颖而出,就需要从营销方面入手了&#xff0c;这就意味着卖家们需要掌握一定的营销技巧。而在现…

jsp+SSM368的药品销售配送网站系统maven

管理员登录&#xff0c;管理员通过输入用户名、密码、角色等信息进行系统登录 管理员登录进入药品销售系统可以查看&#xff1b;个人中心、用户管理、医生管理、药品信息管理、药品分类管理、订单配送管理、系统管理、订单管理等内容 个人信息&#xff0c;个人信息页面可以填写…

Swig/CPP2Java

简介 实际工程可能存在如下部分&#xff1a;业务接口需要编程高效的语言&#xff08;如Python、Java等&#xff09;&#xff0c;易于部署维护&#xff1b;而核心算法部分&#xff0c;某些场景需要高效计算&#xff0c;会使用性能高效的语言&#xff08;如C/C等&#xff09;。 …

超详细Netty入门,看这篇就够了!

简介&#xff1a; 本文主要讲述Netty框架的一些特性以及重要组件&#xff0c;希望看完之后能对Netty框架有一个比较直观的感受&#xff0c;希望能帮助读者快速入门Netty&#xff0c;减少一些弯路。 前言 本文主要讲述Netty框架的一些特性以及重要组件&#xff0c;希望看完之后…

一起自学SLAM算法:10.2 VINS算法

连载文章&#xff0c;长期更新&#xff0c;欢迎关注&#xff1a; 不管是激光SLAM还是视觉SLAM&#xff0c;由于传感器采样率、传感器测量精度、主机计算力等因素的限制&#xff0c;在高速运动状态下定位追踪极易丢失。虽然轮式里程计能为激光SLAM系统提供短期运动预测以避免高速…

记录一次ubuntu进入不了界面的恢复记录

能说服一个人的从来不是道理&#xff0c;而是南墙&#xff1b;能点醒一个人的从来不是说教&#xff0c;而是磨难 一、问题描述 1、 卸载Python之后&#xff0c;ubuntu启动进入黑屏tty界面无法联网&#xff0c;无法进入桌面 2、 进入到界面之后没有网络&#xff0c;网络中或者右…

【分析向】没有三级缓存会导致什么?

通过上篇&#xff08;【实践向】当移除了三级缓存…… &#xff09;的实践&#xff0c;我们得出的结论是&#xff1a;如果不存在代理对象&#xff0c;二级缓存就可以解决循环依赖性的问题&#xff0c;但是当存在代理对象的时候&#xff0c;二级缓存则无法完全解决循环依赖&…

机器自动翻译古文拼音 - 十大宋词 - ALL

机器自动翻译古文拼音 - 十大宋词 - 雨霖铃寒蝉凄切 柳永https://mp.csdn.net/mp_blog/creation/editor/128779245机器自动翻译古文拼音 - 十大宋词 - 江城子乙卯正月二十日夜记梦 苏轼https://mp.csdn.net/mp_blog/creation/editor/128779156机器自动翻译古文拼音 - 十大宋词 …

0基础小白十分钟入门人工智能强化学习(附有实战源码)

强化学习概述 1.1 强化学习的学习任务目标 强化学习&#xff08;Reinforcement Learning, RL&#xff09;&#xff0c;用官话讲&#xff0c;是机器学习的范式和方法论之一&#xff0c;用于描述和解决智能体&#xff08;agent&#xff09;在与环境的交互过程中通过学习策略以达成…

Mybatis-Plus 乐观锁与代码生成器

目录 乐观锁 问题引入 乐观锁实现思路 实现步骤 代码生成器 代码生成器分析 代码生成器实现 乐观锁 问题引入 业务并发现象带来的问题:秒杀 假如有100个商品或者票在出售&#xff0c;为了能保证每个商品或者票只能被一个人购买&#xff0c;如何保证不会出现超买或者重复…

记一次nginx崩溃事件

一、事件描述 2023年春节复工第一天&#xff0c;项目组同事反馈说业务系统中图像处理代理Nginx服务于1月23日发生崩溃&#xff0c;完成了重启操作&#xff0c;检查nginx的日志有如下报错&#xff1a; 2023/01/23 11:07:07 [crit] 3237#3237: *2253009 pwritev() "/var/c…

网络编程-----(Socket编程TCP)

在咱们的TCP API中&#xff0c;也是主要是涉及到两个类: 1)ServerSocket:主要是给TCP服务器来进行使用的&#xff1b; 2)Socket:我们既需要给客户端来进行使用&#xff0c;也需要给服务器来进行使用&#xff1b; 这样就是说我们是不需要使用专门的类来进行表示传输的包&#x…

Java学习之抽象模板模式

目录 一、基本介绍 二、模板设计模式能解决的问题 三、最佳实践 一、AA类 二、BB类 三、main方法实现 四、提取相同语句 五、建立继承关系 父类-Template 子类-AA类 子类-BB类 六、运行中的动态绑定机制 一、基本介绍 抽象类体现的就是一种模板模式的设计&#xff…

【Git】概述

目录 1.1 是什么 介绍 历史时间轴 版本控制工具 1.2 能干嘛 作用 Git工作机制 代码托管中心 集中式版本控制系统 分布式版本控制系统 1.3 去哪下 命令行工具&#xff1a;Git for windows 操作系统中可视化工具&#xff1a;TortoiseGit(了解) GitHub网站 1.1 是什…

带你走进Java8新特性Stream流的小世界

目录 一. 什么是流&#xff08;Stream&#xff09; 1.1 流的定义 1.2 流的特点 1.3 操作流 1.4 创建流 二. 流的中间操作 2.1 流的筛选与切片 2.1.1 filter 2.1.2 limit 2.1.3 skip 2.1.4 distinct 2.2 流的映射 2.2.1 map 2.2.2 flatMap 2.3 流的排序 2.3.1 s…

智公网:2023年教师编必背30考点

1、制度化教育阶段开始于&#xff1a;近代。 2、各国的学校教育系统基本形成于&#xff1a;19世纪末。 3、现在世界上大多数国家的义务教育年限在&#xff1a;9年或9年以上。 4、“不愤不启&#xff0c;不悱不发”启发教学法的最早倡导者是&#xff1a;孔子。 5、“建国君民…

【Spring】Spring 6 新特性一一HTTP Interface

简介 Spring 6 的第一个 GA 版本发布了&#xff0c;其中带来了一个新的特性——HTTP Interface。 这个新特性&#xff0c;可以让开发者将 HTTP 服务&#xff0c;定义成一个包含特定注解标记的方法的 Java 接口&#xff0c;然后通过对接口方法的调用&#xff0c;完成 HTTP 请求…

硬盘损坏数据恢复怎么操作?恢复数据的常用方法

硬盘一般固定在电脑里面的存储装置&#xff0c;里面保存着我们大量的数据。随着电脑的使用越加广泛&#xff0c;有时不免出现一些问题&#xff0c;比如硬盘在使用过程中出现数据错误&#xff0c;或者是硬盘的内部零件出现故障。出现这些问题&#xff0c;硬盘损坏数据恢复怎么操…

Redis实现UV统计 | 黑马点评

一、HyperLogLog 1、为什么用HyperLogLog 先介绍两个概念&#xff1a; UV&#xff1a;全称 Unique Visitor&#xff0c;也叫独立访客量&#xff0c;是指通过互联网访问、浏览这个网页的自然人、1 天内同一个用户多次访问该网站&#xff0c;只记录 1 次。PV&#xff1a;全称 …

车载以太网 - SomeIP测试专栏 - 总纲

关于车载以太网中的SomeIP在网上也逐渐有越来越多的资料,讲的也是非常好;但是个人认为讲的泛,很难让初学者或者初入门者真正了解SomeIP到底是一个什么东西,以及它究竟在车载上有什么作用,本专栏会由浅入深的讲解SomeIP整个协议内容规范,并且对Tc8中SomeIP相关的协议测试用…