使用OpenFeign实现服务调用的方法详解

更新时间：2023年06月12日 10:13:59 作者：现在没有牛仔了

OpenFeign是运行在客户端的声明式服务调用的框架，通过声明接口的方式来达到对服务的调用，本文就来和大家讲讲如何使用OpenFeign实现服务调用吧

OpenFeign

OpenFeign是运行在客户端的声明式服务调用的框架，通过声明接口的方式来达到对服务的调用，表面上看起来就好像在调用本地方法一样。

OpenFeign使用方法

创建一个Springboot的Web工程，命名为feign-consumer并引入相关依赖如下

<!-- eureka客户端依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    <version>3.1.6</version>
</dependency>
<!-- springcloud-openfeign依赖 -->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-openfeign</artifactId>
    <version>3.1.7</version>
</dependency>

在项目中创建一个业务接口HelloService，这个步骤即是对相关的调用进行声明，为接口指定一个@FeignClient("myservice")注解开启客户端服务调用，其中myservice表示对应的服务名

@FeignClient("myservice")
public interface HelloService {
    @GetMapping({"/hello4"})
    String hello(@RequestParam("name") String var1);
    @GetMapping({"/hello5"})
    String hello(@RequestHeader("name") String var1, @RequestHeader("age") int var2);
    @PostMapping({"/hello6"})
    String hello(@RequestBody User var1);
}

需要注意的是，@RequestParam、@RequestHeader注解中的参数名不可以省略

在Controller中添加API方法，依次调用HelloService的三个方法

@RequestMapping(value = "/consumer2",method = RequestMethod.GET)
public String helloConsumer2(){
    StringBuilder sb = new StringBuilder();
    sb.append(helloService.hello("张三")).append("\n");
    sb.append(helloService.hello("张三",18)).append("\n");
    sb.append(helloService.hello(new User("张三",18))).append("\n");
    return sb.toString();
}

在配置文件中设置注册中心的地址

server.port=9001
spring.application.name=feign-consumer
eureka.client.service-url.defaultZone=http://peer1:1111/eureka/

最后在启动类中添加注解开启feign客户端服务调用以及eureka客户端注解

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

启动注册中心、注册服务提供者和消费者，访问/consumer2

抛开编码问题不谈，调用成功哈哈。

完成OpenFeign服务调用的优化

通过对比消费者及服务提供者的相关代码发现，消费者HelloService声明式服务接口的代码与服务提供者Controller层的服务接口代码基本相同。为了实现代码的复用以及降低代码的耦合度，现在将这些代码独立成一个单独的模块。

首先创建一个简单的Maven项目，取名为hello-service-api。因为要使用Spring-MVC相关注解，所以导入相应的依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
        <version>2.7.0</version>
    </dependency>
</dependencies>

紧接着创建HelloService服务调用接口，因为使用到了User对象，所以还要创建一个User类

@Component
public interface HelloService {
    @GetMapping("/hello4")
    String hello(@RequestParam("name") String name);
    @GetMapping("/hello5")
    String hello(@RequestHeader("name") String name,@RequestHeader("age") int age);
    @PostMapping("/hello6")
    String hello(@RequestBody User user);
}

public class User {
    private String name;
    private int age;
    public User(){}
    public User(String name,int age){
        this.name = name;
        this.age = age;
    }
    /** 省略get、set、toString方法 */
}

需要注意的是，必须要提供构造函数，因为OpenFeign需要将JSON数据转换为对象，没有会抛异常

使用Maven工具对其进行打包后，分别对消费者及服务提供者的代码进行重构

在服务提供者的Controller中实现HelloService接口，并编写具体的实现

@RestController
public class ClientController implements HelloService {
    @Override
    public String hello(String name) {
        return name;
    }
    @Override
    public String hello(String name, int age) {
        return name+"|"+age;
    }
    @Override
    public String hello(User user) {
        return user.getName()+"|"+user.getAge();
    }
}

在服务消费者的feign服务调用客户端中继承HelloService接口

@FeignClient("myservice")
public interface HelloServiceDidi extends com.didi.service.HelloService {
}

最后在Controller中通过helloServiceDidi示例完成服务调用

@RequestMapping(value = "/consumer2",method = RequestMethod.GET)
public String helloConsumer2(){
    StringBuilder sb = new StringBuilder();
    sb.append(helloServiceDidi.hello("张三")).append("\n");
    sb.append(helloServiceDidi.hello("张三",18)).append("\n");
    sb.append(helloServiceDidi.hello(new User("张三",18))).append("\n");
    return sb.toString();
}

测试结果如下

抛开编码问题不谈，调用成功哈哈。

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

您可能感兴趣的文章:

feign如何打印出http请求
这篇文章主要介绍了feign如何打印出http请求，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-06-06
springboot项目快速搭建的方法步骤
这篇文章主要介绍了springboot项目快速搭建的方法步骤，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-12-12
Mybatis联合查询的实现方法
本文主要介绍了 Mybatis联合查询的实现方法，文中通过示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2022-01-01
java继承学习之super的用法解析
本文介绍java继承super的用法,Java继承是会用已存在的类的定义作为基础建立新类的技术新类的定义可以增加新的数据或者新的功能,也可以使用父类的功能,但不能选择性的继承父类这种继承使得复用以前的代码非常容易,能够大大的缩短开发的周期,需要的朋友可以参考下
2022-02-02
几句话说清session,cookie和token的区别及说明
这篇文章主要介绍了几句话说清session,cookie和token的区别及说明,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-12-12
如何理解Java线程池及其使用方法
线程池是首先创建一些线程，它们的集合称为线程池。使用线程池可以提高性能，它在系统启动时创建大量空闲的线程，程序将一个任务传给线程池，它就会启动一条线程来执行这个任务，执行结束以后，该线程并不会死亡，而是再次返回线程池中成为空闲状态，等待执行下一个任务
2021-06-06
SpringBoot集成Swagger2的方法
这篇文章主要介绍了SpringBoot集成Swagger2的方法,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12
Java那点事——StringBuffer与StringBuilder原理与区别
本文给大家分享StringBuffer与StringBuilder的区别，它们的应用场景是什么？非常不错，面试考官经常考的一个问题，有需要的朋友跟着脚本之家小编一起学习吧
2016-06-06
一文彻底搞定Java哈希表和哈希冲突
本文介绍了什么是哈希表?什么是哈希函数?什么是哈希冲突?三个问题的解决方案,文中有非常详细的代码示例,对正在学习java的小伙伴们很有帮助,需要的朋友可以参考下
2021-05-05
JDK15正式发布(新增功能预览)
这篇文章主要介绍了JDK15正式发布，新增功能预览，小编觉得挺不错的，现在分享给大家，也给大家做个参考。一起跟随小编过来看看吧
2020-09-09