SpringCloud 之 openfeign 服务使用

前言：

        首先说下feign 跟 openfeign 区别：前者理解为一个简约版，后者支持 spring 的一些注解并且内置了 hystrix 熔断；如果想使用 hystrix，前者需要额外配置 hystrix。在没用 feign 之前，服务调用可以使用 RestTemplate，当然前者优点更多；默认大家已经理解 eureka 这些，如果不理解参考 SpringCloud 之 Eureka 服务的使用场景和搭建。

版本声明：

springboot：2.3.2.RELEASE

springcloud：Hoxton.SR11

1. 服务提供者信息

首先看一下服务提供者的接口文件：

@RestController
@RequestMapping("/client")
public class ControllerTest {

    @GetMapping("/test")
    public String name() {
        return "this is from client-1";
    }
}

2. 服务调用者集成 openfeign

pom 文件：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.test</groupId>
    <artifactId>eureka-customer</artifactId>
    <version>1.0.0</version>
    <packaging>jar</packaging>

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

    <repositories>
        <repository>
            <id>spring-milestones</id>
            <name>Spring Milestones</name>
            <url>https://repo.spring.io/milestone</url>
            <snapshots>
                <enabled>false</enabled>
            </snapshots>
        </repository>
    </repositories>

    <dependencies>

        <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>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>   <!-- openfeign 依赖 -->

    </dependencies>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR11</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>


</project>

服务调用接口 ClientService 声明：

@FeignClient(name = "eureka-client", fallback = ClientServiceFallback.class)
@Component
public interface ClientService {

    @GetMapping(value = "/client/test")
    String getClientService();

}

其中 fallback 参数是服务熔断（服务提供者服务故障）需要调用的类，在类面实现了 ClientService 所有的接口，ClientServiceFallback 实现如下：

@Component
public class ClientServiceFallback implements ClientService {

    public String getClientService() {
        return "服务出现故障......";
    }

}

测试接口文件：

@RestController
@RequestMapping("/customer")
public class ControllerTest {

    @Autowired
    ClientService clientService;

    @GetMapping("/test")
    public String get() {
        return clientService.getClientService();
    }
}

启动类加上 @EnableFeignClients 注解

配置文件加上开启 hystrix 配置，如下：

feign:
  hystrix:
    enabled: true

至此，集成完成，下面开始测试。

3. 测试服务调用和熔断

依次开启注册中心、服务提供者、服务调用者，浏览器输入 http://localhost:8003/customer/test，显示：

关闭服务提供者，刷新页面：

再次打开服务提供者，调用又恢复正常。

4.openfeign 常用参数

value、name：作用一样，如果没有配置url那么配置的值将作为服务名称，用于服务发现。反之只是一个名称。

url：用于配置指定服务的地址，相当于直接请求这个服务。

path：定义当前FeignClient访问接口时的统一前缀，比如接口地址是/user/get, 如果你定义了前缀是user, 那么具体方法上的路径就只需要写/get 即可。

fallback：定义容错的处理类。

contextId：我们不想将所有的调用接口都定义在一个类中，有一种解决方案就是为每个Client手动指定不同的contextId，这样就不会冲突了。

qualifier：对应的是@Qualifier注解

5.常见配置参数

feign:
  client:
    config:
      default: #这里就是指的所有被加载的默认FeignClient实现的服务配置都生效
        connectTimeout: 1000
        readTimeout: 3000

6.最新版本说明

如果你用的是阿里的那套 springcloud 解决方案，ribbon可能不生效（消费降级不生效），需要引入如下配置：

        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-sentinel</artifactId>
        </dependency>

并且再配置文件中声明：

feign:
  sentinel:
    enabled: true