Spring Cloud Gateway - 快速开始

Posted 2023-04-04 Gerald Newton

Spring Cloud Gateway 工作原理

客户端向 Spring Cloud Gateway 发出请求，如果请求与网关程序定义的路由匹配，则将其发送到网关 Web 处理程序，此处理程序运行特定的请求过滤器链。

过滤器之间用虚线分开的原因是过滤器可能会在发送代理请求之前或之后执行逻辑。所有 “pre” 过滤器逻辑先执行，然后执行代理请求，代理请求完成后，执行 “post” 过滤器逻辑。

如何启动 Spring Cloud Gateway

1、新建 Maven 工程，添加相关依赖 pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.anoyi</groupId>
    <artifactId>core-gateway</artifactId>
    <version>0.0.1-SNAPSHOT</version>

    <name>core-gateway</name>
    <description>gateway for miroservice</description>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-gateway</artifactId>
                <version>2.0.0.RELEASE</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>

        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

2、添加启动类 Application.java

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.Configuration;

@Configuration
@SpringBootApplication
public class Application 

    public static void main(String[] args) 
        SpringApplication.run(Application.class, args);
    

3、启动 Application（和 Spring Boot 项目一样）

访问 http://localhost:8080/ 报错 404，同时日志输出：

2018-06-27 09:18:48.981  WARN 44156 --- [ctor-http-nio-2] .a.w.r.e.DefaultErrorWebExceptionHandler : 
Failed to handle request [GET http://localhost:8080/]: Response status 404

配置服务的路由：配置文件方式

假设本地启动了另外两个 Spring Boot 服务，分别是 服务A( http://localhost:8081 )、服务B( http://localhost:8082 )，下面通过 Spring Cloud Gateway 来路由到这两个服务。

1、在 resources 路径下添加配置文件 application.yml

spring:
  cloud:
    gateway:
      routes:
      - id: host_route
        uri: http://localhost:8081
        predicates:
        - Path=/a/**
        filters:
        - StripPrefix=1
      - id: host_route
        uri: http://localhost:8082
        predicates:
        - Path=/b/**
        filters:
        - StripPrefix=1

• id：固定，不同 id 对应不同的功能，可参考 官方文档

• uri：目标服务地址

• predicates：路由条件

• filters：过滤规则

2、重启 Gateway 服务

3、测试

访问 http://localhost:8080/a/ 路由到 服务A http://localhost:8081/

访问 http://localhost:8080/b/ 路由到 服务B http://localhost:8082/

其他地址，例如 http://localhost:8080/a/user/all 路由到 服务A http://localhost:8081/user/all

配置服务的路由：编码方式

实现如上服务路由，还可以通过编码的方式实现。

1、删除配置文件 application.yml

2、修改 Application.java， 添加自定义路由配置

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.gateway.filter.factory.StripPrefixGatewayFilterFactory;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;

@SpringBootApplication
public class Application 

    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) 
        StripPrefixGatewayFilterFactory.Config config = new StripPrefixGatewayFilterFactory.Config();
        config.setParts(1);
        return builder.routes()
                .route("host_route", r -> r.path("/a/**").filters(f -> f.stripPrefix(1)).uri("http://localhost:8081"))
                .route("host_route", r -> r.path("/b/**").filters(f -> f.stripPrefix(1)).uri("http://localhost:8082"))
                .build();
    

    public static void main(String[] args) 
        SpringApplication.run(Application.class, args);
    

在此我向大家推荐一个架构学习交流圈。交流学习伪鑫：539413949（里面有大量的面试题及答案）里面会分享一些资深架构师录制的视频录像：有Spring，MyBatis，Netty源码分析，高并发、高性能、分布式、微服务架构的原理，JVM性能优化、分布式架构等这些成为架构师必备的知识体系。还能领取免费的学习资源，目前受益良多

spring cloud微服务快速教程之 gateway 服务网关

0、前言

　　gateway是spring的二代网关， 作为Netflix Zuul的替代者，是异步非阻塞网关 ，ZUUL2也是异步非阻塞的，但未纳入spring cloud整合计划

　　基于WebFlux ，与spring-boot-starter-web冲突，要排除该依赖；ZUUL1是阻塞io的API Gateway，使用简单方便；

　　性能上，自然是异步非阻塞的gateway胜出；

　　如何取舍，见仁见智了，不要盲目认为gateway比ZUUL1好，适合项目才是最好的；

　　实际项目中建议选择gateway；

1、集成gateway

1-1、添加依赖

　　新建gateway模块，添加依赖，注意要排除spring-boot-starter-web依赖，不能添加该依赖

        <!-- 集成nacos -->
        <dependency>
            <groupId>com.alibaba.cloud</groupId>
            <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            <version>2.0.1.RELEASE</version>
        </dependency>

        <!-- 集成gateway -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

 

1-2、添加配置

uri： lb://注册中心的微服务名称

Path=/api/user/**  相当于该微服务前缀 

StripPrefix=2   表示跳过前缀节数，上面前缀/api/user/是两节，说以是2，如果/api/则跳过1节

以上几个常用属性是通俗的解释，具体各个属性及其详细用法请参考官方文档

 

server:
  port: 8770
spring:
  application:
    name: gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

    gateway:
      discovery:
        locator:
          enabled: false
          #开启小写验证，默认feign根据服务名查找都是用的全大写
          lowerCaseServiceId: true
      routes:
        - id: nacos-user
          uri: lb://nacos-user
          predicates:
            - Path=/api/user/**
          filters:
            - StripPrefix=2
        - id: nacos-order
          uri: lb://nacos-order
          predicates:
            - Path=/api/order/**
          filters:
            - StripPrefix=2

 

1-3、运行测试

　　以上即可，运行项目，可以看到路由已经正常转发了

 

 

gateway简单的路由转发功能就这样完成了，其他的诸多路由过滤、匹配、限流等功能以后再探讨