springcloudgateway网关配置文件gateway联动nacosgateway自动定位

开发运维 2023-07-19 穿过生命散发芬芳 手机阅读
Scan me!

上一篇：微服务架构与单体应用架构的区别---以及微服务工程的基础搭建--springcloud - 掘金 (juejin.cn)

gateway网关

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

常见的API网关:

l Ngnix+lua

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

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

l Kong

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

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

l Zuul 1.0----老的微服务项目

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

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

l 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 链的方式提供了网关基本的功能，例如：安全，监控和限流。

如何使用gateway

(1)引入依赖

如果你引入了gateway的依赖，那么不能引用spring-boot-starter-web的依赖。
gateway使用的服务netty服务，如果你引入web，而web使用的tomcat服务器。两个服务会出现冲突

 
        
            org.springframework.cloud
            spring-cloud-starter-gateway

(2)主启动类

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

(3)配置文件

#端口号
server:
  port: 81
spring:
  application:
    #网关的服务名称
    name: aaa-gateway
  #路径规则
  cloud:
    gateway:
      routes:
        #微服务一号
        #商品服务的路由标志，不写就是随机生成
        - id: cjj-product
          #转发的地址
          uri: http://localhost:8001
          #断言：当满足断言条件的时候，才会真正转发到uri地址
          predicates:
            - Path=/product/**
        #微服务二号
        #商品服务的路由标志，不写就是随机生成
        - id: aaa-order
          #转发的地址
          uri: http://localhost:9002
          #断言：当满足断言条件的时候，才会真正转发到uri地址
          predicates:
            - Path=/order/**

image.png

（4）gateway联动nacos

发现uri地址是一个死数据，未来我们可能是集群。

如何解决? --我们也可以把网关交于注册中心来管理，那么网关就可以从注册中心拉取服务信息。

（1）在网关中引入nacos依赖

（2）修改配置文件:

#端口号
server:
  port: 81
spring:
  application:
    #网关的服务名称
    name: aaa-gateway
  #路径规则
  cloud:
    gateway:
      routes:
        #微服务一号
        #商品服务的路由标志，不写就是随机生成
        - id: cjj-product
          #真实要转发的地址：lb://微服务
          uri: lb://cjj-product
          #断言：当满足断言条件的时候，才会真正转发到uri地址
          predicates:
            - Path=/product/**
        #微服务二号
        #商品服务的路由标志，不写就是随机生成
        - id: aaa-order
          #真实要转发的地址：lb://微服务
          uri: lb://cjj-order
          #断言：当满足断言条件的时候，才会真正转发到uri地址
          predicates:
            - Path=/order/**
 
    nacos:
      discovery:
        #微服务的ip地址和端口号
        server-addr: localhost:8848
        #只拉取nacos微服务，不上传当前微服务
        register-enabled: false

image.png

(5)gateway自动定位功能

思考: 如果未来我们有1w个微服务，那么就需要在gateway中配置1w微服务的路由。

解决方案: 可以使用gateway自动定位功能

#端口号
server:
  port: 81
spring:
  application:
    #网关的服务名称
    name: aaa-gateway
    nacos:
      discovery:
        #微服务的ip地址和端口号
        server-addr: localhost:8848
        #只拉取nacos微服务，不上传当前微服务
        register-enabled: false
  #开启微服务自动定位功能
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true

image.png

image.png

（6）gateway的断言方式--只作为了解,具体使用方法自行百度

l **基于 ****Datetime **类型的断言工厂

此类型的断言根据时间做判断，主要有三个：

AfterRoutePredicateFactory： 接收一个日期参数，判断请求日期是否晚于指定日期

BeforeRoutePredicateFactory： 接收一个日期参数，判断请求日期是否早于指定日期

BetweenRoutePredicateFactory： 接收两个日期参数，判断请求日期是否在指定时间段内

-After=2019-12-31T23:59:59.789+08:00[Asia/Shanghai]

l **基于远程地址的断言工厂 ****RemoteAddrRoutePredicateFactory **：

接收一个IP地址段，判断请求主机地址是否在地址段中

-RemoteAddr=192.168.1.1/24

l **基于 ****Cookie **的断言工厂

CookieRoutePredicateFactory：接收两个参数，cookie 名字和一个正则表达式。 判断请求

cookie是否具有给定名称且值与正则表达式匹配。

-Cookie=chocolate, ch.

l **基于 ****Header **的断言工厂

HeaderRoutePredicateFactory：接收两个参数，标题名称和正则表达式。 判断请求Header是否

具有给定名称且值与正则表达式匹配。 key value

-Header=X-Request-Id, d+

l **基于 ****Host **的断言工厂

HostRoutePredicateFactory：接收一个参数，主机名模式。判断请求的Host是否满足匹配规则。

-Host=**.testhost.org

l **基于 ****Method **请求方法的断言工厂

MethodRoutePredicateFactory：接收一个参数，判断请求类型是否跟指定的类型匹配。

-Method=GET

l **基于 ****Path **请求路径的断言工厂

PathRoutePredicateFactory：接收一个参数，判断请求的URI部分是否满足路径规则。

-Path=/foo/{segment}基于Query请求参数的断言工厂

QueryRoutePredicateFactory ：接收两个参数，请求param和正则表达式， 判断请求参数是否具

有给定名称且值与正则表达式匹配。

-Query=baz, ba.

l 基于路由权重的断言工厂

WeightRoutePredicateFactory：接收一个[组名,权重], 然后对于同一个组内的路由按照权重转发

routes:

-id: weight_route1 uri: host1 predicates:

-Path=/product/**

-Weight=group3, 1

-id: weight_route2 uri: host2 predicates:

-Path=/product/**

-Weight= group3, 9

（7）gateway内置的过滤器--了解

image.png

image.png

（8）自定义过滤器-全局过滤器

自定义过滤器的作用

认证判断

权限校验

黑白名单

跨域配置

认证判断

l 当客户端第一次请求服务时，服务端对用户进行信息认证（登录）

l 认证通过，将用户信息进行加密形成token，返回给客户端，作为登录凭证

l 以后每次请求，客户端都携带认证的token

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

image.png

如上图，对于验证用户是否已经登录鉴权的过程可以在网关统一检验。

检验的标准就是请求中是否携带token凭证以及token的正确性。

如何定义全局过滤器

自定义全局过滤器

 
@Component
public class LoginFilter implements GlobalFilter, Ordered {
 
    @Autowired
    private FilterUrl filterUrl;
 
    @Override
    public Mono filter(ServerWebExchange exchange, GatewayFilterChain chain) {
        //拿到请求端的数据
        final ServerHttpRequest request = exchange.getRequest();
        //拿到返回给前端前端的数据
        final ServerHttpResponse response = exchange.getResponse();
        //过滤的业务代码
        //1.获取请求路径---
        final String url = request.getPath().toString();
        //判断该路径是否是放行路径
        if(filterUrl.getWhitePaths().contains(url)){
            return chain.filter(exchange);
        }
 
        //获取请求头
        final String token = request.getHeaders().getFirst("token");
        //模拟权限校验,如果有权限就放行
        if(StringUtils.hasText(token)&&"admin".equals(token)){
            return chain.filter(exchange);
        }
 
        //json数据
        Map map = new HashMap();
        map.put("msg", "未登录");
        map.put("code", 403);
 
        //作JSON转换,将map转换为json
        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;
    }
}

获取配置文件的实体类，白名单黑名单

 
@Component
@ConfigurationProperties(prefix = "filter")
public class FilterUrl {
 
    private Set whitePaths = new HashSet();
 
 
    private Set blackPaths = new HashSet();
 
    public FilterUrl() {
    }
 
    public FilterUrl(Set whitePaths, Set blackPaths) {
        this.whitePaths = whitePaths;
        this.blackPaths = blackPaths;
    }
 
    /**
     * 获取
     * @return whitePaths
     */
    public Set getWhitePaths() {
        return whitePaths;
    }
 
    /**
     * 设置
     * @param whitePaths
     */
    public void setWhitePaths(Set whitePaths) {
        this.whitePaths = whitePaths;
    }
 
    /**
     * 获取
     * @return blackPaths
     */
    public Set getBlackPaths() {
        return blackPaths;
    }
 
    /**
     * 设置
     * @param blackPaths
     */
    public void setBlackPaths(Set blackPaths) {
        this.blackPaths = blackPaths;
    }
 
    public String toString() {
        return "FilterUrl{whitePaths = " + whitePaths + ", blackPaths = " + blackPaths + "}";
    }
}

配置文件

#端口号
server:
  port: 81
spring:
  application:
    #网关的服务名称
    name: aaa-gateway
    nacos:
      discovery:
        #微服务的ip地址和端口号
        server-addr: localhost:8848
        #只拉取nacos微服务，不上传当前微服务
        register-enabled: false
  #开启微服务自动定位功能
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true
         # 截断原始请求路径的第一个，比如aaa/bbb/ccc，截断后变为bbb/ccc
#      default-filters:
#        - StripPrefix=1
#过滤器路径
filter:
#白名单
  whitePaths:
#    - "/cjj-product/product/findProductById/{id}"
    - "/cjj-order/order/insertOrder"
#黑名单
  blackPaths:
    - "login"

解决跨域问题的两种方式

（1）第一种：写一个跨域配置类

package com.cjj.gateway.crossconfig;
 
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.cors.CorsConfiguration;
import org.springframework.web.cors.reactive.CorsWebFilter;
import org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource;
import org.springframework.web.filter.CorsFilter;
import org.springframework.web.util.pattern.PathPatternParser;
 
@Configuration
public class CorConfig { //处理跨域
    //处理跨域
    @Bean
    public CorsWebFilter corsFilter() {
        CorsConfiguration config = new CorsConfiguration();
        config.addAllowedMethod("*");
        config.addAllowedOrigin("*");
        config.addAllowedHeader("*");
        org.springframework.web.cors.reactive.UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource(new PathPatternParser());
        source.registerCorsConfiguration("/**", config);
        return new CorsWebFilter(source);
    }
}

（2）跨域解决写在配置文件中

spring:
  application:
    name: gateway  #服务名称
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 #nacos地址
    gateway:
      globalcors:
        add-to-simple-url-handler-mapping: true
        cors-configurations:
          '[/**]':  #拦截的请求
            allowedOrigins: #允许跨域的请求
              - "http://localhost:8080"
            allowedMethods: #运行跨域的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" #允许请求中携带的头信息
            allowedCredentials: true #是否允许携带cookie
            maxAge: 36000 #跨域检测的有效期,单位s

上面的方案选择一个就行。