Feign详解

南波顽

已于 2022-08-16 19:30:53 修改

阅读量1.3w

点赞数 6

文章标签： spring java spring boot

于 2022-08-16 19:26:11 首次发布

本文链接：https://blog.csdn.net/qq_46147786/article/details/126368304

版权

一. Feign概述

Feign是Spring Cloud提供的声明式、模板化的HTTP客户端，它使得调用远程服务就像调用本地服务一样简单，只需要创建一个接口并添加一个注解即可。

Spring Cloud集成Feign并对其进行了增强，使Feign支持了Spring MVC注解；Feign默认集成了Ribbon，所以Fegin默认就实现了负载均衡的效果。

二. 入门案例

2.1 创建服务提供者

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springcloud_parent</artifactId>
        <groupId>com.bjpowernode</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>feign_provider</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.bjpowernode</groupId>
            <artifactId>springcloud_common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--nacos客户端-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
    </dependencies>
</project>

配置文件：application.yml

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

controller

package com.bjpowernode.controller;


import com.bjpowernode.pojo.User;
import com.bjpowernode.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.security.SecurityProperties;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


@RestController
@RequestMapping("/provider")
public class ProviderController {
    @Autowired
    private UserService userService;

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

    @RequestMapping("/deleteUserById")
    public User deleteUserById( Integer id){
        return userService.deleteUserById(id);
    }

    @RequestMapping("/addUser")
    public User addUser(@RequestBody User user){
        return userService.addUser(user);
    }
}

service（接口我在这里就不放上去了，自己写的时候别忘了），启动类自行写入

package com.bjpowernode.service.impl;

import com.bjpowernode.pojo.User;
import com.bjpowernode.service.UserService;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {
    @Override
    public User getUserById(Integer id) {
      
        return new User(id,"王粪堆-1",18);
    }

    @Override
    public User deleteUserById(Integer id) {
        return new User(id,"已删除王粪堆用户",18);
    }

    @Override
    public User addUser(User user) {
        return new User(user.getId(),"已添加"+user.getName(),user.getAge());
    }
}

2.2 创建服务消费者

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springcloud_parent</artifactId>
        <groupId>com.bjpowernode</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>feign_consumer</artifactId>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <!--nacos客户端-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>
        <!--feign接口-->
        <dependency>
            <groupId>com.bjpowernode</groupId>
            <artifactId>feign_interface</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>
</project>

配置文件：application.yml

server:
  port: 81
  compression:
    enabled: true #开启gzip压缩 提高宽带利用率和加速数据的传输速度
spring:
  cloud:
    nacos:
      discovery:
        server-addr: 192.168.128.132:8848 #nacos服务的地址
  application:
    name: feign-consumer #向注册中心注册的名字

#超时优化有两种方式（默认超时时间为1000毫秒，时间太短）
#1.通过修改 Ribbon 的超时时间，被动的修改 OpenFeign 的超时时间。
#2.直接修改 OpenFeign 的超时时间(推荐使用)
#ribbon:
#  ConnectTimeout: 5000 #请求连接的超时时间
#  ReadTimeout: 5000 #请求处理的超时时间
#开启feign日志--前提feign包下的logger日志为：debug模式
feign:
  client:
    config:
      default:
        loggerLevel: full
        ConnectTimeout: 5000 #请求连接的超时时间
        ReadTimeout: 5000 #请求处理的超时时间
    httpclient:
      enabled: true  #开启httpclient 默认开启
#扫描feign包下的使用debug日志输出
logging:
  level:
    com.bjpowernode.feign: debug

controller

package com.bjpowernode.controller;

import com.bjpowernode.feign.UserFeign;
import com.bjpowernode.pojo.User;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;


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

    @Autowired
    private UserFeign userFeign;

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

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

    @RequestMapping(value = "/addUser")
    public User addUser( User user) {
        return userFeign.addUser(user);
    }
}

启动类App（注意：在启动类上开启feign接口扫描）

package com.bjpowernode;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.cloud.openfeign.EnableFeignClients;


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

2.3 创建服务提供者

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <parent>
        <artifactId>springcloud_parent</artifactId>
        <groupId>com.bjpowernode</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>feign_interface</artifactId>

    <properties>
        <maven.compiler.source>11</maven.compiler.source>
        <maven.compiler.target>11</maven.compiler.target>
    </properties>

    <dependencies>
        <!--Spring Cloud OpenFeign Starter -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>com.bjpowernode</groupId>
            <artifactId>springcloud_common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
        <!--http连接池-->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-httpclient</artifactId>
        </dependency>
    </dependencies>
</project>

feign(只做演示，我这里用feign表示接口包名)

package com.bjpowernode.feign;

import com.bjpowernode.fallback.UserFeignFallback;
import com.bjpowernode.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;

@FeignClient(value = "feign-provider")
@RequestMapping("/provider")
public interface UserFeign {

    @RequestMapping("/getUserById/{id}") //拼接url，restful风格形式拼接传参
    User getUserById(@PathVariable("id") Integer id);

    @RequestMapping("/deleteUserById") //拼接url， ？形式传参
    User deleteUserById(@PathVariable("id") Integer id);

    @RequestMapping("/addUser") //将user对象以json字符串的形式传参
    User addUser(@RequestBody User user);
}

2.4 测试

三. Feign原理

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

@EnableFeignClients注解开启Feign扫描，先调用FeignClientsRegistrar.registerFeignClients()方法扫描@FeignClient注解的接口，再将这些接口注入到Spring IOC容器中，方便后续被调用。

3.2 为接口的方法创建RequestTemplate

当consumer调用feign代理类时，代理类会调用SynchronousMethodHandler.invoke()创建RequestTemplate(url，参数)

3.3 发出请求

代理类会通过RequestTemplate创建Request，然后client(URLConnetct、HttpClient、OkHttp)使用Request发送请求

四. Feign参数传递的三种方式

restful传参 @PathVariable() 将参数id以restful风格拼接到路径中

@RequestMapping("/getUserById/{id}") //拼接url，restful风格形式拼接传参
User getUserById(@PathVariable("id") Integer id);

？传参 @RequestParam【拼接?形式的url】

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

pojo参数传参 @RequestBody 将user对象以json字符串的形式传参

@RequestMapping("/addUser") //将user对象以json字符串的形式传参
User addUser(@RequestBody User user);

五. Feign优化小技巧

5.1 开启feign日志

OpenFeign 提供了日志增强功能，它的日志级别有以下几个：

NONE：默认的，不显示任何日志。
BASIC：仅记录请求方法、URL、响应状态码及执行时间。
HEADERS：除了 BASIC 中定义的信息之外，还有请求和响应的头信息
FULL：除了 HEADERS 中定义的信息之外，还有请求和响应的正文及元数据

通过配置文件来设置日志级别，配置信息如下:

feign:
    client:
        config:
            default:
                loggerLevel: full
logging:
    level:
        com.bjpowernode.feign: debug

其中 com.bjpowernode.feign 为 OpenFeign 接口所在的包名。
虽然 OpenFeign 默认是不输出任何日志，但在开发阶段可能会被修改，因此在生产环境中，
我们应仔细检查并设置合理的日志级别，以提高 OpenFeign 的运行效率。

5.2 feign超时

OpenFeign 底层内置了 Ribbon 框架，并且使用了 Ribbon 的请求连接超时时间和请求处理超时时间作为其超时时间，而 Ribbon 默认的请求连接超时时间和请求处理超时时间都是 1s

由于1秒时间太短，我们需要手动设置超时时间，OpenFeign 的超时时间有以下两种更改方法：

通过修改 Ribbon 的超时时间，被动的修改 OpenFeign 的超时时间。
直接修改 OpenFeign 的超时时间(推荐使用)。

在项目配置文件 application.yml 中添加以下配置：


#超时优化有两种方式（默认超时时间为1000毫秒，时间太短）
#1.通过修改 Ribbon 的超时时间，被动的修改 OpenFeign 的超时时间。
ribbon:
  ConnectTimeout: 5000 #请求连接的超时时间
  ReadTimeout: 5000 #请求处理的超时时间


#开启feign日志--前提feign包下的logger日志为：debug模式
#2.直接修改 OpenFeign 的超时时间(推荐使用)
feign:
  client:
    config:
      default:
        ConnectTimeout: 5000 #请求连接的超时时间
        ReadTimeout: 5000 #请求处理的超时时间

5.3 http连接池

专用通信组件自带连接池可以更好地对 HTTP 连接对象进行重用与管理，同时也能大大的提升 HTTP 请求的效率

引入Apache HttpClient依赖

        <!--Spring Cloud OpenFeign Starter -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <!--http连接池-->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-httpclient</artifactId>
        </dependency>

开启Apache HttpClient使用（只要引入依赖即可，程序默认开启）


feign:
  httpclient:
    enabled: true #开启httpclient 默认开启

5.4 gzip压缩

为了提高宽带利用率和加速数据的传输速度

在项目配置文件 application.yml 中添加以下配置：

server:
  compression:
    enabled: true #开启gzip压缩 提高宽带利用率和加速数据的传输速度

注意事项

如果服务消费端的 CPU 资源比较紧张的话，建议不要开启数据的压缩功能，因为数据压缩和解压都需要消耗 CPU 的资源，这样反而会给 CPU 增加了额外的负担，也会导致系统性能降低。

5.5 优化总结

OpenFeign 是 Spring 官方推出的一种声明式服务调用和负载均衡组件，在生产环境中我们可以通过以下配置来优化 OpenFeign 的运行：

修改 OpenFeign 的超时时间，让 OpenFeign 能够正确的处理业务。
通过配置专用的通信组件 Apache HttpClient 或 OKHttp，让 OpenFeign 可以更好地对 HTTP 连接对象进行重用和管理，以提高其性能。
开启数据压缩功能，可以提高宽带利用率和加速数据传输速度。
检查生成环境中 OpenFeign 的日志级别，选择合适的日志输出级别，防止无效的日志输出。

南波顽

关注

6
点赞
踩
56

收藏

觉得还不错? 一键收藏
1
评论
Feign详解

Feign是Spring Cloud提供的声明式、模板化的HTTP客户端；Spring Cloud集成Feign并对其进行了增强，使Feign支持了Spring MVC注解；Feign默认集成了Ribbon，默认就实现了负载均衡。
复制链接

扫一扫