springcloud:OpenFeign服务接口调用

springcloud

openFeign

今天又是新的组件学习啦! ! !
链接:源码仓库

Feign是什么?

​ Feign是一个声明式的web服务客户端，让编写web服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可.

Feign能干什么?

使用Feign可以让我们在编写java HTTP客户端的时候变得更加的容易

我们在之前的项目中使用的是Ribbon + Resttemplate的时候,利用Resttemplate对请求的封装处理,形成了一套模版话的调用方法,但是实际开发中,由于对服务的依赖调用可能不止一处**,往往一个接口要被多处调用,所以通常都会针对每个微服务自行封装一些客户端类来包装**.**这个依赖服务的调用.**所以,Feign在此基础上,做了进一步的封装,由他来帮助我们定义和实现依赖服务接口的定义.在Feign的实现下,**我们只需要创建一个接口并使用注解的方式来配置他(以前是dao接口上面标注mapper注解,现在是一个微服务接口上面标注一个Feign注解即可),**即可完成对服务提供方的接口绑定,简化了使用spring cloud ribbon 时候,自动封装服务调用客户端的开发量

同时Feign集成了Ribbon

利用Ribbon维护了Payment的服务列表信息,并且通过轮询实现了客户端的负载均衡.而与Ribbon不同的是.通过feign只需要定义服务绑定的接口且以声明式的方法,简单的实现了服务的调用

这个时候有人要提问了

我们学习openFeign和Feign有什么区别嘛,

区别如下

也就是说,我们要使用openFeign需要使用

接口+注解的方式来开发:微服务调用接口+@FeignClient

使用之前强调一点,也是官方文档说的,fegin 在消费端使用

前置知识强调完之后我们开始编码吧!

老规矩,新建一个模块: cloud-consumer-feign-order80

导入相关的依赖

  <!--openfeign-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>com.atguigu.springcloud</groupId>
            <artifactId>cloud-api-commons</artifactId>
            <version>${project.version}</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

底下的依赖是平常的使用的,主要是第一个依赖

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

之后编写配置文件:编写端口和Eureka的相关配置

server:
  port: 80
eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka, http://eureka7002.com:7002/eureka

我们可以学习的时候就发现,我们每次接触到新的组件,主启动类就会多一个新的注解@EnableFeignClients

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

之后就编写业务类就可以了

业务逻辑接口+@FeignClient配置调用provider服务

新建服务层接口

@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {
    @GetMapping("/payment/get/{id}")
    public CommonResult getPaymentByid(@PathVariable("id") long id);
    @GetMapping(value = "/payment/feign/timeout")
    public String paymentFeignTimeout();
}

@FeignClient(value = "CLOUD-PAYMENT-SERVICE")这里是我们需要使用fegin来调用的服务提供者的,服务名称

编写控制层之后测试

@RestController
public class openFeginController {
    @Resource
    private PaymentFeignService paymentFeignService;


    @GetMapping("/consumer/payment/get/{id}")
    public CommonResult getPaymentByid(@PathVariable("id") long id){
        System.out.println(id);
        return paymentFeignService.getPaymentByid(id);
    }
    @GetMapping(value = "/consumer/payment/feign/timeout")
    public String paymentFeignTimeout(){
        return paymentFeignService.paymentFeignTimeout();
    }
}

测试

• 先启动2个eureka集群7001/7002
• 再启动2个微服务8001/8002
• 启动OpenFeign启动
• http://localhost/consumer/payment/get/1
• Feign自带负载均衡配置项

这里是调用的服务名称的对应和服务调用的地址

OpenFeign超时控制

场景演示

超时设置，故意设置超时演示出错情况

服务提供方8001故意写暂停程序

@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout(){
    try { TimeUnit.SECONDS.sleep(3); }catch (Exception e) {e.printStackTrace();}
    return serverPort;
}
 

服务消费方80添加超时方法PaymentFeignService

@GetMapping(value = "/payment/feign/timeout")
public String paymentFeignTimeout();

服务消费方80添加超时方法OrderFeignController

@GetMapping(value = "/consumer/payment/feign/timeout")
public String paymentFeignTimeout(){
   return paymentFeignService.paymentFeignTimeout();
}
 

测试方法

访问延时方法:http://localhost/consumer/payment/feign/timeout

错误页面:

OpenFeign默认等待一秒钟，超过后报错,因为集成了ribbon,默认超过一秒钟就会超时

怎么配置呢 ? :我们在yml中配置ribbon的超时即可

ribbon:
  ReadTimeout:  5000
  ConnectTimeout: 5000

OpenFeign日志打印功能

feign支持日志打印功能

我们可以通过日志来获取到feign的http请求中的细节

对使用了feign的接口调用情况监控和输出

opnefeign的日志级别

要使用opnefeign的日志

我们需要去配置config

package com.atguigu.springcloud.config;

import feign.Logger;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class FeignConfig {

    @Bean
    Logger.Level feignLoggerLevel(){
        return Logger.Level.FULL;
    }
}

之后在yml配置日志的级别

logging:
  level:
    com.hyc.springcloud.service.PaymentFeignService: debug

之后查看日志内容