http客户端Feign

  • http客户端Feign
    • a.Feign替代RestTemplate
    • b.自定义Feign的配置
    • c.Feign的性能优化
    • d.Feign的最佳实践分析
    • e.Feign实现最佳实践(方式二)

http客户端Feign

a.Feign替代RestTemplate

以前利用RestTemplate发起远程调用的代码:

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

存在下面的问题:

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

Feign的介绍

Feign是一个声明式的http客户端, 其作用就是帮助我们优雅的实现http请求的发送, 解决上面提到的问题。

使用Feign的步骤如下:

1.引入依赖:

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

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

@EnableFeignClients@MapperScan("cn.itcast.order.mapper")@SpringBootApplicationpublic class OrderApplication {public static void main(String[] args) {SpringApplication.run(OrderApplication.class, args);}}

3.编写clients/UserClient中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客户端代替RestTemplate

b.自定义Feign的配置

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

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

配置Feign日志有两种方式:

方式一:配置文件方式

  • 全局生效:
feign:client:config:default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置loggerLevel: Full # 日志级别
  • 局部生效:
feign:client:config:userservice: # 写服务名称,则是针对某个微服务的配置loggerLevel: Full # 日志级别

方式二:java代码方式,需要先声明一个Bean,在config/DefaultFeignConfiguration:

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

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

@EnableFeignClients(defaultConfiguration = FeignClientConfiguration.class) 

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

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

c.Feign的性能优化

Feign底层的客户端实现:

  • URLConnection:默认实现,不支持连接池
  • Apache HttpClient :支持连接池
  • OKHttp:支持连接池

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

  • 使用HttpClient 或者OKHttp连接池代替默认的URLConnection
  • 日志级别,最好用basic或none

Feign添加HttpClient的支持:

1.引入依赖:

<dependency><groupId>io.github.openfeign</groupId><artifactId>feign-httpclient</artifactId></dependency>

2.配置连接池:

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

d.Feign的最佳实践分析

方式一(继承):给消费者的FeignClient和提供者的controller定义统一的父接口作为标准

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

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

e.Feign实现最佳实践(方式二)

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

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

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

方式一:指定FeignClient所在包

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

方式二 (推荐):指定FeignClient字节码

@EnableFeignClients(clients = {UserClient.class})