HM-SpringCloud微服务系列2.2【Feign远程调用】

2023-10-11 18:11:22

1 Feign替代RestTemplate

1.1 RestTemplate方式调用存在的问题

1.2 http客户端Feign的介绍

Feign是一个声明式的http客户端，官方地址：https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送，解决上面提到的问题。

1.3 定义和使用Feign

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

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

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

编写Feign的客户端
在order-service中新建一个接口

package cn.itcast.order.client;

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;

@FeignClient("userservice")
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable("id") Long id);
}

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

服务名称：userservice
请求方式：GET
请求路径：/user/{id}
请求参数：Long id
返回值类型：User
这样，Feign就可以帮助我们发送http请求，无需自己使用RestTemplate来发送了。

用Feign客户端代替RestTemplate
修改order-service中的OrderService类中的queryOrderById方法，使用Feign客户端代替RestTemplate

测试

首先启动本地nacos（for OrderApplication）
其次启动本地nacos集群(for UserApplication & UserApplication2)
考虑到2.1节中已对UserApplication & UserApplication2进行了集群搭建，参考https://www.cnblogs.com/yppah/p/15791141.html启动本地nacos集群&nginx反向代理负载均衡
启动3个微服务

注意：OrderApplication参考上节2.1，也将nacos地址改为80端口（与UserApplication & UserApplication2统一）；并且将namespace注释掉，不然报错

清空UserApplication & UserApplication2的控制台启动日志信息
测试：浏览器访问http://localhost:8080/order/1014遍

可以看出feign不仅实现了远程调用，而且实现了负载均衡(原因是feign中已经集成了ribbon负载均衡，如下图)

1.4 小结

使用Feign的步骤：
① 引入依赖
② 添加@EnableFeignClients注解
③ 编写FeignClient接口
④ 使用FeignClient中定义的方法代替RestTemplate

2 自定义配置

下面以日志为例来演示如何自定义配置

2.1 方式1：配置文件

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

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

全局生效
也可以针对所有服务：

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

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

配置之前清空控制台日志，访问一下http://localhost:8080/order/101

配置全局，重启OrderApplication服务，清空控制台启动日志，再访问一下

日志输出没变化，不知道为啥qaq

2.2 方式2：java代码

基于Java代码来修改日志级别，先声明一个配置类，然后在其中声明一个Logger.Level的对象Bean：

public class DefaultFeignConfiguration  {
    @Bean
    public Logger.Level feignLogLevel(){
        return Logger.Level.BASIC; // 日志级别为BASIC
    }
}

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

@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration .class)

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

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

重启服务后，清空控制台，访问http://localhost:8080/order/101

ok

2.3 小结

3 Feign性能优化

3.1 Feign底层的客户端实现&性能优化手段

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

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

因此提高Feign的性能主要手段包括：

使用连接池代替默认的URLConnection
日志级别，最好用basic或none

3.2 优化示例：连接池配置（Apache HttpClient）

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

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

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

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

测试
在FeignClientFactoryBean中的loadBalance方法中打断点：

Debug方式启动order-service服务，可以看到这里的client，底层就是Apache HttpClient：

3.3 小结

Feign的优化：

日志级别尽量用basic
使用HttpClient或OKHttp代替URLConnection
- 引入feign-httpClient依赖
- 配置文件开启httpClient功能，设置连接池参数

4 最佳实践

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

通过观察可以发现，Feign的客户端（order-service中）与服务提供者的controller（user-service中）代码非常相似：

有没有一种办法简化这种重复的代码编写呢？

4.1 最佳实践1：继承方式

优点：

简单
实现了代码共享

缺点：

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

4.2 最佳实践2：抽取方式

传统实现：
优化实现：

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

4.3 实现基于抽取的最佳实践(方式2)

步骤：

4.3.1 抽取(新建feign-api模块)

在当前cloud-demo项目下创建一个module，命名为feign-api
在feign-api中引入feign的starter依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

3. order-service模块中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api模块中

4.3.2 在order-service中使用feign-api模块

order-service模块中的UserClient、User、DefaultFeignConfiguration删掉

注意：此处本地未删，仅将他们更名为：原名2

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

<dependency>
    <groupId>cn.itcast.demo</groupId>
    <artifactId>feign-api</artifactId>
    <version>1.0</version>
</dependency>

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

可以看到OrderService中注入的userClient编译异常了，此问题会在4.3.4小节中解决

4.3.3 重启测试

重启OrderApplication服务，报错了
Field userClient in cn.itcast.order.service.OrderService required a bean of type 'cn.itcast.feign.clients.UserClient' that could not be found.

这是因为UserClient现在在cn.itcast.feign.clients包下，
而order-service的@EnableFeignClients注解是在cn.itcast.order包下，不在同一个包，无法扫描到UserClient。

扫不到包导致注入失败，解决方法如下4.3.4

4.3.4 解决启动报错：扫描包问题

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

方式一：指定Feign应该扫描的包

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

方式二：指定需要加载的Client接口（推荐）

@EnableFeignClients(clients = {UserClient.class})

解决跨模块依赖注入问题(扫描包问题)后，重启测试

可以看到此时，OrderService中注入的userClient编译正常了，不再报错
重启OrderApplication服务，浏览器访问订单101测试ok

码农公寓

HM-SpringCloud微服务系列2.2【Feign远程调用】

1 Feign替代RestTemplate

1.1 RestTemplate方式调用存在的问题

1.2 http客户端Feign的介绍

1.3 定义和使用Feign

1.4 小结

2 自定义配置

2.1 方式1：配置文件

2.2 方式2：java代码

2.3 小结

3 Feign性能优化

3.1 Feign底层的客户端实现&性能优化手段

3.2 优化示例：连接池配置（Apache HttpClient）

3.3 小结

4 最佳实践

4.1 最佳实践1：继承方式

4.2 最佳实践2：抽取方式

4.3 实现基于抽取的最佳实践(方式2)

4.3.1 抽取(新建feign-api模块)

4.3.2 在order-service中使用feign-api模块

4.3.3 重启测试

4.3.4 解决启动报错：扫描包问题

4.4 小结

码农公寓

1 Feign替代RestTemplate

1.1 RestTemplate方式调用存在的问题

1.2 http客户端Feign的介绍

1.3 定义和使用Feign

1.4 小结

2 自定义配置

2.1 方式1：配置文件

2.2 方式2：java代码

2.3 小结

3 Feign性能优化

3.1 Feign底层的客户端实现&性能优化手段

3.2 优化示例：连接池配置（Apache HttpClient）

3.3 小结

4 最佳实践

4.1 最佳实践1：继承方式

4.2 最佳实践2：抽取方式

4.3 实现基于抽取的最佳实践(方式2)

4.3.1 抽取(新建feign-api模块)

4.3.2 在order-service中使用feign-api模块

4.3.3 重启测试

4.3.4 解决启动报错：扫描包问题

4.4 小结

相关文章