👳我亲爱的各位大佬们好😘😘😘
♨️本篇文章记录的为 微服务组件之http客户端Feign 相关内容,适合在学Java的小白,帮助新手快速上手,也适合复习中,面试中的大佬🙉🙉🙉。
♨️如果文章有什么需要改进的地方还请大佬不吝赐教❤️🧡💛
👨🔧 个人主页 : 阿千弟
🔥 上期内容👉👉👉 : 魔法反射--java反射初入门(基础篇)
近期,Spring 6 的第一个 GA 版本发布了,其中带来了一个新的特性——HTTP Interfac,这个新特性,可以让开发者将 HTTP 服务,定义成一个包含特定注解标记的方法的 Java 接口,然后通过对接口方法的调用,完成 HTTP 请求。看起来很像使用 Feign 来完成远程服务调用,这可能是 Spring “抛弃” feign 等 http 调用的一种趋势😕😕😕
2023年了, 总有一些人会说什么Feign已经过时了, 但是话说回来 Spring6只支持jdk17+的版本, 以国内的大多数互联网公司发展来讲, 目前已有的技术既然可以稳定使用, 为什么要费尽心思的迭代升级呢, 这个成本也是相当高的, 愿意为这项技术升级应该不少目前国内的主流趋势, 所以呢, 还是综合各种因素来讲, Feign可能在很长的一段时间内都不会过时, 还是老老实实的使用我们的Feign吧.😃😃😃
@[toc]
下面再来介绍一下Feign的概念
Feign并没有过时。Feign是一个基于HTTP的客户端,它可以帮助开发人员轻松地编写RESTful API客户端。它提供了一种简单的方式来定义和使用RESTful服务,而不需要手动编写HTTP请求和解析响应。Feign还提供了负载均衡和服务发现的支持,使得它在微服务架构中非常有用。虽然现在有一些新的HTTP客户端库出现,但Feign仍然是一个非常流行和可靠的选择👍👍👍。
为什么要说它可以帮助开发人员轻松地编写RESTful API客户端?
在此之前, 我们通常使用的是Spring框架提供的一个用于访问RESTful服务的客户端工具类RestTemplate。它封装了HTTP请求的细节,使得我们可以通过简单的API调用来发送HTTP请求并处理响应。
Feign的老前辈RestTemplate
RestTemplate的使用步骤
使用RestTemplate发送HTTP请求的步骤如下:
1. 创建RestTemplate对象
可以通过new关键字创建RestTemplate对象,也可以通过Spring容器注入RestTemplate对象。2. 发送HTTP请求
RestTemplate提供了多个方法用于发送HTTP请求,例如getForObject、postForObject、exchange等。这些方法的参数包括请求URL、请求方法、请求头、请求体等。
3. 处理响应
RestTemplate的HTTP请求方法返回的是响应体的数据,可以将响应体的数据转换为Java对象,也可以直接获取响应体的字符串。
以下是一个使用RestTemplate发送GET请求的示例代码:
RestTemplate restTemplate = new RestTemplate();
String url = "http://example.com/api/users/{id}";
User user = restTemplate.getForObject(url, User.class, 1);
用起来看着很简单对不对
但是呢, 如果我们的请求路径的url比如长下面这个样子
我们也都看到了, 这玩意写起来挺折磨人的
RestTemplate缺点:
- 代码可读性差,编程体验不统一
- 参数复杂URL难以维护
所以呢, 我们必须找一个更好的东西来代替
Feign : 没错正是在下
Feign的优点
代码简洁:Feign的接口定义非常简单,只需要定义一个接口,就可以轻松地调用远程服务。
自动化:Feign自动处理负载均衡和服务发现,可以轻松地将请求分发到不同的服务实例。
易于扩展:Feign可以轻松地扩展,可以添加拦截器和解码器,以满足不同的需求。
支持多种协议:Feign支持多种协议,包括HTTP、HTTPS、TCP和UDP等。
快速使用
Feign是一个声明式的Web服务客户端,它使得编写Web服务客户端变得更加容易。
举个例子, 如果我们要在一个微服务中调用另一个微服务, 比如我们现在想通过订单微服务去查询用户的信息, 显然正常情况下, 我们通常会将订单和用户拆分成两个不同的模块, 查询信息的思路无非是用订单微服务的controller调用用户微服务的controller, 思路其实很简单
以下是使用Feign的一些步骤:
- 添加Feign依赖
在Maven项目中,可以在pom.xml文件中添加以下依赖:
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 创建Feign客户端接口
创建一个接口,用于定义要调用的Web服务的方法。例如:
在OrderService
中创建client.UserClient
接口
UserClient 内容如下
@FeignClient(value = "userservice")
public interface UserClient {
@GetMapping("/user/{id}")
User findById(@PathVariable("id") Long id);
}
在上面的代码中,@FeignClient注解指定了要调用的服务的名称。接口中的方法定义了要调用的Web服务的HTTP方法和路径。
这里注意:UserClient
中findById
方法的请求路径必须和user-service微服务模块
中的UsersController
的queryById
方法的请求路径保持一致, @PathVariable不能省去
@Slf4j
@RestController
@RequestMapping("/user")
// @RefreshScope
public class UserController {
@Resource
private UserService userService;
/**
* 路径: /user/101
* @param id 用户id
* @return 用户
*/
@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id,
@RequestHeader(value = "Truth", required = false) String truth) {
System.out.println("truth: " + truth);
return userService.queryById(id);
}
}
- 注入Feign客户端
在需要调用Web服务的类中,注入Feign客户端接口。例如:
@Service
public class OrderService {
@Resource
private OrderMapper orderMapper;
@Resource
private UserClient userClient;
public Order queryOrderById(Long orderId) {
// 1.查询订单
Order order = orderMapper.findById(orderId);
// 2.用Feign远程调用
User user = userClient.findById(order.getUserId());
// 3.封装user到Order
order.setUser(user);
// 4.返回
return order;
}
}
在上面的代码中,OrderService 类注入了UserClient 接口,并使用它来调用Web服务。
我们对结果对结果进行测试, 发现已成功响应
这里我起了两个user-service微服务, 经过以上的多次请求order-service微服务发现两个user-service微服务均有结果响应, 说明它不仅解决了远程调用问题, 还解决了服务调用间的负载均衡问题.
关于解决url路径复杂问题
是否记得我们上面接受请求参数使用的是
@PathVariable
注解,feign
客户端是基于注解的形式来写参数的 , 那这就好办了, 不管url
路径中的参数多么复杂, 我们一个@PathVariable
给路径中的参数接过来就可以了
自定义Feign的配置
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析,例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过http请求发送 |
feign. Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
feign. Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试 |
一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。
一般需要配置的就是日志级别。
NONE
:不记录任何日志信息,这是默认值。BASIC
:仅记录请求的方法,URL以及响应状态码和执行时间HEADERS
:在BASIC的基础上,额外记录了请求和响应的头信息FULL
:记录所有请求和响应的明细,包括头信息、请求体、元数据。
yaml配置feign的日志级别
基于配置文件修改feign的日志级别可以针对单个服务:
feign:
client:
config:
userservice: # 针对某个微服务的配置
loggerLevel: FULL # 日志级别
也可以针对所有服务:
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
Java代码方式配置feign的日志级别
也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:
public class DefaultFeignConfiguration {
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC; // 日志级别为BASIC
}
}
如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)
如果是局部生效,则把它放到对应的@FeignClient这个注解中:
@FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class)
配置Feign客户端
Feign底层的客户端实现:
- URLConnection:默认实现,不支持连接池
- Apache HttpClient :支持连接池
- OKHttp:支持连接池
因此优化Feign的性能主要包括:
- 使用连接池代替默认的URLConnection
- 日志级别,最好用basic或none
可以通过配置文件来配置Feign客户端的一些属性,例如连接超时时间、重试次数等。
例如:
Feign添加HttpClient的支持:
引入依赖:
<!--httpClient的依赖 -->
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-httpclient</artifactId>
</dependency>
httpclient配置
example-service:
ribbon:
ReadTimeout: 5000
ConnectTimeout: 5000
feign:
client:
config:
default:
loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
retryer: com.netflix.client.retry.DefaultLoadBalancerRetryer
readTimeout: 5000
connectTimeout: 5000
httpclient:
enabled: true # 开启feign对HttpClient的支持
max-connections: 200 # 最大的连接数
max-connections-per-route: 50 # 每个路径的最大连接数
在上面的代码中,配置了连接超时时间和重试次数。
以上就是使用Feign的基本步骤。
如果这篇【文章】有帮助到你💖,希望可以给我点个赞👍,创作不易,如果有对Java后端或者对
spring
感兴趣的朋友,请多多关注💖💖💖
👨🔧 个人主页 : 阿千弟