先来看我们以前利用RestTemplate发起远程调用的代码:
var url = "http://categoryservice/category/" + book.getCategoryId();
var category = restTemplate.getFor0bject(url, Category.class);
存在下面的问题:
Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign
其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。
1.在book-service服务的build.gradle文件中引入feign的依赖:
implementation 'org.springframework.cloud:spring-cloud-starter-openfeign'
2.在book-service的启动类添加注解开启Feign的功能:
@EnableFeignclients
@SpringBootApplication
public class BookApplication {
public static void main(String[] args) {
SpringApplication.run(BookApplication.class,args);
}
3.编写Feign的客户端,在book-service中新建一个接口,内容如下
package edu.uestc.canary.client;
import edu.uestc.canary.pojo.Category;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
@FeignClient("category-service")
public interface CategoryClient {
@GetMapping("/category/{id}")
Category findById(@PathVariable("id") Integer id);
}
这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:
这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。
4.测试
修改book-service中的BookService类中的queryById方法,使用Feign客户端代替RestTemplate:
@Resource
private CategoryClient categoryClient;
public Book queryCategoryById(Integer categoryId) {
var book = repository.findById(categoryId);//利用Feign发起http请求,查询类别
var category = categoryClient.findById(book.getCategoryId());/3.封装category到book
book.setCategory(category);
return book;
}
Feign可以支持很多的自定义配置,如下表所示
类型 | 作用 | 说明 |
---|---|---|
feign.Logger.Level | 修改日志级别 | 包含四种不同的级别:NONE、BASIC、HEADERS、FULL |
feign.codec.Decoder | 响应结果的解析器 | http远程调用的结果做解析,例如解析json字符串为java对象 |
feign.codec.Encoder | 请求参数编码 | 将请求参数编码,便于通过http请求发送 |
feign. Contract | 支持的注解格式 | 默认是SpringMVC的注解 |
feign. Retryer | 失败重试机制 | 请求失败的重试机制,默认是没有,不过会使用Ribbon的重试 |
一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。
下面以日志为例来演示如何自定义配置。
基于配置文件修改feign的日志级别可以针对单个服务:
feign:
client:
config:
categoryservice: # 针对某个微服务的配置
loggerLevel: FULL # 日志级别
也可以针对所有服务:
feign:
client:
config:
default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
loggerLevel: FULL # 日志级别
而日志的级别分为四种:
也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:
public class DefaultFeignConfiguration {
@Bean
public Logger.Level feignLogLevel(){
return Logger.Level.BASIC; // 日志级别为BASIC
}
}
如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:
@EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class)
如果是局部生效,则把它放到对应的@FeignClient这个注解中:
@FeignClient(value = "categoryservice", configuration = DefaultFeignConfiguration.class)
Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:
因此提高Feign的性能主要手段就是使用**连接池**代替默认的URLConnection。
这里我们用Apache的HttpClient来演示。
1)引入依赖
在book-service的pom文件中引入Apache的HttpClient依赖:
implementation 'io.github.openfeign:feign-httpclient'
2)配置连接池
在book-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方式启动book-service服务,可以看到这里的client,底层就是Apache HttpClient:
1)定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。
2)Feign客户端和Controller都集成改接口
优点:
缺点:
将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。
例如,将CategoryClient、Category、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。