SpringCLoud OpenFeign的使用介绍

于 2024-07-24 19:00:00 发布
阅读量1.1k 收藏 15
点赞数 17
分类专栏： 微服务 文章标签： spring cloud spring 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/Mwt258/article/details/140646556
版权

Spring Cloud OpenFeign使用介绍

文章目录

导引

在之前的文章中，我们使用过RestTemplate来进行远程调用：

@Service
public class OrderServiceImpl implements OrderService {

    @Autowired
    private OrderMapper orderMapper;

    @Autowired
    private RestTemplate restTemplate;
    @Override
    public OrderInfo selectOrderById(Integer orderId) {
        OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
        String url = "http://product-service/product/" + orderInfo.getProductId();
        ProductInfo productInfo = restTemplate.getForObject(url, ProductInfo.class);
        orderInfo.setProductInfo(productInfo);
        return orderInfo;
    }
}

虽说RestTemplate对HTTP封装后已经比直接使用HTTPClient简单方便很多，但还是存在这一些问题：

  • 需要拼接URL，灵活性高，但是封装臃肿，当URL复杂时则容易出错
  • 代码可读性差，风格不统一

于是，我们可以使用OpenFeign来更”优雅“的实现远程通信！

1. 简单介绍

OpenFeign是一个声明式的Web Service 客户端，它让微服务之间的调用变得更加简单，类似于controller调用service，只需要创建一个接口，然后添加注解即可使用OpenFeign：

OpenFeign 官方文档：GitHub - OpenFeign/feign: Feign makes writing java http clients easier

2. 操作方式

当前代码基于Nacos配置完成的基础上进行编写【代码获取】：

  1. 先给order-service(哪个实例需要进行远程调用就给谁加)引入依赖

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

  2. 在order-service的启动类上添加注解@EnableFeignClients，开启OpenFeign功能

    package com.order;

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

@EnableFeignClients
@SpringBootApplication
public class OrderServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderServiceApplication.class, args);
    }
}

  3. 编写OpenFeign的客户端(接口)，且只需进行方法声明，基于SpringMVC的注解来声明远程调用的信息

    package com.order.api;

import com.order.model.ProductInfo;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.cloud.openfeign.SpringQueryMap;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.Date;

@FeignClient(value = "product-service" , path = "/product")
public interface ProductApi {

    @RequestMapping("/{productId}")
    ProductInfo getProductById(@PathVariable("productId") Integer productId);

}

    注：

    • value：指定FeignClient的名称，也就是微服务的名称，用于服务发现
    • path：定义当前FeignClient的统一前缀

  4. 修改远程调用的方法

    package com.order.service.Impl;

import com.order.api.ProductApi;
import com.order.mapper.OrderMapper;
import com.order.model.OrderInfo;
import com.order.model.ProductInfo;
import com.order.service.OrderService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

@Service
public class OrderServiceImpl implements OrderService {

    @Autowired
    private OrderMapper orderMapper;

    @Autowired
    private RestTemplate restTemplate;

    @Autowired
    private ProductApi productApi;
    @Override
    public OrderInfo selectOrderById(Integer orderId) {
        OrderInfo orderInfo = orderMapper.selectOrderById(orderId);
//        String url = "http://product-service/product/" + orderInfo.getProductId();
//        ProductInfo productInfo = restTemplate.getForObject(url, ProductInfo.class);
        ProductInfo productInfo = productApi.getProductById(orderInfo.getProductId());
        orderInfo.setProductInfo(productInfo);
        return orderInfo;
    }
}

完成上述配置后，启动服务，访问接口测试远程调用：

在这里插入图片描述

远程调用测试成功，同时远程调用的代码也变的更加简洁了！

3. 参数传递

在上述例子中，介绍了从Feign从URL中获取参数，接下来介绍Feign参数传递的其它方式.

3.1 传递单个参数

服务提供方 product-service (ProductController)

package com.product.controller;

import com.product.service.model.ProductInfo;
import com.product.service.ProductService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Date;

@Slf4j
@RequestMapping("/product")
@RestController
public class ProductController {

    @RequestMapping("p1")
    public String p1(Integer id) {
        return "p1接受单个参数Id = " + id;
    }
}

Feign客户端

package com.order.api;

import com.order.model.ProductInfo;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.cloud.openfeign.SpringQueryMap;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;

import java.util.Date;

@FeignClient(value = "product-service" , path = "/product")
public interface ProductApi {
    
    @RequestMapping("/p1")
    String p1(@RequestParam("id") Integer id);
    
}

注：@RequestParam作参数绑定，不能省略

服务消费方 order-service (FeignController)

package com.order.controller;

import com.order.api.ProductApi;
import com.order.model.ProductInfo;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@RequestMapping("/feign")
@RestController
public class FeignController {

    @Autowired
    private ProductApi productApi;

    @RequestMapping("/o1")
    public String o1(Integer id) {
        log.info("调用o1");
        return productApi.p1(id);
    }
}

测试远程调用：http://127.0.0.1:8080/feign/o1?id=5

在这里插入图片描述

3.2 传递多个参数

使用多个@RequestParam进行参数绑定即可

服务提供方 product-service (ProductController)

@RequestMapping("p2")
public String p2(Integer id, String productName) {
    return "p2接收多个参数：id = " + id + " productName = " + productName;
}

Feign客户端

@RequestMapping("p2")
String p2(@RequestParam("id") Integer id, @RequestParam("productName") String productName);

服务消费方 order-service (FeignController)

@RequestMapping("/o2")
public String o2(Integer id, String productName) {
    log.info("调用o2");
    return productApi.p2(id, productName);
}

这里我们使用Postman进行远程调用测试：

在这里插入图片描述

3.3 传递对象

服务提供方 product-service (ProductController)

@RequestMapping("/p3")
public String p3(ProductInfo productInfo) {
    // 这里我们只给对象传入 id 和 productName，剩下的由内部封装如下
    productInfo.setProductPrice(99);
    productInfo.setState(0);
    productInfo.setCreateTime(new Date(System.currentTimeMillis()));
    productInfo.setUpdateTime(new Date(System.currentTimeMillis()));
    return productInfo.toString();
}

Feign客户端

@RequestMapping("/p3")
String p3(@SpringQueryMap ProductInfo productInfo);

注：传入对象参数的话需要加上注解 @SpringQueryMap

服务消费方 order-service (FeignController)

@RequestMapping("/o3")
public String o3(ProductInfo productInfo) {
    log.info("调用o3");
    return productApi.p3(productInfo);
}

进行远程调用测试：

在这里插入图片描述

3.4 传递JSON类型参数

服务提供方 product-service (ProductController)

@RequestMapping("/p4")
public String p4(@RequestBody ProductInfo productInfo) {
    productInfo.setProductPrice(99);
    productInfo.setState(0);
    productInfo.setCreateTime(new Date(System.currentTimeMillis()));
    productInfo.setUpdateTime(new Date(System.currentTimeMillis()));
    return productInfo.toString();
}

Feign客户端

@RequestMapping("/p4")
String p4(@RequestBody ProductInfo productInfo);

服务消费方 order-service (FeignController)

@RequestMapping("/o4")
    public String o4(@RequestBody ProductInfo productInfo) {
        log.info("调用o4");
        return productApi.p4(productInfo);
    }
}

进行远程调用测试：

在这里插入图片描述

4. 最佳实践

最佳实践，其实就是经过历史的迭代，在项目的实际过程中总结出来的最好的使用方式。

在上文配置Feign客户端时也能看出，它与服务提供方的代码非常相似：

在这里插入图片描述

如果需要在每个模块中都配置重复的代码，一旦数量上来则会造成一定的代码冗余！

对此我们可以对其做出简化，将Feign的客户端抽取为一个独立的模块，并把涉及到的实体类等都放在这个模块中，打成一个jar包，消费方只需要依赖该jar包即可(jar包通常由服务提供方来实现)

具体操作如下：

  1. 先创建一个模块 product-api

    在这里插入图片描述

  2. 给刚创建的模块product-api引入依赖

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

  3. 复制ProductApi、ProductInfo 到 product-api模块中

    在这里插入图片描述

  4. 通过Maven将该模块打包到本地Maven仓库

    在这里插入图片描述

    在这里插入图片描述

    在这里插入图片描述

  5. 删除 order-service 中的ProductApi与ProductInfo

  6. 为服务消费方 order-service引入依赖

    <dependency>
    <groupId>org.example</groupId>
    <artifactId>product-api</artifactId>
    <version>1.0-SNAPSHOT</version>
	<scope>compile</scope>
</dependency>

    会出现报错信息，此时需要修改项目中ProductApi与ProductInfod 路径为 product-api中的路径

  7. 给服务消费方 order-service启动类添加扫描路径

    @EnableFeignClients(basePackages = {“com.api”}, clients = {ProductApi.class})

    其中basePackages为扫描路径，clients为需要加载的Feign客户端

    package com.order;

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

@EnableFeignClients(basePackages = {"com.api"}, clients = {ProductApi.class})
@SpringBootApplication
public class OrderServiceApplication {
    public static void main(String[] args) {
        SpringApplication.run(OrderServiceApplication.class, args);
    }
}

完成上述配置后即可进行远程测试调用:

在这里插入图片描述

注：若需要将服务部署到服务器上，需要修改服务消费方的pom文件，因为其使用了部署在本地Maven仓库的jar包：

<dependency>
     <groupId>org.example</groupId>
     <artifactId>product-api</artifactId>
     <version>1.0-SNAPSHOT</version>
<!--  <scope>compile</scope>-->
     <scope>system</scope>
     <systemPath>D:/maven_test/.m2/repository/org/example/product-api/1.0-SNAPSHOT/product-api-1.0-SNAPSHOT.jar</systemPath>
</dependency>

<plugins>
    <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
      <configuration>
          <includeSystemScope>true</includeSystemScope>
      </configuration>
    </plugin>
</plugins>

以上便是对OpenFeign的使用介绍了！！如果内容对大家有帮助的话请给这篇文章一个三连关注吧💕( •̀ ω •́ )✧( •̀ ω •́ )✧✨

&梧桐树夏
关注
  • 17
    点赞
  • 踩
  • 15
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
【springcloud 微服务】springcloud openfeign使用详解
congge_study的博客
05-14 6598
springcloud openfeign使用详解
SpringCloud之OpenFeign的使用
爱晴禹
11-04 419
Feign是Netflix开源的声明式HTTP客户端feign默认是不打印任何日志的，但是如果想要打印一些日志信息。比如调用的时间。级别打印日志内容NONE（默认值)不记录任何日志BASIC仅记录请求方法、URL、响应状态代码以及执行时间HEADERS记录BASIC级别的基础上，记录请求和响应的headerFULL记录请求和响应的header、body和元数据让父子上下文ComponentScan重叠（强烈不建议使用）/*** 日志级别。
SpringCloud - OpenFeign使用
java123456111的博客
06-06 3153
OpenFeign的使用首先肯定得依赖Spring Cloud，作为Alibaba微服务架构，以下依赖必不可少。 2、消费端开启Feign服务调用 在订单服务（dt-order-service）启动器上开启Feign的服务调用，以此来调用库存服务端的接口方法。 @EnableFeignClients ：开启服务调用 在默认情况下，OpenFeign默认的日志是关闭的，在我们开发过程中，需要调试接口，或者看看调用性能，就需要配置OpenFeign的日志，把OpenFeign的调用日志清晰的打印出来，方
spring cloud openfeign 使用入门
灵波微布
12-23 472
如下图所示，直接使用 ribbon+RestTemplate 完成微服务之间的方法调用存在一些问题，例如代码冗余、服务地址修改会增加维护成本等等，那有没有更优雅的方式呢？答案是肯定的，spring cloud提供了 openfeign 来帮我们解决上述的问题。 SpringCloud OpenFeign 简介 Spring Cloud OpenFeign 是声明式、模板化的HTTP客户端，可以更加便捷、优雅的调用HTTP API。它整合了 Ribbon 和 Eureka 以提供负载均衡的服务调用及基于 H
SpringCloud使用OpenFeign
培根芝士的专栏
07-08 1054
OpenFeign是一种声明式、模板化的HTTP客户端。使用OpenFeign能让编写Web Service客户端更加简单。使用时只需定义服务接口，然后在上面添加注解。OpenFeign也支持可拔插式的编码和解码器。Spring cloud对Feign进行了封装，使其支持MVC注解和HttpMessageConverts。和Eureka和Ribbon组合可以实现负载均衡。OpenFeign默认将Ribbon作为负载均衡器，直接内置了 Ribbon。在导入OpenFeign 依赖后无需专门导入Ribbon 依
05Spring Cloud OpenFeign：基于Ribbon和Hystrix的声明式服务调用1
08-04
在本篇文章中，我们将对 Spring Cloud OpenFeign 进行详细介绍，讨论其在声明式服务调用中的应用，包括与 Ribbon 和 Hystrix 的集成。 什么是 Spring Cloud OpenFeign？ Spring Cloud OpenFeign 是一个声明式的...
Spring Cloud OpenFeign 使用示例
08-10
Spring Cloud OpenFeign 示例代码工程。该工程基于官方示例（https://github.com/spring-cloud-samples/feign-eureka），额外添加了注册中心模块feign-eureka-central（eureka is running on http://localhost:8761...
微服务 Springcloud OpenFeign
06-02
在Spring Cloud体系中，OpenFeign是一个关键组件，它提供了一种声明式的方式来实现服务之间的调用，使得编写分布式系统如同调用本地方法一样简单。本文将详细探讨Spring Cloud OpenFeign的相关知识点，帮助初学者更...
spring cloud openfeign 源码实例解析
08-25
Spring Cloud OpenFeign 是基于 Spring Boot 和 Netflix 的 OpenFeign 框架实现的客户端负载均衡器，本文将对 Spring Cloud OpenFeign 源码进行实例解析，通过示例代码对其进行详细介绍，对大家的学习或者工作具有...
SpringCloud之OpenFeign
qq_36813853的博客
04-29 873
OpenFeign是一个声明式的Web服务客户端，只需创建一个Rest接口并在该接口添加注解@FeignClient即可。OpenFeign基本上就是当前微服务之间调用的事实标准。
Spring Cloud 系列之OpenFeign：(5)OpenFeign的高级用法
weigeshikebi的博客
02-04 2077
Spring Cloud，OpenFeign
Spring Cloud 之 Open Feign
最新发布
qq_66292058的博客
05-21 2403
本篇主要介绍微服务远程调用的的另一种方式OpenFeign。
SpringCloud Alibaba微服务 -- OpenFeign的使用（保姆级）
知道的越多 不知道的就越多
07-04 8772
openfeign的使用、springcloud微服务之间的调用，fallback的使用
SpringCloud-OpenFeign官方文档使用大全详解
秃了也弱了
03-31 3706
Feign是一个声明式的web服务客户端，让编写web服务客户端变得非常容易，只需创建一个接口并在接口上添加注解即可。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持了Spring MVC标准注解和HttpMessageConverters。Feign可以与Eureka和Ribbon组合使用以支持负载均衡。
Spring Cloud（三）--OpenFeign服务接口调用
qq_52434217的博客
03-24 961
微服务框架中OpenFeign的简单用法。
SpringCloud - OpenFeign 参数传递和响应处理（全网最详细）
CYK_byte的博客
11-10 6296
因为 openfeign 是 伪HttpClient 对象，我们在远程调用他的客户端提供的接口时，并不知道你到底是路径传参还是问号传参，因此需要通过注解的方式来指明传参方式（就像 Spring Web 一样，只不过 Spring Web 中如果没指明传参类型，底层会按默认方式走，而 openfeign 则没有）.然而，需要注意的是，OpenFeign 只能处理简单的 Java 对象和 Map 对象，对于复杂的 Java 对象或包含特殊类型的对象，可能无法自动进行正确的序列化和反序列化。
Spring Cloud OpenFeign 中文手册 菜鸡翻译
m0_60453176的博客
03-18 750
这样，等真的沉下心来学习，不至于被找资料分散了心神。另外，给大家安排了一波学习面试资料：以上就是本文的全部内容，希望对大家的面试有所帮助，祝大家早日升职加薪迎娶白富美走上人生巅峰！望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。**[外链图片转存中…(img-ZUdXI0IW-1710739501767)][外链图片转存中…(img-7VAUGuq9-1710739501768)][外链图片转存中…(img-RUIthRnO-1710739501768)]
SpringCloud之OpenFeign入门与实战系列
qq_63218110的博客
03-05 1125
本文主要介绍OpenFeign的超时重试机制，以及如何自定义超时重试机制。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值