Spring Cloud Alibaba-Gateway服务网关

Have_MonkeyG

已于 2022-08-23 15:46:57 修改

阅读量486

点赞数

文章标签： gateway java spring cloud 微服务开发语言

于 2022-08-22 21:12:21 首次发布

本文链接：https://blog.csdn.net/Have_MonkeyG/article/details/126472844

版权

一、网关简介

大家都都知道在微服务架构中，一个系统会被拆分为很多个微服务。那么作为客户端（pc androud ios 平板）要如何去调用这么多的微服务呢？如果没有网关的存在，我们只能在客户端记录每个微服务的地址，然后分别去调用。 axios.get(ip:port/url) axios.get(ip:port/url)

这样的架构，会存在着诸多的问题：

客户端多次请求不同的微服务，增加客户端代码或配置编写的复杂性
认证复杂，每个服务都需要独立认证。
存在跨域请求，在一定场景下处理相对复杂。

（跨域: 浏览器的ajax从一个地址访问另一个地址：

协议://ip:port 如果三则有一个不同，则会出现跨域问题。

上面的这些问题可以借助API网关来解决。

所谓的API网关，就是指系统的统一入口，它封装了应用程序的内部结构，为客户端提供统一服务，一些与业务本身功能无关的公共逻辑可以在这里实现，诸如认证、鉴权、监控（黑白名单）、路由转发等等。

二、业界比较流行的网关

在业界比较流行的网关，有下面这些：

Ngnix+lua

使用nginx的反向代理和负载均衡可实现对api服务器的负载均衡及高可用

lua是一种脚本语言,可以来编写一些简单的逻辑, nginx支持lua脚本

Kong

基于Nginx+Lua开发，性能高，稳定，有多个可用的插件(限流、鉴权等等)可以开箱即用。问题：

只支持Http协议；二次开发，自由扩展困难；提供管理API，缺乏更易用的管控、配置方式。

Zuul 1.0（慢 servlet 2.0 ） zuul2.0 没出来。

Netflix开源的网关，功能丰富，使用JAVA开发，易于二次开发问题：缺乏管控，无法动态配

置；依赖组件较多；处理Http请求依赖的是Web容器，性能不如Nginx

Spring Cloud Gateway

Spring公司为了替换Zuul而开发的网关服务，将在下面具体介绍。

注意：SpringCloud alibaba技术栈中并没有提供自己的网关，我们可以采用Spring Cloud Gateway来做网关

三、Gateway简介

Spring Cloud Gateway是Spring公司基于Spring 5.0，Spring Boot 2.0 和 Project Reactor 等术开发的网关，它旨在为微服务架构提供一种简单有效的统一的 API 路由管理方式。它的目标是替代 Netflix Zuul，其不仅提供统一的路由方式，并且基于 Filter 链的方式提供了网关基本的功能，例如：安全，监控和限流。

优点：

性能强劲：是第一代网关Zuul的1.6倍
功能强大：内置了很多实用的功能，例如转发、监控、限流等
设计优雅，容易扩展.

缺点：

其实现依赖Netty与WebFlux，不是传统的Servlet编程模型，学习成本高
不能将其部署在Tomcat、Jetty等Servlet容器里，只能打成jar包执行 web.Jar
需要Spring Boot 2.0及以上的版本，才支持gateway内置了服务器 netty服务器。

四、Gateway的使用

1.创建一个gateway模块

2.导入相关的依赖

        <!--只需要添加该依赖，不要使用spring-boot-starter- web依赖 因为gateway内置了服务器netty.而web的jar内置 tomcat-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>
        <!--拉取服务-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

3.创建主启动类



import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;

/**
 * @Auther: haohao
 * @Date:2022/8/2015:07
 */
@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApp {
    public static void main(String[] args) {
        SpringApplication.run(GatewayApp.class, args);
    }
}

4.修改配置文件

application.yml配置文件中的内容:

server:
  port: 7000
spring:
  application:
    name: springcloud-gateway
  # 配置api
  cloud:
    gateway:
      routes:
        - id: springcloud-product   # 路由的唯一标识，只要不重复都可以，如果不写默认会通过UUID产生，一般写成被路由的服务名称
          uri: http://localhost:8081/  # 被路由的地址真实地址
          order: 1                     #表示优先级  数字越小优先级越高
          predicates:                  #断言: 执行路由的判断条件,predicates:当满足断言时，才会转发到真实的uri地 址
            - Path= /product/**

5.启动项目, 并通过网关去访问微服务

访问成功即可

6.实现让gateway网关从注册中心拉取服务

通过发现:

路由配置时uri的地址还是一个固定的网络地址，如果后期微服

务地址发送改变，也需要修改网关的配置。不能完成负载均衡。

解决:

我们知道，gateway他也是可一个微服务，它可以从注册中心拉

取服务信息。

(1)引入依赖

<!--拉取服务-->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
        </dependency>

(2)修改application.yml的配置文件

server:
  port: 7000

spring:
  application:
    name: springcloud-gateway
  cloud:
    gateway:
      routes:
        - id: springcloud-product
          #路由转发的真实地址
          uri: lb://springcloud-product
          #predicates：断言:当满足断言时，才会触发到只能说的uri地址
          predicates:
            - Path=/product/**
        - id: springcloud-order
            #路由转发的真实地址
          uri: lb://springcloud-order
            #predicates：断言:当满足断言时，才会触发到只能说的uri地址
          predicates:
            - Path=/order/**
#    指定注册中心地址
    nacos:
      discovery:
        server-addr: localhost:81
        register-enabled: false

7.自动路由

通过gateway拉去服务我们发现:

有一个微服务需要配置一个路由，如果这时增加一个新的微服务，则需要在配置文件中增加一个新的路由配置。

修改application.yml的配置文件

server:
  port: 7000

spring:
  application:
    name: springcloud-gateway
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true#是否开启自动gateway的自动定位功能
    nacos:
      server-addr: localhost:81

访问时 :

http:// 网关的 ip: 网关的 port/ 微服务名称 / 资源路径

8.过滤器(全局过滤器)

全局过滤器作用于所有路由, 无需配置。通过全局过滤器可以实现对权限的统一校验，安全性验证等功能。

自定义全局过滤器:

内置的过滤器已经可以完成大部分的功能，但是对于企业开发的一些业务功能处理，还是需要我们自己编写过滤器来实现的，那么我们一起通过代码的形式自定义一个过滤器，去完成统一的权限校验。

开发中的鉴权逻辑：

当客户端第一次请求服务时，服务端对用户进行信息认证（登录）
认证通过，将用户信息进行加密形成token，返回给客户端aaaa，作为登录凭证
以后每次请求，客户端都携带认证的token

服务端对token进行解密，判断是否有效。

过滤器的内容:

package com.gsh.gateway.filter;

import com.alibaba.fastjson.JSON;
import com.gsh.gateway.entity.Aoon;
import com.gsh.gateway.util.CommonResult;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.core.io.buffer.DataBuffer;
import org.springframework.http.HttpStatus;
import org.springframework.http.server.RequestPath;
import org.springframework.http.server.reactive.ServerHttpRequest;
import org.springframework.http.server.reactive.ServerHttpResponse;
import org.springframework.stereotype.Component;
import org.springframework.util.StringUtils;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;

import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;



@Component
public class LoginFilter implements GlobalFilter, Ordered {
    @Autowired
    private Aoon aoon;
    //过滤方法
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        ServerHttpRequest request = exchange.getRequest();
        ServerHttpResponse response = exchange.getResponse();
        //获取请求
        String path = request.getPath().toString();
        //判断当前请求路径是否为放行路径
        if(aoon.getUrl().contains(path)){
            return chain.filter(exchange);//放行
        }
        //2.判断是否携带token
        String token=request.getHeaders().getFirst("token");
        if(StringUtils.hasText(token)&&"admin".equals(token)){
            //从redis中获取
            return chain.filter(exchange);//放行
        }
        //设置状态码
        response.setStatusCode(HttpStatus.UNAUTHORIZED);
        //封装返回数据
        Map<String, Object> map = new HashMap<>();
         map.put("msg", "未登录");
         map.put("code", 4000);
         //转换为jason格式
        byte[] bytes = JSON.toJSONString(map).getBytes(StandardCharsets.UTF_8 );
        //调用bufferFactory方法,生成DataBuffer对象
        DataBuffer buffer = response.bufferFactory().wrap(bytes);
        //调用Mono中的just方法,返回要写给前端的JSON数据
        return response.writeWith(Mono.just(buffer));


    }
    //过滤条件的优先级
    @Override
    public int getOrder() {
        return 0;
    }
}