前言
Feign现在是Spring Cloud OpenFeign的独立模块,Feign和Ribbon一样,也是一个客户端负载均衡器,客户端负载均衡和服务器负载均衡有着本质的区别,后面文章详说这个。Feign在Ribbon的基础上做了封装,所以Feign负载均衡c策略也是使用Ribbon配置的。
Feign 是一个声明式的web服务客户端,让我们更容易的编写开发负载均衡客户端。我们通过创建一个接口并用注解标注它就可以使用Feign。同时它有可插拨式的注解支持,包括Feign注解和 JAX-RS 注解。Feign也支持可插拨式编解码,Feign同时支持SpringMVC 的所有特性以及数据转换等。当我们使用Feign是,它集成了Ribbon和Eureka来支持Http的负载均衡客户端。
Feign的使用
以之前文章的工程为基础,我们创建一个 Feign-service 模块,以 eureka-client 作为服务提供者。
pom文件引入相关jar
<dependency>
<groupid>org.springframework.cloud/<groupid>
<artifactid>spring-cloud-starter-openfeign/<artifactid>
/<dependency>
<dependency>
<groupid>org.springframework.cloud/<groupid>
<artifactid>spring-cloud-starter-netflix-ribbon/<artifactid>
/<dependency>
<dependency>
<groupid>org.springframework.cloud/<groupid>
<artifactid>spring-cloud-starter-netflix-eureka-client/<artifactid>
/<dependency>
<dependency>
<groupid>org.springframework.boot/<groupid>
<artifactid>spring-boot-starter-web/<artifactid>
/<dependency>
配置application.yml
server:
port: 8769
spring:
application:
name: feign-service
eureka:
client:
serviceUrl:
defaultZone: http://eureka-server1:8761/eureka/
启动类
@SpringBootApplication
@EnableFeignClients
public class FeignServiceApplication {
public static void main(String[] args) {
SpringApplication.run(FeignServiceApplication.class, args);
}
}
@EnableFeignClients 启动Feign注解,如果我们要指定扫描特定包下的feign客户端,可以这样
@EnableFeignClients(basePackages = {xx,xx})
接口Feign客户端
@FeignClient( "eureka-client")
public interface EurekaCleintApi {
@GetMapping("/feignhello")
String feignHello(@RequestParam("name")String name);
}
eureka-client是服务提供者在Eureka的注册名,值得注意的是,传递参数必须加上参数注解,不然会报错。
调用的controller
@RestController
public class FeignController {
@Autowired
private EurekaCleintApi eurekaCleintApi;
@GetMapping("/testFeign")
public String testFeign(String name){
return eurekaCleintApi.feignHello(name);
}
}
经过以上几步,Feign负载均衡客户端整合完成
Feign定制配置文件覆盖默认配置
Feign有一份默认的配置写在 FeignClientsConfiguration,假如像上面我们什么Feign配置都没做的话,Feign就会用这份默认配置,但是我们应用往往会加入很多个Feign虚拟客户端,但不一定都使用默认的 FeignClientsConfiguration
Spring Cloud的Feign支持中的中心概念是指定客户端的概念。每个虚拟客户端都是组件集合的一部分,这些组件可以一起工作以按需联系远程服务器,并且该集合的名称是使用@FeignClient注解作为应用程序开发人员提供的。Spring Cloud ApplicationContext使用来为每个命名客户端按需创建一个新集合 FeignClientsConfiguration。FeignClientsConfiguration包含了 a feign.Decoder,a feign.Encoder和a feign.Contract。通过使用批注的contextId 属性,可以覆盖该集合的名称@FeignClient。
上面的接口客户端我们可以改成
@FeignClient(contextId = "eurekaCleintApi",name = "eureka-client",configuration = FeignConfig.class)
public interface EurekaCleintApi {
@GetMapping("/feignhello")
String feignHello(@RequestParam("name")String name);
}
然后我们的FeignConfig
@Configuration
public class FeignConfig {
}
可以在FeignConfig 定义我们自己的 Decoder,Encoder,Contract 等等
注意:按照官方的说法,FeignConfig应该排除在@ComponentScan的扫描范围之外
第二种方式配置Feign
假如我们不想再接口加注解的方式定义客户端,官方提供的第二种办法
EurekaCleintApi的注解去掉,FeignController改成
@RestController
public class FeignController {
private EurekaCleintApi eurekaCleintApi;
@Autowired
public FeignController(Decoder decoder, Encoder encoder, Client client, Contract contract) {
this.eurekaCleintApi = Feign.builder().client(client)
.encoder(encoder)
.decoder(decoder)
.contract(contract)
.target(EurekaCleintApi.class, "http://eureka-client");
}
@GetMapping("/testFeign")
public String testFeign(String name){
return eurekaCleintApi.feignHello(name);
}
}
Decoder decoder, Encoder encoder, Client client, Contract contract 这几个参数都是默认配置好的,不用担心找不到
Feign请求响应压缩
有时候为了传输的效率,在传输之前我们需要将我们请求和响应的数据进行压缩,我们通过如下的配置来启用
feign.compression.request.enabled=true
feign.compression.response.enabled=true
feign.compression.request.enabled=true
feign.compression.request.mime-types=text/xml,application/xml,application/json
feign.compression.request.min-request-size=2048
代码没有完全贴出来,具体完成代码如下
代码github地址:https://github.com/Chandgaochengdong/spring-cloud-sample
閱讀更多 蝸牛與小羊 的文章