关于springcloud:NacosOpenFegin正确调用服务的姿势

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 的升级版，它们的关系如下图所示：

因为 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 是用在服务生产端的，有生产端就得有服务提供端，它们的关系如下图所示：
   
   所以咱们先要创立一个服务提供者 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);
    }
   }

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

   注意事项

   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 客户端拜访服务，就会呈现如下报错信息：
   
   
   解决方案：通过批改配置文件中的超时时长，也就是手动调节接口的超时时长来解决此问题，因为 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