深入微服务-SpringCloud调用组件Feign

前言

本系列带着大家深入微服务 Spring体系的各个框架的底层原理。上一篇文章介绍了SpringBoot自动装配原理,本节将带着大家熟悉下SpringCloud体系的调用组件Feign

---

Feign是什么

• Feign是一个声明式 Web 服务客户端。它使编写 Web 服务客户端更容易
• 它具有可插入的注解支持，包括 Feign 注解和 JAX-RS 注解
• Feign 还支持可插拔的编码器和解码器
• 对 Spring MVC 注解的支持，并支持使用HttpMessageConvertersSpring Web 中默认使用的注解
• Spring Cloud 集成了 Eureka、Spring Cloud CircuitBreaker 以及 Spring Cloud LoadBalancer,使用 Feign 时提供负载均衡的 http 客户端

---

SpringCloud整合Feign

加入pom依赖

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

启用Feign客户端

@SpringBootApplication
@EnableFeignClients
public class Application {

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

创建一个 Spring Cloud LoadBalancer client

@FeignClient("demo")
public interface DemoFeignClient {
    @RequestMapping(method = RequestMethod.GET, value = "/getDemo")
    DemoDTO getDemo();
}

rpc调用client

@RestController
@RequestMapping("/remote")
public class RemoteService {

    @Autowired
    DemoFeignClient demoFeignClient;

    @RequestMapping(value = "/getRemoteDemo")
    public DemoDTO   getRemoteDemo() {
        DemoDTO  result = demoFeignClient.getDemo();
        return result;
    }
}

Feign 核心配置

超时配置

相关配置解释：

connectTimeout ：建立连接所用的超时时间

readTimeout ：从连接建立时开始，并在返回响应的时间

1)针对feign配置

feign:
    client:
        config:
            feignName:
                connectTimeout: 5000
                readTimeout: 5000

2)通用配置

feign:
    client:
        config:
            default:
                connectTimeout: 5000
                readTimeout: 5000

拦截器配置

可以使用feign的拦截器功能实现接口的验证、鉴权功能

1)Basic认证

@Configuration
public class DemoFeignConfiguration {
    @Bean
    public BasicAuthRequestInterceptor basicAuthRequestInterceptor() {
        return new BasicAuthRequestInterceptor("user", "password");
    }
}

2)自定义拦截器实现
需要实现接口RequestInterceptor

public interface RequestInterceptor {

  /**
   * Called for every request. Add data using methods on the supplied {@link RequestTemplate}.
   */
  void apply(RequestTemplate template);
}

2.1)请求头放上TOKEN认证信息

public class UserInfoRequestInterceptor implements RequestInterceptor {

    public void apply(RequestTemplate template) {
        template.header("USER-INFO", "TOKEN");
    }
}

2.2)将配置添加到feign

feign:
    client:
        config:
            feignName:
                connectTimeout: 5000
                readTimeout: 5000
                requestInterceptors:
                    - com.example.UserInfoRequestInterceptor

日志配置

Feign使用过程中需要打印日志可以实现Fegin的Logger功能,可以打印http的调用链路用于功能调试。

1)Logger.Level 级别：

• NONE，无日志记录（默认）
• BASIC, 只记录请求方法和 URL 以及响应状态码和执行时间。
• HEADERS,记录基本信息以及请求和响应标头
• FULL, 记录请求和响应的标头、正文和元数据

2）配置
2.1) yaml配置

logging:
  level:
    com.example.feign.DemoFeign: debug

2.2) Config配置

@Configuration
public class FeignConfiguration {
    @Bean
    Logger.Level feignLoggerLevel() {
        return Logger.Level.FULL;
    }
}

@FeignClient 常用属性

• name：指定FeignClient的名称
• url:指定@FeignClient调用的地址，可用于线上调试
• configuration: Feign配置类
• fallback: 请求错误回调的处理类
• path: 指定FeignClient的统一前缀