基础使用
使用步骤
- 引入jar包
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
- 开启注解
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
public class SpringCloudProviderCosumerApplication {
public static void main(String[] args) {
SpringApplication.run(SpringCloudProviderCosumerApplication.class, args);
}
}
- 提供Service接口描述。
这里可以在客户端单独提供一个API进行描述,客户端可以直接引入,无需再定义。服务端也同样引入,直接实现即可。
@FeignClient("spring-cloud-ribbon-service")
public interface OpenFeignTestService {
@GetMapping("/test")
String OpenFeignTest();
}
OpenFeign底层也是通过http请求实现。
该接口其实就是为了描述http请求所需要的全部条件。如:服务名称(地址)、请求方式、请求方法、请求参数、返回类型...等
- 调用示例
@RestController
public class OpenFeignTestController {
@Autowired
OpenFeignTestService openFeignTestService;
@GetMapping("/openFeignTest")
public String openFeignTest(){
return openFeignTestService.OpenFeignTest();
}
}
请求、响应压缩
在远程调用请求、响应数据较大的情况下可以配置使用GZIP压缩。(默认2048字符以上)
#配置请求GZIP压缩
feign.compression.request.enabled=true
#配置响应GZIP压缩
feign.compression.response.enabled=true
# 配置压缩数据大小限制 (字符)
feign.compression.request.min-request-size=2048
日志级别控制
可以针对某些Feign接口指定日志跟踪。
- 新增配置
logging.level.[com.fishbone.example.springcloudprovidercosumer.OpenFeignTestService] = debug
- 注册Bean
@Configuration
public class FishBoneFeignLogLevel {
@Bean
Logger.Level feignLogLevel(){
return Logger.Level.FULL;
}
}
- 绑定配置类(增加configuration)
@FeignClient(value = "spring-cloud-ribbon-service",configuration = FishBoneFeignLogLevel.class)
public interface OpenFeignTestService {
@GetMapping("/test")
String OpenFeignTest();
}
替换底层通讯方式
修改配置关闭httpclient,开启okhttp
feign.httpclient.enabled=false
feign.okhttp.enabled=true
引入okhttp jar
<dependency>
<groupId>io.github.openfeign</groupId>
<artifactId>feign-okhttp</artifactId>
<version>10.2.0</version>
</dependency>
OpenFeign原理
- 动态代理注入。
- 注入结果通过Spring的哪个扩展点实现?与Mybatis的扩展行为是否类似?
- Mybatis动态代理主要通过,SqlSessionFactory的初始化(实现了InitializingBean),将扫描需要生成代理的对象Mapper生成BeanDefinition注册到SpringIOC容器,方便Service层引入(主要通过Mybatis配置来确认需要扫描路径)
- 注入结果通过Spring的哪个扩展点实现?与Mybatis的扩展行为是否类似?
- 代理类可以从接口维度,统一进行解析存储。
- 发起请求时需要进行LoadBlance。
OpenFeign可以看做是一个模板。比如下方示例。定义了请求方式,包括。服务名称(host)、请求路径、GET/POST、参数、结果,这些已经可以满足我们进行http请求调用。OpenFeign客户端便是通过这些,生成代理对象,从而在调用时向服务端发起请求。
代理对象中主要通过对注解进行解析,从Eureka中获取服务列表,再利用LoadBlance进行负载均衡,最后向服务端请求数据结果。
public interface IGoodsService {
@GetMapping("/getGoods") // 请求路径
String getGoodsInfo(@RequestParam("id") int goodsId);
}
@FeignClient(name = "spring-cloud-service-goods") // 服务名称
public interface IGoodsServiceFeignClient extends IGoodsService {
}
问题思考
OpenFeign 优点
OpenFeign方便了跨服务之间的调用。如果没有OpenFeign我们要知道具体的地址才可以发起http请求获得返回结果。
如何与Ribbon配合实现跨服务调用?
底层是采用什么通讯方式?与RestTemplate区别在哪里?
底层使用Http通讯方式。RestTemplate是对Http协议的一种封装。
OpenFeign 为什么要抽离一个接口Module?
首先,接口是需要提供给服务端做实现,给客户端做调用,为了方便两者使用, 直接抽离出一个Module可以使客户端引入更轻量(只包含接口定义),也可以使服务端无需向服务端提供一些单独的接口说明。
其次,直接引入jar包方式更加的透明,有改动服务端便可感知,避免不一致错误。
客户单不引入服务端jar包,直接手写接口是否可以?
不引入服务端jar包自己写接口也完全可以。
只要定义好FeignClient模板,交给Feingn去扫描加载,都可以请求到服务端。服务端直接提供jar包的方式是一种接口的收敛,方便客户端调用,有变动仅需要修改服务端版本即可。比如,服务端A提供了接口IA,同时被服务B/C/D使用,如果不引入jar包由客户端B/C/D自行定义,容易出错,且服务A修改需要增加参数时,B/C/D必需要修改。
思考,如果服务A 1.0版本接口 IA 只有一个参数 id,B服务引入了该版本服务接口。 然后服务A 升级版本,1.1 ,接口IA 增加参数 name,此时,服务 B 继续使用1.0版本接口IA,请求时是否会出现问题?取决于什么?为什么?