Feign学习笔记

HTTP客户端Feign

定义和使用Feign客户端

使用Feign的步骤如下：

1. 引入依赖：

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

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

在启动类上添加注解@EnableFeignClients

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

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

3. 编写Feign客户端：

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

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

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

4. 调用Feign方法实现远程调用

使用方法和mappeer接口一致

@Resource
private OrderMapper orderMapper;
@Resource
private UserClient userClient;

public Order queryOrderById(Long orderId) {
    // 1.查询订单
    Order order = orderMapper.findById(orderId);
    // 2.用Feign远程调用
    User user = userClient.findById(order.getUserId());
    // 3.封装user到order
    order.setUser(user);
    // 4.返回
    return order;
}

5. Feign的使用步骤

① 引入依赖

② 添加注解@EnableFeignClients

③ 编写FeignClient接口

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

自定义Feign的配置

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

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

NONE：没有日志记录
BASIC：记录请求方法、URL以及响应状态代码和执行时间
HEADERS：记录基本信息以及请求和响应头信息
FULL：记录基本信息以及请求和响应头信息、请求和响应体信息

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

2. 配置Feign日志的两种方式：

方式一：配置文件方式

① 全局生效

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

② 局部生效

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

方式二：java代码方式，需要先声明一个Bean

public class FeignClientConfiguration {
    @Bean
    public Logger.Level feignLogLevel() {
        return Logger.Level.FULL;
    }
}

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

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

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

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

@FeignClient(value = "userservice", configuration = FeignClientConfiguration.class)
public interface UserClient {
    @GetMapping("/user/{id}")
    User findById(@PathVariable Long id);
}

Feign的性能优化

1. Feign底层的客户端实现：

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

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

① 使用连接池带气体默认的URLConnection

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

2. 连接池配置

Feign添加HttpClient的支持：

引入依赖：

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

配置连接池：

feign:
  client:
    config:
      default: # 这里用default就是全局配置，如果是写服务名称，则是针对某个微服务的配置
        loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
  httpclient:
    enabled: true # 开启Feign对HttpClient的支持
    max-connections: 200 # 最大的连接数
    max-connections-per-route: 50 # 每个路径的最大连接数

抽取FeignClient

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

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. 重启测试

2. 问题

当定义的FeignClient不在SpringBootApplication的扫描包范围时，这些FeignClient无法使用。

3. 两种方法解决

• 方式一：指定FeignClient所在包

@EnableFeignClients(basePackages = "com.buyi.feign.client")

• 方式二：指定FeignClient字节码

@EnableFeignClients(clients = {UserClient.class})