SpringCloud学习六（http客户端Feign）

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

// 2、利用RestTemplate发起http请求，查询用户
String url = "http://userserver/user/"+order.getUserId();
// 3、发送请求
User user = restTemplate.getForObject(url, User.class);

存在下面的问题：

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

•参数复杂URL难以维护

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign

其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

1、Feign替代ResTemplate

我们在order-service服务的pom文件中引入feign的依赖：

<!--使用feign代替RestTemplate-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

在order-service的启动类添加@EnableFeignClients注解开启Feign的功能：

@MapperScan("cn.itcast.order.mapper")
@SpringBootApplication
@EnableFeignClients
public class OrderApplication {
      
      

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

    }
}

创建客户端接口

package cn.itcast.order.clients;

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

/**
 * 项目名称：cloud-demo
 * 描述：feign客户端接口
 *
 * @author zhong
 * @date 2022-05-29 10:32
 */
@FeignClient("userserver")
public interface UserClient {
      
      

    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

修改order-server的业务层代码，修改请求方式为feign的请求

/**
 * 注入feign客户端
 */
@Autowired
UserClient userClient;

public Order queryOrderById(Long orderId) {
      
      
    // 1.查询订单
    Order order = orderMapper.findById(orderId);
    // 2、利用RestTemplate发起http请求，查询用户
    User user = userClient.findById(order.getUserId());
    // 3、发送请求
    order.setUser(user);
    // 4.返回
    return order;
}

注释原来的

启动服务实例测试

之前的学习上对各自的配置文件都有所修改，那么我们需要将order-server的命名空间去掉，否则访问就会报错

启动访问数据，一样可以重新到user的用户信息

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

服务名称：userservice
请求方式：GET
请求路径：/user/{id}
请求参数：Long id
返回值类型：User

这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。

总结使用步骤：

① 引入依赖

② 添加@EnableFeignClients注解

③ 编写FeignClient接口

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

2、自定义配置

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即可。

2.1、配置文件方式

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

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

也可以针对所有服务：

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

而日志的级别分为四种：

NONE：不记录任何日志信息，这是默认值。
BASIC：仅记录请求的方法，URL以及响应状态码和执行时间
HEADERS：在BASIC的基础上，额外记录了请求和响应的头信息
FULL：记录所有请求和响应的明细，包括头信息、请求体、元数据。

2.2、Java代码方式

也可以基于Java代码来修改日志级别，先声明一个类，然后声明一个Logger.Level的对象：

package cn.itcast.order.config;

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

/**
 * 项目名称：cloud-demo
 * 描述：基于java代码的feign自定义配置设置
 *
 * @author zhong
 * @date 2022-05-29 11:07
 */
public class DefaultFeignConfiguration {
    
    
    @Bean
    public Logger.Level logLevel() {
    
    
        return Logger.Level.BASIC;
    }
}

如果要全局生效，将其放到启动类的@EnableFeignClients这个注解中：

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

如果是局部生效，则把它放到对应的@FeignClient这个注解中：

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

3、Feign使用优化

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

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

•Apache HttpClient ：支持连接池

•OKHttp：支持连接池

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

优化步骤

在order-service的pom文件中引入Apache的HttpClient依赖：

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

在order-service的application.yml中添加连接池配置：

如果是使用了java代码来定义配置文件的话就不需要在application.yml配置文件中再次配置了

feign:
  client:
    config:
      default: # default全局的配置
        loggerLevel: BASIC # 日志级别，BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

总结，Feign的优化：

1.日志级别尽量用basic

2.使用HttpClient或OKHttp代替URLConnection

① 引入feign-httpClient依赖

② 配置文件开启httpClient功能，设置连接池参数

4、最佳实践

所谓最近实践，就是使用过程中总结的经验，最好的一种使用方式。

自习观察可以发现，Feign的客户端与服务提供者的controller代码非常相似：

feign客户端：
@FeignClient("userserver")
public interface UserClient {
     
     

    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}
客户端的请求是必须与我们请求的一致
// userserver的请求查询用户的方法
@GetMapping("/user/{id}")
public User queryById(@PathVariable("id") Long id) {
     
     
    return userService.queryById(id);
}

4.1、最佳实现方式一：继承方式

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

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

2）Feign客户端和Controller都集成改接口

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-5Ltmvr4e-1653798006872)(images/feign/image-20220529120148526.png)]

优点：

简单
实现了代码共享

缺点：

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

4.2、最佳实现方式二：抽取独立模块

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

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

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-QaYuxSuK-1653798006874)(images/feign/image-20220529120225162.png)]

最佳实现方式二的实现步骤：

首先创建一个module，命名为feign-api：

在feign-api中然后引入feign的starter依赖

<dependencies>
    <!--引入feign的依赖坐标-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

然后，order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

在order-service的pom文件中中引入feign-api的依赖：

<!--引入feign-api包-->
<dependency>
    <groupId>com.zcl</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

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

解决扫描包问题

方式一：

指定Feign应该扫描的包：

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

方式二：

指定需要加载的Client接口：

@EnableFeignClients(clients = {
      
      UserClient.class})