SpringCloud中集成OpenFeign实现服务调用

Dear 丶 2023-09-30 13:36 50阅读 0赞

## 场景 ##

SpringCloud中集成Eureka实现服务注册(单机Eureka构建)：

[SpringCloud中集成Eureka实现服务注册(单机Eureka构建)\_霸道流氓气质的博客-CSDN博客][SpringCloud_Eureka_Eureka_-CSDN]

SpringCloud中集成Eureka实现集群部署服务注册与服务提供者：

[SpringCloud中集成Eureka实现集群部署服务注册与服务提供者\_霸道流氓气质的博客-CSDN博客][SpringCloud_Eureka_-CSDN]

SpringCloud中集成Eureka时通过Discovery实现服务发现：

[SpringCloud中集成Eureka时通过Discovery实现服务发现\_霸道流氓气质的博客-CSDN博客][SpringCloud_Eureka_Discovery_-CSDN]

在上面使用Eureka作为服务注册与发现时进行过集群搭建并测试了负载均衡的调用。

SpringCloud中集成Ribbon实现负载均衡以及修改负载均衡规则和轮询算法原理分析：

[SpringCloud中集成Ribbon实现负载均衡以及修改负载均衡规则和轮询算法原理分析\_霸道流氓气质的博客-CSDN博客][SpringCloud_Ribbon_-CSDN]

并且使用了Ribbon进行服务调用。

下面通过OpenFeign实现服务调用。

### OpenFeign ###

Feign是一个声明式WebService客户端。

使用Feign能让编写Web Service客户端更加简单。

它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支持可插拔式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。Feign也可以Eureka和Rabbion组合使用以支持负载均衡。

Github:

[GitHub - spring-cloud/spring-cloud-openfeign: Support for using OpenFeign in Spring Cloud apps][GitHub - spring-cloud_spring-cloud-openfeign_ Support for using OpenFeign in Spring Cloud apps]

### Feign能干啥 ###

Feign旨在使编写的Java Http 客户端变得更加容易。

前面在使用Ribbon + RestTemplate时，利用RestTemplate对http请求的封装处理，形成了一套模板化的调用方法。

但是在实际开发中，由于对服务依赖的调用可能不止一处，往往一个接口会被多处调用，所以通常都会针对每个微服务自行封装一些客户端类

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

在Feign的实现下，我们只需要创建一个接口并使用注解的方式来配置它(以前是Dao接口上面标注Mapper注解，现在是一个微服务接口上面标注一个

Feign注解即可)，即可完成对服务提供方的接口绑定，简化了使用SpringCloudRibbon时，自动封装服务调用客户端的开发量。

### Feign集成了Ribbon ###

![42efd52f3d72c0d6768a2bb21b560f48.png][]

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

通过feign只需要定义服务绑定接口且以声明式的方法，优雅而简单的实现了服务调用。

注：

博客：  
[霸道流氓气质的博客\_CSDN博客-C\#,架构之路,SpringBoot领域博主][CSDN_-C_SpringBoot]  
关注公众号  
霸道的程序猿  
获取编程相关电子书、教程推送与免费下载。

## 实现 ##

1、参考上面的新建子模块的流程，新建cloud-consumer-feign-order88消费者子模块

![85a097b203e38a833c3288b9eac545c1.png][]

2、添加pom依赖

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

这里使用Eureka作为服务注册中心，所以还需要添加Eureka的依赖

<dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>

其他依赖根据自己需要，完整Pom

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0"
             xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <parent>
            <artifactId>SpringCloudDemo</artifactId>
            <groupId>com.badao</groupId>
            <version>1.0-SNAPSHOT</version>
        </parent>
        <modelVersion>4.0.0</modelVersion>
    
        <artifactId>cloud-consumer-feign-order88</artifactId>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
        </properties>
    
        <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.badao</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>
        </dependencies>
    </project>

3、新建application.yml

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

配置项目端口号以及Eureka集群的Server地址

4、新建主启动类并添加@EnableFeignClients注解

package com.badao.springclouddemo;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cloud.openfeign.EnableFeignClients;
    
    
    @SpringBootApplication
    @EnableFeignClients
    public class OrderFeignMain88
    {
        public static void main(String[] args) {
                SpringApplication.run(OrderFeignMain88.class, args);
        }
    }

5、新建service包，包下新建service用来实现服务调用

package com.badao.springclouddemo.service;
    
    
    import com.badao.springclouddemo.entities.CommonResult;
    import com.badao.springclouddemo.entities.Payment;
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.stereotype.Component;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    
    @Component
    @FeignClient(value = "CLOUD-PAYMENT-SERVICE")
    public interface PaymentFeignService
    {
        @GetMapping(value = "/payment/get/{id}")
        public CommonResult<Payment> getPaymentById(@PathVariable("id") Long id);
    
    }

注意这里要在service上添加@FeignClient注解，并且value值就是服务名，服务名就是注册进Eureka的服务别名。

然后这里服务消费者接口调用的注解以及路径和服务提供者Controller的接口一致。

6、然后新建Controller，用来实现对service进行调用

package com.badao.springclouddemo.controller;
    
    
    import com.badao.springclouddemo.entities.CommonResult;
    import com.badao.springclouddemo.entities.Payment;
    import com.badao.springclouddemo.service.PaymentFeignService;
    import lombok.extern.slf4j.Slf4j;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RestController;
    
    import javax.annotation.Resource;
    
    
    @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);
        }
    
    }

7、启动Eureka集群7001和7002以及服务提供者8001和8002，然后启动88服务消费者。

调用88的接口查看效果

![e2cdfd87204dadbfd33597a4710459e7.gif][]

[SpringCloud_Eureka_Eureka_-CSDN]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124688609
[SpringCloud_Eureka_-CSDN]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124710576
[SpringCloud_Eureka_Discovery_-CSDN]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124725905
[SpringCloud_Ribbon_-CSDN]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/124802698
[GitHub - spring-cloud_spring-cloud-openfeign_ Support for using OpenFeign in Spring Cloud apps]: https://github.com/spring-cloud/spring-cloud-openfeign
[42efd52f3d72c0d6768a2bb21b560f48.png]: https://img-blog.csdnimg.cn/img_convert/42efd52f3d72c0d6768a2bb21b560f48.png
[CSDN_-C_SpringBoot]: https://blog.csdn.net/badao_liumang_qizhi
[85a097b203e38a833c3288b9eac545c1.png]: https://img-blog.csdnimg.cn/img_convert/85a097b203e38a833c3288b9eac545c1.png
[e2cdfd87204dadbfd33597a4710459e7.gif]: https://img-blog.csdnimg.cn/img_convert/e2cdfd87204dadbfd33597a4710459e7.gif