devbox
黑客灵魂
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

Gateway网关的配置和使用_gateway网关配置

作者：黑客灵魂 | 2024-07-15 20:51:38

赞

踩

gateway网关配置

网关的作用:
        ·对用户请求做身份认证、权限校验
        ·将用户请求路由到微服务，并实现负载均衡心
        ·对用户请求做限流

网关搭建步骤:
        1.创建项目，引入nacos服务发现和gateway依赖
        2.配置application.yml，包括服务基本信息、nacos地址、路由
路由配置包括:
        1.路由id:路由的唯一标示
        2.路由目标(uri):路由的目标地址，http代表固定地址，lb代表根据服务名负载均衡
        3.路由断言( predicates) :判断路由的规则
        4.路由过滤器( filters) :对请求或响应做处理

PredicateFactory的作用是什么?
        读取用户定义的断言条件，对请求做出判断
Path=/user/**是什么含义?
        路径是以/user开头的就认为是符合的

过滤器的作用是什么?
        1、对路由的请求或响应做加工处理，比如添加请求头

        2、配置在路由下的过滤器只对当前路由的请求生效

defaultFilters的作用是什么?
        对所有路由都生效的过滤器

全局过滤器的作用是什么?
        对所有路由都生效的过滤器，并且可以自定义处理逻辑

实现全局过滤器的步骤?
        1、实现GlobalFilter接口
        2、添加@Order注解或实现Ordered接口

        3、写处理逻辑

路由过滤器、defaultFilter、全局过滤器的执行顺序?

        1、order值越小，优先级越高
        2、当order值一样时，顺序是defaultFilter最先，然后是局部的路由过滤器，最后是全局过滤器

CORS跨域要配置的参数包括哪几个?
        1、允许哪些域名跨域?
        2、允许哪些请求头?
        3、允许哪些请求方式?
        4、是否允许使用cookie?
        5、有效期是多久?

目录

搭建网关服务的步骤:

1、创建新的module，引入SpringCloudGateway的依赖和nacos的服务发现依赖:

2、编写路由配置及nacos地址

网关路由可以配置的内容包括:

给所有进入userservice的请求添加一个请求头

给所有服务加请求头

全局过滤器GlobalFilter

过滤器执行顺序

跨域问题处理

搭建网关服务的步骤:

1、创建新的module，引入SpringCloudGateway的依赖和nacos的服务发现依赖:

创建一个新的模块

在gateway的pom文件引入SpringCloudGateway的依赖和nacos的服务发现依赖

<!--服务发现依赖-->
<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<!--网关依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3.          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4.          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5.     <parent>
  6.         <artifactId>cloud-demo</artifactId>
  7.         <groupId>cn.itcast.demo</groupId>
  8.         <version>1.0</version>
  9.     </parent>
  10.     <modelVersion>4.0.0</modelVersion>
  11.  
  12.     <artifactId>gateway</artifactId>
  13.  
  14.     <properties>
  15.         <maven.compiler.source>8</maven.compiler.source>
  16.         <maven.compiler.target>8</maven.compiler.target>
  17.     </properties>
  18.  
  19.     <dependencies>
  20.         <!--服务发现依赖-->
  21.         <dependency>
  22.             <groupId>com.alibaba.cloud</groupId>
  23.             <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
  24.         </dependency>
  25.         <!--网关依赖-->
  26.         <dependency>
  27.             <groupId>org.springframework.cloud</groupId>
  28.             <artifactId>spring-cloud-starter-gateway</artifactId>
  29.         </dependency>
  30.     </dependencies>
  31.  
  32. </project>

 在gateway中创建一个启动类

  1. package cn.itcast.gateway;
  2.  
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5.  
  6. @SpringBootApplication
  7. public class GatewayApplication {
  8.     public static void main(String[] args) {
  9.         SpringApplication.run(GatewayApplication.class, args);
  10.     }
  11. }

2、编写路由配置及nacos地址

server:
    port: 10010 #网关端口

spring:
    application:
        name: gateway #服务名称

    cloud :
        nacos:
            server-addr: localhost:8848 #nacos地址

        gateway:

            routes: #网关路由配置

                - id: user-service #路由id，自定义，只要唯一即可
                # uri: http://127.0.0.1:8081 #路由的目标地址 http就是固定地址
                uri: lb://userservice  #路由的目标地址lb就是负载均衡，后面跟服务名称

                predicates:  #路由断言，也就是判断请求是否符合路由规则的条件
                    - Path=/user/**  #这个是按照路径匹配，只要以/user/开头就符合要求

运行10010端口，可以发现无论是访问order还是user，都可以访问了 

网关路由可以配置的内容包括:

路由id：路由唯一标示
uri：路由目的地，支持lb和http两种
predicates：路由断言，判断请求是否符合要求，符合则转发到路由目的地
filters：路由过滤器，处理请求或响应

我们在配置文件中写的断言规则只是字符串，这些字符串会被Predicate Factory读取并处理，转变为路由判断的条件


例如Path=/user/**是按照路径匹配，这个规则是由
org.springframework.cloud.gateway.handler.predicate.PathRoutePredicateFactory类来处理的

像这样的断言工厂在SpringCloudGateway还有十几个

Spring提供了11种基本的Predicate工程： 

这里我们演示After

- After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后
  1. server:
  2.   port: 10010 #网关端口
  3. spring:
  4.   application:
  5.     name: gateway #服务名称
  6.   cloud :
  7.     nacos:
  8.       server-addr: localhost:8848 #nacos地址
  9.     gateway:
  10.       routes: #网关路由配置
  11.         - id: user-service #路由id，自定义，只要唯一即可
  12.         # uri: http://127.0.0.1:8081 #路由的目标地址 http就是固定地址
  13.           uri: lb://userservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  14.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  15.             - Path=/user/** #这个是按照路径匹配，只要以/user/开头就符合要求
  16.         - id: order-service #路由id，自定义，只要唯一即可
  17.           uri: lb://orderservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  18.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  19.             - Path=/order/** #这个是按照路径匹配，只要以/user/开头就符合要求
  20.             - After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后

最后一行我们用After来限制了，必须在这个时间之后才能访问。所以访问失败

 这里我们改成Before

- Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后
  1. server:
  2.   port: 10010 #网关端口
  3. spring:
  4.   application:
  5.     name: gateway #服务名称
  6.   cloud :
  7.     nacos:
  8.       server-addr: localhost:8848 #nacos地址
  9.     gateway:
  10.       routes: #网关路由配置
  11.         - id: user-service #路由id，自定义，只要唯一即可
  12.         # uri: http://127.0.0.1:8081 #路由的目标地址 http就是固定地址
  13.           uri: lb://userservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  14.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  15.             - Path=/user/** #这个是按照路径匹配，只要以/user/开头就符合要求
  16.         - id: order-service #路由id，自定义，只要唯一即可
  17.           uri: lb://orderservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  18.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  19.             - Path=/order/** #这个是按照路径匹配，只要以/user/开头就符合要求
  20. #            - After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后
  21.             - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后

此时访问成功 

给所有进入userservice的请求添加一个请求头

实现方式:在gateway中修改application.yml文件，给userservice的路由添加过滤器:

spring:
    cloud:
        gateway:
            routes: #网关路由配置

                - id: user-service
                uri: lb: //userservice、

                predicates:
                    - Path=/user/**

                filters: #过滤器
                - AddRequestHeader=Truth,Itcast is freaking awesome! #添加请求头

这里我在user-service里加上 

filters:
            - AddRequestHeader=Truth,Itcast is freaking awesome! #添加请求头

  1. server:
  2.   port: 10010 #网关端口
  3. spring:
  4.   application:
  5.     name: gateway #服务名称
  6.   cloud :
  7.     nacos:
  8.       server-addr: localhost:8848 #nacos地址
  9.     gateway:
  10.       routes: #网关路由配置
  11.         - id: user-service #路由id，自定义，只要唯一即可
  12.         # uri: http://127.0.0.1:8081 #路由的目标地址 http就是固定地址
  13.           uri: lb://userservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  14.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  15.             - Path=/user/** #这个是按照路径匹配，只要以/user/开头就符合要求
  16.           filters:
  17.             - AddRequestHeader=Truth,Itcast is freaking awesome! #添加请求头
  18.         - id: order-service #路由id，自定义，只要唯一即可
  19.           uri: lb://orderservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  20.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  21.             - Path=/order/** #这个是按照路径匹配，只要以/user/开头就符合要求
  22. #            - After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后
  23.             - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后

在user-service的controller里修改一下

@GetMapping("/{id}")
public User queryById(@PathVariable("id") Long id,@RequestHeader(value = "Truth",required = false) String truth) {
    System.out.println("truth:" + truth);
    return userService.queryById(id);
}

  1. package cn.itcast.user.web;
  2.  
  3. import cn.itcast.user.config.PatternProperties;
  4. import cn.itcast.user.pojo.User;
  5. import cn.itcast.user.service.UserService;
  6. import lombok.extern.slf4j.Slf4j;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.beans.factory.annotation.Value;
  9. import org.springframework.cloud.context.config.annotation.RefreshScope;
  10. import org.springframework.web.bind.annotation.*;
  11.  
  12. import java.text.DateFormat;
  13. import java.time.LocalDateTime;
  14. import java.time.format.DateTimeFormatter;
  15.  
  16. @Slf4j
  17. @RestController
  18. @RequestMapping("/user")
  19. //@RefreshScope
  20. public class UserController {
  21.  
  22.     @Autowired
  23.     private UserService userService;
  24.  
  25. //    @Value("${pattern.dateformat}")
  26. //    //注解读取该配置
  27. //    private String dateformat;
  28.  
  29.     @Autowired
  30.     private PatternProperties properties;//注入新的java类
  31.  
  32.     @GetMapping("prop")
  33.     public  PatternProperties properties(){
  34.         return properties;
  35.     }
  36.  
  37.     @GetMapping("now")
  38.     public String now(){
  39.         return LocalDateTime.now().format(DateTimeFormatter.ofPattern(properties.getDateformat()));//通过该配置改变时间格式
  40.     }
  41.  
  42.     /**
  43.      * 路径： /user/110
  44.      *
  45.      * @param id 用户id
  46.      * @return 用户
  47.      */
  48.     @GetMapping("/{id}")                                  //请求头      变量名为Truth     可以不传         
  49.     public User queryById(@PathVariable("id") Long id,@RequestHeader(value = "Truth",required = false) String truth) {
  50.         System.out.println("truth:" + truth);
  51.         return userService.queryById(id);
  52.     }
  53. }

 在网页通过端口10010请求user的服务

会看到这句请求头被打印出来，证明成功

给所有服务加请求头

default-filters: #默认过滤器，会对所有的路由请求都生效
- AddRequestHeader=Truth,Itcast is freakina awesome! #添加情求头

这里我把上次user-service的请求头注释掉，看看能不能通过默认过滤器让所有服务默认带上请求头 

  1. server:
  2.   port: 10010 #网关端口
  3. spring:
  4.   application:
  5.     name: gateway #服务名称
  6.   cloud :
  7.     nacos:
  8.       server-addr: localhost:8848 #nacos地址
  9.     gateway:
  10.       routes: #网关路由配置
  11.         - id: user-service #路由id，自定义，只要唯一即可
  12.         # uri: http://127.0.0.1:8081 #路由的目标地址 http就是固定地址
  13.           uri: lb://userservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  14.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  15.             - Path=/user/** #这个是按照路径匹配，只要以/user/开头就符合要求
  16. #          filters:
  17. #            - AddRequestHeader=Truth,Itcast is freaking awesome! #添加请求头
  18.         - id: order-service #路由id，自定义，只要唯一即可
  19.           uri: lb://orderservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  20.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  21.             - Path=/order/** #这个是按照路径匹配，只要以/user/开头就符合要求
  22. #            - After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后
  23.             - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后
  24.       default-filters: #默认过滤器，会对所有的路由请求都生效
  25.         - AddRequestHeader=Truth,Itcast is freakina awesome! #添加情求头

访问任意一个服务，都能带上请求头。但要注意，我没有在order-service里打印出来，所以是看不到的

全局过滤器GlobalFilter

全局过滤器的作用也是处理一切进入网关的请求和微服务响应，与GatewayFilter的作用一样。
区别在于GatewayFilter通过配置定义，处理逻辑是固定的。而GlobalFilter的逻辑需要自己写代码实现。

定义方式是实现GlobalFilter接口。

举例：

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

        1、参数中是否有authorization,
        2、authorization参数值是否为admin

如果同时满足则放行，否则拦截

创建一个新类AuthorizeFilter

  1. package cn.itcast.gateway;
  2.  
  3. import org.springframework.cloud.gateway.filter.GatewayFilterChain;
  4. import org.springframework.cloud.gateway.filter.GlobalFilter;
  5. import org.springframework.core.Ordered;
  6. import org.springframework.core.annotation.Order;
  7. import org.springframework.http.HttpStatus;
  8. import org.springframework.http.server.reactive.ServerHttpRequest;
  9. import org.springframework.stereotype.Component;
  10. import org.springframework.util.MultiValueMap;
  11. import org.springframework.web.server.ServerWebExchange;
  12. import reactor.core.publisher.Mono;
  13.  
  14. //@Order(-1)//这是通过注解来实现的执行顺序，越小优先级越高
  15. @Component
  16. public class AuthorizeFilter implements GlobalFilter, Ordered {
  17.  
  18.     @Override
  19.     public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
  20.         // 1.获取请求参数
  21.         ServerHttpRequest request = exchange.getRequest();
  22.         MultiValueMap<String,String> params = request.getQueryParams();//2.获取参数中的authorization参数
  23.         String auth = params.getFirst( "authorization");//3.判断参数值是否等于admin
  24.         if ( "admin".equals(auth)) {
  25.         //4.是，放行     这步的操作是：直接运行下一个过滤器的filter，相当于直接通过此时的过滤器
  26.             return chain.filter(exchange);
  27.         }
  28.         //5.否，拦截
  29.         // 5.1.设置状态码                                  未认证
  30.         exchange.getResponse().setStatusCode(HttpStatus.UNAUTHORIZED) ;
  31.         //5.2.拦截请求     这步的操作是：把此时的响应结束
  32.         return exchange.getResponse().setComplete();
  33.     }
  34.  
  35.     //这是通过继承Ordered来实现的执行顺序
  36.     @Override
  37.     public int getOrder() {
  38.         return -1;
  39.     }
  40. }

 直接访问：报401

加入参数 ：访问成功

过滤器执行顺序

1、每一个过滤器都必须指定一个int类型的order值，order值越小，优先级越高，执行顺序越靠前

2、GlobalFilter通过实现Ordered接口，或者添加@Order注解来指定order值，由我们自己指定

3、路由过滤器和defaultFilter的order由Spring指定，默认是按照声明顺序从1递增。
4、当过滤器的order值一样时，会按照defaultFilter >路由过滤器>GlobalFilter的顺序执行。

跨域问题处理

跨域:域名不一致就是跨域，主要包括:
        1、域名不同: www.taobao.com和www.taobao.org和www.jd.com和miaosha.jd.com

        2、域名相同，端口不同:localhost:8080和localhost8081
跨域问题：浏览器禁止请求的发起者与服务端发生跨域ajax请求，请求被浏览器拦截的问题

解决方案：CORS

网关处理跨域采用的同样是CORS方案，并且只需要简单配置即可实现: 

spring:
  cloud:
    gateway:
      globalcors: # 全局的跨域处理
        add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
        corsConfigurations:
          '[/**]':
            allowedOrigins: # 允许哪些网站的跨域请求
              - "http://localhost:8090"
              - "http://www.leyou.com"
            allowedMethods: # 允许的跨域ajax的请求方式
              - "GET"
              - "POST"
              - "DELETE"
              - "PUT"
              - "OPTIONS"
            allowedHeaders: "*" # 允许在请求中携带的头信息
            allowCredentials: true # 是否允许携带cookie
            maxAge: 360000 # 这次跨域检测的有效期

通过网址通过ip运行前端的html，在F12中会出现报错

  1. server:
  2.   port: 10010 #网关端口
  3. spring:
  4.   application:
  5.     name: gateway #服务名称
  6.   cloud :
  7.     nacos:
  8.       server-addr: localhost:8848 #nacos地址
  9.     gateway:
  10.       routes: #网关路由配置
  11.         - id: user-service #路由id，自定义，只要唯一即可
  12.         # uri: http://127.0.0.1:8081 #路由的目标地址 http就是固定地址
  13.           uri: lb://userservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  14.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  15.             - Path=/user/** #这个是按照路径匹配，只要以/user/开头就符合要求
  16. #          filters:
  17. #            - AddRequestHeader=Truth,Itcast is freaking awesome! #添加请求头
  18.         - id: order-service #路由id，自定义，只要唯一即可
  19.           uri: lb://orderservice #路由的目标地址lb就是负载均衡，后面跟服务名称
  20.           predicates: #路由断言，也就是判断请求是否符合路由规则的条件
  21.             - Path=/order/** #这个是按照路径匹配，只要以/user/开头就符合要求
  22. #            - After=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后
  23.             - Before=2031-04-13T15:14:47.433+08:00[Asia/Shanghai] #要求访问时间在这个之后
  24.       default-filters: #默认过滤器，会对所有的路由请求都生效
  25.         - AddRequestHeader=Truth,Itcast is freakina awesome! #添加情求头
  26.       globalcors: # 全局的跨域处理
  27.         add-to-simple-url-handler-mapping: true # 解决options请求被拦截问题
  28.         corsConfigurations:
  29.           '[/**]':
  30.             allowedOrigins: # 允许哪些网站的跨域请求
  31.               - "http://localhost:8090"
  32.               - "http://www.leyou.com"
  33.             allowedMethods: # 允许的跨域ajax的请求方式
  34.               - "GET"
  35.               - "POST"
  36.               - "DELETE"
  37.               - "PUT"
  38.               - "OPTIONS"
  39.             allowedHeaders: "*" # 允许在请求中携带的头信息
  40.             allowCredentials: true # 是否允许携带cookie
  41.             maxAge: 360000 # 这次跨域检测的有效期

 再次启动该前端，在F12中可以请求到数据

代码文件点击下载icon-default.png?t=N7T8https://pan.baidu.com/s/10vVSJiccKxAirQYDgzZu-Q?pwd=8e5w 上一篇：Feign的配置和使用

下一篇：Docker的安装和使用

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/黑客灵魂/article/detail/830925
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号