spring cloud openfeign 使用入门

如下图所示，直接使用 ribbon+RestTemplate 完成微服务之间的方法调用存在一些问题，例如代码冗余、服务地址修改会增加维护成本等等，那有没有更优雅的方式呢？答案是肯定的，spring cloud提供了 openfeign 来帮我们解决上述的问题。

SpringCloud OpenFeign 简介

Spring Cloud OpenFeign 是声明式、模板化的HTTP客户端，可以更加便捷、优雅的调用HTTP API。它整合了 Ribbon 和 Eureka 以提供负载均衡的服务调用及基于 Hystrix 的服务容错保护功能。在使用时，我们只需创建一个接口并用注解的方式来配置它，就可以实现对某个服务接口的调用，简化了直接使用 RestTemplate 来调用服务接口的开发量。

如何使用

1、pom添加 spring-cloud-starter-openfeign 依赖

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.3.0.RELEASE</version>
    <relativePath/>
</parent>

<properties>
    <java.version>1.8</java.version>
    <spring-cloud.version>Hoxton.SR9</spring-cloud.version>
</properties>

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-dependencies</artifactId>
            <version>${spring-cloud.version}</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependencies>
    <!--web相关依赖-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!--注册中心客户端-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>

    <!--open-feign客户端-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
    </dependency>
</dependencies>

2、Application启动类添加 @EnableFeignClients 注解

@SpringBootApplication
@EnableDiscoveryClient
@EnableFeignClients
public class ConsumerDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(ConsumerDemoApplication.class, args);
    }
}

3、使用注解 @FeignClient 创建客户端

• 方法有多个参数，需要使用注解 @RequestParam 进行修饰
• fallbackFactory 指定方法的熔断降级策略

@FeignClient(value = "provider-demo", fallbackFactory = ProviderFeignClientFallBackFactory.class)
public interface ProviderFeignClient {
    @GetMapping("providerCalculateAdd")
    BigDecimal providerCalculateAdd(@RequestParam("number1") BigDecimal number1,
                                    @RequestParam("number2") BigDecimal number2);
}

4、FeignClient客户端方法熔断降级工厂

@Component
public class ProviderFeignClientFallBackFactory implements FallbackFactory<ProviderFeignClient> {
    @Override
    public ProviderFeignClient create(Throwable throwable) {
        return new ProviderFeignClient() {
            @Override
            public BigDecimal providerCalculateAdd(BigDecimal number1, BigDecimal number2) {
                return BigDecimal.ZERO;
            }
        };
    }
}

5、Controller控制器类

@RestController
public class ConsumerController {

    @Autowired
    private ProviderFeignClient providerFeignClient;

    @GetMapping("consumerCalculateAdd")
    public BigDecimal consumerCalculateAdd(BigDecimal number1, BigDecimal number2) {
        return providerFeignClient.providerCalculateAdd(number1, number2);
    }
}

6、bootstrap.yml 项目参数配置，feign.hystrix.enabled=true 开启Hystrix 的服务容错保护功能。

spring:
  application:
    name: consumer-demo
  profiles:
    active: dev
server:
  port: 3035
# 注册中心配置
eureka:
  client:
    service-url:
      defaultZone: http://localhost:8090/eureka/
  instance:
    lease-expiration-duration-in-seconds: 30
    lease-renewal-interval-in-seconds: 10
    prefer-ip-address: true
    instance-id: ${spring.cloud.client.ip-address}:${server.port}

feign:
  client:
    config:
      default:
        # 服务连接超时时间
        connectTimeout: 5000
        readTimeout: 5000
  hystrix:
    # 启用熔断功能
    enabled: true

使用postman调用 consumer-demo 项目的方法

在 consumer-demo 控制台打印的日志说明已经成功调用了 provider-demo 的方法，DynamicServerListLoadBalancer 说明open-feign已经集成了负载均衡器。

详细的控制台日志如下：

2020-12-23 10:17:31.573  INFO 12972 --- [provider-demo-1] c.netflix.config.ChainedDynamicProperty  : Flipping property: provider-demo.ribbon.ActiveConnectionsLimit to use NEXT property: niws.loadbalancer.availabilityFilteringRule.activeConnectionsLimit = 2147483647
2020-12-23 10:17:31.657  INFO 12972 --- [provider-demo-1] c.n.u.concurrent.ShutdownEnabledTimer    : Shutdown hook installed for: NFLoadBalancer-PingTimer-provider-demo
2020-12-23 10:17:31.662  INFO 12972 --- [provider-demo-1] c.netflix.loadbalancer.BaseLoadBalancer  : Client: provider-demo instantiated a LoadBalancer: DynamicServerListLoadBalancer:{NFLoadBalancer:name=provider-demo,current list of Servers=[],Load balancer stats=Zone stats: {},Server stats: []}ServerList:null
2020-12-23 10:17:31.679  INFO 12972 --- [provider-demo-1] c.n.l.DynamicServerListLoadBalancer      : Using serverListUpdater PollingServerListUpdater
2020-12-23 10:17:31.763  INFO 12972 --- [provider-demo-1] c.netflix.config.ChainedDynamicProperty  : Flipping property: provider-demo.ribbon.ActiveConnectionsLimit to use NEXT property: niws.loadbalancer.availabilityFilteringRule.activeConnectionsLimit = 2147483647
2020-12-23 10:17:31.769  INFO 12972 --- [provider-demo-1] c.n.l.DynamicServerListLoadBalancer      : DynamicServerListLoadBalancer for client provider-demo initialized: DynamicServerListLoadBalancer:{NFLoadBalancer:name=provider-demo,current list of Servers=[192.168.0.119:3030],Load balancer stats=Zone stats: {defaultzone=[Zone:defaultzone;	Instance count:1;	Active connections count: 0;	Circuit breaker tripped count: 0;	Active connections per server: 0.0;]
},Server stats: [[Server:192.168.0.119:3030;	Zone:defaultZone;	Total Requests:0;	Successive connection failure:0;	Total blackout seconds:0;	Last connection made:Thu Jan 01 08:00:00 CST 1970;	First connection made: Thu Jan 01 08:00:00 CST 1970;	Active Connections:0;	total failure count in last (1000) msecs:0;	average resp time:0.0;	90 percentile resp time:0.0;	95 percentile resp time:0.0;	min resp time:0.0;	max resp time:0.0;	stddev resp time:0.0]
]}ServerList:org.springframework.cloud.netflix.ribbon.eureka.DomainExtractingServerList@30f7c8ef
2020-12-23 10:17:32.696  INFO 12972 --- [erListUpdater-0] c.netflix.config.ChainedDynamicProperty  : Flipping property: provider-demo.ribbon.ActiveConnectionsLimit to use NEXT property: niws.loadbalancer.availabilityFilteringRule.activeConnectionsLimit = 2147483647
2020-12-23 10:22:24.417  INFO 12972 --- [trap-executor-0] c.n.d.s.r.aws.ConfigClusterResolver      : Resolving eureka endpoints via configuration

在 provider-demo 方法打断点模拟方法出现线程阻塞或者抛出异常，等到了熔断时间 ，consumer-demo的方法就会自动使用降级方法优雅的进行后续的业务处理。

至此，openfeign入门分享结束了