百木园-与人分享,
就是让自己快乐。

Feign远程调用 (介绍与使用)

Feign远程调用

Feign是代替RestTemplate进行远程调用的组件,避免了RestTemplate手写复杂的url容易出错的问题,并提高代码的可读性

使用Feign步骤

1)引入依赖

哪个服务要发送远程请求就导入在哪个服务

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

2)添加注解

在order-service的启动类添加注解 @EnableFeignClients 开启Feign的功能:

image

3)编写Feign的客户端

在order-service中新建一个接口UserClient,内容如下:①加注解 ②写url语句

@FeignClient(\"userservice\")
public interface UserClient {
    @GetMapping(\"/user/{id}\")
    User findById(@PathVariable(\"id\") Long id);
}

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

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

4)调用接口

注入接口类对象,调用接口类的方法

image

自定义配置

Feign可以支持很多的自定义配置,如下表所示:(一般只会修改日志级别来查bug,其他不改)

类型 作用 说明
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即可。

下面以日志为例来演示如何自定义配置。

1)配置文件方式

基于配置文件修改feign的日志级别可以针对单个服务:只有通过当前服务中访问userservice服务时日志会打印

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

也可以针对所有服务:通过当前服务访问的all服务都会打印日志

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

而日志的级别分为四种:

不建议FULL,因为会影响性能。一般是BASIC、NONE(默认)

  • NONE:不记录任何日志信息,这是默认值
  • BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
  • HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
  • FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。

2)Java代码方式

也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:

该类没有注入到bean所以暂时不起作用。只有当被其他类写入到注解中才生效

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的优化:

1.日志级别尽量用basic

2.使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

② 配置文件开启httpClient功能,设置连接池参数

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

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

•Apache HttpClient :支持连接池

•OKHttp:支持连接池

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

这里我们用Apache的HttpClient来演示。

1)引入依赖

在order-service的pom文件中引入Apache的HttpClient依赖:

<!--httpClient的依赖 -->
<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-httpclient</artifactId>
</dependency>

2)配置连接池

在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 # 每个路径的最大连接数

测试:

接下来,在FeignClientFactoryBean中的loadBalance方法中打断点:

image

Debug方式启动order-service服务,可以看到这里的client,底层就是Apache HttpClient:

image

最佳实践

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

自习观察可以发现,Feign的客户端与服务提供者的controller代码非常相似:

feign客户端:

image

UserController:

image

有没有一种办法简化这种重复的代码编写呢?

1、继承方式【不建议】

一样的代码可以通过继承来共享:

1)定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。

2)Feign客户端和Controller都集成改接口

image

优点:

  • 简单
  • 实现了代码共享

缺点:

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

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

2、抽取方式

就是将每一个功能业务写成一个小的微服务,然后其他的大业务可以导入依赖调用这些小的微服务,从而减少重复写同样的功能代码

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

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

image

3、 实现抽取的最佳实践

1)抽取

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

image

项目结构:

image

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

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

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

image

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)重启测试

重启后,发现服务报错了:

image

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

4)解决跨服务扫描包问题

在启动类上添加注解属性

方式一:

指定Feign应该扫描的包:

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

方式二:

指定需要加载的Client接口:这里是数组可以放多个参数

@EnableFeignClients(clients = {UserClient.class})

本文来自博客园,作者:不吃紫菜,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接:https://www.cnblogs.com/buchizicai/p/17093549.html及本声明。

本文版权归作者所有,欢迎转载,但未经作者同意必须保留此段声明,且在文章页面明显位置给出原文连接,否则保留追究法律责任的权利。


来源:https://www.cnblogs.com/buchizicai/p/17093549.html
本站部分图文来源于网络,如有侵权请联系删除。

未经允许不得转载:百木园 » Feign远程调用 (介绍与使用)

相关推荐

  • 暂无文章