SpringCloud系列（六）Feign 客户端的配置及使用

news2024/11/19 8:54:04

❓Feign 是什么?
🙊Feign 是一个声明式的 http 客户端, 其主要的作用就是帮助我们实现 http 的请求发送, 正如官网所说, Feign使编写Java http客户端更容易;
❓❓为什么要用 Feign?
🙊🙊如在未学习 Feign 之前, 我们利用的是 RestTemplate 进行发起远程的调用, 如下面的代码所示:
String url = "http://providerservice/provider/" + consumer.getProviderId();
Provider provider = restTemplate.getForObject(url, Provider.class);
先写出 url 路径, 然后再利用 RestTemplate 发送 http 请求, 实现远程的调用; 通过代码也可以看出来这样的方式存在代码可读性比较差, 编程体验不是很好, 并且参数比较复杂, URL 不容易维护, 而 Feign 就是为了解决这个问题而生;
❓❓❓为什么选择 Feign?
🙊🙊🙊关于为什么要选择 Feign, 如下图官网所说: Feign 这个工具啊和 Jersey 和 CXF 一样都是利用了 ReST 或者 SOAP 工具, 但是呢 Feign 允许我们程序猿在 http 库里面自行写代码, 就像 Apache HC 一样, 通过可定制的解码器和错误处理方式将您的代码连接到http API，可以写入任何基于文本的http API, 并且开销和代码量是最少得.

Feign

1 使用步骤
2 自定义使用 Feign
- 2.1 配置 Feign 日志的两种方式
3 Feign 性能优化
4 Feign 最佳实践

1 使用步骤

步骤一: 引入 Feign 客户端依赖;

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

步骤二: 在 consumer-service 的启动类中添加注解 @EnableFeignClients 来开启 Feign 的功能;
在这里插入图片描述
步骤三: 开始编写 Feign 客户端;
我这里是新建了一个 feign 包, 然后在 clients 中声明远程调用的信息, 这里也是基于 Spring 的注解;

@FeignClient("providerservice")  // 服务名称
public interface ProviderClient {
    @GetMapping("/provider/{id}")  // 请求方式及路径
    provider findById(@PathVariable("id") Long id);
}

步骤四: 使用 Feign 客户端来进行发送请求;
对比: 通过代码数量就可以看得出简单了很多!
在这里插入图片描述

@Service
public class ConsumerService {

    @Resource
    private ConsumerMapper consumerMapper;
    @Resource
    private ConsumerClient consumerClient;
    
    public Consumer queryOrderById(Long consumerId) {
        // 1. 查询订单
        Consumer consumer = consumerMapper.findById(consumerId);
        // 2. 用 Feign 远程调用
        Provider provider = consumerClient.findById(consumer.getProviderId());
        // 3. 封装 user 到 Order
        consumer.setProvider(provider);
        // 4.返回
        return consumer;
    }
}

2 自定义使用 Feign

通常还会自定义一些配置来覆盖其默认的配置, 如常用的修改日志的配置; 如下图便是某些配置修改的类型及说明:
在这里插入图片描述
关于具体使用我们以配置 Feign 日志为例子进行说明.

2.1 配置 Feign 日志的两种方式

方式一: 文件配置方式;
在这里插入图片描述

这里的 default 就是全局配置, 如果写的是 consumerservice 则就是对此服务的配置, FULL 为日志级别;

方式二: 使用 java 代码方式; 在 feign 包中加入 config 类, 添加相关的配置; 注意这里要声明一下 bean;

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

如果是全局配置, 则放在 @EnableFeignClients 这个注解里面:
在这里插入图片描述
如果是局部配置, 就放在 @FeignClient 这个注解中;

@FeignClient(value = "providerservice", configuration = FeignClientsConfiguration.class)
public interface ProviderClient {

    @GetMapping("/provider/{id}")
    Provider findById(@PathVariable("id") Long id);
}

3 Feign 性能优化

关于 Feign 的优化主要体现在使用连接池代替默认的 URLConnection, 其次在日志设置要日志级别最好设置为 BASIC 或者是 NONE;
配置连接池方式:
步骤一: consumerservice 中引入 httpClient 依赖;

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