当前位置:   article > 正文

OpenFeign微服务调用组件!!!_微服务的服务调用组件

微服务的服务调用组件

1.Feign是什么

GitHub - OpenFeign/feign: Feign makes writing java http clients easierFeign makes writing java http clients easier. Contribute to OpenFeign/feign development by creating an account on GitHub.icon-default.png?t=N7T8https://github.com/OpenFeign/feignFeign是Netflix开发的声明式、模板化的HTTP客户端, Feign可以帮助我们更快捷、优雅地调用HTTP API,目的是让编写HTTP接口的客户端变得更简洁和直接。

在Spring Cloud中,使用Feign非常简单——创建一个接口,并在接口上添加一些注解,代码就完成了。Feign支持多种注解,例如Feign自带的注解或者JAX-RS注解等。

Feign是一个声明式的Web服务客户端,让编写Web服务客户端变的更加容易。只需要创建一个接口并添加注解即可

优势:

Feign可以做到使用 HTTP 请求远程服务时就像调用本地方法一样的体验,开发者完全感知不到这是远程方法,更感知不到这是个 HTTP 请求,开发者无需关注与远程的交互细节,更无需关注分布式环境开发。

2.OpenFeign

Feign 和 OpenFeign 的区别(精简记忆版)?

1.支持spring mvc 注解

2.整合了更多的扩展 (请求重试策略、超时控制、请求拦截器

3.Spring Cloud Alibaba快速整合OpenFeign

准备工作:创建一个模块,用来提供服务:

  1. <dependency>
  2. <groupId>com.alibaba.cloud</groupId>
  3. <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>cn.hutool</groupId>
  7. <artifactId>hutool-all</artifactId>
  8. </dependency>
  1. server.port=8080
  2. spring.application.name=order-service-app
  3. spring.cloud.nacos.discovery.server-addr=192.168.11.91:8848
  1. /*
  2. * Copyright (c) 2020, 2024, All rights reserved.
  3. *
  4. */
  5. package com.by.controller;
  6. import cn.hutool.core.thread.ThreadUtil;
  7. import com.by.model.OrderQuery;
  8. import com.by.model.OrderingDTO;
  9. import org.springframework.web.bind.annotation.*;
  10. import java.math.BigDecimal;
  11. /**
  12. * <p>Project: spring-could-alibaba-root - OrderController</p>
  13. * <p>Powered by scl On 2024-04-25 11:26:56</p>
  14. * <p>描述:<p>
  15. *
  16. * @author 孙臣龙 [1846080280@qq.com]
  17. * @version 1.0
  18. * @since 17
  19. */
  20. @RestController
  21. @RequestMapping("/api/order")
  22. public class OrderController {
  23. @GetMapping("/ordering")
  24. public String ordering() throws InterruptedException {
  25. //睡眠15s用来验证请求处理超时时间
  26. ThreadUtil.safeSleep(15000);
  27. return "下单成功";
  28. }
  29. @GetMapping("/ordering1")
  30. public OrderingDTO ordering1() {
  31. OrderingDTO orderingDTO = OrderingDTO.builder().id(10086L).needPay(BigDecimal.valueOf(100)).build();
  32. return orderingDTO;
  33. }
  34. @PostMapping("/ordering2")
  35. public OrderingDTO ordering2(@RequestBody OrderingDTO orderingDTO) {
  36. return orderingDTO;
  37. }
  38. @GetMapping("/select")
  39. public String select(OrderQuery orderingDTO) {
  40. String msg="";
  41. if (orderingDTO.getId()!=null){
  42. msg="根据id查询成功,id:"+orderingDTO.getId();
  43. }
  44. if (orderingDTO.getName()!=null){
  45. msg="根据name查询成功,name:"+orderingDTO.getName();
  46. }
  47. return msg;
  48. }
  49. }

 服务调用方操作下列内容:

        1)引入依赖

  1. <!-- openfeign 远程调用 -->
  2. <dependency>
  3. <groupId>org.springframework.cloud</groupId>
  4. <artifactId>spring-cloud-starter-openfeign</artifactId>
  5. </dependency>

        2)编写调用接口+@FeignClient注解

  1. /*
  2. * Copyright (c) 2020, 2024, All rights reserved.
  3. *
  4. */
  5. package com.by.feign;
  6. import com.by.config.FeignConfig;
  7. import com.by.model.OrderQuery;
  8. import com.by.model.OrderingDTO;
  9. import org.springframework.cloud.openfeign.FeignClient;
  10. import org.springframework.cloud.openfeign.SpringQueryMap;
  11. import org.springframework.web.bind.annotation.GetMapping;
  12. import org.springframework.web.bind.annotation.PostMapping;
  13. import org.springframework.web.bind.annotation.RequestBody;
  14. import org.springframework.web.bind.annotation.RequestMapping;
  15. /**
  16. * <p>Project: spring-could-alibaba-root - UserService</p>
  17. * <p>Powered by scl On 2024-04-25 15:57:48</p>
  18. * <p>描述:<p>
  19. *
  20. * @author 孙臣龙 [1846080280@qq.com]
  21. * @version 1.0
  22. * @since 17
  23. */
  24. //@FeignClient(name = "order-service-app",configuration = FeignConfig.class)
  25. @FeignClient(name = "order-service-app")
  26. @RequestMapping("/api/order")
  27. public interface UserService {
  28. // @GetMapping("/api/order/ordering")
  29. @GetMapping("/ordering")
  30. String ordering();
  31. @GetMapping("/ordering1")
  32. OrderingDTO ordering1();
  33. @PostMapping("/ordering2")
  34. OrderingDTO ordering2(@RequestBody OrderingDTO orderingDTO);
  35. @GetMapping("/select")
  36. String select(@SpringQueryMap OrderQuery orderingDTO);
  37. }

        3)调用端在启动类上添加@EnableFeignClients注解

  1. package com.by;
  2. import org.springframework.boot.SpringApplication;
  3. import org.springframework.boot.autoconfigure.SpringBootApplication;
  4. import org.springframework.cloud.openfeign.EnableFeignClients;
  5. @SpringBootApplication
  6. @EnableFeignClients
  7. public class UserService01Application {
  8. public static void main(String[] args) {
  9. SpringApplication.run(UserService01Application.class, args);
  10. }
  11. }

        4)发起调用,像调用本地方法一样调用远程服务

  1. /*
  2. * Copyright (c) 2020, 2024, All rights reserved.
  3. *
  4. */
  5. package com.by.controller;
  6. import com.by.feign.UserService;
  7. import com.by.model.OrderQuery;
  8. import com.by.model.OrderingDTO;
  9. import org.springframework.beans.factory.annotation.Autowired;
  10. import org.springframework.web.bind.annotation.GetMapping;
  11. import org.springframework.web.bind.annotation.PostMapping;
  12. import org.springframework.web.bind.annotation.RequestMapping;
  13. import org.springframework.web.bind.annotation.RestController;
  14. import org.springframework.web.client.RestTemplate;
  15. import java.math.BigDecimal;
  16. /**
  17. * <p>Project: spring-could-alibaba-root - UserController</p>
  18. * <p>Powered by scl On 2024-04-25 15:59:27</p>
  19. * <p>描述:<p>
  20. *
  21. * @author 孙臣龙 [1846080280@qq.com]
  22. * @version 1.0
  23. * @since 17
  24. */
  25. @RestController
  26. @RequestMapping("/api/user")
  27. public class UserController {
  28. @Autowired
  29. private UserService orderService;
  30. @Autowired
  31. private RestTemplate restTemplate;
  32. @GetMapping("/shopping")
  33. public String shopping() {
  34. // String forObject = restTemplate.getForObject("http://nacos-a/api/nacos-a/test", String.class);
  35. String ordering = orderService.ordering();
  36. return "";
  37. }
  38. @GetMapping("/shopping1")
  39. public String shopping1() {
  40. OrderingDTO orderingDTO = orderService.ordering1();
  41. return "";
  42. }
  43. @PostMapping("/shopping2")
  44. public String shopping2() {
  45. OrderingDTO orderingDTO1 = OrderingDTO.builder().id(1L).needPay(BigDecimal.valueOf(100)).build();
  46. OrderingDTO orderingDTO = orderService.ordering2(orderingDTO1);
  47. return "";
  48. }
  49. @GetMapping("/select")
  50. public String select() {
  51. //String select = orderService.select(OrderQuery.builder().id(1).build());
  52. String select = orderService.select(OrderQuery.builder().name("scl").build());
  53. return "";
  54. }
  55. }

        5)配置类

  1. /*
  2. * Copyright (c) 2020, 2024, All rights reserved.
  3. *
  4. */
  5. package com.by.config;
  6. import feign.Logger;
  7. import feign.Request;
  8. import org.springframework.context.annotation.Configuration;
  9. /**
  10. * <p>Project: spring-could-alibaba-root - FeignConfig</p>
  11. * <p>Powered by scl On 2024-04-25 15:23:34</p>
  12. * <p>描述:<p>
  13. *
  14. * @author 孙臣龙 [1846080280@qq.com]
  15. * @version 1.0
  16. * @since 17
  17. */
  18. @Configuration
  19. public class FeignConfig {
  20. //配置日志
  21. //@Bean
  22. Logger.Level level() {
  23. return Logger.Level.FULL;
  24. }
  25. //配置超时时间
  26. // @Bean
  27. public Request.Options options() {
  28. return new Request.Options(5000, 10000);
  29. }
  30. }
  1. /*
  2. * Copyright (c) 2020, 2024, All rights reserved.
  3. *
  4. */
  5. package com.by.config;
  6. import org.springframework.cloud.client.loadbalancer.LoadBalanced;
  7. import org.springframework.context.annotation.Bean;
  8. import org.springframework.context.annotation.Configuration;
  9. import org.springframework.http.client.HttpComponentsClientHttpRequestFactory;
  10. import org.springframework.web.client.RestTemplate;
  11. /**
  12. * <p>Project: spring-could-alibaba-root - RestTemplateA</p>
  13. * <p>Powered by scl On 2024-04-23 11:23:50</p>
  14. * <p>描述:<p>
  15. *
  16. * @author 孙臣龙 [1846080280@qq.com]
  17. * @version 1.0
  18. * @since 17
  19. */
  20. @Configuration
  21. public class RestTemplateA {
  22. @Bean
  23. @LoadBalanced
  24. public RestTemplate restTemplate() {
  25. RestTemplate restTemplate = new RestTemplate();
  26. restTemplate.setRequestFactory(new HttpComponentsClientHttpRequestFactory());
  27. return restTemplate;
  28. }
  29. }

        6)用到的DTO

  1. @Data
  2. @AllArgsConstructor
  3. @NoArgsConstructor
  4. @Builder
  5. public class OrderQuery {
  6. private Integer id;
  7. private String name;
  8. }
  1. @Data
  2. @AllArgsConstructor
  3. @NoArgsConstructor
  4. @Builder
  5. public class OrderingDTO {
  6. private Long id;
  7. private BigDecimal needPay;
  8. }

         7)Get 传递对象?

4.高级配置

Feign 提供了很多的扩展机制,让用户可以更加灵活的使用。

4.1 日志配置

有时候我们遇到 Bug,比如接口调用失败、参数没收到等问题,或者想看看调用性能,就需要配置 Feign 的日志了,以此让 Feign 把请求信息输出来。

Feign 提供了日志打印功能,我们可以通过配置来调整日志级别,从而了解 Feign 中 Http 请求的细节。说白了就是对Feign接口的调用情况进行监控和输出

通过源码可以看到日志等级有 4 种,分别是:

  • NONE【性能最佳,适用于生产】:不记录任何日志(默认值)。

  • BASIC【适用于生产环境追踪问题】:仅记录请求方法、URL、响应状态代码以及执行时间。

  • HEADERS:记录BASIC级别的基础上,记录请求和响应的header。

  • FULL【比较适用于开发及测试环境定位问题】:记录请求和响应的header、body和元数据。

4.1.1 全局配置

注意一:此处配置@Configuration注解就会全局生效,如果想指定对应某一个服务生效,就不能配置.

注意二: 因为feign调试日志是debug级别输出,springboot默认的日志级别是info,所以feign的debug日志级别就不会输出,一定要结合

logging.level.com.beiyou = debug

  1. @Configuration
  2. public class FeignConfig
  3. {
  4. @Bean
  5. Logger.Level feignLoggerLevel()
  6. {
  7. return Logger.Level.FULL;
  8. }
  9. }

4.1.2 局部配置

局部配置,让调用的微服务生效,在@FeignClient 注解中指定使用的配置类

4.1.3 在配置文件配置

  1. logging.level.com.beiyou = debug开启日志
  2. ##配置feign 的日志级别
  3. #-- default 全局配置
  4. feign.client.config.default.loggerLevel=NONE
  5. #-- nacos-a 具体服务名
  6. feign.client.config.nacos-a.loggerLevel=FULL

4.2 超时配置

通过 Options 可以配置连接超时时间和读取超时时间

4.2.1 全局配置

  1. @Configurationpublic class FeignConfig {
  2. @Bean public Request.Options options() {
  3. return new Request.Options(10L, TimeUnit.SECONDS, 60L,TimeUnit.SECONDS,true);
  4. }}

Java

4.2.2 配置文件中配置

  1. #全局配置feign.client.config.default.connectTimeout=5000
  2. feign.client.config.default.readTimeout=10000
  3. 这里default 是一个特殊的客户端名称,用于表示全局配置。设置 connectTimeout 和 readTimeout 属性的值来定义全局的连接超时时间和读取超时时间。
  4. #局部配置 请将 <clientName> 替换为实际的Feign客户端名称。feign.client.config.<clientName>.connectTimeout=5000
  5. feign.client.config.<clientName>.readTimeout=10000
  6. feign.client.config.order-service.connectTimeout=5000 # 连接超时时间,默认10s order-service: #对应微服务feign.client.config.order-service.readTimeout=10000 # 请求处理超时时间,默认60s

补充说明: Feign的底层用的是Ribbon,但超时时间以Feign配置为准

04-OpenFeign-请求超时机制_openfeign.timeout-CSDN博客文章浏览阅读876次,点赞27次,收藏7次。基于 2021.0.1版本 具体有以下几种超时参数设置以下仅限2021.0.1 以前的版本,高于该版本的spring cloud 已修复该问题。_openfeign.timeouthttps://blog.csdn.net/xcg340123/article/details/136021389

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/Li_阴宅/article/detail/1005758
推荐阅读
相关标签
  

闽ICP备14008679号