网盘链接:https://pan.baidu.com/s/1C-nJBWwjs39P73M-LSwnsA
提取码:toby
OpenFeign目前是Spring Cloud 二级子项目。平时说的Feign指的是Netflix下的Feign,现在我们学习的是OpenFeign,是Spring提供的。
OpenFeign是一种声明式、模板化的HTTP客户端(仅在Application Client中使用)(称OpenFeign作用:声明式服务调用)。声明式调用是指,就像调用本地方法一样调用远程方法,无需感知操作远程http请求。学习完OpenFeign后可以不使用RestTemplate进行调用。
Spring Cloud的声明式调用, 可以做到使用 HTTP请求远程服务时能就像调用本地方法一样的体验,开发者完全感知不到这是远程方法,更感知不到这是个HTTP请求。Feign的应用,让Spring Cloud微服务调用像Dubbo一样,Application Client直接通过接口方法调用Application Service,而不需要通过常规的RestTemplate构造请求再解析返回数据。它解决了让开发者调用远程接口就跟调用本地方法一样,无需关注与远程的交互细节,更无需关注分布式环境开发。
使用OpenFeign时就好像在写控制器方法,OpenFeign都是写在接口中,在声明的方法上添加SpringMVC注解或声明的参数上添加SpringMVC注解就可以完成调用远程的控制器方法。
OpenFeign代替之前的RestTemplate代码。也是写在Application Client中。把OpenFeign接口单独放在feign包中,表示服务调用层。当需要调用其他服务时,直接注入OpenFeign接口对象就可以像调用本地方法一样调用远程服务。
整体流程说明:
1. ApplicationService 向Eureka Server 注册服务。
2. Application Client从Eureka Server中发现服务信息。
3. 在Application Client中调用OpenFeign接口中方法
4. Application Client中OpenFeign通过应用程序名调用Application Service
前提:
保证有Eureka Server (以单机版举例,端口为8761)
新建一个项目名称任意。(示例中叫做applicationservice)
添加了Spring Boot和Spring Cloud版本声明。
添加了web环境和eureka client依赖
必须要有应用程序名,因为OpenFeign是通过应用程序名进行调用。
spring.application.name=applicationservice |
新建com.bjsxt.controller.ServiceController
新建com.bjsxt.ApplicationserviceApplication
新建项目,名称任意(示例中叫做applicationclient)
比application service项目多了openfeign的依赖
新建application.properties
spring.application.name=applicationclient server.port=8081 |
OpenFeign接口命名:
调用应用程序+Feign
新建了com.bjsxt.feign.ApplicationServiceFeign。
注意:
@FeignClient 参数要写调用的Application Service的应用程序名
@RequestMapping中值要和需要调用的控制器方法URL相同
方法返回值要和调用控制器方法返回值相同。
方法名称随意,没有要求。
新建com.bjsxt.service.ClientService及实现类。
在实现类中直接注入OpenFeign接口对象即可。没有在启动类上添加@EnableFeignClients时此处可能会报编译错误。
新建com.bjsxt.controller.ClientController
新建com.bjsxt.ApplicationClientApplication
增加注解@EnableFeignClients,用于开启OpenFeign注解支持。
在浏览器中输入http://localhost:8081/client 如果打印“service1的返回内容”说明OpenFeign调用成功
@RequestParam注解必须有
如果Feign接口方法参数名和调用控制器参数名相同可以省略@RequestParam的参数。
1.2.1 applicationclient其他代码省略
service及controller代码省略。
如果Feign接口中方法参数没有写注解,表示把该参数值设置到请求体中,在Application Service方参数必须添加@RequestBody接收。
但是由于请求体数据特性,Feign接口方法最多只能出现一个不带有注解的参数。否则出现违法状态异常。
但是允许Feign接口方法参数列表中,一个参数不带有注解,其他都带有注解,表示不带有注解的参数设置到请求体中,其他参数为普通表单参数。
请求体中数据可以是一个实体类,也可以是集合,更可以是简单数据类型。
Feign接口中方法参数都没有@RequestParam注解。
请求体数据必须有@RequestBody。
name表示设置到请求体中,其他参数为普通表单数据。
由于SpringMVC支持Restful请求方式,所以在Feign接口中可以按照restful传递参数
在spring-cloud-starter-openfeign中,对PathVariable有额外的约束。
要求必须为PathVariable注解的属性value赋值,如果未赋值属性value,则抛出异常:
java.lang.IllegalStateException: PathVariable annotation was empty on param 0.
源代码位置:
上述问题是源码中对注解PathVariable属性value的检查导致的,要么为注解PathVariable增加属性value的定义,要么使用下述办法解决:
在spring-boot-starter-parent中定义了编译插件maven-compiler-plugin,并约束了编译的同时为必要属性提供默认值,这个插件会为代码中的PathVariable必要属性value赋予默认值,默认值与注解描述的方法参数命名一致。
如果使用spring-boot-dependencies管理Spring Boot版本,那么可以通过自定义插件管理的方式,约束maven-compiler-plugin为代码中的必要参数填充默认值。
gzip介绍:gzip是一种数据格式,采用用deflate算法压缩数据;gzip是一种流行的数据压缩算法,应用十分广泛,尤其是在Linux平台。
gzip能力:当Gzip压缩到一个纯文本数据时,效果是非常明显的,大约可以减少70%以上的数据大小。
gzip作用:网络数据经过压缩后实际上降低了网络传输的字节数,最明显的好处就是可以加快网页加载的速度。网页加载速度加快的好处不言而喻,除了节省流量,改善用户的浏览体验外,另一个潜在的好处是Gzip与搜索引擎的抓取工具有着更好的关系。例如 Google就可以通过直接读取gzip文件来比普通手工抓取更快地检索网页。
第一:客户端向服务器请求头中带有:Accept-Encoding:gzip, deflate 字段,向服务器表示,客户端支持的压缩格式(gzip或者deflate),如果不发送该消息头,服务器是不会压缩的。
第二:服务端在收到请求之后,如果发现请求头中含有Accept-Encoding字段,并且支持该类型的压缩,就对响应报文压缩之后返回给客户端,并且携带Content-Encoding:gzip消息头,表示响应报文是根据该格式压缩过的。
第三:客户端接收到响应之后,先判断是否有Content-Encoding消息头,如果有,按该格式解压报文。否则按正常报文处理。
在Spring Cloud微服务体系中,一次请求的完整流程如下:
在整体流程中,如果使用GZIP压缩来传输数据,涉及到两次请求-应答。而这两次请求-应答的连接点是Application Client,那么我们需要在Application Client中配置开启GZIP压缩,来实现压缩数据传输。
在交互数据量级不够的时候,看不到压缩内容。
这里只开启Feign请求-应答过程中的GZIP,也就是浏览器-Application Client之间的请求应答不开启GZIP压缩。
在全局配置文件中,使用下述配置来实现OpenFeign请求-应答的GZIP压缩
在配置文件中提供下述配置: