Spring Cloud 学习 --- 声明式REST客户端 Fegin

2024-04-02 16:38

本文主要是介绍Spring Cloud 学习 --- 声明式REST客户端 Fegin,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

基于上一文 Eureka服务注册与发现 中的项目,继续完成关于 Fegin 相关的代码编写。

本次学习最终实现效果

fegin

版本信息

https://spring.io/projects/spring-cloud

  • Spring Boot 版本:2.1.11.RELEASE
  • Spring Cloud 版本:Greenwich.SR4

WHAT — 定义

来自 官网 的定义:

Feign is a declarative web service client. It makes writing web service clients easier. To use Feign create an interface and annotate it. It has pluggable annotation support including Feign annotations and JAX-RS annotations. Feign also supports pluggable encoders and decoders. Spring Cloud adds support for Spring MVC annotations and for using the same HttpMessageConverters used by default in Spring Web. Spring Cloud integrates Ribbon and Eureka, as well as Spring Cloud LoadBalancer to provide a load-balanced http client when using Feign.

Feign是一个声明性web服务客户端。它使编写web服务客户端变得更容易。使用Feign创建一个接口并对其进行注释。它有可插入的注释支持,包括外部注释和JAX-RS注释。Feign还支持可插入的编码器和解码器。Spring Cloud增加了对Spring MVC注释的支持,以及对使用Spring Web中默认使用的httpMessageConverter的支持。Spring Cloud集成了Ribbon和Eureka以及Spring Cloud LoadBalancer,在使用Feign时提供了一个负载平衡的http客户端。

什么是声明式?

声明式调用就像调用本地方法一样调用远程方法,无感知远程HTTP请求。它解决了让开发者调用远程接口就跟调用本地方法一样,无需关注与远程的交互细节,更无需关注分布式环境开发。

WHY — 特点

Feign是一个声明式的伪Http客户端,它使得写Http客户端变得更简单。

使用Feign,只需要创建一个接口并注解,它具有可插拔的注解特性,可使用Feign 注解和JAX-RS注解,Feign支持可插拔的编码器和解码器,Feign默认集成了Ribbon,并和Eureka结合,默认实现了负载均衡的效果。

Feign 具有如下特性:

  • 可插拔的注解支持,包括Feign注解和JAX-RS注解
  • 支持可插拔的HTTP编码器和解码器
  • 支持Hystrix和它的Fallback
  • 支持Ribbon的负载均衡
  • 支持HTTP请求和响应的压缩Feign是一个声明式的Web Service客户端,它的目的就是让Web Service调用更加简单。它整合了RibbonHystrix,从而不再需要显式地使用这两个组件。Feign还提供了HTTP请求的模板,通过编写简单的接口和注解,就可以定义好HTTP请求的参数、格式、地址等信息。接下来,Feign会完全代理HTTP的请求,我们只需要像调用方法一样调用它就可以完成服务请求。

简而言之:Feign能干RibbonHystrix的事情,但是要用RibbonHystrix自带的注解必须要引入相应的jar包才可以。

HOW — 使用

入门调用
  • 步骤一:修改 pom 文件,添加 Feign 依赖
<dependency><groupId>org.springframework.cloud</groupId><artifactId>spring-cloud-starter-openfeign</artifactId>
</dependency>
  • 步骤二:修改启动类,添加开启 Feign 注解
@SpringBootApplication
@EnableEurekaClient
@EnableFeignClients  //开启Feign客户端
public class EurekaClientConsumerApplication {public static void main(String[] args) {SpringApplication.run(EurekaClientConsumerApplication.class, args);}}
  • 步骤三:编写 Feign 接口,完成远程调用,取代 dao
/*** @Description: 用户模块通过feign调用接口** 定义个feign接口 @FeignClient("服务名") 来确定调哪个服务*/
@FeignClient(name = "eureka-client-provider")
public interface UserFeignClient {@GetMapping("/login")String login();
}
  • 步骤四:修改 controller, 将调用 dao 修改成 feign
@RestController
public class UserController {@Autowiredprivate UserFeignClient userFeignClient;@GetMapping("/userlogin")public String login() {return "8881收到结果:" + userFeignClient.login();}
}

上面使用 fegin 为入门版,后面的几种调用更接近实际开发:多参数调用实体类调用图片上传

多参数调用
  • 步骤一:provider 中增加调用方法,完成处理逻辑
    @PostMapping("/userLoginPostParam")public String postParamLogin(@RequestParam("name") String name, @RequestParam("pwd") String pwd) {String result = "登录失败。";if (StringUtils.isNotEmpty(name) && StringUtils.isNotEmpty(pwd)) {if (name.equals("tyron") && pwd.equals("123456")) {result = "登录成功";}}return result;}
  • 步骤二:consumerservices 增加接口,供 controller 调用
    @PostMapping("/userLoginPostParam")String postParamLogin(@RequestParam("name") String name, @RequestParam("pwd") String pwd);
  • 步骤三:consumercontroller 增加方法,暴露给外部调用
    @PostMapping("/userLoginPostParam")public String postParamLogin(@RequestParam("name") String name, @RequestParam("pwd") String pwd) {return "登录结果:" + userFeignClient.postParamLogin(name, pwd);}
  • 步骤四:postman调用

postman调用

实体类调用
  • 步骤一:引入 common 项目,方便 providerconsumer 项目同时调用

构建 maven 项目即可!链接:

  • 步骤二:common 项目创建实体类 UserModel
@Getter
@Setter
public class UserModel {private String name;private String pwd;private int age;private Date birthday;}
  • 步骤三:providerconsumer 项目同时引入 common 项目
<!--common依赖-->
<dependency><groupId>com.tyron</groupId><artifactId>common</artifactId><version>1.0-SNAPSHOT</version>
</dependency>
  • 步骤四:provider 中增加调用方法,完成处理逻辑
	@PostMapping("/userLoginPostModel")public String postModelLogin(@RequestBody UserModel userModel) {String result = "登录失败。";if (StringUtils.isNotEmpty(userModel.getName()) && StringUtils.isNotEmpty(userModel.getPwd())) {if (userModel.getName().equals("tyron") && userModel.getPwd().equals("654321")) {result = "登录成功";}}return result;}
  • 步骤五:consumerservices 增加接口,供 controller 调用
    @PostMapping("/userLoginPostModel")String userLoginPostModel(@RequestBody UserModel userModel);
  • 步骤六:consumercontroller 增加方法,暴露给外部调用
    @PostMapping("/userLoginPostModel")public String postModelLogin(@RequestBody UserModel userModel) {return "登录结果:" + userFeignClient.userLoginPostModel(userModel);}
  • 步骤七:postman调用

postman调用

文件上传
  • 步骤一:provider 中增加调用方法,完成处理逻辑
@RestController
public class FileUpload {@PostMapping(value = "/uploadFile", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)public String handleFileUpload(@RequestPart(value = "file") MultipartFile file) {if (file == null) {return "文件不能为空。";}return file.getOriginalFilename() + "的文件上传成功";}
}
  • 步骤二:consumerapplication.yml 修改配置文件
spring:application:name: eureka-client-consumer# 多个接口上的@FeignClient(“相同服务名”)会报错:name has already been defined and overriding is disabled。# 设置 为true ,即 允许 同名main:allow-bean-definition-overriding: true
  • 步骤三:provider 中增加调用方法,完成处理逻辑
@FeignClient(name = "eureka-client-provider", configuration = FileUploadClient.MultipartSupportConfig.class)
public interface FileUploadClient {@PostMapping(value = "/uploadFile", consumes = MediaType.MULTIPART_FORM_DATA_VALUE)String handleFileUpload(@RequestPart(value = "file") MultipartFile file);public class MultipartSupportConfig {@Autowiredprivate ObjectFactory<HttpMessageConverters> messageConverters;@Beanpublic Encoder feignFormEncoder() {return new SpringFormEncoder(new SpringEncoder(messageConverters));}}
}
  • 步骤四:consumer 项目引入依赖
<dependency><groupId>io.github.openfeign.form</groupId><artifactId>feign-form</artifactId><version>3.8.0</version>
</dependency>
<dependency><groupId>io.github.openfeign.form</groupId><artifactId>feign-form-spring</artifactId><version>3.8.0</version>
</dependency>
<dependency><groupId>commons-fileupload</groupId><artifactId>commons-fileupload</artifactId><version>1.4</version>
</dependency>
  • 步骤五:provider 中增加测试方法,完成处理逻辑
    @Autowiredprivate FileUploadClient fileUploadClient;@Test@SneakyThrowspublic void testHandleFileUpload() {File file = new File("C:\\Users\\Administrator\\Desktop\\111.txt");DiskFileItem fileItem = (DiskFileItem) new DiskFileItemFactory().createItem("file",MediaType.TEXT_PLAIN_VALUE, true, file.getName());try (InputStream input = new FileInputStream(file); OutputStream os = fileItem.getOutputStream()) {IOUtils.copy(input, os);} catch (Exception e) {throw new IllegalArgumentException("Invalid file: " + e, e);}MultipartFile multi = new CommonsMultipartFile(fileItem);log.info(fileUploadClient.handleFileUpload(multi));}
  • 步骤六:运行,观察日志输出

文件上传

参考

  • OpenFeign/feign
  • 官方Feign文件上传
  • tyronczt/Spring-Cloud-Learning 提交记录
  • Spring Cloud中如何优雅的使用Feign调用接口
  • 学习SpringCloud Feign带你从0到1
  • Spring Cloud Feign的文件上传实现

这篇关于Spring Cloud 学习 --- 声明式REST客户端 Fegin的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/870508

相关文章

Java堆转储文件之1.6G大文件处理完整指南

《Java堆转储文件之1.6G大文件处理完整指南》堆转储文件是优化、分析内存消耗的重要工具,:本文主要介绍Java堆转储文件之1.6G大文件处理的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言文件为什么这么大?如何处理这个文件?分析文件内容(推荐)删除文件(如果不需要)查看错误来源如何避

SpringBoot整合Dubbo+ZK注册失败的坑及解决

《SpringBoot整合Dubbo+ZK注册失败的坑及解决》使用Dubbo框架时,需在公共pom添加依赖,启动类加@EnableDubbo,实现类用@DubboService替代@Service,配... 目录1.先看下公共的pom(maven创建的pom工程)2.启动类上加@EnableDubbo3.实

SpringBoot整合(ES)ElasticSearch7.8实践

《SpringBoot整合(ES)ElasticSearch7.8实践》本文详细介绍了SpringBoot整合ElasticSearch7.8的教程,涵盖依赖添加、客户端初始化、索引创建与获取、批量插... 目录SpringBoot整合ElasticSearch7.8添加依赖初始化创建SpringBoot项

JAVA覆盖和重写的区别及说明

《JAVA覆盖和重写的区别及说明》非静态方法的覆盖即重写,具有多态性;静态方法无法被覆盖,但可被重写(仅通过类名调用),二者区别在于绑定时机与引用类型关联性... 目录Java覆盖和重写的区别经常听到两种话认真读完上面两份代码JAVA覆盖和重写的区别经常听到两种话1.覆盖=重写。2.静态方法可andro

SpringBoot中六种批量更新Mysql的方式效率对比分析

《SpringBoot中六种批量更新Mysql的方式效率对比分析》文章比较了MySQL大数据量批量更新的多种方法,指出REPLACEINTO和ONDUPLICATEKEY效率最高但存在数据风险,MyB... 目录效率比较测试结构数据库初始化测试数据批量修改方案第一种 for第二种 case when第三种

Java docx4j高效处理Word文档的实战指南

《Javadocx4j高效处理Word文档的实战指南》对于需要在Java应用程序中生成、修改或处理Word文档的开发者来说,docx4j是一个强大而专业的选择,下面我们就来看看docx4j的具体使用... 目录引言一、环境准备与基础配置1.1 Maven依赖配置1.2 初始化测试类二、增强版文档操作示例2.

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

Spring Boot中的路径变量示例详解

《SpringBoot中的路径变量示例详解》SpringBoot中PathVariable通过@PathVariable注解实现URL参数与方法参数绑定,支持多参数接收、类型转换、可选参数、默认值及... 目录一. 基本用法与参数映射1.路径定义2.参数绑定&nhttp://www.chinasem.cnbs

JAVA中安装多个JDK的方法

《JAVA中安装多个JDK的方法》文章介绍了在Windows系统上安装多个JDK版本的方法,包括下载、安装路径修改、环境变量配置(JAVA_HOME和Path),并说明如何通过调整JAVA_HOME在... 首先去oracle官网下载好两个版本不同的jdk(需要登录Oracle账号,没有可以免费注册)下载完

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命