[SpringCloud] Feign 与 Gateway 简介

这篇具有很好参考价值的文章主要介绍了[SpringCloud] Feign 与 Gateway 简介。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

目录

一、Feign 简介

1、RestTemplate 远程调用中存在的问题

2、定义和使用 Feign 客户端

3、Feign 自定义配置

4、Feign 性能优化

5、Feign 最佳实践

6、Feign 使用问题汇总

二、Gateway 网关简介

1、搭建网关服务

2、路由断言工厂

3、路由的过滤器配置

4、全局过滤器

5、过滤器链执行顺序

6、网关的 cors 跨域配置

7、Gateway 网关使用问题汇总


一、Feign 简介

Feign 是 Netflix 开发的声明式、模板化的 Http 客户端,Feign 可以帮助我们更快捷、优雅地调用Http API。

  • Feign 是在 Ribbon 的基础上进行了一次改进,是一个使用起来更加方便的 HTTP 客户端。
  • SpringCloud 对 Feign 进行了增强,使 Feign 支持了 Spring MVC 注解,并整合了 Ribbon 和 Eureka,集成了服务发现和负载均衡,从而让 Feign 的使用更加方便。

1、RestTemplate 远程调用中存在的问题

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

该远程调用的代码有以下问题:

  • 代码可读性差,编程体验不统一;
  • 参数复杂,URL 难以维护;

2、定义和使用 Feign 客户端

在 SpringCloud 中,使用 Feign 非常简单,创建一个 Interface,并在接口上添加一些注解,代码就完成了。 

(1)引入依赖

  • 给需要远程调用的模块,引入 openfeign 起步依赖;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)添加 @EnableFeignClients 注解

  • 给需要远程调用的启动类,添加 @EnableFeignClients 注解;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(3)编写 Feign 客户端

  • 添加 @FeignClient 和 @GetMapping 注解; 

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

上述注解声明了如下信息:

  • 服务名称:user-service;
  • 请求方式:get;
  • 请求路径:/user/{userId};
  • 请求参数:String userId;
  • 返回值类型:User;

(4)OrderService 远程调用过程

该远程调用过程,就好像平常处理请求的逆过程:

  • OrderService 将 userId 传递给接口中的方法;
  • queryUserById 方法再将参数赋值给请求路径中的占位符 {userId};
  • 然后再通过 get 请求向 UserController 发送请求;
  • 最终获得 User 对象信息;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

3、Feign 自定义配置

Spring 虽然帮我们做好了配置,但是也允许我们修改默认配置。

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

配置 Feign 日志有 2 种方式:

(1)application/bootstrap 配置文件方式

  • 注意:logging.level 属性值需要改为 trace; 

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)Java 代码方式

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

4、Feign 性能优化

Feign 底层客户端实现:

  • URLConnection:默认使用,java 原生 jdk,性能较差,不支持连接池;
  • Apache HttpClient:支持连接池;(推荐)
  • OKHttp:支持连接池;(推荐)

对 Feign 的性能优化,最重要的一点就是对底层实现的改变。

因此优化 Feign 的性能主要包括:

  • 使用连接池代替默认的 URLConnection;
  • 日志级别,最好用 basic 或 none;(因为开启日志也需要占用较多资源)

下面以 HttpClient 为例子,说明性能优化的步骤:

(1)引入依赖

  • httpClient 已经被 Spring 管理好版本了,不需要指定版本;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)修改 application 配置文件

  • 将 feign.httpclient.enabled 的属性值改为 true,表明底层使用 httpclient;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

5、Feign 最佳实践

最佳实践是指,企业开发过程中,总结设计缺点,得出的一种相对比较好的使用方式。

通常会用到 2 种方式,各有利弊,按自己的需求使用:

  • 继承:给消费者的 FeignClient 和提供者的 controller 定义统一的父接口,然后实现接口;
  • 比如 order 模块要调用 user 模块的服务,就定义 UserClient 接口,继承 UserAPI;
  • 缺点:耦合度高;
  • 优点:遵从了契约;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 抽取:将 FeignClient 抽取为独立模块,并且把接口有关的 POJO、默认的 Feign 配置都放到这个模块中,提供给所有消费者使用;
  • 缺点:消费者可能会引入很多用不到的 api;
  • 优点:耦合度低,层次分明;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

我个人更喜欢第二种抽取的方式,下面使用这种方式做一个例子。

(1)创建 feign-api 模块

  • 在 feign-api 模块中引入 feign 的起步依赖;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 将消费者模块中对提供者模块所需的 Client、Pojo,以及 Config 类都移动到 feign-api 中;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)引入 feign-api 模块

  • 在消费者 order-service 模块中,引入 feign-api 模块;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(3)消除报错

  • 将 order-service 模块内原来依赖 pojo、config、client 的类,修改为 feign-api 模块内的类;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 由于 order-service 模块的 application 启动类无法扫描到 feign-api 模块下的 Client 的 Bean 对象,因此会出现如下报错:

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 需要在 @EnableFeignClients 中加入 clients 属性;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

6、Feign 使用问题汇总

(1)Did you forget to include spring-cloud-starter-loadbalancer?

出错原因: 

  • SpringCloud Feign 在 Hoxton.M2 RELEASED 版本之后不再使用 Ribbon,而是使用 spring-cloud-loadbalancer,所以在不引入 spring-cloud-loadbalancer 的情况下会报错。

参考了很多解决方法,主要是要区别版本问题:

包含 RELEASE 关键字的版本中,只有下面这样操作才能使用:

  • 首先排除 ribbon 的起步依赖,排除位置在消费者依赖的服务提供者的 dependency;
  • 添加 loadBalancer 依赖;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

而在 2021 及更新版本中(也就是没有 RELEASE 关键字的版本),只需要如下操作:

  • 引入 loadBalancer 依赖;
  • 不需要排除 ribbon 的起步依赖;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

二、Gateway 网关简介

为什么需要网关?

  • 如果没有网关,那么所有人都可以访问我们所有的服务,但是有很多服务其实是不能对外公开的。
  • 需要使用网关进行身份验证,通过后才能访问敏感服务。
  • 一切请求需要先通过网关,才能到微服务。

因此,网关有如下功能:

  • 身份认证和权限校验;
  • 服务路由、负载均衡;(也就是能知道将请求送到哪个微服务)
  • 限制请求流量;

SpringCloud 提供了 2 个组件实现网关功能:

  • gateway;(新版本)
  • zuul;(早期版本)

Zuul 是基于 Servlet 的实现,属于阻塞式编程。

而 SpringCloudGateway 则是基于 Spring5 中提供的 WebFlux,属于响应式编程的实现,具备更好的性能。

1、搭建网关服务

(1)创建 gateway 模块

  • 创建一个新的模块专门用于网关:gateway-module,需要 SpringBoot 启动类;
  • 引入 SpringCloudGateway 起步依赖;
  • 引入 Nacos 服务发现依赖;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)编写路由配置以及 Nacos 地址

  • gateway 中的 routes 属性之前的配置,目的是为了让 gateway 将服务注册到 nacos;
  • gateway 中的 routes 属性之后的配置,指明了可以使用的 service 路由;
  • id:表示这个路由的名字,与其他属性无关;
  • uri:表示路由目标地址,其中 lb 表示负载均衡,后面跟着服务的 name;
  • predicates:指定路由规则,符合规则就可以放行;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(3)测试网关功能

  • 启动 gateway 的 application;
  • 发起请求:localhost:10010/order/queryOrderById/1;
  • 这个请求中,order-service 模块会调用 user-service 的服务;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 访问失败,说明我们的网关起作用了,因为我们没有为网关配置 order-service 的路由;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 添加对 order-service 的服务的路由后,就可以从 gateway 访问 order 的服务了;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

2、路由断言工厂

路由断言工厂 Route Predicate Factory,作用是:

  • 我们在配置文件中写的 predicates 断言规则只是字符串,这些字符串会被 Predicate Factory 读取并解析为路由判断的条件。
  • 每种规则都有各自的断言工厂去解析,比如 Path 有 PathRoutePredicateFactory 断言工厂;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

下面以 After 举一个例子:

(1)添加断言规则 After

  • After 断言规则,规定在这个时间之后,才能进行访问; 

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)访问 order 的服务

  • 发送请求 /order/queryOrderById/1;
  • 理向情况应该是:无法访问;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 修改断言规则的时间为:2020-12-31,重启 gateway 模块;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 再次发起请求,就可以访问了;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

3、路由的过滤器配置

路由过滤器是:GatewayFilter。

  • GatewayFilter 是网关中提供的一种过滤器,可以对进入网关的请求微服务返回的响应做处理。

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

在这个过程中,过滤器就可对请求和响应做出各种各样的处理,这样往下游传递的数据中,就包含了修改后的信息。

具体有什么样的操作,就要看使用哪个过滤器工厂:

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

下面我们以添加一个请求头为例子:

(1)修改 application 配置文件

  • 给 routes 中的一个路由添加 filters 属性;
  • filters 中添加:- AddRequestHeader=[key],[value];

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)编写 Controller,获取请求头信息

  • 既然在 filter 中设置了 header:orderStatus=001;
  • 那么请求传递到 Controller 后,一定可以获取到这个头信息;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 访问 /order/queryOrderById/1,查看控制台输出;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(3)编写默认过滤器 default-filter

如果我们想为所有的请求都添加 header 信息,也不需要给每一个路由都写上 filters。

  • 只需要在 routes 同级下,添加 default-filter 属性;
  • 给 default-filter 属性添加:- AddRequestHeader=[key],[value] 等属性值;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 访问 /order/queryOrderById/1,查看控制台输出;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

4、全局过滤器

全局过滤器是:GlobalFilter。

  • 全局过滤器的作用:处理一切进入网关的请求和微服务响应,与 GatewayFilter 的作用一样,只是作用范围不同。
  • 其中,GatewayFilter 通过配置定义,运行逻辑是固定的。(官方定义)
  • 而 GlobalFilter 的运行逻辑需要自己写代码实现。(自定义)

需求

定义全局过滤器,拦截请求,判断请求的参数是否满足下面条件:

  • 参数中是否有 authorization;
  • authorization 参数值是否为 admin;
  • 如果同时满足则放行,否则拦截;

(1)定义实现类

  • 创建 AuthorFilter 实现类,实现 GlobalFilter 接口;
  • exchange:请求上下文,里面可以获取Request. Response等信息;
  • chain:用来把请求委托给下一个过滤器;
  •  Nono<Void>:返回表示当前过滤器业务结束

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)定义 filter 方法的运行逻辑

  • 添加 @Component;
  • 添加 @Order,方便多过滤器时指定顺序;
  • 网关中采用的都是基于 WebFlux(响应式编程)的 API,因此使用上与 ServletAPI 不同;
@Order(-1)
@Component
public class AuthorFilter implements GlobalFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        // 1.获取请求参数
        ServerHttpRequest request = exchange.getRequest();
        MultiValueMap<String, String> params = request.getQueryParams();
        // 2.获取请求参数中的 author 参数值
        String author = params.getFirst("author");
        // 3.判断是否等于 admin
        if (author.equalsIgnoreCase("admin")) {
            // 放行
            return chain.filter(exchange);
        }
        // 4.不相等,获取响应
        ServerHttpResponse response = exchange.getResponse();
        // 4.1.设置状态码,401表示未登录
        response.setStatusCode(HttpStatus.UNAUTHORIZED);
        // 4.2.拦截请求
        return response.setComplete();
    }
}

(3)启动 gateway 的 application

  • 访问 /order/queryOrderById/1/author=admin111,先使用错误的 authon 参数值;
  • 发现返回了 401;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 访问 /order/queryOrderById/1/author=admin,使用正确的 authon 参数值;
  • 可以正常访问

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

5、过滤器链执行顺序

请求进入网关会碰到三类过滤器:当前路由的过滤器、DefaultFilter、GlobalFilter。

请求路由后,会将当前路由过滤器DefaultFilterGlobalFilter,合并到一个过滤器链(集合)中,排序后依次执行每个过滤器。

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

过滤器执行顺序:

  • 每一个过滤器都必须指定一个 int 类型的 order 值:order 值越小,优先级越高,执行顺序越靠前;
  • GlobalFilter 通过实现 Ordered 接口,或者添加 @Order 注解来指定 order 值,由我们自己指定;
  • 路由过滤器和 defaultFilter 的 order 由 Spring 官方指定,默认是按照声明顺序从 1 递增;
  • 当过滤器的 order 值一样时,会按照 defaultFilter > 路由过滤器 > GlobalFilter 的顺序执行;

6、网关的 cors 跨域配置

由于一些页面可能需要从微服务中获取某些数据,此时需要发起 AJAX 请求,那么这就可能属于跨域请求的范畴。(一般我们的 web 页面端口都不会与微服务的相同,所以请求基本上都是跨域请求)

跨域请求不需要在微服务中处理,只需要在网关中处理即可。

跨域:域名不一致就是跨域,主要包括:

  • 域名不同:www.taobao.com 和 www.taobao.org 和 www.jd.com 和 miaosha.jd.com;
  • 域名相同,端口不同:localhost:8080 和 localhost:8081

跨域问题的 2 个要素:

  • 浏览器、服务端:浏览器禁止请求向服务端发起跨域 ajax 请求,请求会被拦截;
  • 解决方案:CORS;

需求:

  • 使用 localhost:8090 发起请求,8090 发送的是 AJAX 的 GET 请求。
  • 8090 发起的 AJAX 请求需要通过网关,在 AJAX 的目标地址中要用 10010 端口;

(1)编写 gateway 的配置文件

  • 各个属性的作用都写在注释中了;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

(2)端口 8090 的 AJAX 请求

  • 这里使用 JQuery 发起 AJAX 请求,传递参数为 author=admin;
  • 这里参数是必须传递的,因为发起的请求目标地址是要通过网关的,需要鉴权;
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script type="text/javascript" src="JQuery-3.7.0.js"></script>
    <script type="text/javascript">
        $(function() {
            $("#ajaxButton").click(function() {
                $.ajax({
                    url:"http://localhost:10010/order/queryOrderById/1",
                    data: {
                        author : "admin"
                    },
                    type: "get",
                    dataType: "json",
                    success: function(data) {
                        console.log(data);
                    }
                });
            });
        });
    </script>
</head>
<body>
    <a href="http://localhost:10010/order/queryOrderById/1?author=admin"> 发起普通GET请求 </a>
    <input id="ajaxButton" type="button" value="发起 ajax 请求"/>
</body>
  • 发起请求,可以在控制台看到返回的数据;

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

  • 而如果我们用 <a> 来请求,是会跳转到 10010 得页面的,这就不算跨域请求了;

7、Gateway 网关使用问题汇总

(1)搭建网关服务时,报错 503

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java

这是因为在 Spring Cloud 2020 版本以后,默认移除了对 Netflix 的依赖,其中就包括 Ribbon,官方默认推荐使用 Spring Cloud Loadbalancer 正式替换 Ribbon,并成为了 Spring Cloud 负载均衡器的唯一实现。

Loadbalancer 依赖:

[SpringCloud] Feign 与 Gateway 简介,Spring,spring cloud,gateway,java文章来源地址https://www.toymoban.com/news/detail-740007.html

到了这里,关于[SpringCloud] Feign 与 Gateway 简介的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • 【springcloud 微服务】Spring Cloud 微服务网关Gateway使用详解

    目录 一、微服务网关简介 1.1 网关的作用 1.2 常用网关 1.2.1 传统网关 1.2.2 云原生网关

    2023年04月16日
    浏览(50)
  • 【SpringCloud】11、Spring Cloud Gateway使用Sentinel实现服务限流

    1、关于 Sentinel Sentinel 是阿里巴巴开源的一个流量防卫防护组件,可以为微服务架构提供强大的流量防卫能力,包括流量控制、熔断降级等功能。Spring Cloud Gateway 与 Sentinel 结合,可以实现强大的限流功能。 Sentinel 具有以下特性: 丰富的应用场景:Sentinel 承接了阿里巴巴近

    2024年02月01日
    浏览(54)
  • Spring Cloud 之 Sentinel简介与GATEWAY整合实现

    随着微服务的流行,服务和服务之间的稳定性变得越来越重要。Sentinel 是面向分布式服务架构的流量控制组件,主要以流量为切入点,从限流、流量整形、熔断降级、系统负载保护、热点防护等多个维度来帮助开发者保障微服务的稳定性。 熔断 微服务架构的系统通常会包含

    2024年02月19日
    浏览(41)
  • Java之SpringCloud Alibaba【七】【Spring Cloud微服务网关Gateway组件】

    Java之SpringCloud Alibaba【一】【Nacos一篇文章精通系列】 跳转 Java之SpringCloud Alibaba【二】【微服务调用组件Feign】 跳转 Java之SpringCloud Alibaba【三】【微服务Nacos-config配置中心】 跳转 Java之SpringCloud Alibaba【四】【微服务 Sentinel服务熔断】 跳转 Java之SpringCloud Alibaba【五】【微服务

    2024年02月06日
    浏览(60)
  • SpringCloud - Spring Cloud 之 Gateway网关,Route路由,Predicate 谓词/断言,Filter 过滤器(十三)

    阅读本文前可先参考 ​​​​​​SpringCloud - Spring Cloud根/父项目,开发准备(二)_MinggeQingchun的博客-CSDN博客 SpringCloud - Spring Cloud 之 Gateway网关(十三)_MinggeQingchun的博客-CSDN博客 Web 有三大组件(监听器 过滤器 servlet),Spring Cloud GateWay 最主要的功能就是路由转发,而在定义

    2024年02月14日
    浏览(64)
  • spring cloud gateway中出现503 spring cloud gateway中出现503

    当搭建网关模块的时候出现503的错误的最大的可能就是没有设置负载均衡的依赖包  原先搭建的时候采用的是下面的方式进行设置的 上面的这种方式可以直接进行注册和发现,但是要求必须导入下面的依赖 希望简单的随笔能够帮助你!

    2024年02月11日
    浏览(48)
  • 【Spring Cloud 八】Spring Cloud Gateway网关

    【Spring Cloud一】微服务基本知识 【Spring Cloud 三】Eureka服务注册与服务发现 【Spring Cloud 四】Ribbon负载均衡 【Spring Cloud 五】OpenFeign服务调用 【Spring Cloud 六】Hystrix熔断 【Spring Cloud 七】Sleuth+Zipkin 链路追踪 在项目中是使用了Gateway做统一的请求的入口,以及统一的跨域处理以及

    2024年02月12日
    浏览(46)
  • Spring Cloud Gateway

    目录 一、Spring Cloud Gateway 1、网关介绍 2、GateWay 3、GateWay项目搭建 4、GateWay配置路由的两种方式 4.1、YML配置 4.2、配置类 5、GateWay实现负载均衡 5.1、自动负载均衡 5.2、手动负载均衡 6、GateWay断言Predicate 7、GateWay的Filter         在 微服务架构 中,一个 系统会被拆分为很多

    2024年02月10日
    浏览(48)
  • spring cloud 之 gateway

    在微服务架构体系中,一个系统会被拆分为很多个微服务,那么作为客户端要如何去调用这么多的微服务呢?如果没有网关的存在,我们只能在客户端记录每个微服务的地址,然后分别调用,当然这样是不现实的 Kong    基于Nginx+Lua开发,性能高,稳定,有多个可用的插件

    2024年02月12日
    浏览(38)
  • 细说 Spring Cloud Gateway

    在微服务架构中,API 网关是一个非常重要的组件,它可以帮助我们实现服务的路由、负载均衡、认证授权等功能。Spring Cloud Gateway 是 Spring Cloud 官方推出的一个基于 Spring 5、Spring Boot 2 和 Project Reactor 的 API 网关实现。本文将介绍 Spring Cloud Gateway 的基本概念、核心组件以及如何

    2024年02月14日
    浏览(34)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包