【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用)
作者:mmseoamin日期:2023-12-05

【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第1张

🏆 作者简介,愚公搬代码

🏆《头衔》:华为云特约编辑,华为云云享专家,华为开发者专家,华为产品云测专家,CSDN博客专家,阿里云专家博主,阿里云签约作者,腾讯云优秀博主,腾讯云内容共创官,掘金优秀博主,51CTO博客专家等。

🏆《近期荣誉》:2022年CSDN博客之星TOP2,2022年华为云十佳博主等。

🏆《博客内容》:.NET、Java、Python、Go、Node、前端、IOS、Android、鸿蒙、Linux、物联网、网络安全、大数据、人工智能、U3D游戏、小程序等相关领域知识。

🏆🎉欢迎 👍点赞✍评论⭐收藏

文章目录

  • 🚀前言
  • 🚀一、Feign远程调用
    • 🔎1.Feign替代RestTemplate
      • 🦋1.1 引入依赖
      • 🦋1.2 添加注解
      • 🦋1.3 编写Feign的客户端
      • 🦋1.4 测试
      • 🔎2.自定义配置
        • 🦋2.1 配置文件方式
        • 🦋2.2 Java代码方式
        • 🔎3.Feign使用优化
        • 🔎4.最佳实践
          • 🦋4.1 继承方式
          • 🦋4.2 抽取方式
          • 🦋4.3 实现基于抽取的最佳实践
            • ☀️4.3.1 抽取
            • ☀️4.3.2 在order-service中使用feign-api
            • ☀️4.3.3 重启测试
            • 🚀感谢:给读者的一封信

🚀前言

微服务架构中,不同的服务之间需要相互通信来完成任务。其中一种常见的通信方式是远程调用。远程调用是指在不同的服务之间进行函数调用,而这些服务运行在不同的计算机、进程或容器中。

常见的微服务远程调用方式有:

  1. REST API:基于 HTTP 协议实现,通过发送 HTTP 请求来调用服务,并通过 JSON 或 XML 等格式传递数据。

  2. gRPC:基于 Google 的开源 RPC 框架实现,支持多种语言,并使用 Protocol Buffers 作为数据格式,提供了更高效的数据传输和更简单的接口定义。

  3. AMQP:基于消息队列实现,使用消息进行服务之间的通信,可保证消息的可靠性和可恢复性。

  4. Apache Thrift:开源的跨语言 RPC 框架,可生成多种语言的代码库,并支持多种数据传输协议,如 TCP、HTTP、ZLIB、FRAMED 等。

  5. Socket:原始的方式,通过套接字进行通信,在性能上有一定优势,但需要自行处理数据格式和协议。

🚀一、Feign远程调用

用RestTemplate发起远程调用的代码:

【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第2张

存在下面的问题:

  • 代码可读性差,编程体验不统一
  • 参数复杂URL难以维护

    Feign是一个声明式的http客户端,官方地址:https://github.com/OpenFeign/feign

    其作用就是帮助我们优雅的实现http请求的发送,解决上面提到的问题。

    【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第3张

    🔎1.Feign替代RestTemplate

    🦋1.1 引入依赖

    我们在order-service服务的pom文件中引入feign的依赖:

    
    
        org.springframework.cloud
        spring-cloud-starter-openfeign
    
    

    🦋1.2 添加注解

    在order-service的启动类添加注解开启Feign的功能:

    【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第4张

    🦋1.3 编写Feign的客户端

    在order-service中新建一个接口,内容如下:

    package cn.itcast.order.client;
    import cn.itcast.order.pojo.User;
    import org.springframework.cloud.openfeign.FeignClient;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.PathVariable;
    @FeignClient("userservice")
    public interface UserClient {
        @GetMapping("/user/{id}")
        User findById(@PathVariable("id") Long id);
    }
    

    这个客户端主要是基于SpringMVC的注解来声明远程调用的信息,比如:

    • 服务名称:userservice
    • 请求方式:GET
    • 请求路径:/user/{id}
    • 请求参数:Long id
    • 返回值类型:User

      这样,Feign就可以帮助我们发送http请求,无需自己使用RestTemplate来发送了。

      🦋1.4 测试

      修改order-service中的OrderService类中的queryOrderById方法,使用Feign客户端代替RestTemplate:

      【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第5张

      运行

      【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第6张

      🔎2.自定义配置

      Feign可以支持很多的自定义配置,如下表所示:

      类型作用说明
      feign.Logger.Level修改日志级别包含四种不同的级别:NONE、BASIC、HEADERS、FULL
      feign.codec.Decoder响应结果的解析器http远程调用的结果做解析,例如解析json字符串为java对象
      feign.codec.Encoder请求参数编码将请求参数编码,便于通过http请求发送
      feign. Contract支持的注解格式默认是SpringMVC的注解
      feign. Retryer失败重试机制请求失败的重试机制,默认是没有,不过会使用Ribbon的重试

      一般情况下,默认值就能满足我们使用,如果要自定义时,只需要创建自定义的@Bean覆盖默认Bean即可。

      下面以日志为例来演示如何自定义配置。

      🦋2.1 配置文件方式

      基于配置文件修改feign的日志级别可以针对单个服务,可以在order-service中添加:

      feign:  
        client:
          config: 
            userservice: # 针对某个微服务的配置
              loggerLevel: FULL #  日志级别 
      

      也可以针对所有服务:

      feign:  
        client:
          config: 
            default: # 这里用default就是全局配置,如果是写服务名称,则是针对某个微服务的配置
              loggerLevel: FULL #  日志级别 
      

      如下图所示:

      【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第7张

      而日志的级别分为四种:

      • NONE:不记录任何日志信息,这是默认值。
      • BASIC:仅记录请求的方法,URL以及响应状态码和执行时间
      • HEADERS:在BASIC的基础上,额外记录了请求和响应的头信息
      • FULL:记录所有请求和响应的明细,包括头信息、请求体、元数据。

        🦋2.2 Java代码方式

        也可以基于Java代码来修改日志级别,先声明一个类,然后声明一个Logger.Level的对象:

        public class DefaultFeignConfiguration  {
            @Bean
            public Logger.Level feignLogLevel(){
                return Logger.Level.BASIC; // 日志级别为BASIC
            }
        }
        

        如果要全局生效,将其放到启动类的@EnableFeignClients这个注解中:

        @EnableFeignClients(defaultConfiguration = DefaultFeignConfiguration.class) 
        

        如果是局部生效,则把它放到对应的@FeignClient这个注解中:

        @FeignClient(value = "userservice", configuration = DefaultFeignConfiguration .class) 
        

        优先级配置文件要高于代码声明式,如果想验证新的需先注释配置文件中的配置项

        🔎3.Feign使用优化

        Feign底层发起http请求,依赖于其它的框架。其底层客户端实现包括:

        • URLConnection:默认实现,不支持连接池

        • Apache HttpClient :支持连接池

        • OKHttp:支持连接池

          因此提高Feign的性能主要手段就是使用连接池代替默认的URLConnection。

          这里我们用Apache的HttpClient来演示。

          1)引入依赖

          在order-service的pom文件中引入Apache的HttpClient依赖:

          
          
              io.github.openfeign
              feign-httpclient
          
          

          2)配置连接池

          在order-service的application.yml中添加配置:

          feign:
            client:
              config:
                default: # default全局的配置
                  loggerLevel: BASIC # 日志级别,BASIC就是基本的请求和响应信息
            httpclient:
              enabled: true # 开启feign对HttpClient的支持
              max-connections: 200 # 最大的连接数
              max-connections-per-route: 50 # 每个路径的最大连接数
          

          运行测试

          【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第8张

          🔎4.最佳实践

          🦋4.1 继承方式

          一样的代码可以通过继承来共享:

          1)定义一个API接口,利用定义方法,并基于SpringMVC注解做声明。

          2)Feign客户端和Controller都集成改接口

          【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第9张

          优点:

          • 简单
          • 实现了代码共享

            缺点:

            • 服务提供方、服务消费方紧耦合

            • 参数列表中的注解映射并不会继承,因此Controller中必须再次声明方法、参数列表、注解

              🦋4.2 抽取方式

              将Feign的Client抽取为独立模块,并且把接口有关的POJO、默认的Feign配置都放到这个模块中,提供给所有消费者使用。

              例如,将UserClient、User、Feign的默认配置都抽取到一个feign-api包中,所有微服务引用该依赖包,即可直接使用。

              【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第10张

              🦋4.3 实现基于抽取的最佳实践

              ☀️4.3.1 抽取

              首先创建一个module,命名为feign-api:

              【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第11张

              在feign-api中然后引入feign的starter依赖

              
              
                  
                      cloud-demo
                      cn.itcast.demo
                      1.0
                  
                  4.0.0
                  feign-api
                  
                      8
                      8
                  
                  
                      
                          org.springframework.cloud
                          spring-cloud-starter-openfeign
                      
                  
              
              

              然后,order-service中编写的UserClient、User、DefaultFeignConfiguration都复制到feign-api项目中

              【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第12张

              ☀️4.3.2 在order-service中使用feign-api

              首先,删除order-service中的UserClient、User、DefaultFeignConfiguration等类或接口。

              在order-service的pom文件中中引入feign-api的依赖:

              
              
                  cn.itcast.demo
                  feign-api
                  1.0
              
              

              修改order-service中的所有与上述三个组件有关的导包部分,改成导入feign-api中的包

              • 删除order-service中的User类
              • 更新依赖:cn.itcast.order.pojo.Order
              • 更新依赖:cn.itcast.order.client.UserClient
              • 更新依赖:cn.itcast.order.service.OrderService

                以下调整均在启动类中增加

                方式一:

                指定Feign应该扫描的包:

                @EnableFeignClients(basePackages = "cn.itcast.feign.clients")
                

                方式二:

                指定需要加载的Client接口(注意引包是:feign-api下的别引错了):

                @EnableFeignClients(clients = {UserClient.class})
                
                ☀️4.3.3 重启测试

                【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第13张


                🚀感谢:给读者的一封信

                亲爱的读者,

                我在这篇文章中投入了大量的心血和时间,希望为您提供有价值的内容。这篇文章包含了深入的研究和个人经验,我相信这些信息对您非常有帮助。

                如果您觉得这篇文章对您有所帮助,我诚恳地请求您考虑赞赏1元钱的支持。这个金额不会对您的财务状况造成负担,但它会对我继续创作高质量的内容产生积极的影响。

                我之所以写这篇文章,是因为我热爱分享有用的知识和见解。您的支持将帮助我继续这个使命,也鼓励我花更多的时间和精力创作更多有价值的内容。

                如果您愿意支持我的创作,请扫描下面二维码,您的支持将不胜感激。同时,如果您有任何反馈或建议,也欢迎与我分享。

                【愚公系列】2023年11月 Java教学课程 188-SpringCloud(Feign远程调用),在这里插入图片描述,第14张

                再次感谢您的阅读和支持!

                最诚挚的问候, “愚公搬代码”