声明式服务调用Feign

Carpediemn

已于 2022-08-16 17:23:45 修改

阅读量222

点赞数

文章标签： java spring cloud spring boot

于 2022-08-16 17:05:15 首次发布

本文链接：https://blog.csdn.net/Carpediemn/article/details/126365495

版权

一、Feign 概述

在我们使用 restTemplate 调用其他服务的 API 的时候，需要将请求参数拼接在请求的 URL 后面，如果参数少的话还可以接受，当参数多的时候，通过 URL 拼接参数效率就会很低了。Netflix 开发的组件 Feign 给我们提供了解决方案。
Feign 是 Spring Cloud 提供的声明式的、模板化的HTTP客户端，我们只需要创建接口并添加相应的注解即可。Spring Cloud 对 Feign进行了增强，Feign 支持SpringMVC的注解，而且 Feign 集成了 Ribbon ，默认支持负载均衡。

二、Feign 入门案列

2.1 创建服务提供者工程 feign_provider

在这里插入图片描述

2.1.1 pom.xml

	<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>
        <dependency>
            <groupId>com.penghui</groupId>
            <artifactId>springcloud_common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

2.1.2 application.yml

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

2.1.3 启动类

@SpringBootApplication
@EnableDiscoveryClient//向注册中心注册该服务，并可以获取其他服务的调用地址
public class FeignProviderApp {

    public static void main(String[] args) {
        SpringApplication.run(FeignProviderApp.class,args);
    }
}

2.2 feign接口工程 feign_interface

在这里插入图片描述

2.2.1 pom.xml

	<dependencies>
        <!--Spring Cloud OpenFeign Starter -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>com.penghui</groupId>
            <artifactId>springcloud_common</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

2.2.2 接口 UserFeign

@FeignClient(value="feign-provider")
@RequestMapping(value = "/provider")
public interface UserFeign {
    @RequestMapping(value = "/getUserById/{id}")
    public User getUserById(@PathVariable(value="id") Integer id);
}

2.3 创建服务消费者工程 feign_consumer

在这里插入图片描述

2.3.1 pom.xml

	<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.penghui</groupId>
            <artifactId>feign_interface</artifactId>
            <version>1.0-SNAPSHOT</version>
        </dependency>
    </dependencies>

2.3.2 application.yml

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

2.3.3 Controller

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

    @Autowired
    private UserFeign userFeign;

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

2.3.4 启动类

@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容器中

Feign 接口工程的启动类上的 @EnableFeignClients 注解，会扫描启动类所在包及其子包内带有 @FeignClient 注解的接口，并将这些接口添加到 Spring IOC 容器中，方便 Feign 消费者工程里面通过 @AutoWired 注解注入后调用；
@EnableFeignClients 注解是通过在Spring容器中导入一个 FeignClientsRegistrar 类型的对象，然后调用FeignClientsRegistrar.registerFeignClients()方法扫描 @FeignClient 注解的接口，将这些接口注入到 Spring IOC 容器中。
在这里插入图片描述

	public void registerFeignClients(AnnotationMetadata metadata,
			BeanDefinitionRegistry registry) {
		... ... ...
         //扫描feign接口   
		for (String basePackage : basePackages) {
			Set<BeanDefinition> candidateComponents = scanner
					.findCandidateComponents(basePackage);
			for (BeanDefinition candidateComponent : candidateComponents) {
				if (candidateComponent instanceof AnnotatedBeanDefinition) {
					AnnotatedBeanDefinition beanDefinition = (AnnotatedBeanDefinition) 
                                                              candidateComponent;
                      //获得UserFeign的详细信息
					AnnotationMetadata annotationMetadata = beanDefinition.getMetadata();
					Assert.isTrue(annotationMetadata.isInterface(),
							"@FeignClient can only be specified on an interface");

					Map<String, Object> attributes = annotationMetadata
							.getAnnotationAttributes(FeignClient.class.getCanonicalName());
					String name = getClientName(attributes);
					registerClientConfiguration(registry, name,
							attributes.get("configuration"));
                      //注入Feign接口到Spring容器中
					registerFeignClient(registry, annotationMetadata, attributes);
				}
			}
		}
	}

3.2 RequestTemplate 封装请求信息

当 Feign 接口中的方法被调用的时候，Spring 通过 JDK 动态代理的方式生成一个接口的代理类。同时，Feign 会为每一个方法生成一个 RequestTemplate 对象，该对象封装了发送HTTP请求所需的所有信息，如请求类型、URL、请求参数等。

	public Object invoke(Object[] argv) throws Throwable {
        //创建一个RequestTemplate
        RequestTemplate template = this.buildTemplateFromArgs.create(argv);
        Retryer retryer = this.retryer.clone();

        while(true) {
            try {
                //发出请求
                return this.executeAndDecode(template);
            } catch (RetryableException var8) {
                ... ... ...
            }
        }
    }

	package feign;
	
	public final class RequestTemplate implements Serializable {
	    ... ... ... ... ... ...
	    private UriTemplate uriTemplate;
	    private HttpMethod method;
	    private Body body;
	    ... ... ... ... ... ...
	}

3.3 发送请求

RequestTemplate 会生成 Request，并将其交给 Client，Client 默认是JDK原生的 URLConnection（不支持池连）、也可以是Apache的 HttpClient（支持池连）或是 OKhttp（支持池连），最后 Client 会结合Ribbon负载均衡向其他服务发送请求，进行服务调用。

	Object executeAndDecode(RequestTemplate template) throws Throwable {
	        //生成请求对象
	        Request request = this.targetRequest(template);
	        if (this.logLevel != Level.NONE) {
	            this.logger.logRequest(this.metadata.configKey(), this.logLevel, request);
	        }
	
	        long start = System.nanoTime();
	
	        Response response;
	        try {
	            //发起请求
	            response = this.client.execute(request, this.options);
	        } catch (IOException var15) {
	            ... ... ...
	
	            throw FeignException.errorExecuting(request, var15);
	        }
	 }

四、Feign参数传递

4.1 ？拼接传参

Feign 接口中的方法：
在这里插入图片描述

4.2 restful风格传参

Feign 接口中的方法：
在这里插入图片描述

4.3 对象类型传参

Feign 接口中的方法：
在这里插入图片描述

五、Feign 的优化

Feign 是通过发送HTTP请求的方式来调用其他服务的API的，而发送HTTP请求之前需要建立稳定的 TCP/IP 连接，每次连接都需要经历三次握手和四次挥手，这对服务将的通信效率非常不友好。另外传输数据的大小本身也会影响传输效率。
因此我们可以从优化连接的建立及压缩出传输数据的大小两个方面来优化 Feign。

5.1 http连接池

使用http连接池，可以避免每次发送请求都要经历三次握手和四次挥手来建立连接，提高发送HTTP请求的效率。
在 Feign 接口工程中添加 HttpClient 连接池依赖：添加依赖之后就默认开启，无需额外配置。

		<!--HttpClient连接池依赖-->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-httpclient</artifactId>
        </dependency>

5.2 对传输数据进行gzip压缩

通过压缩传输数据的大小，提高服务间通信的效率。如果是纯文本的数据，gzip可以减少70%数据大小。
在Feign消费者工程的配置文件开启gzip压缩：

server:
  port: 8080
  compression:
    enabled: true #开启gzip压缩

在这里插入图片描述

5.3 修改Feign超时时间

修改超市时间，主要用于方便我们调试。
在Feign消费者工程的配置文件中配置超市时间：

ribbon: #通过Ribbon配置全局的超时时间
  ConnectTimeout: 5000 #请求连接的超时时间
  ReadTimeout: 5000 #请求处理的超时时间

feign: #通过Feign配置某个模块的超时时间
  client:
    config:
      feign-provider: # 此处配置的是feign-provider模块的超时时间，也可改为default表示配置全局超时时间
        ConnectTimeout: 5000 #请求连接的超时时间
        ReadTimeout: 5000 #请求处理的超时时间

5.4 开启Feign日志

在Feign消费者工程的配置文件中开启Feign的日志

feign:
  client:
    config:
      feign-provider: #此处配置的是输出feign-provider模块的日志，也可改为default表示全局配置，输出所有模块的日志
        loggerLevel: full #full输出所有内容
logging:
  level:
    com.penghui.feign: debug #日志级别为debug