Nacos+OpenFegin正确调用服务的姿势！

分类：Spring Cloud作者：磊哥|www.javacn.site

Nacos 支持两种 HTTP 服务请求，一个是 REST Template，另一个是 Feign Client。之前的文章咱们介绍过 Rest Template 的调用方式，主要是通过 Ribbon（负载均衡） + RestTemplate 实现 HTTP 服务调用的，请求的核心代码是这样的：

@RestController
public class ConsumerController {
    @Resource
    private RestTemplate restTemplate;
    @GetMapping("/consumer")
    public String consumer(@RequestParam String name) {
        // 请求并获取结果（springcloud-nacos-provider 是 nacos 中的服务id）
        String result = restTemplate.getForObject("http://springcloud-nacos-provider/call/" + name, String.class);
        return result;
    }
}

从上述的实现代码我们可以看出一个问题，虽然以上代码可以实现 HTTP 服务调用，但需要开发者手动拼接调用地址和参数，并且远程服务调用和客户端自身的业务逻辑实现是混合在一起，不利于后期的维护与扩展，那如何要解决这个问题呢？这就是我们今天要介绍的 OpenFeign 的原因了。

OpenFeign 介绍

OpenFeign 的全称是 Spring Cloud OpenFeign，它是 Spring 官方推出的一种声明式服务调用和负载均衡组件。它的出现就是为了替代已经进入停更维护状态的 Feign（Netflix Feign）的。也就是说 OpenFeign（Spring Cloud OpenFeign）是 Feign 的升级版，它们的关系如下图所示：

image.png


因为 Feign 停更维护了，所以 Spring 官方需要推出了一个新的新的框架来对 Feign 功能进行升级和扩展。

OpenFeign 常用注解

OpenFeign 声明式服务调用和负载均衡组件，因此它的核心是使用注解 + 接口的方式实现服务调用，所以了解 OpenFeign 的注解就至关重要了。
对于 Feign 框架来说，它只支持 Feign 注解和 JAX-RS 注解，但 OpenFeign 在 Feign 的基础上还增加了对 Spring MVC 注解的支持，例如 @RequestMapping、@GetMapping 和 @PostMapping 等注解。
OpenFeign 常用注解有以下几个：

  1. @EnableFeignClients：该注解用于开启 OpenFeign 功能，当 Spring Cloud 应用启动时，OpenFeign 会扫描标有 @FeignClient 注解的接口，生成代理并注册到 Spring 容器中。
  2. @FeignClient：该注解用于通知 OpenFeign 组件对 @RequestMapping 注解下的接口进行解析，并通过动态代理的方式产生实现类，实现负载均衡和服务调用。
  3. @RequestMapping：向服务提供者发起 Request 请求（默认为 GET 方式请求），这里需要注意 @RequestMapping/@GetMapping/@PostMapping 和 Spring MVC 中的同名注解的含义是完全不同的。
  4. @GetMapping：向服务提供者发起 GET 请求。
  5. @PostMapping：向服务提供者发起 POST 请求。

OpenFeign 使用

OpenFeign 是用在服务消费端的，有消费端就得有服务提供端，它们的关系如下图所示：

image.png


所以我们先要创建一个服务提供者 Provider，创建步骤如下。

创建服务提供者

第一步：先创建一个 Spring Boot 项目（Spring Cloud 项目是基于 Spring Boot 创建的），添加 spring-web 和 nacos-discovery 依赖，具体依赖信息如下：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 添加 Nacos 支持 -->
<dependency>
  <groupId>com.alibaba.cloud</groupId>
  <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

第二步：设置 Nacos 相关配置，在 application.yml 中添加以下配置：

spring:
  application:
    name: springcloud-nacos-provider # 项目名称（nacos 注册的服务名）
  cloud:
    nacos:
      discovery:
        username: nacos # nacos 登录用户名
        password: nacos666 # nacos 密码
        server-addr: 127.0.0.1:8848 # nacos 服务端地址
server:
  port: 8081 # 项目启动端口号

第三步：添加服务方法，如下代码所示：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@SpringBootApplication
@RestController
public class HttpProviderApplication {

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

    /**
     * 为客户端提供可调用的接口
     */
    @RequestMapping("/call/{name}")
    public String call(@PathVariable String name) {
        return LocalTime.now() + "——服务提供者1：" + name;
    }
}

创建服务消费者

第一步：创建一个 Spring Boot 项目，添加 spring-web、nacos-discovery 和 openfeign 依赖，具体依赖内容如下：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 添加 nacos 框架依赖 -->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!-- 添加 openfeign 框架依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>

第二步：设置 Nacos 相关配置，在 application.yml 中添加以下配置：

spring:
  application:
    name: springcloud-nacos-consumer # 项目名称（nacos 注册的服务名）
  cloud:
    nacos:
      discovery:
        username: nacos # nacos 登录用户名
        password: nacos666 # nacos 密码
        server-addr: 127.0.0.1:8848 # nacos 服务端地址
server:
  port: 8093 # 项目启动端口号

第三步：在 Spring Boot 项目的启动文件上添加 @EnableFeignClients 注解，开启 OpenFeign，具体实现代码如下：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;

@SpringBootApplication
@EnableFeignClients // 启用 OpenFeign
public class OpenfeignConsumerApplication {
    public static void main(String[] args) {
        SpringApplication.run(OpenfeignConsumerApplication.class, args);
    }
}

第四步：最重要的一步，创建 OpenFeign 与服务提供者的调用接口，实现代码如下：

import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;

@FeignClient("springcloud-nacos-provider") // nacos 服务 id
public interface SpringCloudNacosProviderClient {
    @GetMapping("/call/{name}") // 使用 get 方式，调用服务提供者的 /call/{name} 接口
    public String call(@PathVariable(value = "name") String name);
}

第五步：编写服务调用者代码，经过了上一步对服务提供者的封装之后，在控制器中我们可以像调用本地方法一样调用远程接口了，具体实现代码如下：

import com.example.openfeignconsumer.feignclient.SpringCloudNacosProviderClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import javax.annotation.Resource;

@RestController
public class ConsumerController {
    @Resource
    private SpringCloudNacosProviderClient providerClient; // 加载 openfeign client
    
    @GetMapping("/consumer")
    public String consumer(@RequestParam String name) {
        // 向调用本地方法一样，调用 openfeign client 中的方法
        return providerClient.call(name);
    }
}

然后分别启动服务提供者和服务调用者程序，执行结果如下图所示：

image.png

注意事项

OpenFeign 默认的接口超时时间为 1s，所以如果接口的执行时间超过 1s，那么程序调用就会报错。
接下来，我们编写程序测试一下，将服务提供者的代码休眠 2s，具体实现代码如下：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.time.LocalTime;
import java.util.concurrent.TimeUnit;

@SpringBootApplication
@RestController
public class HttpProviderApplication {

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

    /**
     * 为客户端提供可调用的接口
     */
    @RequestMapping("/call/{name}")
    public String call(@PathVariable String name) throws InterruptedException {
        // 让程序休眠 2s
        TimeUnit.SECONDS.sleep(2);
        return LocalTime.now() + "——服务提供者1：" + name;
    }
}

之后使用 OpenFeign 客户端访问服务，就会出现如下报错信息：

image.png


image.png


解决方案：通过修改配置文件中的超时时长，也就是手动调节接口的超时时长来解决此问题，因为 1s 确实太短了，修改的配置信息如下：

ribbon:
  ReadTimeout: 5000 # 请求连接的超时时间
  ConnectionTimeout: 10000 # 请求处理的超时时间

总结

OpenFeign 是基于 Feign 实现的，是 Spring Cloud 官方提供的注解式调用 REST 接口框架，OpenFeign/Feign 底层是基于 Ribbon 实现负载均衡的。使用 OpenFeign 有三个关键步骤，首先在 Spring Boot 启动类上使用注解 @EnableFeignClients 开启 OpenFeign；第二，使用 @FeignClient + @GetMapping/@PostMapping 调用服务提供者的接口；第三，在客户端中注入 Feign Client 对象，像调用本地方法一样调用远程接口。

项目源码

https://gitee.com/mydb/spring-cloud-alibaba-example

参考 & 鸣谢

c.biancheng.net/springcloud/open-feign.html

是非审之于己，毁誉听之于人，得失安之于数。

公众号：Java中文社群

Java面试合集：https://gitee.com/mydb/interview

原文地址：https://www.cnblogs.com/vipstone/p/16042857.html

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 dio@foxmail.com 举报，一经查实，本站将立刻删除。

相关推荐

多图|一文详解Nacos参数！
Nacos 中的参数有很多，如：命名空间、分组名、服务名、保护阈值、服务路由类型、临时实例等，那这些参数都是什么意思？又该如何设置？接下来我们一起来盘它。 1.命名空间 在 Nacos 中通过命名空间（Namespace）+ 分组（Group）+服务名（Name）可以定位到一个唯一的服务实例。 命名
Nacos+OpenFegin正确调用服务的姿势！
Nacos 支持两种 HTTP 服务请求，一个是 REST Template，另一个是 Feign Client。之前的文章咱们介绍过 Rest Template 的调用方式，主要是通过 Ribbon（负载均衡） + RestTemplate 实现 HTTP 服务调用的，请求的核心代码是这样的： @
Spring Cloud Alibaba Nacos 服务注册与发现功能实现！
Nacos 是 Spring Cloud Alibaba 中一个重要的组成部分，它提供了两个重要的功能：服务注册与发现和统一的配置中心功能。 服务注册与发现功能解决了微服务集群中，调用者和服务提供者连接管理和请求转发的功能，让程序的开发者无需过多的关注服务提供者的稳定性和健康程度以及调用地址，因为这
快速搭建 SpringCloud Alibaba Nacos 配置中心！
Spring Cloud Alibaba 是阿里巴巴提供的一站式微服务开发解决方案，目前已被 Spring Cloud 官方收录。而 Nacos 作为 Spring Cloud Alibaba 的核心组件之一，提供了两个非常重要的功能：服务注册中心（服务注册和发现）功能，和统一配置中心功能。 Nac
Spring Cloud Alibaba Nacos路由策略之保护阈值！
在 Nacos 的路由策略中有 3 个比较重要的内容：权重、保护阈值和就近访问。因为这 3 个内容都是彼此独立的，所以今天我们就单独拎出“保护阈值”来详细聊聊。 保护阈值 保护阈值（ProtectThreshold）：为了防止因过多实例故障，导致所有流量全部流入剩余健康实例，继而造成流量压力将剩余健
Nacos中服务删除不了，怎么办？
前两天遇到了一个问题，Nacos 中的永久服务删除不了，折腾了一番，最后还是顺利解决了。以下是原因分析和解决方案，建议先收藏，以备不时之需。 临时实例和持久化实例是 Nacos 1.0.0 中新增了一个特性。临时实例和持久化实例最大的区别是健康检查的方式：临时实例使用客户端主动上报的健康检查模式，而
Nacos服务注册与发现的2种实现方法！
Spring Cloud Alibaba 技术体系中的 Nacos，提供了两个重要的功能：注册中心（服务注册与发现）功能和配置中心功能。 其中注册中心解决了微服务调用中，服务提供者和服务调用者的解耦，让程序开发者可以无需过多的关注服务提供者和调用者的运行细节，只需要通过 Nacos 的注册中心就可以
Spring Cloud Ribbon 中的 7 种负载均衡策略
负载均衡通器常有两种实现手段，一种是服务端负载均衡器，另一种是客户端负载均衡器，而我们今天的主角 Ribbon 就属于后者——客户端负载均衡器。 服务端负载均衡器的问题是，它提供了更强的流量控制权，但无法满足不同的消费者希望使用不同负载均衡策略的需求，而使用不同负载均衡策略的场景确实是存在的，所以客
如何解决Spring Cloud 服务冲突问题
本篇文章为大家展示了如何解决Spring Cloud 服务冲突问题，内容简明扼要并且容易理解，绝对能使你眼前一亮，通过这篇文章的详细介绍希望你能有所收获。一、背景...
spring cloud服务的注册与发现怎么实现
本篇内容主要讲解“spring cloud服务的注册与发现怎么实现”，感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷，实用性强。下面就让小编来带大家学习“spri...
Dubbo怎么实现Spring Cloud服务治理
本篇内容介绍了“Dubbo怎么实现Spring Cloud服务治理 ”的有关知识，在实际案例的操作过程中，不少人都会遇到这样的困境，接下来就让小编带领大家学习一下如何处...
SpringCloud相关面试题有哪些
本篇内容主要讲解“SpringCloud相关面试题有哪些”，感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷，实用性强。下面就让小编来带大家学习“SpringCloud相...
如何分析Spring Cloud Ribbon、Spring Cloud Feign以及断路器
如何分析Spring Cloud Ribbon、Spring Cloud Feign以及断路器，相信很多没有经验的人对此束手无策，为此本文总结了问题出现的原因和解决方法，通过这篇文章希
springcloud微服务的组成部分有哪些
这篇文章主要讲解了“springcloud微服务的组成部分有哪些”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习“s...
SpringCloud的OpenFeign项目怎么创建
这篇文章主要讲解了“SpringCloud的OpenFeign项目怎么创建”，文中的讲解内容简单清晰，易于学习与理解，下面请大家跟着小编的思路慢慢深入，一起来研究和学习...
spring cloud oauth3整合JWT后获取用户信息不全怎么办
本篇内容主要讲解“spring cloud oauth3整合JWT后获取用户信息不全怎么办”，感兴趣的朋友不妨来看看。本文介绍的方法操作简单快捷，实用性强。下面就让小编来带...
怎样解析微服务架构SpringCloud
怎样解析微服务架构SpringCloud，针对这个问题，这篇文章详细介绍了相对应的分析和解答，希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。...
spring cloud中API网关的示例分析
这篇文章主要介绍spring cloud中API网关的示例分析，文中介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们一定要看完！一、服务网关简介1、外观模式客户端...
Spring Cloud微服务的相关问题有哪些
本篇内容介绍了“Spring Cloud微服务的相关问题有哪些”的有关知识，在实际案例的操作过程中，不少人都会遇到这样的困境，接下来就让小编带领大家学习一下如何处...
spring cloud config整合gitlab如何搭建分布式的配置中心
本文小编为大家详细介绍“spring cloud config整合gitlab如何搭建分布式的配置中心”，内容详细，步骤清晰，细节处理妥当，希望这篇“spring cloud config整合gi...
pythonJavaScriptjavaHTMLPHPreactjsC#AndroidCSSNode.jssqlrpython-3.xMysqLjQueryc++pandasFlutterangularIOSdjangolinuxswifttypescript路由器JSON路由器设置无线路由器h3c华三华三路由器设置华三路由器电脑软件教程arraysdocker软件图文教程Cvue.jslaravelspring-boot