Spring Cloud OpenFeign基本使用

Spring Cloud OpenFeign是什么

Ribbon + RestTemplate

Ribbon + RestTemplate是一套RESTful风格的Http服务客户端，两者结合可以实现服务调用和负载均衡，在实际开发中，由于对服务依赖的调用可能不止一处，往往一个服务接口会被多次调用，为了避免直接在控制层内直接使用 RestTemplate远程调用，通常都会针对每个微服务自行封装一些客户端类来包装对这些依赖服务的调用（一个微服务的调用封装到一个业务层的接口中，在业务层中使用 RestTemplate远程调用，并实现负载均衡）。

Feign是什么

Feign是Spring Cloud组件中一个声明式WebService客户端，旨在使编写Java Http客户端变得更加容易。其内置了Ribbon，是对Ribbon + RestTemplate的进一步封装，由它来帮我们定义和实现依赖服务接口，我们只需要创建一个业务层接口并使用注解的方式来配置它（我们不需要再像上面一样手动实现封装的接口，包括调用和负载均衡处理，这些工作Feign会扫描注解并通过动态代理的方式产生实现类，实现类中已经帮我们把这些事情都做好了），即可完成对服务提供方的接口绑定（一个业务层类绑定一个微服务）。

OpenFeign简述

OpenFeign是Spring Cloud在Feign的基础上支持了Spring MVC的注解，如@RequestMapping等， OpenFeign的@FeignClient可以解析Spring MVC的注解。

OpenFeign简单使用演示

pom.xml

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

application.yaml

server:
  port: 80
spring:
  application:
    name: cloud-openfeign-order
eureka:
  client:
    register-with-eureka: false
    fetch-registry: true
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka #采用Eureka作为服务注册中心，这里是服务注册中心的地址

启动类

@SpringBootApplication
@EnableEurekaClient //开启EurekaClient客户端
@EnableFeignClients //开启FeignClients
public class ApplicationContextMain80 {

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

业务类

定义业务接口绑定远程微服务调用

@Component
@FeignClient("CLOUD-PAYMENT") //@FeignClient注解表明该接口是一个调用服务的接口，绑定一个远程微服务，CLOUD-PAYMENT是微服务名称
public interface PaymentService {//接口名随意取
    @GetMapping("/payment/{id}")//该方法对应CLOUD-PAYMENT微服务里的一个接口，该方法方法名随意取，但参数和返回值必须和要调用的远程接口一致
    public CommonResult<Payment> getPaymentById(@PathVariable("id") int id);
}

控制层直接调用业务接口

@RestController
public class OrderController {

    @Autowired
    PaymentService paymentService;

    @GetMapping("/order/openfeign/payment/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") int id){
        return  paymentService.getPaymentById(id);
    }
}

OpenFeign配置连接时间和请求资源的时间

feign:
  client:
    config:
      default:
        ConnectTimeOut: 5000 #允许的最长连接时间，秒为单位
        ReadTimeOut: 5000 #允许的最长请求资源时间

OpenFeign配置日志

显示Http调用的信息，包括请求信息和响应信息
需要两步：1.配置日志显示内容 2.配置日志显示级别

配置日志显示内容

有四种显示内容

显示内容	说明
NONE	默认，不显示任何日志
BASIC	仅记录请求方法、URL、响应状态码以及执行时间
HEADERS	除了BASIC中定义的信息外，还有请求和响应的头信息
FULL	除了HEADERS中定义的信息外，还有请求和响应的正文及元数据

@Configuration
public class LoggerConfig {
    @Bean
    public Logger.Level loggerLevel(){
        return Logger.Level.FULL;
    }
}

配置日志显示级别

logging:
  level:
    com.fl.demo.service.PaymentService: debug #被@FeignClient注解的业务接口全类名: 日志显示级别，定制该业务接口特定的显示级别