Spring Cloud OpenFeign实例介绍使用方法

 更新时间:2022年09月10日 11:23:01   作者:C陈三岁  
Spring Cloud OpenFeign 对 Feign 进行了二次封装,使得在 Spring Cloud 中使用 Feign 的时候,可以做到使用 HTTP 请求访问远程服务,就像调用本地方法一样的,开发者完全感知不到这是在调用远程访问,更感知不到在访问 HTTP 请求

一. OpenFeign概述

OpenFeign 可以将提供者提供的 Restful 服务伪装为接口进行消费,消费者只需使用“ feign 接口 + 注解 ”的方式即可直接调用提供者提供的 Restful 服务,而无需再使用 RestTemplate 。

注意:

  • Feign 只涉及到消费者端,与提供者端无关
  • Feign 仅仅是一个伪客户端,其不会对请求做任何处理。即其与使用 RestTemplate 效果 是一样的
  • Feign 是通过注解实现RESTful 请求的

二. 使用步骤

2.1 feign接口模块

单独将feign接口放在模块中,方便后续为各个服务使用。

2.1.1依赖配置

springCloud版本使用

<properties>
        <java.version>1.8</java.version>
        <spring-cloud.version>Hoxton.SR6</spring-cloud.version>
        <spring-cloud-alibaba.version>2.2.1.RELEASE</spring-cloud-alibaba.version>
    </properties>
    <dependencies>
        <!--fegin-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
    </dependencies>
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>

2.1.2编写FeignClient的接口, 并加@FeignCleint 注解

url写死在接口中不方便,可以使用动态参数配置,只需要在配置文件中添加key为feign.client.url的路径。这里使用是单体模式,如果分布式项目中配置多个url管理起来非常费事,就需要升级使用注册中心来解决。

import com.example.vo.DepartVO;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.*;
import java.util.List;
// 注意,接口名与方法名可以随意
// 参数指定了要访问的提供者微服务名称
//@FeignClient(url ="http://127.0.0.1:8081", value="abcmsc-provider-depart", path = "/provider/depart")
@FeignClient(url ="${feign.client.url}", value="abcmsc-provider-depart", path = "/provider/depart")
public interface DepartService {
    @PostMapping("/save")
    boolean saveDepart(@RequestBody DepartVO depart);
    @DeleteMapping("/del/{id}")
    boolean removeDepartById(@PathVariable("id") int id);
    @PutMapping("/update")
    boolean modifyDepart(@RequestBody DepartVO depart);
    @GetMapping("/get/{id}")
    DepartVO getDepartById(@PathVariable("id") int id);
    @GetMapping("/list")
    List<DepartVO> listAllDeparts();
}

2.2 消费端使用fegin接口

2.2.1在消费者端添加feign接口依赖

2.2.2在消费者端配置文件中添加 feign.client.url

指定服务端的url和端口

2.2.3在消费者端启动类中添加@EnableFeignClients

开启Feign功能:此注解会扫描启动类所在的包及其子包下面@FeignClient标注的接口,将其交给spring容器管理,方便后续使用。

2.2.4在消费者端使用fegin接口

需要在哪里使用接口直接注入后即可使用

import com.example.providerapi.DepartService;
import com.example.vo.DepartVO;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
@RestController
@RequestMapping("/consumer/depart")
public class DepartController {
    @Autowired
    private DepartService departService;
    @PostMapping("/save")
    public boolean saveHandle(@RequestBody DepartVO depart) {
 
        return departService.saveDepart(depart);
    }
    @DeleteMapping("/del/{id}")
    public void deleteHandle(@PathVariable("id") int id) {
        departService.removeDepartById(id);
    }
    @PutMapping("/update")
    public void updateHandle(@RequestBody DepartVO depart) {
        departService.modifyDepart(depart);
    }
    @GetMapping("/get/{id}")
    public DepartVO getHandle(@PathVariable("id") int id) {
        return departService.getDepartById(id);
    }
    @GetMapping("/list")
    public List<DepartVO> listHandle() {
        return departService.listAllDeparts();
    }
}

2.3 测试

启动生产者服务,消费者服务

http://localhost:8080/consumer/depart/save

到此这篇关于Spring Cloud OpenFeign实例介绍使用方法的文章就介绍到这了,更多相关Spring Cloud OpenFeign内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 让Java代码更高效

    让Java代码更高效

    这篇文章主要介绍了如何让你的Java代码更高效,让Java跑得更快,感兴趣的小伙伴们可以参考一下
    2015-09-09
  • SpringMVC使用自定义验证器进行数据验证的方法

    SpringMVC使用自定义验证器进行数据验证的方法

    SpringMVC 提供了强大的数据验证机制,可以方便地验证表单提交的数据,除了自带的验证器之外,SpringMVC 还支持自定义验证器,允许开发者根据业务需求自定义验证规则,本文将介绍如何在 SpringMVC 中使用自定义验证器
    2023-07-07
  • Java多线程Atomic包操作原子变量与原子类详解

    Java多线程Atomic包操作原子变量与原子类详解

    这篇文章主要介绍了Java多线程Atomic包操作原子变量与原子类详解,简单介绍了Atomic,同时涉及java.util.concurrent中的原子变量,Atomic类的作用等相关内容,具有一定参考价值,需要的朋友可以了解下。
    2017-11-11
  • 关于Java大整数运算之BigInteger类

    关于Java大整数运算之BigInteger类

    这篇文章主要介绍了关于Java大整数运算之BigInteger类,BigInteger提供高精度整型数据类型及相关操作,所有操作中,都以二进制补码形式表示,需要的朋友可以参考下
    2023-05-05
  • @JsonFormat处理LocalDateTime失效的问题

    @JsonFormat处理LocalDateTime失效的问题

    这篇文章主要介绍了关于@JsonFormat处理LocalDateTime失效的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-08-08
  • SpringBoot整合任务系统quartz和SpringTask的方法

    SpringBoot整合任务系统quartz和SpringTask的方法

    这篇文章主要介绍了SpringBoot整合任务系统(quartz和SpringTask),Quartz是一个比较成熟了的定时任务框架,但是捏,它稍微的有些许繁琐,本文先给大家讲解下Quartz的一些基本概念结合实例代码给大家详细讲解,需要的朋友可以参考下
    2022-10-10
  • shiro之记住登录信息

    shiro之记住登录信息

    Shiro提供了记住我(RememberMe)的功能,当关闭浏览器时下次再次打开还能记住你的信息,下面小编给大家分享shiro之记住登录信息的相关知识,感兴趣的朋友一起看看吧
    2017-09-09
  • EDI中JAVA通过FTP工具实现文件上传下载实例

    EDI中JAVA通过FTP工具实现文件上传下载实例

    这篇文章主要介绍了EDI中JAVA通过FTP工具实现文件上传下载实例,具有一定的参考价值,有需要的可以了解一下。
    2016-11-11
  • Selenium Webdriver实现截图功能的示例

    Selenium Webdriver实现截图功能的示例

    今天小编就为大家分享一篇Selenium Webdriver实现截图功能的示例,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2018-05-05
  • Java中MessageDigest来实现数据加密的方法

    Java中MessageDigest来实现数据加密的方法

    这篇文章主要介绍了Java中MessageDigest来实现数据加密的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-05-05

最新评论