Fegin的使用

Fegin的使用

Spring Cloud Fegin是什么

• Spring Cloud NetFix的微服务都是以HTTP接口的形式暴露的（现在一般都是json），所以可以使用Apache的HttpClient或Spring的RestTemplate去调用
• 而Fegin是一个使用起来更加方便的客户端，它用起来就好像调用本地方法一样，完全感觉不到时调用远程方法
• Fegin是一个声明式的Web Service客户端，它的目的就是让Web Service调用更加简单。Fegin提供了HTTP请求的模板，通过编写简单的接口和插入注解（Dao/Sevice 层），就可以定义好HTTP请求的参数、格式、地址等信息
• Fegin会完全代理HTTP请求，我们只需要像调用方法（1.注入 2.使用 像Controller层调用Service层）一样调用它就可以完成服务请求及相关处理
• Fegin整合了Ribbon和Hystrix，可以让我们不再需要显式的使用这两个组件
  Fegin的工作原理
• 在开发微服务应用时，我们会在主程序入口添加 @EnableFeignClients注解开启对 Feign Client 扫描加载处理。根据 Feign Client 的开发规范，定义接口并加 @FeignClient 注解
• 当程序启动时，会进行包扫描，扫描所有 @FeignClient 的注解的类，并将这些信息注入 Spring IOC 容器中。当定义的 Fegin 接口中的方法被调用时，通过 JDK代理 的方式，来生成具体的 RequestTemplate。当生成代理时，Fegin 会为每个接口方法创建一个 RequestTemplate对象，该对象封装了HTTP请求需要的全部信息。
• 然后有 RequestTemplate 生成 Request，然后把 Request 交给 Client 去处理，这里指的 Client 可以是 JDK 原生的 URLConnection、Apache 的 Http Client 也可以是 OKhttp。 最后 Client 被封装到 LoadBalanceclient 类，这各类结合 Ribbon 负载均衡发起服务之间的调用

@FeginClient的一些重要注解

• name：指定 Fegin Client的名称，如果项目使用了 Eureka，name 属性会作为微服务的名称，用于服务发现
• url：url 一般用于调试，可以手动指定 @FeginClient 调用地址
• decode404：当发生404错误时，如果该字段为 true，会调用 decoder 进行解码，否则抛出 FeginException。
• configuration：Fegin 配置类，可定义 Fegin 的 Encoder、Decoder、LogLevel、Contract。
• fallback：定义容错的处理类，当调用远程接口失败或超时时，会调用对应接口的容错逻辑，fallback 指定的类必须实现 @FeginClient 标记的接口
• fallbackFactory：工厂类，用于生成 fallback 类示例，通过这个属性我们可以实现每个接口通用的容错逻辑，减少重复的代码。
• path：定义当前 FeginClient 的统一前缀。

下面一个简单的实例代码

依赖：

	<dependencies>
	     <!--spring-cloud依赖-->
	     <dependency>
	         <groupId>org.springframework.cloud</groupId>
	         <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
	     </dependency>
	     <!--openfeign依赖-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
            <version>2.2.2.RELEASE</version>
        </dependency>
	</dependencies>
	

    <!--spring-cloud 依赖管理-->
    <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>

application.properties

#配置端口号
server.port=8082

#配置名称
spring.application.name=requestUrlConsumer-eureka-feign
#配置eureka 客户端
#服务器地址
eureka.client.service-url.defaultZone=http://localhost:8761/eureka

#配置 feign
feign.client.config.feignName.connectTimeout=5000
feign.client.config.feignName.readTimeout=5000

核心启动类

package com.hp.weather_microservice;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients
public class WeatherMicroServiceApplication {

    public static void main(String[] args) {
        SpringApplication.run(WeatherMicroServiceApplication.class, args);
    }

}

jdk代理类

@FeignClient("cityProvider-eureka") // @FeignClient注解使用
public interface GetCityJson {
    @GetMapping("/city_data/city")
    public List<CityObj> getCities();
}