Feign远程调用
本文最后更新于49 天前,其中的信息可能已经过时,如有错误请发送邮件到big_fw@foxmail.com

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

(1)基于Feign的远程调用

RestTemplate方式调用存在的问题:①代码可读性差,编程体验不统一;②参数复杂URL难以维护。

//以前利用RestTemplate发起远程调用的代码:
String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);

(2)Feign替代RestTemplate

//1、引入依赖
//在order-service服务的pom文件中引入feign的依赖:
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
​
//2、添加注解
//在order-service的启动类添加注解开启Feign的功能:
//编写Feign的客户端
//在order-service中新建一个接口,内容如下:
package cn.itcast.order.client;
​
import cn.itcast.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
​
@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}
  • 客户端基于SpringMVC的注解来声明远程调用的信息,如:
    • 服务名称:userservice
    • 请求方式:GET
    • 请求路径:/user/{id}
    • 请求参数:Long id
    • 返回值类型:User
  • 测试:修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:

(3)自定义配置

  • 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即可。

  • 配置Feign日志有两种方式:

配置文件方式和Java代码方式

  • 配置文件方式:
    • 基于配置文件修改feign的日志级别可以针对单个服务
feign:  
  client:
    config: 
      userservice: # 针对某个微服务的配置
        loggerLevel: FULL #  日志级别 
feign:  
  client:
    config: 
      default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
        loggerLevel: FULL #  日志级别 
  • 日志的级别分为四种:
    • NONE:不记录任何日志信息,这是默认值。
    • BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
    • HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
    • FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。
  • Java代码方式

基于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)

(4)性能优化

  • Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
    • URLConnection:默认实现,不支持连接池
    • Apache HttpClient :支持连接池
    • OKHttp:支持连接池

因此优化Feign的性能主要包括:①使用连接池代替默认的URLConnection;②日志级别,最好用basic或none

  • 引入依赖

在order-service的pom文件中引入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
    • 使用HttpClient或OKHttp代替URLConnection
      • 引入feign-httpClient依赖;
      • 配置文件开启httpClient功能,设置连接池参数。

(5)最佳实践

最佳实践:使用过程中总结的经验,最好的一种使用方式。

Feign的客户端与服务提供者的controller代码非常相似:

Feign的客户端:

UserController:

如何简化重复代码编写?

  • 继承方式
    • 定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。
    • Feign客户端和Controller都集成改接口
  • 优点:
    • 简单
    • 实现了代码共享
    • 缺点:
    • 服务提供方、服务消费方紧耦合
- 参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解
  • 抽取方式

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

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

  • 实现基于抽取的最佳实践
    • 抽取:创建一个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项目中
  • 在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>
  • 重启测试

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

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

  • 解决扫描包问题

方式一:指定Feign应该扫描的包

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

方式二:指定需要加载的Client接口

@EnableFeignClients(clients = {UserClient.class})
文末附加内容
暂无评论

发送评论 编辑评论


				
|´・ω・)ノ
ヾ(≧∇≦*)ゝ
(☆ω☆)
(╯‵□′)╯︵┴─┴
 ̄﹃ ̄
(/ω\)
∠( ᐛ 」∠)_
(๑•̀ㅁ•́ฅ)
→_→
୧(๑•̀⌄•́๑)૭
٩(ˊᗜˋ*)و
(ノ°ο°)ノ
(´இ皿இ`)
⌇●﹏●⌇
(ฅ´ω`ฅ)
(╯°A°)╯︵○○○
φ( ̄∇ ̄o)
ヾ(´・ ・`。)ノ"
( ง ᵒ̌皿ᵒ̌)ง⁼³₌₃
(ó﹏ò。)
Σ(っ °Д °;)っ
( ,,´・ω・)ノ"(´っω・`。)
╮(╯▽╰)╭
o(*////▽////*)q
>﹏<
( ๑´•ω•) "(ㆆᴗㆆ)
😂
😀
😅
😊
🙂
🙃
😌
😍
😘
😜
😝
😏
😒
🙄
😳
😡
😔
😫
😱
😭
💩
👻
🙌
🖕
👍
👫
👬
👭
🌚
🌝
🙈
💊
😶
🙏
🍦
🍉
😣
Source: github.com/k4yt3x/flowerhd
颜文字
Emoji
小恐龙
花!
上一篇
下一篇