微服务日志从0到1-----第四章Feign的使用

微服务日志从0到1-----第四章Feign的使用

Http客户端Feign的使用

在之前我们一直使用的是RestTemplate来进行服务的调用

在这里就有很多的不方便，代码的书写，阅读性差，难以维护，为了解决这些问题，就需要使用到一个Http客户端Feign

01.Feign介绍

Feign 是⼀个 HTTP 请求的轻量级客户端框架。通过 接口 + 注解的方式发起 HTTP 请求调用，面向接口编程，而不是像 Java 中通过封装 HTTP 请求报文的方式直接调用。服务消费方拿到服务提供方的接⼝，然后像调⽤本地接⼝⽅法⼀样去调⽤，实际发出的是远程的请求。让我们更加便捷和优雅的去调⽤基于 HTTP 的 API，被⼴泛应⽤在 Spring Cloud 的解决⽅案中。

Feign 的首要目标就是减少 HTTP 调用的复杂性。在微服务调用的场景中，我们调用很多时候都是基于 HTTP 协议的服务，如果服务调用只使用提供 HTTP 调用服务的 HTTP Client 框架（e.g. Apache HttpComponnets、HttpURLConnection OkHttp 等），我们需要关注哪些问题呢？

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Gg6FO1kv-1657601282043)(https://p3-juejin.byteimg.com/tos-cn-i-k3u1fbpfcp/44ddd61c8f2248479dd3b9edaaf6b907~tplv-k3u1fbpfcp-watermark.image)]

相比这些 HTTP 请求框架，Feign 封装了 HTTP 请求调用的流程，而且会强制使用者去养成面向接口编程的习惯（因为 Feign 本身就是要面向接口）。

02.简单使用Feign

01.引入fegn

<!-- feign 服务-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-feign</artifactId>
    <version>1.4.7.RELEASE</version>
</dependency>

02.在启动类上添加注解

@EnableFeignClients

03.编写接口

@FeignClient("feign-user")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findUserById(@PathVariable("id")String id);
}

04.使用Feign

@Autowired
UserClient userClient;

public Order queryOrderById(Long orderId) {
    //查询订单
    Order order = orderMapper.findById(orderId);

    //查询用户
    User user = userClient.findUserById(String.valueOf(order.getUserId()));

    //存值
    order.setUser(user);

    //返回
    return order;
}

05.请求结果

{
    "id": 103,
    "price": 43900,
    "name": "骆驼（CAMEL）休闲运动鞋女",
    "num": 1,
    "userId": 3,
    "user": {
        "id": 3,
        "username": "华沉鱼",
        "address": "湖北省十堰市"
    }
}

03.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的重试

一般情况下，默认值就能满足我们使用，如果要自定义时，只需要创建自定义的 @Bean 覆盖默认 Bean 即可。下面以日志为例来演示如何自定义配置。

基于配置文件修改 feign 的日志级别可以针对单个服务：

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

针对所有服务:

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

而日志的级别分为四种：

• NONE：不记录任何日志信息，这是默认值。

• BASIC：仅记录请求的方法，URL以及响应状态码和执行时间

• HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息

• FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据

除了通过配置文件来设置，也可以通过Java代码来设置，首先需要定义一个类用来注入

/**
 * @author CodeXYW
 * @date 2022/7/2 13:22
 */
@Configuration
public class MyFeignConfig {

    @Bean
    public Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

定义为全局生效的话在启动类上的@EnableFeignClients注解里面添加

@EnableFeignClients(defaultConfiguration = MyFeignConfig.class)

定义为局部生效就在@FeignClient(“xxx”)里面设置

@FeignClient(value = "feign-user",configuration = MyFeignConfig.class)

04.Feign性能优化

Feign 底层发起 http 请求，依赖于其它的框架。其底层客户端实现有：

• URLConnection：默认实现，不支持连接池
• Apache HttpClient ：支持连接池
• OKHttp：支持连接池

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

另外，日志级别应该尽量用 basic/none，可以有效提高性能。

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

配置连接池

在配置文件中使用

feign:
  httpclient:
    max-connections: 200 //最大连接数
    max-connections-per-route: 50 //单地址最大连接数
    enabled: true //开启

05.feign最佳实践

继承方式

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

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

2）Feign 客户端、Controller 都集成该接口

优点

• 简单
• 实现了代码共享

缺点

• 服务提供方、服务消费方紧耦合
• 参数列表中的注解映射并不会继承，因此 Controller 中必须再次声明方法、参数列表、注解

抽取方式

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

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

项目简答实现地址: https://github.com/codeXYW/Microservices/tree/main/feign