SpringCloud04-声明式服务调用openfeign

天气晚来秋天凉好个qiu

已于 2022-08-17 10:20:59 修改

阅读量170

点赞数

分类专栏：笔记文章标签： java spring spring cloud

于 2022-08-16 21:49:57 首次发布

本文链接：https://blog.csdn.net/weixin_73181422/article/details/126367782

版权

笔记专栏收录该内容

7 篇文章 0 订阅

订阅专栏

一、OpenFeign介绍

1、什么OpenFeign?

OpenFeign是spring cloud提供的一个声明式的http客户端。
OpenFeign是被Spring封装之后的Feign，支持springmvc的注解，在Spring Cloud中使用feign，只需要创建一个接口并注解，服务调用者就能通过调用这个代理接口的方式来调用远程服务，就像调用本地方法一样
OpenFeign整合了Ribbon，也支持负载均衡（具体的实现是ribbon的轮询策略）
OpenFeign可以看作是（ribbon+restTemplate)的优化整合，可以进行服务调用、负载均衡。

二、feign入门案例

2.1.创建服务提供者

2.1.1.创建工程

2.1.2.application.yml

server:
  port: 9090

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.5.131:8848 #nacos服务的地址
  application:
    name: feign-provider #向注册中心注册的名字

2.2.创建feign接口

2.2.1.创建工程

2.2.2.引入依赖

<!--Spring Cloud OpenFeign Starter -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

2.2.3.feign接口

@FeignClient(value="feign-provider") //注册中心服务名
@RequestMapping(value = "/provider") 
public interface UserFeign {
    @RequestMapping(value = "/getUserById/{id}")
    User getUserById(@PathVariable("id") Integer Id);
}

2.3.创建服务消费者

2.3.1.创建工程

2.3.2.引入feign接口

        <!--feign接口-->
        <dependency>
            <groupId>com.bjpowernode</groupId>
            <artifactId>feign_interface</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>

2.3.3.application.yml

server:
  port: 80
spring:
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.5.131:8848 #nacos服务的地址
  application:
    name: feign-consumer #向注册中心注册的名字

2.3.4.controller

@RestController
@RequestMapping(value = "/consumer")
public class ConsumerController {

    @Autowired //注入feign接口，需要启动类上添加feign接口扫描注解
    private UserFeign userFeign;

    @RequestMapping(value="/getUserById/{id}")
    public User getUserById(@PathVariable Integer id){
        return userFeign.getUserById(id);
    }
}

2.3.5.启动类

@SpringBootApplication
@EnableDiscoveryClient//向注册中心注册该服务，并可以获取其他服务的调用地址
@EnableFeignClients//开启feign接口扫描
public class FeignConsumerApp {
    public static void main(String[] args) {
        SpringApplication.run(FeignConsumerApp.class,args);
    }
}

2.4.测试

三、feign原理

3.1.将Feign接口注入到Spring容器中

启动类上的@EnableFeignClients注解，引用Import 注解导入了 FeignClientsRegistrar 类

FeignClientsRegistrar类，负责 Feign 接口的加载

FeignClientsRegistrar类的registerBeanDefinitions()方法

FeignClientsRegistrar类的registerFeignClients()方法，扫描指定包所有带有@FeignClient注解的接口，再将这些接口注入到Spring IOC容器中，方便后续被调用。

源码分析：

1.扫描指定包中所有带有@FeignClient注解类型的类和接口

2.只保留带有 @FeignClient 的接口，注入spring容器

3.2.RequestTemplate封装请求信息

SynchronousMethodHandler.invoke()：当定义的的Feign接口中的方法被调用时，通过JDK的代理方式为Feign接口生成了一个动态代理类，当生成代理时，Feign会为每个接口方法创建一个RequestTemplate。该对象封装了HTTP请求需要的全部信息，如请url、参数，请求方式等信息都是在这个过程中确定的。

3.3.发起请求

SynchronousMethodHandler.executeAndDecode()：

通过RequestTemplate生成Request，然后把Request交给Client去处理，Client可以是JDK原生的URLConnection，Apache的HttpClient，也可以时OKhttp，最后Client结合Ribbon负载均衡发起服务调用。

四、feign接口传参

1、？传参
       @RequestParam("id")
2、restful传参
       @PathVariable("id")
3、pojo
       @RequestBody

示例：

@FeignClient("feign-provider") //远程调用注册中心服务名
@RequestMapping("/provider")
public interface UserFeign {

    @RequestMapping("/getUserById/{id}")//拼接url
    public User getUserById(@PathVariable("id") Integer id);//restful形式拼接参数

    @RequestMapping("/deleteUserById")//拼接url
    User deleteUserById(@RequestParam("id") Integer id);//？形式拼接参数，?id=250

    @RequestMapping("/addUser")
    User addUser(@RequestBody User user);//pojo--->json
}

五、feign优化

5.1、开启feign日志

5.1.1. 设置接口日志级别

logging:
  level:
    feign.interface.package: debug #feign接口所在包的日志输出级别

也可以使用配置文件 logback.xml 设置日志级别

5.1.2.配置 OpenFeign 日志级别

OpenFeign 有四种类型的日志：

1，NONE：不记录任何日志信息，默认是 NONE 配置。

2，BASIC：只记录发起请求的方法，请求的 URL 地址，请求状态码和请求的响应时间。

3，HEADERS：在 BASIC 级别的基础上，还多记录了请求头和响应头的信息。

4，FULL：记录所有的日志信息，包括请求和响应的所有具体信息。

两种配置方式：

一：在配置文件中配置 Feign 的日志

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

二：通过配置类的方式

@Configuration
public class FeignLoggerConfiguration {
    @Bean
    public Logger.Level logLevel(){
        return Logger.Level.full;
    }
}

全局配置：

在启动类的 @EnableFeignClients 注解中加上参数

defaultConfiguration = FeignLoggerConfiguration .class

局部配置：

Feign 接口注解 @FeignClient 加上参数

configuration = FeignLoggerConfiguration .class

5.1.3.配置后控制台效果

5.2、feign超时

方式一：底层内置了 Ribbon 框架，通过修改 Ribbon 的超时时间，被动的修改 OpenFeign 的超时时间。相当于做了全局超时配置

ribbon:
  ConnectTimeout: 5000 #请求连接的超时时间
  ReadTimeout: 5000 #请求处理的超时时间

方式二：直接修改 OpenFeign 的超时时间

feign:
  client:
    config:
      feign-provider: #服务名则修改当前服务超时时间，default则相当于配置全局超时时间
        ConnectTimeout: 5000 #请求连接的超时时间
        ReadTimeout: 5000 #请求处理的超时时间

5.3、http连接池

        两台服务器建立HTTP连接的过程涉及到三次握手四次分手，很消耗时间。采用HTTP连接池可以节约大量的时间提升吞吐量

        Feign的HTTP客户端支持3种框架：HttpURLConnection、HttpClient、OkHttp。
        默认是采用HttpURLConnection 的，每次请求都会建立、关闭连接。
        为了性能考虑，我们可以引入httpclient、okhttp作为底层的通信框架。
        例如将 Feign 的 HTTP 客户端工具修改为 HttpClient。

5.3.1.引入依赖

        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-httpclient</artifactId>
        </dependency>

5.3.2.配置文件中开启

feign:
  httpclient:
    enabled: true # 默认开启可省略

默认开启可省略

5.3.3.效果

配置前

配置后

5.4、gzip压缩

介绍

gzip 是一种数据格式，采用用 deflate 算法压缩 data；gzip 是一种流行的文件压缩算法，应用十分广泛，尤其是在 Linux 平台。

能力

当 Gzip 压缩到一个纯文本文件时，效果是非常明显的，大约可以减少 70％以上的文件大小。

作用

网络数据经过压缩后实际上降低了网络传输的字节数，最明显的好处就是可以加快网页加载的速度。网页加载速度加快的好处不言而喻，除了节省流量，改善用户的浏览体验外，另一个潜在的好处是 Gzip 与搜索引擎的抓取工具有着更好的关系。例如 Google 就可以通过直接读取 gzip 文件来比普通手工抓取更快地检索网页。

server:
  compression:
    enabled: true #开启gzip压缩
    mime-types: #配置支持压缩的类型，一般使用默认即可

mime-types:默认有"text/html", "text/xml", "text/plain", "text/css", "text/javascript", "application/javascript", "application/json", "application/xml"，一般使用默认即可

效果