1. 概述
1.1 OpenFeign 是什么
OpenFeign 可以将提供者提供的 Restful 服务伪装为接口进行消费,消费者只需使用 feign 接口 + 注解
的方式即可直接调用提供者提供的 Restful 服务,而无需再使用 RestTemplate
-
Feign 只与消费者端有关,与提供者端无关
-
Feign 本身是一个假的客户端,其不会额外地对请求做处理
-
Feign 是通过注解方式实现 RESTful 请求的
1.2 OpenFeign 与 Ribbon
说到 OpenFeign,不得不提的就是 Ribbon。Ribbon 是 Netflix 公司的一个开源的负载均衡项目,是一个客户端负载均衡器,运行在消费者端。
OpenFeign 也是运行在消费者端的,使用 Ribbon 进行负载均衡,所以 OpenFeign 直接内置了 Ribbon。即在导入 OpenFeign 依赖后,无需再专门导入 Ribbon 依赖了。
1.3 OpenFeign 与 Feign
Spring Cloud D 版及之前的版本使用的是 Feign,而该项目现已更新为了 OpenFeign。所以后续使用的依赖也发生了变化。
<!-- openFeign -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
<!-- feign -->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-feign</artifactId>
</dependency>
2. OpenFeign 环境搭建
代码已经上传至 https://github.com/masteryourself-tutorial/tutorial-spring ,详见
tutorial-spring-cloud/tutorial-spring-cloud-consumer/tutorial-spring-cloud-consumer-feign-6003
工程
2.1 配置文件
1. pom.xml
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.1.4.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-dependencies</artifactId>
<version>Greenwich.SR6</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
2. application.properties
# 端口号
server.port=6003
# 此实例注册到 eureka 服务端的 name
spring.application.name=tutorial-spring-cloud-consumer-feign
# 指定 eureka 服务注册中心地址
eureka.client.service-url.defaultZone=http://localhost:7001/eureka
# 此实例注册到 eureka 服务端的唯一的实例 ID
eureka.instance.instance-id=tutorial-spring-cloud-consumer-feign-6003
# 是否显示 IP 地址
eureka.instance.prefer-ip-address=true
# eureka 客户需要多长时间发送心跳给 eureka 服务器,表明它仍然活着,默认为 30 秒
eureka.instance.lease-renewal-interval-in-seconds=10
# eureka 服务器在接收到实例的最后一次发出的心跳后,需要等待多久才可以将此实例删除,默认为 90 秒
eureka.instance.lease-expiration-duration-in-seconds=30
# 设置 info 信息
info.app.name=tutorial-spring-cloud-consumer-feign
# feign 客户端默认连接超时
feign.client.config.default.connect-timeout=5000
# feign 客户端默认读取超时
feign.client.config.default.read-timeout=5000
2.2 代码
1. ConsumerApplication6003
@SpringBootApplication
@EnableFeignClients
public class ConsumerApplication6003 {
public static void main(String[] args) {
SpringApplication.run(ConsumerApplication6003.class, args);
}
}
2. ConsumerController
@RestController
@RequestMapping("/consumer")
public class ConsumerController {
@Autowired
private ProviderFeign feign;
@RequestMapping("/info")
public Map<String, String> info() {
return feign.info();
}
}
3. ProviderFeign
@FeignClient(value = "tutorial-spring-cloud-provider-eureka")
@RequestMapping("/provider")
public interface ProviderFeign {
@RequestMapping("/info")
Map<String, String> info();
}
3. Ribbon
代码已经上传至 https://github.com/masteryourself-tutorial/tutorial-spring ,详见
tutorial-spring-cloud/tutorial-spring-cloud-consumer/tutorial-spring-cloud-consumer-feign-loadbalance-6004
工程
3.1 更换内置策略
1. 配置类
/**
* 方式一:使用代码覆盖默认负载均衡策略
* 默认使用轮询策略
*
* @return {@link IRule}
*/
@Bean
public IRule randomRule() {
return new RandomRule();
}
2. 配置文件
# 方式二:使用配置文件覆盖默认负载均衡策略,配置格式为 微服务名称.ribbon.NFLoadBalancerRuleClassName
tutorial-spring-cloud-provider-eureka.ribbon.NFLoadBalancerRuleClassName=com.netflix.loadbalancer.RandomRule
3.2 自定义负载均衡策略
1. CustomRule
public class CustomRule extends AbstractLoadBalancerRule {
@Value("${ribbon.exclude.ips:}")
private String excludeIps;
@Override
public void initWithNiwsConfig(IClientConfig iClientConfig) {
}
@Override
public Server choose(Object o) {
// 获取到所有可用的 servers
List<Server> reachableServers = super.getLoadBalancer().getReachableServers();
if (reachableServers.size() == 1) {
return reachableServers.get(0);
}
// 排除指定 ip
List<Server> availableServers = this.excludeIp(reachableServers);
if (availableServers.size() == 0) {
return reachableServers.get(new Random().nextInt(reachableServers.size()));
}
// 随机抽取一个 server
return availableServers.get(new Random().nextInt(availableServers.size()));
}
private List<Server> excludeIp(List<Server> reachableServers) {
return reachableServers.stream()
.filter(server -> !(excludeIps.contains(server.getHost() + ":" + server.getPort())))
.collect(Collectors.toList());
}
}
2. application.properties
# 自定义负载均衡策略
ribbon.exclude.ips=192.168.0.113:5003
tutorial-spring-cloud-provider-eureka.ribbon.NFLoadBalancerRuleClassName=pers.masteryourself.tutorial.spring.cloud.consumer.feign.CustomRule