SpringCloud之OpenFeign调用解读

news2024/9/21 2:50:22

目录

基本介绍

引进

OpenFeign概述

OpenFeign作用 

@FeignClient 

@EnableFeignClients 

Java代码实战

实战架构

父工程pom文件 

teacher-service服务

student-service服务

测试

自定义配置

基本介绍

引进

如果我们利用RestTemplate发起远程调用的代码时会存在一些问题比如：

•代码可读性差，编程体验不统一

•参数复杂URL难以维护

String url="http://teacherservice/getTeacher";
Teacher teacher = restTemplate.getForObject(url, Teacher.class);

OpenFeign概述

OpenFeign是一个显示声明式的WebService客户端。使用OpenFeign能让编写Web Service客户端更加简单。使用时只需定义服务接口，然后在上面添加注解。OpenFeign也支持可拔插式的编码和解码器。spring cloud对feign进行了封装，使其支持MVC注解和HttpMessageConverts。和eureka（服务注册中心）和ribbon组合可以实现负载均衡。

在Spring Cloud中使用OpenFeign，可以做到使用HTTP请求访问远程服务，就像调用本地方法一样的，开发者完全感知不到这是在调用远程方法，更感知不到在访问HTTP请求，非常的方便。

cloud官网介绍Feign：Spring Cloud OpenFeign

OpenFeign源码：GitHub - OpenFeign/feign: Feign makes writing java http clients easier

OpenFeign作用 

  • OpenFeign的设计宗旨式简化Java Http客户端的开发。Feign在restTemplate的基础上做了进一步的封装，由其来帮助我们定义和实现依赖服务接口的定义。在OpenFeign的协助下，我们只需创建一个接口并使用注解的方式进行配置（类似于Dao接口上面的Mapper注解）即可完成对服务提供方的接口绑定，大大简化了Spring cloud Ribbon的开发，自动封装服务调用客户端的开发量。
  • OpenFeign集成了Ribbon,利用ribbon维护了服务列表，并且通过ribbon实现了客户端的负载均衡。与ribbon不同的是，通过OpenFeign只需要定义服务绑定接口且以申明式的方法，优雅而简单的实现了服务调用。

@FeignClient 

@FeignClient 实现的是声明式的、模块化的Http客户端，可以让我们对其他服务接口的访问更边界就像是controller和service之间的调用一样。

@FeignClient属性如下：

  • name：指定该类的容器名称，类似于@Service（容器名称）
  • url: url一般用于调试，可以手动指定@FeignClient调用的地址
  • decode404:当发生http 404错误时，如果该字段位true，会调用decoder进行解码，否则抛出FeignException
  •  configuration: Feign配置类，可以自定义Feign的Encoder、Decoder、LogLevel、Contract
  •  fallback: 定义容错的处理类，当调用远程接口失败或超时时，会调用对应接口的容错逻辑，fallback指定的类必须实现@FeignClient标记的接口
  • fallbackFactory: 工厂类，用于生成fallback类示例，通过这个属性我们可以实现每个接口通用的容错逻辑，减少重复的代码
  • path: 定义当前FeignClient的统一前缀，当我们项目中配置了server.context-path,server.servlet-path时使用
@FeignClient(name="teacherservice")
public interface TeacherServiceFeign {
    @GetMapping("/getTeacher/{id}")
    Teacher getInfo(@PathVariable("id") String id);
}

@EnableFeignClients 

在的启动类添加​ @EnableFeignClients注解开启Feign的功能  

用注解@EnableFeignClients启用feign客户端；扫描和注册feign客户端bean定义

@EnableFeignClients注解中的basePackges属性中是一个数组，可以填写多个值，其主要作用是指定当前模块中需要用到那些地址下的feign接口，起到一个discovery发现feign接口的作用。

Java代码实战

实战架构

俩个为俩个不同的端口的service端，客户端向8002端口的studentservice发送一个请求（/getInfo/{id}）以后，8002端口的studentservice需要往teacherservice发送一个请求（/getTeacher/{id}）返回数据。

父工程pom文件 

统一管理版本信息 

    <groupId>org.example</groupId>
    <artifactId>eurek-test</artifactId>
    <version>1.0-SNAPSHOT</version>
    <modules>
        <module>eurek-serve</module>
        <module>student-service</module>
        <module>teacher-service</module>
    </modules>


    <packaging>pom</packaging>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.3.12.RELEASE</version>
        <relativePath/>
    </parent>
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Hoxton.SR10</spring-cloud.version>
        <mysql.version>5.1.47</mysql.version>
        <mybatis.version>2.1.1</mybatis.version>
    </properties>
    <dependencyManagement>
        <dependencies>
            <!-- springCloud -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <!--nacos的管理依赖-->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>2.2.5.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

teacher-service服务

 pom文件

   <dependencies>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
       <!-- nacos客户端依赖包 -->
       <dependency>
           <groupId>com.alibaba.cloud</groupId>
           <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
       </dependency>
   </dependencies>

启动类

@SpringBootApplication
public class TeacherApplication {

    public static void main(String[] args) {
        SpringApplication.run(TeacherApplication.class,args);

    }

}

yml配置文件 

server:
  port: 8002
spring:
  application:
    name: teacherservice
  cloud:
    nacos:
      server-addr: localhost:8848

 Teacher类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Teacher implements Serializable {
    private  String name;
    private  String sex;
}

TeachertController

@RestController
public class TeacherController {


    @GetMapping("/getTeacher/{id}")
    public Teacher getInfo(@PathVariable("id") String id){
        return new Teacher("张三-"+id,"男");
    }
}

student-service服务

pom文件

   <dependencies>
       <dependency>
           <groupId>org.springframework.boot</groupId>
           <artifactId>spring-boot-starter-web</artifactId>
       </dependency>
       <!-- nacos客户端依赖包 -->
       <dependency>
           <groupId>com.alibaba.cloud</groupId>
           <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
       </dependency>
       <dependency>
           <groupId>org.springframework.cloud</groupId>
           <artifactId>spring-cloud-starter-openfeign</artifactId>
       </dependency>
   </dependencies>

yml配置文件 

server:
  port: 8002
spring:
  application:
    name: studentservice
  cloud:
    nacos:
      server-addr: localhost:8848

 启动类 

@SpringBootApplication
@EnableFeignClients
public class StudentApplication {

    public static void main(String[] args) {
        SpringApplication.run(StudentApplication.class,args);

    }

}

 Teacher类

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Teacher implements Serializable {
    private  String name;
    private  String sex;
}

TeacherServiceFeign ​ 

@FeignClient("teacherservice")
public interface TeacherServiceFeign {
    @GetMapping("/getTeacher/{id}")
    Teacher getInfo(@PathVariable("id") String id);
}

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

  • 服务名称：teacherservice

  • 请求方式：GET

  • 请求路径：/getTeacher/{id}

  • 请求参数：String id

  • 返回值类型：Teacher

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

 StudentController

@RestController
public class StudentController implements Serializable {
    @Autowired
    TeacherServiceFeign teacherServiceFeign;

    @GetMapping("/getInfo")
    public Teacher getInfo(){
        Teacher teacher = teacherServiceFeign.getInfo("111");
        return teacher;
    }

}

测试

GET http://localhost:8002/getInfo

HTTP/1.1 200 
Content-Type: application/json
Transfer-Encoding: chunked
Date: Tue, 17 Oct 2023 02:46:43 GMT
Keep-Alive: timeout=60
Connection: keep-alive

{
  "name": "张三-111",
  "sex": "男"
}

自定义配置

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即可。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1122915.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

docker部署nginx并设置挂载

docker部署nginx并设置挂载

前言&#xff1a; 最近在学习docker和nginx&#xff0c;因为容器在运行过程中&#xff0c;相关的配置文件及日志都会存在容器内。对容器以来较高&#xff0c;当容器不存在的时候。所有的文件也就都没有了。并且当需要查看日志&#xff0c;修改配置文件的时候必须进入到容器内部…
阅读更多...
JavaWeb配置Servle

JavaWeb配置Servle

在Java Web开发中&#xff0c;数据流主要遵循以下流程&#xff1a; 用户在浏览器中输入URL或点击链接&#xff0c;发送HTTP请求到服务器。服务器接收到请求后&#xff0c;根据请求的URL找到对应的Servlet。Servlet处理请求&#xff0c;可能需要查询数据库或执行其他业务逻辑。…
阅读更多...
Docker笔记-docker搭建nginx及移植

Docker笔记-docker搭建nginx及移植

从官网找到对应的镜像&#xff1a; ​​​​​​https://hub.docker.com/_/nginx/tags 查看镜像 docker images 运行容器&#xff0c;然后将配置文件等拷贝到主机上&#xff1a; docker run --name nginx -d nginx 拷贝路径&#xff1a; docker cp nginx:/etc/nginx/nginx…
阅读更多...
[SQL开发笔记]SELECT 语句：读取数据表的信息

[SQL开发笔记]SELECT 语句：读取数据表的信息

一、功能描述&#xff1a; 用于从数据库中读取数据 二、SELECT语法详解&#xff1a; 1&#xff09;查询整个表的信息&#xff1a; SELECT * FROM table_name; 2&#xff09;查询表中的字段或多个字段&#xff1a; SELECT column1, column2, ...FROM table_name; 参数说明…
阅读更多...
面试中被问到：Netty中的零拷贝机制是怎么样的？

面试中被问到：Netty中的零拷贝机制是怎么样的？

零拷贝(Zero-copy), CPU不需要为数据在内存之间的拷贝消耗资源。而它通常是指计算机在网络上发送文件时&#xff0c;不需要将文件内容拷贝到用户空间&#xff08;User Space&#xff09;而直接在内核空间&#xff08;Kernel Space&#xff09;中传输到网络的方式。Zero Copy的模…
阅读更多...
雪数据同化系统Snow Data Assimilation System数据集

雪数据同化系统Snow Data Assimilation System数据集

雪数据同化系统&#xff08;SNODAS&#xff09; 雪资料同化系统&#xff08;SNODAS&#xff09;是国家水文遥感业务中心&#xff08;NOHRSC&#xff09;精心开发的综合建模和资料同化系统。其主要目标是提供高度准确的积雪和相关参数估计&#xff0c;作为水文建模和分析的重要…
阅读更多...
分类预测 | MATLAB实现SSA-CNN-BiLSTM麻雀算法优化卷积双向长短期记忆神经网络数据分类预测

分类预测 | MATLAB实现SSA-CNN-BiLSTM麻雀算法优化卷积双向长短期记忆神经网络数据分类预测

分类预测 | MATLAB实现SSA-CNN-BiLSTM麻雀算法优化卷积双向长短期记忆神经网络数据分类预测 目录 分类预测 | MATLAB实现SSA-CNN-BiLSTM麻雀算法优化卷积双向长短期记忆神经网络数据分类预测分类效果基本描述程序设计参考资料 分类效果 基本描述 1.MATLAB实现SSA-CNN-BiLSTM数据…
阅读更多...
【RocketMQ】RocketMQ 5.0新特性（三）- Controller模式

【RocketMQ】RocketMQ 5.0新特性（三）- Controller模式

在RocketMQ 5.0以前&#xff0c;有两种集群部署模式&#xff0c;分别为主从模式&#xff08;Master-Slave模式&#xff09;和Dledger模式。 主从模式 主从模式中分为Master和Slave两个角色&#xff0c;集群中可以有多个Master节点&#xff0c;一个Master节点可以有多个Slave节…
阅读更多...
优雅的用户体验：微信小程序中的多步骤表单引导

优雅的用户体验：微信小程序中的多步骤表单引导

前言 在微信小程序中&#xff0c;实现一个多步骤表单引导界面既可以提供清晰的任务指引&#xff0c;又可以增加用户体验的互动性。本文将探讨如何使用微信小程序的特性&#xff0c;构建一个流程引导界面&#xff0c;帮助用户一步步完成复杂任务。我们将从设计布局和样式开始&am…
阅读更多...
彻底弄懂base64的编码与解码原理

彻底弄懂base64的编码与解码原理

背景 base64的编码原理网上讲解较多&#xff0c;但解码原理讲解较少&#xff0c;并且没有对其中的内部实现原理进行剖析。想要彻底了解base64的编码与解码原理&#xff0c;请耐心看完此文&#xff0c;你一定会有所收获。 涉及算法与逻辑运算概念 在探究base64编码原理和解码…
阅读更多...
macrodata数据集在Python统计建模和计量经济学中的应用

macrodata数据集在Python统计建模和计量经济学中的应用

目录 一、数据介绍二、应用三、statsmodels 统计模块四、使用 statsmodels 统计模块分析 macrodata.csv 数据集参考 一、数据介绍 macrodata.csv是一个示例数据集&#xff0c;通常用于统计分析和计量经济学中的教育和训练目的。这个数据集通常包括以下列&#xff1a; year&am…
阅读更多...
17.3 实现无管道反向CMD

17.3 实现无管道反向CMD

WSASocket无管道反向CMD&#xff0c;与无管道正向CMD相反&#xff0c;这种方式是在远程主机上创建一个TCP套接字&#xff0c;并绑定到一个本地地址和端口上。然后在本地主机上&#xff0c;使用WSASocket函数连接到远程主机的套接字&#xff0c;并将标准输入、输出和错误输出重定…
阅读更多...
深入 Meven：构建杰出的软件项目的完美工具

深入 Meven：构建杰出的软件项目的完美工具

掌握 Meven&#xff1a;构建更强大、更智能的应用程序的秘诀 Maven1.1 初识Maven1.1.1 什么是Maven1.1.2 Maven的作用 02. Maven概述2.1 Maven介绍2.2 Maven模型2.3 Maven仓库2.4 Maven安装2.4.1 下载2.4.2 安装步骤 03. IDEA集成Maven3.1 配置Maven环境3.1.1 当前工程设置3.1.…
阅读更多...
JDBC相关记录

JDBC相关记录

JDBC&#xff1a;Java DadaBase Connectivity 即Java语言连接数据库。 本质&#xff1a;JDBC是SUN公司制定的一套接口&#xff08;interface&#xff09;。 作用&#xff1a;不同的数据库有自己独特设计原理&#xff0c;JDBC的可以让Java程序员关注业务本身&#xff0c;而不需要…
阅读更多...
Programming abstractions in C阅读笔记：p181-p183

Programming abstractions in C阅读笔记：p181-p183

《Programming Abstractions In C》学习第61天&#xff0c;p181-p183总结。 一、技术总结 1.linear search algorithm 2.lexicographic order(字典顺序) 3.binary search algorithm(二分查找算法) /** 1.二分查找也应用了递归的思想。* 2.这里的代码只是demo*/ #include &…
阅读更多...
17.2 实现无管道正向CMD

17.2 实现无管道正向CMD

WSASocket 无管道正向CMD&#xff0c;使用WSASocket函数创建一个TCP套接字&#xff0c;并绑定到一个本地地址和端口上。然后使用CreateProcess函数创建一个新的CMD进程&#xff0c;并将标准输入、输出和错误输出重定向到套接字的句柄上。这样&#xff0c;客户端可以通过网络连接…
阅读更多...
应用开发平台集成工作流系列之16——办理意见设计与实现

应用开发平台集成工作流系列之16——办理意见设计与实现

背景 流程任务流转过程中&#xff0c;各环节的处理&#xff0c;会填写处理意见。 Camunda自带了相关的功能&#xff0c;但功能过于简陋&#xff0c;问题较多&#xff0c;今天来说说这一块。 自带功能的问题 如使用Camunda官方自身的办理意见相关功能&#xff0c;会遇到两个问…
阅读更多...
【C++进阶(九)】C++多态深度剖析

【C++进阶(九)】C++多态深度剖析

&#x1f493;博主CSDN主页:杭电码农-NEO&#x1f493;   ⏩专栏分类:C从入门到精通⏪   &#x1f69a;代码仓库:NEO的学习日记&#x1f69a;   &#x1f339;关注我&#x1faf5;带你学习C   &#x1f51d;&#x1f51d; 多态 1. 前言2. 多态的概念以及定义3. 多态的实…
阅读更多...
Generator异步解决方案详解

Generator异步解决方案详解

一&#xff1a;三种常见的异步解决方案 Promise&#xff1a;链式编程async&#xff1a;使用 async 去修饰函数&#xff0c;然后使用 await 去等待成功Generator&#xff1a;使用 * 修饰函数&#xff0c;然后使用 yield 去等待成功 通俗来讲&#xff0c;Generator 类似于 Promi…
阅读更多...
【Java 进阶篇】Java XML组成部分：理解XML的结构

【Java 进阶篇】Java XML组成部分：理解XML的结构

XML&#xff08;可扩展标记语言&#xff09;是一种常用于存储和交换数据的标记语言。了解XML的结构和组成部分对于有效处理XML数据至关重要。在本篇博客中&#xff0c;我们将深入探讨XML的组成部分&#xff0c;以及如何使用Java来处理和操作XML数据。 什么是XML&#xff1f; …
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023