【SpringCloud（4）】OpenFeign客户端：OpenFeign服务绑定；调用服务接口；Feign和OpenFeign

凉凉心.

发布于 2025-10-13 18:01:06

1380

文章被收录于专栏：CSDN专栏CSDN专栏

1. OpenFeign

Feign是一个WebService客户端。使用Feign能让编写WebService客户端更加简单。

它的使用方法是定义一个服务接口然后再上面添加注解。Feign也支持可拔插式的编码器和解码器。SpringCloud对Feign进行了封装，十七支持了SpringMVC标准注解和HttpMessageConverters。

Feign可用于Eureka和Ribbon组合使用以支持负载均衡

可用将Feign就是在Eureka和Ribbon之上创建的父接口

1.1 Feign能干什么？

Feign旨意在使编写JAVA http客户端变得更加容易

前面在使用Ribbon+RestTemplate时，利用restTemplate对Http请求的封装处理，形成了一套模板化的调用方法。但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类来包装这些依赖的服务。

所以，Feign在此基础上做了进一步封装，由它来帮我们定义和实现依赖服务接口的定义。

在Feign的实现下，我们只需要创建一个接口并使用注解的方式来配置它（以前是Dao接口上面标注Mapper注解，现在是一个微服务接口上标注一个Feign注解即可），即可完成对服务提供方的接口绑定，简化了使用Spring Cloud Ribbon时，自动封装服务调用客户端的开发量。

1.2 Feign集成了Ribbon

利用Ribbon维护了Payment的服务列表信息，并且通过轮询实现了客户端的负载均衡。

而与Ribbon不同的是，通过Feign只需要定义服务绑定接口且以声明式的方式，优雅而简单的实现了服务调用

1.3 Feign和OpenFeign

Feign式SpringCloud组件中的一个轻量级RESTful的HTTP服务客户端，Feign内置了Ribbon，用来做客户端负载均衡，去调用服务注册中心的服务，Feign的使用方式是：使用Feign的注解定义接口，调用这个接口，就可以调用服务注册中心的服务

OpenFeign是SpringCloud在Feign的基础上支持了SpringMVC的注解，如@RequstMapping等等。OpenFeign的@FeignClient可用解析SPringMVC的@RequestMapping注解下的接口，并通过动态代理的方式产生实现类，实现类中做负载均衡并调用其他服务

2. OpenFeign 开发

引入jar包：

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

配置yaml

server:
  port: 80
eureka:
  client:
    register-with-eureka: false
    service-url:
      defaultZone: http://eureka7001.com:7001/eureka,http://eureka7002.com:7002/eureka
ribbon:
  # 指的是建立连接所用的时间，适用于网络状况正常的情况下，两端连接所用的时间
  ReadTimeout: 5000
  # 指的是建立连接后从服务器读取到可用资源所用的时间
  ConnectTimeout: 5000

logging:
  level:
    # feign日志以什么级别监控哪个接口
    com.renex.springcloud.service.PaymentFeignService: debug

开启日志增强：

需要先创建配置类

package com.renex.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;// 配置日志为详细日志
    }
}

在主启动类上需要添加@EnableFeignClient注解

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

开发的关键就是在于Feign模块下的Service接口和controller

Service

/**
 * FeignClient 向指定的微服务中寻找对应的方法
 */
@Component
@FeignClient(value = "CLOUD-PAYMENT-SERVICE")
public interface PaymentFeignService {
   	/**
   		这个路径要对应提供者的方法路径，不可以错误
   	*/
    @GetMapping("/payment/get/{id}")
    public CommonResult getPaymentById(@PathVariable("id") Long id);
}

Controller

@Slf4j
@RestController
public class OrderFeignController {

    @Resource
    private PaymentFeignService paymentFeignService;
    
    /*
    	控制器中的方法需要调用Feign的Service接口，进而向微服务提供者模块发送请求
    	另，mapping地址也必须与提供者的Controller下的方法mapping地址一致！
    */
    @GetMapping("/payment/get/{id}")
    public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id){
        return paymentFeignService.getPaymentById(id);
    }
}

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2025-10-11，如有侵权请联系 cloudcommunity@tencent.com 删除

服务