Feign

Http客户端Feign

1、Feign替代RestTemplate

1.1、RestTemplate方式调用存在的问题

先来看我们以前利用RestTemplate发起远程调用的代码：

String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);

存在下面的问题：

​ 代码可读性差，编程体验不统一

​ 参数复杂URL难以维护

1.2、Feign介绍

Feign是一个声明式的http客户端，其作用就是帮助我们实现http请求的发送，解决上面提到的问题

管方地址：https://github.com/OpenFeign/feign

1.3、定义和使用Feign客户端

1、引入依赖：

<!--        Feign客户端依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>

2、在order-service启动类上添加注解开启Feign的功能

@MapperScan("com.itwpf.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderApplication.class, args);
    }
}

3、编写Feign客户端

主要是基于SpringMVC的注解来声明远程调用的信息，比如：

•服务名称：userservice

•请求方式：GET

•请求路径：/user/{id}

•请求参数：Long id

•返回值类型：User

package com.itwpf.order.client;

import com.itwpf.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

/**
 * @author wpf
 */
@FeignClient("userservice")
public interface UserClient {

    /**
     * 远程调用方法：根据id查找User信息
     * @author wpf
     * @date 2023/01/11 20:33
     * @param id 用户id
     * @return com.itwpf.order.pojo.User
     */
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

4、使用FeignClient中定义的方法替代RestTemplate

package com.itwpf.order.client;

import com.itwpf.order.pojo.User;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

/**
 * @author wpf
 */
@FeignClient("userservice")
public interface UserClient {

    /**
     * 远程调用方法：根据id查找User信息
     * @author wpf
     * @date 2023/01/11 20:33
     * @param id 用户id
     * @return com.itwpf.order.pojo.User
     */
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

2、Feign的自定义配置

Feign运行自定义配置来覆盖默认配置，可以修改的配置如下：

类型	作用	说明
feign.Logger.Level	修改日志级别	包含四种不同的级别：NONE、BASIC、HEADERS、FULL
feign.codec.Decoder	响应结果的解析器	http远程调用的结果做解析，例如解析json字符串为java对象
feign.codec.Encoder	请求参数编码	将请求参数编码，便于通过http请求发送
feign. Contract	支持的注解格式	默认是SpringMVC的注解
feign. Retryer	失败重试机制	请求失败的重试机制，默认是没有，不过会使用Ribbon的重试

一般我们需要配置的就是日志级别。

2.1、修改日志级别

方式一：配置文件方式

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

方式二：java代码配置

先声明一个Bean：

package com.itwpf.order.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;

/**
 * 配置Feign日志声明Bean
 *
 * @author 
 * @date 2023/01/11 21:01
 **/

public class DefaultFeignConfiguration {
    @Bean
    public Logger.Level logLevel(){
        return Logger.Level.BASIC;
    }
}

1、如果是全局配置，则把它放到@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)

2、如果是局部配置，则把它放到@FeignClient这个注解中：

@FeignClient(value = "userservice", configuration = FeignClientConfiguration.class) 

3、Feign的性能优化

Feign底层的客户端实现：

​ URLConnection：默认实现，不支持连接池

​ Apache HttpClient ：支持连接池

​ OKHttp：支持连接池

因此优化Feign的性能主要包括：

①使用连接池代替默认的URLConnection

②日志级别，最好用basic或none

3.1、Feign的性能优化-连接池配置

添加HttpClient的支持

引入依赖

<!--        引入HttpClient依赖-->
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-httpclient</artifactId>
        </dependency>

配置连接池

feign:
  client:
    config:
      default:
        loggerLevel: FULL
  httpclient:
    enabled: true # 支持httpclient的开关
    max-connections-per-route: 50 #单个路径的最大连接数
    max-connections: 200 #最大连接数

4、Feign的最佳实践

4.1、方式一（继承）：

给消费者的FeignClient和提供者的controller定义统一的父接口作为标准。

问题：

服务紧耦合

父接口参数列表中的映射不会被继承

4.2、方式二（抽取）：

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

4.3、总结

Feign的最佳实践：

①让controller和FeignClient继承同一接口

②将FeignClient、POJO、Feign的默认配置都定义到一个项目中，供所有消费者使用

4.4、实现方式2

实现最佳实践方式二的步骤如下：

1.首先创建一个module，命名为feign-api，然后引入feign的starter依赖

2.将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

3.在order-service中引入feign-api的依赖

4.修改order-service中的所有与上述三个组件有关的import部分，改成导入feign-api中的包

5.重启测试

当定义的FeignClient不在SpringBootApplication的扫描包范围时，这些FeignClient无法使用。有两种方式解决：

方式一：指定FeignClient所在包

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

方式二：指定FeignClient字节码

@EnableFeignClients(clients = UserClient.class, defaultConfiguration = DefaultFeignConfiguration.class)

的扫描包范围时，这些FeignClient无法使用。有两种方式解决：

方式一：指定FeignClient所在包

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

方式二：指定FeignClient字节码

@EnableFeignClients(clients = UserClient.class, defaultConfiguration = DefaultFeignConfiguration.class)