Feign入门

Feign入门

Feign入门

Feign代替RestTemplate

RestTemplate方式调用存在的问题

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

String url = "http://userservice/user/" + order.getUserId();
User user = restTemplate.getForObject(url, User.class);

存在下面的问题：

代码可读性差，编程体验不统一
参数复杂URL难以维护

Feign的介绍

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

定义和使用Feign客户端

使用Feign的步骤如下：

引入依赖：

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

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

@EnableFeignClients
@MapperScan("com.zsl0.cloud.order.mapper")
@SpringBootApplication
public class OrderApplication {
    
    

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

    @Bean
    @LoadBalanced
    public RestTemplate restTemplate() {
    
    
        return new RestTemplate();
    }
}

编写Feign客户端：

@FeignClient("user-service")
public interface UserClient {
    
    
    @GetMapping("/user/{id}")
    User queryById(@PathVariable("id") Long id);
}

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

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

用Feign客户端代替RestTemplate

    @Autowired
    private UserClient userClient;

    public Order queryOrderById(Long orderId) {
    
    
        // 1.查询订单
        Order order = orderMapper.findById(orderId);
        // 查询用户信息
        Long userId = order.getUserId();
      
        // 远程调用
        User user = userClient.queryById(userId);
      
        order.setUser(user);
        // 4.返回
        return order;
    }

总结：

扫描二维码关注公众号，回复： 15339474 查看本文章

Feign的使用步骤

引入依赖
添加@EnableFeignClients注解
编写FeignClient接口
使用FeignClient中定义的方法代替RestTemplate

自定义配置

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

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

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

配置Feign日志有两种方式：

方式一：配置文件方式

全局生效：

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

局部生效：

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

配置Feign日志的方式二：java代码方式，需要先声明一个Bean：

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

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

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class)

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

@FeignClient(value = "user-service", configuration = FeignClientConfiguration.class)

总结：

Feign的日志配置:

方式一是配置文件，feign.client.config.xxx.loggerLevel
1. 如果xxx是default则代表全局
2. 如果xxx是服务名称，例如userservice则代表某服务
方式二是java代码配置Logger.Level这个Bean
1. 如果在@EnableFeignClients注解声明则代表全局
2. 如果在@FeignClient注解中声明则代表某服务

Feign使用优化

Feign底层的客户端实现：

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

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

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

Feign添加HttpClient的支持：

引入依赖：

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

配置连接池：

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

总结：

Feign的优化：

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

最佳实践

方式一（继承）：给消费者的FeignClient和提供者的controller定义统的父接口作为标准。

服务紧耦合
父接口参数列表中的映射不会被继承

practice

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

practice2

总结：

Feign的最佳实践：

让controller和FeignClient继承同一接口
将FeignClient、POJO、Feign的默认配置都定义到一个项目中，供所有消费者使用

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

首先创建一个module，命名为feign-api，然后引入feign的starter依赖
将order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中
在order-service中引入feign-api的依赖
修改order-service中的所有与上述三个组件有关的import部分，改成导入feign-api中的包
重启测试

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

方式一：指定FeignClient所在包

@EnableFeignClients(basePackages = "com.zsl0.cloud.feign", defaultConfiguration = FeignClientConfiguration.class)

方式二：指定FeignClient字节码

@EnableFeignClients(clients = UserClient.class, defaultConfiguration = FeignClientConfiguration.class)

总结：

不同包的FeignClient的导入有两种方式：

在@EnableFeignClients注解中添加basePackages，指定FeignClient所在的包
在@EnableFeignClients注解中添加clients，指定具体FeignClient的字节码

Feign入门

Feign入门

Feign入门

Feign代替RestTemplate

自定义配置

Feign使用优化

最佳实践

猜你喜欢