优雅的实现服务调用 -- OpenFeign

已于 2024-10-09 23:24:02 修改
阅读量667 收藏 23
点赞数 16
分类专栏： Java Spring cloud 文章标签： spring cloud 微服务
于 2024-10-09 23:23:35 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/m0_60963435/article/details/142798767
版权

文章目录

1. RestTemplate存在问题

之前我们写过的远程调用的代码:

@Autowired
private RestTemplate restTemplate;
public OrderInfo getOrderById(int id) {
    OrderInfo orderInfo = orderMapper.getOrderById(id);
    String url = "http://product-service/product/getProductById?id=" + orderInfo.getProductId();
    ProductInfo productInfo = restTemplate.getForObject(url, ProductInfo.class);
    orderInfo.setProductInfo(productInfo);
    return orderInfo;
}
  • URL需要拼接,灵活性高,但是封装臃肿,容易出错
  • 代码可读性差,风格不统一

微服务之间的通信,通常有两种:RCP和HTTP

在Spring Cloud中,默认是使用HTTP来进行微服务的通信,最常用的实现形式有两种:

  • RestTemplate
  • OpenFeign

2. OpenFeign介绍

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

Feign是Netflix公司的一个组件,16年Netflix将Feign捐献给社区,2016年7月OpenFeign的首个版本9.0.0发布

可以理解为 Netflix Feign是Open Feign的祖先,或者说OpenFeign是NetFlix Feign的升级版

Spring Cloud Feign是Spring 对 Feign的封装,将Feign项目集成到Spring Cloud生态系统中

3. 快速上手

引入依赖

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

添加注解

在order-service的启动类添加注解@EnableFeignClients,开启OpenFeign的功能

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

编写OpenFeign的客户端

基于SpringMVC的注解来声明远程调用的信息

@FeignClient(value = "product-service",path = "/product/getProductBuId")
public interface ProductApi {
    @RequestMapping("/{id}")
    ProductInfo getProductBuId(@PathVariable("id") Integer id);
}

参数说明:

  • name/value:指定FeignClient的名称,也就是微服务的名称,用于服务发现.Feign底层会使用Spring Cloud LoadBalance进行负载均衡,也可以使用url属性指定一个具体的url
  • path:定义当前FeignClient的统一前缀

远程调用

@Service
public class OrderService {
    @Autowired
    private OrderMapper orderMapper;
    @Autowired
    private ProductApi productApi;
    @Autowired
    private RestTemplate restTemplate;
    public OrderInfo getOrderById(int id) {
        OrderInfo orderInfo = orderMapper.getOrderById(id);
//        String url = "http://product-service/product/getProductById?id=" + orderInfo.getProductId();
        ProductInfo productInfo = productApi.getProductById(orderInfo.getProductId());
        orderInfo.setProductInfo(productInfo);
        return orderInfo;
    }
}

Feign 简化了与HTTP服务交互的过程, 把REST客户端的定义转换为Java接⼝, 并通过注解的⽅式来声

明请求参数,请求⽅式等信息, 使远程调⽤更加方便和间接.

4. OpenFeign参数传递

从URL中获取参数

服务提供方product-service

@RequestMapping("product")
@RestController
public class ProductController {
    @RequestMapping("/p1/{id}")
    public String p1(@PathVariable("id") Integer id) {
        return "p1接收到参数" + id;
    }
}

OpenFeign客户端

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

服务消费方order-service

@RestController
@RequestMapping("testOpenFeign")
public class TestFeignController {
    @Autowired
    private ProductApi productApi;
    @RequestMapping("/o1")
    public String o1(Integer id) {
        return productApi.p1(id);
    }
}

测试:

传递单个参数

服务提供方product-service

@RequestMapping("/p2")
public String p2(@RequestParam("id") int id) {
    return "p2接受到参数" + id;
}

OpenFeign客户端

@RequestMapping("/p2")
String p2 (@RequestParam("id") Integer id);// 这里的@RequestParam做参数绑定,不能省略

服务消费方order-service

@RequestMapping("/o2")
    public String o2(Integer id) {
    return productApi.p2(id);
}

测试:

传递多个参数

需要使用多个@RequestParam进行参数绑定

服务提供方product-service

    @RequestMapping("/p3")
    public String p3(Integer id,String name) {
        return "p3接受到参数" + id + ": " + name;
    }

OpenFeign客户端

    @RequestMapping("/p3")
    String o3 (@RequestParam("id")Integer id, @RequestParam("name")String name);

服务消费方order-service


    @RequestMapping("/o3")
    public String o3(Integer id,String name) {
        return productApi.o3(id,name);
    }

测试:

传递对象

服务提供方product-service

    @RequestMapping("/p4")
    public String p4(ProductInfo productInfo) {
        return "接收到参数" + productInfo;
    }

OpenFeign客户端

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

服务消费方order-service

    @RequestMapping("/o4")
    public String o4(ProductInfo productInfo) {
        return productApi.p4(productInfo);
    }

测试:

传递JSON

服务提供方product-service

     @RequestMapping("/p5")
    public String p5(@RequestBody ProductInfo productInfo) {
        return "接收到参数" + productInfo;
    }

OpenFeign客户端

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

服务消费方order-service


    @RequestMapping("/o5")
    public String o5(@RequestBody ProductInfo productInfo) {
        return productApi.p5(productInfo);
    }

测试:

在这里插入图片描述

5. 最佳实践

不难发现,Feign的客户端代码和服务提供者的代码有很大的相似性

提出两种解决方法

Feign继承方式

我们可以将一些常见的操作封装到接口里,服务提供方实现这个接口,服务消费方编写Feign接口的时候,直接继承这个接口

创建一个新的模块

将接口放在一个公共的jar包里面,供服务提供方和服务消费方使用

引入依赖

<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>

编写接口

public interface ProductInterface {
    @RequestMapping("/getProductById")
    ProductInfo getProductById(@RequestParam("id") Integer id);

    @RequestMapping("/p1/{id}")
    String p1 (@PathVariable("id") Integer id);


    @RequestMapping("/p2")
    String p2 (@RequestParam("id") Integer id);

    @RequestMapping("/p3")
    String p3 (@RequestParam("id")Integer id, @RequestParam("name")String name);

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

    @RequestMapping("/p5")
    String p5 (@RequestBody ProductInfo productInfo);
}

注意:这里的ProductInfo需要在product-api抽取出来,因此可以将order-service以及product-service里面的ProductInfo删除

打jar包

此时就会将product-api的jar包放到本地的maven仓库,供product-service以及order-service使用

服务实现方实现ProductApi接口

package org.JWCB.controller;

import org.JWCB.api.ProductInterface;
import org.JWCB.model.ProductInfo;
import org.JWCB.service.ProductService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

@RequestMapping("product")
@RestController
public class ProductController implements ProductInterface {
    private static final Logger log = LoggerFactory.getLogger(ProductController.class);
    @Autowired
    private ProductService productService;
    @RequestMapping("getProductById")
    public ProductInfo getProductById(@RequestParam Integer id) {
        log.info("getProductById");
        return productService.getProductById(id);
    }


    @RequestMapping("/p1/{id}")
    public String p1(@PathVariable("id") Integer id) {
        return "p1接收到参数" + id;
    }

    @RequestMapping("/p2")
    public String p2(@RequestParam("id") Integer id) {
        return "p2接受到参数" + id;
    }

    @RequestMapping("/p3")
    public String p3(Integer id,String name) {
        return "p3接受到参数" + id + ": " + name;
    }

    @RequestMapping("/p4")
    public String p4(ProductInfo productInfo) {
        return "接收到参数" + productInfo;
    }

    @RequestMapping("/p5")
    public String p5(@RequestBody ProductInfo productInfo) {
        return "接收到参数" + productInfo;
    }
}

此时需要将本地Maven仓库的ProductApi导入,可以先将接口名完整打出来,由idea自己导入

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

注意:这里的ProductInfo是来自于product-api这个包

服务消费方继承接口

package org.JWCB.api;
import org.JWCB.model.ProductInfo;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.cloud.openfeign.SpringQueryMap;
import org.springframework.web.bind.annotation.*;

@FeignClient(value = "product-service",path = "/product")
public interface ProductApi extends ProductInterface{
    @RequestMapping("/getProductById")
    ProductInfo getProductById(@RequestParam("id") Integer id);

    @RequestMapping("/p1/{id}")
    String p1 (@PathVariable("id") Integer id);


    @RequestMapping("/p2")
    String p2 (@RequestParam("id") Integer id);

    @RequestMapping("/p3")
    String o3 (@RequestParam("id")Integer id, @RequestParam("name")String name);

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

    @RequestMapping("/p5")
    String p5 (@RequestBody ProductInfo productInfo);
}

测试:

Feign抽取方式

做法实际上与继承的方式相似,但是理念不同,这种方式是将Feign抽取成一个独立的模块

就是将Feign的Client抽取为一个独立的模块,并把涉及的实体类都放入这个模块里面,打成一个jar包. 服务消费方只需要依赖该jar包即可

创建一个module

引入依赖

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

编写API

@FeignClient(value = "product-service",path = "/product")
public interface ProductInterface {
    @RequestMapping("/getProductById")
    ProductInfo getProductById(@RequestParam("id") Integer id);

    @RequestMapping("/p1/{id}")
    String p1 (@PathVariable("id") Integer id);


    @RequestMapping("/p2")
    String p2 (@RequestParam("id") Integer id);

    @RequestMapping("/p3")
    String o3 (@RequestParam("id")Integer id, @RequestParam("name")String name);

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

    @RequestMapping("/p5")
    String p5 (@RequestBody ProductInfo productInfo);
}

打jar包

服务消费方使用接口

删除ProductApi以及ProductInfo

引入依赖:

<dependency>
  <groupId>org.JWCB</groupId>
  <artifactId>product-api</artifactId>
  <version>1.0-SNAPSHOT</version>
</dependency>

修改order-service代码

指定扫描类

测试

在这里插入图片描述

6. 服务部署到Linux注意事项

使用Maven进行打包的时候.默认是从远程中央仓库进行下载的,但是product-api这个包在本地,我们可以制定从本地读取jar包

修改pow.xml文件

<dependency>
  <groupId>org.JWCB</groupId>
  <artifactId>product-api</artifactId>
  <version>1.0-SNAPSHOT</version>
  <scope>system</scope>
  <systemPath>C:/Users/31127/.m2/repository/org/JWCB/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>
t04bf
关注
专栏目录
优雅实现远程调用-OpenFeign
weixin_72953218的博客
08-28 1185
OpenFeign介绍 OpenFeign最佳实践 我再来遇到个问题，我创建的com.xx.xxx包，放到一起了，不是那种一个在一个下面的那种 Nacos，只要看见这种什么网络报错啥的，java.net.SocketException: Network is unreachable
【SpringCloud】优雅实现远程调用 - OpenFeign
Hsusan的博客
09-22 1122
OpenFeign 是⼀个声明式的 Web Service 客⼾端. 它让微服务之间的调⽤变得更简单, 类似controller调⽤service, 只需要创建⼀个接⼝，然后添加注解即可使⽤OpenFeign.OpenFeign 的前⾝Feign 是 Netflix 公司开源的⼀个组件.2013年6⽉, Netflix发布 Feign的第⼀个版本 1.0.02016年7⽉, Netflix发布Feign的最后⼀个版本 8.18.02016年，Netflix 将 Feign 捐献给社区。
【SpringCloud】（一文通）优雅实现远程调用-OpenFeign
bit me的博客
08-26 1115
OpenFeign 学习
004-OpenFeign服务接口调用
weixin_47790139的博客
08-28 1013
004-OpenFeign服务接口调用
OpenFeign服务接口调用-笔记
m0_64589497的博客
08-24 346
Feign是一个声明式WebService客户端，使用Feign能让编写webService客户端更加简单。他的使用方法是定义一个服务接口，然后在上面添加注解。Feign可以与Eureka和Ribbon组合使用以支持负载均衡Feign使编写java Http客户端更加容易。在使用RestTemplate的时候，是直接在controller层对服务依赖进行调用，这样每一次进行远程调用都需要写一遍远程调用。对于这种多次调用的情况，我们可以创建一个接口并使用注解的方式来配置它。也就是在服务接口层创建远程调用。
服务接口调用-OpenFeign
quixotic的博客
07-04 116
概述 官方文档 ​ https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign OpenFeign源码 ​ https://github.com/spring-cloud/spring-cloud-openfeign Feign 视频教程见B站：https://www.bilibili.com/video/BV18E411x7eT?p=44&spm_id_fro
SpringCloud-OpenFeign
f552126506的博客
07-06 1046
Open Feign
SpringCloud微服务-OpenFeign服务接口调用
qq_44887289的博客
12-14 850
一、OpenFeign简介 官网： https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign GitHub： https://github.com/spring-cloud/spring-cloud-openfeign Feign是一个声明式WebService客户端。使用Feign能让编写Web Service客户端更加简单。 它的使用方法是定义一个服务接口然后在上
SpringCloud系列（五）| 集成OpenFeign实现服务间调用
lsqingfeng的博客
12-14 553
在SpringCloud体系中，集成OpenFeign实现各个服务之间的相互调用。
spring-boot-openfeign-restcountries-example:OpenFeign和Thymeleaf的Spring Boot示例以及RestCountries REST服务中的数据
03-27
本文将深入探讨一个基于Spring Boot的应用程序实例，该实例利用OpenFeign和Thymeleaf两个关键组件，结合RestCountries REST服务，展示如何优雅地实现远程调用和服务之间的解耦。让我们一起深入了解这些技术并探讨...
OpenFeign服务接口调用
这很张扬的博客
05-03 444
OpenFeign是什么？ 官网解释： https://cloud.spring.io/spring-cloud-static/Hoxton.SR1/reference/htmlsingle/#spring-cloud-openfeign Feign是一个声明式WebService客户端。使用Feign能让编写Web Service客户端更加简单。 它的使用方法是定义一个服务接口然后在上面添加注解。Feign也支持可拔插式的编码器和解码器。Spring Cloud对Feign进行了封装，使其支持了Sp
Spring Cloud与微服务学习总结（11）——spring cloud-openFeign 声明式远程调用总结
科技D人生
10-13 430
一、概述 1.1、是什么 Feign是一个声明式的Web服务客户端，让编写Web服务客户端变得非常容易，只需创建一个接口并在接口上申明注解 Github:https://github.com/spring-cloud/spring-cloud-openfeign 1.2、作用 Feign旨在使编写Java Http客户端变的更容易；Feign集成了Ribbon，利用Ribbon维护了Payment的服务列表，并且通过轮询实现了客户端的负载均衡。而与Ribbon不同的是，通过Feign只需要定义服务绑
OJ在线评测系统 微服务高级 Gateway网关接口路由和聚合文档 引入knife4j库集中查看管理并且调试网关项目
我见玫瑰生于荆棘之上
10-07 1151
各个服务之间已经能相互调用了为什么需要网关因为我们的不同服务是放在不同的端口上面的如果前端调用服务 需要不同的端口 8101 8102 8103 8104我们最好提供一个唯一的 给前端去调用的路径我们学习技术的时候必须要去思考1.为什么要用？2.是什么？所有的服务端口不同 增大了前端调用成本 同时我们的所有服务是分散的 你可能需要进行集中管理操作比如说 集中解决跨域 鉴权 接口文档 服务的路由 接口安全性 流量染色Gateway 想自定义一些功能需要对这个技术有比较深的理解。
kubernetes中微服务部署
最新发布
m0_70851096的博客
10-10 949
问：用控制器来完成集群的工作负载，那么应用如何暴漏出去？答：需要通过微服务暴漏出去后才能被访问。
微服务swagger解析部署使用全流程
m0_71240584的博客
10-06 1332
swagger是一个在线接口说明文档，在代码中通过注解的方式将说明问题集成到项目，代码发生修改，说明文档同步修改，前后台联调可以快速同步数据。
OJ在线评测系统 微服务 用分布式消息队列 RabbitMQ 解耦判题服务和题目服务 手搓交换机和队列 实现项目异步化
我见玫瑰生于荆棘之上
10-07 774
分布式消息队列是一种用于异步通信的系统，它允许不同的应用程序或服务之间传递消息。消息队列的核心理念是将消息存储在一个队列中，发送方可以将消息发送到队列，而接收方则可以在适当的时候从队列中读取消息。这种机制有助于解耦应用程序，提高系统的可扩展性和可靠性。：发送方和接收方可以在不同的时间工作，不必直接交互。：通过将消息分发到多个消费者，可以有效利用系统资源。：许多消息队列系统支持将消息存储在磁盘上，以防数据丢失。：某些队列支持按顺序处理消息，确保消息的处理顺序。
微服务概述
luosuss的博客
10-07 1183
单体架构：简单方便，高度耦合，扩展性差，适合小型项目。例如：学生管理系统分布式架构：松耦合，扩展性好，但架构复杂，难度大。适合大型互联网项目，例如：京东、淘宝微服务：一种良好的分布式架构方案①优点：拆分粒度更小、服务更独立、耦合度更低②缺点：架构非常复杂，运维、监控、部署难度提高SpringCloud是微服务架构的一站式解决方案，集成了各种优秀微服务功能组件。
微服务_3.微服务保护
qq_43563660的博客
10-04 781
微服务保护学习记录
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值