服务器之家：专注于VPS、云服务器配置技术及软件下载分享
分类导航

PHP教程|ASP.NET教程|Java教程|ASP教程|编程技术|正则表达式|C/C++|IOS|C#|Swift|Android|VB|R语言|JavaScript|易语言|vb.net|

服务器之家 - 编程语言 - Java教程 - SpringCloud OpenFeign基本介绍与实现示例

SpringCloud OpenFeign基本介绍与实现示例

2023-03-02 13:56尚少 Java教程

OpenFeign源于Netflix的Feign，是http通信的客户端。屏蔽了网络通信的细节，直接面向接口的方式开发，让开发者感知不到网络通信细节。所有远程调用，都像调用本地方法一样完成

介绍

  在上面一篇介绍Nacos的文章最后，两个服务的相互调用是用的RestTemplate类完成的。但这种方式不是很推荐，更佳的方式是用OpenFeign组件去调用。OpenFeign是官方推出的服务调用和负载均衡组件，基于Ribbon和Hystrix，前身是第一代Spring Cloud的Feign，对Feign进行了扩展，支持了SpringMvc的相关注解。

常用注解

  OpenFeign是使用接口+注解实现的，因此了解它的常用注解是必要的，有以下几个：

@EnableFeignClients：在启动类上添加，用于开启OpenFeign功能。当项目启动时，会扫描带有@FeignClient的接口，生成代理类并注册到Spring容器中

@FeignClient：通知OpenFeign组件对该注解下的接口进行解析，通过动态代理的方式产生实现类，完成服务调用

@RequestMapping：SpringMvc中的注解，不过此时该注解表示发起Request请求(默认Get方式)

@GetMapping：SpringMvc中的注解，不过此时该注解表示发起Get请求

@PostMapping：SpringMvc中的注解，不过此时该注解表示发起Post请求

代码实现

  首先得把Nacos启动

  服务提供方，

  bootstrap.yml：

server:
  port: 8083
  servlet:
    context-path: /nacosProvider

spring:
  application:
    name: nacos-provider
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

  引入依赖：

?
1
2
3
4
5
6
7
8
9
10
11
12
<dependencies>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery
        </artifactId>
        <version>2.2.0.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

  服务方法：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
@Controller
@RequestMapping("/provide")
public class ProviderController {
    @RequestMapping("/distribute")
    @ResponseBody
    public String distribute() {
        return "吃鸡胸肉";
    }
    @RequestMapping("/distribute1")
    @ResponseBody
    public String distribute1(String name, Integer age) {
        return "姓名：" + name + "，年龄：" + age;
    }
    @PostMapping("/distribute2")
    @ResponseBody
    public String distribute2(@RequestBody Person p) {
        return "身高：" + p.getHeight() + "，肤色：" + p.getSkin();
    }
}
?
1
2
3
4
5
6
import lombok.Data;
@Data
public class Person {
    private Integer height;
    private String skin;
}

  服务调用方，

  bootstrap.yml

server:
  port: 8082
  servlet:
    context-path: /nacosInvoke

spring:
  application:
    name: nacos-invoke
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

  引入依赖：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
<dependencies>
    <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-alibaba-nacos-discovery
        </artifactId>
        <version>2.2.0.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-openfeign</artifactId>
        <version>2.2.0.RELEASE</version>
    </dependency>
    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
    </dependency>
</dependencies>

  启动类上添加注解：

?
1
2
3
4
5
6
7
8
9
10
11
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.openfeign.EnableFeignClients;
//开启OpenFeign
@EnableFeignClients
@SpringBootApplication
public class NacosInvokeApplication {
    public static void main(String[] args) {
        SpringApplication.run(NacosConfigApplication.class, args);
    }
}

  创建@FeignClient修饰的接口：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
import com.gs.nacos_invoke.dto.Person;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
/**
 * value值是服务提供方的服务名称
 */
@FeignClient(value = "nacos-provider")
public interface InvokeClient {
    @GetMapping("/nacosProvider/provide/distribute")
    String distribute();
    @GetMapping("/nacosProvider/provide/distribute1")
    String distribute1(@RequestParam("name") String name,
    @RequestParam("age") Integer age);
    @PostMapping("/nacosProvider/provide/distribute2")
    String distribute2(@RequestBody Person p);
}

  Person类(服务调用方再创建一个，不是同一个)：

?
1
2
3
4
5
6
import lombok.Data;
@Data
public class Person {
    private Integer height;
    private String skin;
}

  编写控制器，使用接口请求提供方的服务：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
import com.gs.nacos_invoke.dto.Person;
import com.gs.nacos_config.feign.InvokeClient;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
@Controller
@RequestMapping("/user")
public class UserController {
    @Autowired
    private InvokeClient invokeClient;
    @GetMapping("/invoke")
    public void invoke(String name, Integer age) {
        String str = invokeClient.distribute();
        System.out.println(str);
    }
    @GetMapping("/invoke1")
    public void invoke1() {
        String str = invokeClient.distribute1("coder", 20);
        System.out.println(str);
    }
    @GetMapping("/invoke2")
    public void invoke2() {
        Person p = new Person();
        p.setHeight(183);
        p.setSkin("黄皮肤");
        String s = invokeClient.distribute2(p);
        System.out.println(s);
    }
}

注意事项

  OpenFeign是基于Ribbon的，所以它默认是负载均衡的。其次，它也是基于Hystrix的，有超时降级的处理：默认服务提供方的接口超时时间是1s，超过1s服务调用方会报错。1s是可以配置的，按照业务需要调整。@FeignClient注解有个fallback属性，当该属性有值时，服务提供方超时，会返回程序所指定的降级值。

  服务调用方，bootstrap.yml添加(更规范的做法是引入spring-cloud-starter-alibaba-nacos-config依赖，nacos中新建配置，然后在这个配置中添加)：

feign:
  hystrix:
    enabled: true
ribbon:
    # 请求连接的超时时间
    ConnectionTimeout: 3000
    # 请求处理的超时时间
    ReadTimeout: 3000

hystrix:
    command:
        default:
            execution:
                isolation:
                    thread:
                        timeoutInMilliseconds: 3000

  接口修改为：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import com.gs.nacos_invoke.dto.Person;
import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestParam;
@FeignClient(value = "nacos-provider",
        fallback = InvokeClientFallback.class)
public interface InvokeClient {
    @GetMapping("/nacosProvider/provide/distribute")
    String distribute();
    @GetMapping("/nacosProvider/provide/distribute1")
    String distribute1(@RequestParam("name") String name,
    @RequestParam("age") Integer age);
    @PostMapping("/nacosProvider/provide/distribute2")
    String distribute2(@RequestBody Person p);
}

  fallback指定的类：

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
import com.gs.nacos_invoke.dto.Person;
import org.springframework.stereotype.Component;
@Component
public class InvokeClientFallback implements InvokeClient {
    @Override
    public String distribute() {
        return "超时3s";
    }
    @Override
    public String distribute1(String name, Integer age) {
        return "超时3s";
    }
    @Override
    public String distribute2(Person p) {
        return "超时3s";
    }
}

  服务提供方ProviderController类的方法中，加入Thread.sleep(4000);或者throw new RuntimeException("抛异常");来触发降级(抛出未捕获的异常也能触发)。

到此这篇关于SpringCloud OpenFeign基本介绍与实现示例的文章就介绍到这了,更多相关SpringCloud OpenFeign内容请搜索服务器之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持服务器之家！

原文链接：https://blog.csdn.net/gs2436/article/details/127938265

  • OpenFeign
  • SpringCloud

    • 延伸 · 阅读

    精彩推荐
    • Java教程轻松掌握Java享元模式

      轻松掌握Java享元模式

      这篇文章主要帮助大家轻松掌握Java享元模式,具有一定的参考价值，感兴趣的小伙伴们可以参考一下...

      断了联系1892020-06-19
    • Java教程Jenkins之Log Parse使用方法详解

      Jenkins之Log Parse使用方法详解

      这篇文章主要为大家详细介绍了Jenkins插件Log Parse使用方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下...

      小龙女先生7892021-05-28
    • Java教程新手了解java 数组基础知识

      新手了解java 数组基础知识

      这篇文章主要介绍了Java 数组分析及简单实例的相关资料,在Java中它就是对象，一个比较特殊的对象，需要的朋友可以参考下，希望可以对你有所帮助...

      王星伟QAQ9492021-09-27
    • Java教程Dubbo 泛化调用在vivo统一配置系统的应用

      Dubbo 泛化调用在vivo统一配置系统的应用

      本文结合在实际开发过程中所遇到的需要远程调用多个三方系统的问题，阐述了如何利用Dubbo泛化调用来简化开发降低系统耦合性的项目实践，最后对Dubb...

      vivo互联网技术4302022-11-09
    • Java教程java继承中的构造方法实例解析

      java继承中的构造方法实例解析

      这篇文章主要介绍了java继承中的构造方法实例解析,针对继承中的构造方法的特点进行了实例分析,需要的朋友可以参考下 ...

      shichen20145572019-12-01
    • Java教程浅谈JMeter engine启动原理

      浅谈JMeter engine启动原理

      本文主要介绍jmeter在控制台在点击执行之后底层所做的一些主要事情及内容，具有一定的参考价值，感兴趣的小伙伴们可以参考一下...

      HenryXiao80805642021-12-18
    • Java教程springboot 集成redission 以及分布式锁的使用详解

      springboot 集成redission 以及分布式锁的使用详解

      这篇文章主要介绍了springboot 集成redission 以及分布式锁的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教...

      介寒食9082022-02-23
    • Java教程浅析Java线程的中断机制

      浅析Java线程的中断机制

      本篇文章通过代码实例给大家分享了学习Java线程的中断机制的一些心得内容，有兴趣的朋友学习下吧。...

      傅易6892021-03-09
    最近更新
    编辑推荐
    阅读排行
    热门标签
    501 　 406 　 415 　 2000 　 1433 　 204 　 401 　 330 　 选择排序法 　 随机抽取 　 内存卡 　 下载器 　 十六进制字符 　 响应 　 静态工厂 　 构造函数 　 swt 　 Overview 　 对象池模式 　 KafkaListener 　 支票 　 金额大写转换 　 空心菱形 　 AspectJ 　 面向切面编程 　 方法名 　 网址信息 　 动态代理模式 　 线程安全 　 htmlparser 　
    © 2019-2023 服务器之家(www.tuohang.net) 版权所有关于我们联系我们版权申明网站地图