SpringCloud服务调用OpenFeign的使用

开发微服务,免不了需要服务间调用,而OpenFeign就是调用其他微服务的一个框架。

以前不同微服务的调用使用的是restTemplate这个组件,也就是将下面的bean纳入到IOC容器:

//    @LoadBalanced//开启负载均衡,默认是轮循
    @Bean
    public RestTemplate getRestTemplate(){
     
        return new RestTemplate();
    }

首先说说这样做有哪些不方便的地方:(都是个人的想法)

  • 1.不符合java的开发习惯(一般Controller是调用Service接口来实现具体功能的)
  • 2.逻辑复杂,不便于开发和维护。

因为存在上面这样的一些问题,于是OpenFeign应运而生,下面具体讲一下OpenFeign是怎么使用的!
注:本项目使用的是Eureka作为服务注册中心,且调用所需的微服务的controller为下面的板块

//!!!!!!!!注意该项目的spring.application.name=cloud-payment-service
    @GetMapping(value = "/payment/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id){
     
        Payment payment = paymentService.getPaymentById(id);
        log.info("****插入结果 :"+payment);
        if (payment!=null){
     
            return new CommonResult(200,"查询成功,serverPort: "+serverPort,payment);
        }else {
     
            return new CommonResult(444,"没有对应记录,查询ID:"+id,null);
        }
    }

下面正式讲解如何使用!


第一步:引入jar包依赖

 		
        <dependency>
            <groupId>org.springframework.cloudgroupId>
            <artifactId>spring-cloud-starter-openfeignartifactId>
        dependency>

第二步:配置项目中的yml文件

server:
  port: 80

eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka   #集群版

第三步:主启动类上加上下面的注解

SpringCloud服务调用OpenFeign的使用_第1张图片

第四步:编写Service层(只需要写接口,无需写实现类),注意添加下面的注解

SpringCloud服务调用OpenFeign的使用_第2张图片
其实Service这个接口里面的方法就是把要调用微服务Controller的方法复制一下就行:

@GetMapping(value = "/payment/get/{id}")
CommonResult<Payment> getPaymentById(@PathVariable("id") Long id); 
//该行代码复制 cloud-provider-payment8001的controller

第五步:编写该客户端的Controller,调用刚刚写的service

@RestController
@Slf4j
public class OrderFeignController {
     
    @Resource
    private PaymentFeignService paymentFeignService;

    @GetMapping(value = "/consumer/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
     
        return paymentFeignService.getPaymentById(id);
    }
}

至此,OpenFeign即搭建完成,可以运行了。






OpenFeign的请求超时问题

下面说说这样的问题:OpenFeign如果调用一个请求时间过长的方法,比如下面的微服务方法:

    @GetMapping(value = "payment/feign/timeout")//故意暂停3s的程序
    public String paymentFeignTimeout(){
     
        try{
     
            TimeUnit.SECONDS.sleep(3);
        }catch (InterruptedException e){
     
            e.printStackTrace();
        }
        return serverPort;
    }

使用openFeign调用该方法时,就会出现下面的报错异常,意思就是请求超时了!
SpringCloud服务调用OpenFeign的使用_第3张图片
其原因就是openfeign-ribbon:客户端默认只等待1s,超过1s就直接抛出异常,解决方法就是在yml文件中添加下面的配置,用于设置ribbon的超时时间

#设置Feign客户端的超时时间(OpenFeign默认支持Ribbon)
ribbon:
  #指的是建立连接所有的时间,适用于网络状态正常的情况下,两端连接所用的时间
  ReadTimeout: 5000
  #指的是建立连接后从服务器读取到可用资源的时间
  ConnectTimeout: 5000






给OpenFeign添加日志:

书写下面的配置类,主要是添加下面的那个Bean

package org.lzl.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;
    }

    //Feign的日志级别:
    /*
     * NONE: 默认的,不显示任何日志
     * BASIC: 仅记录请求方式,URL、响应状态码及执行时间
     * HEADERS: 除了BASIC中定义的信息之外,还有请求和响应的头信息
     * FULL: 除了HEADERS中定义的信息之外,还有请求与响应的正文及元数据
     */
}

然后在yml中写下面的配置,以后每次请求,都会有日志

logging:
  level:
    #feign日志以什么级别监控哪个接口
    org.lzl.springcloud.service.PaymentFeignSerice: debug

SpringCloud服务调用OpenFeign的使用_第4张图片

你可能感兴趣的:(SpringCloud,spring,java)