SpringCloud Gateway 简单使用

发布日期: 2019-10-06

更新日期: 2024-10-10

文章字数: 1.9k

阅读时长: 8 分

阅读次数:

1 说明

因为 SpirngBoot, SpringCloud 的各个版本之间差异还是挺大的, 所以在参照本博客进行学习时, 有可能出现因为版本不一致, 而出现不同的问题。
如果可以和本项目使用的环境保持一致, 即使不一致, 也尽可能不要跨大版本。

环境清单

框架	版本
JDK	1.8
Spring Boot	2.1.4.RELEASE
Spring Cloud	Greenwich.SR1

2 准备

2.1 Maven 父模块配置

先建立一个 Maven 的父模块, 也就是整个项目里面只有一个 pom 文件
在父 pom 里面添加一些共用的配置, 比如 SpringBoot, SpringCloud 的依赖

<?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>

    <!-- 手动引入 spring boot 版本依赖-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
        <relativePath/>
    </parent>

    <groupId>lcn29.github.io</groupId>
    <artifactId>spring-cloud-eureka</artifactId>
    <packaging>pom</packaging>
    <version>1.0-SNAPSHOT</version>

    <dependencyManagement>
        <dependencies>
            <!-- 手动引入 spring cloud 对应的配置 -->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Greenwich.SR1</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!-- 手动 引入 spring cloud 的基础模块-->
    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter</artifactId>
        </dependency>
    </dependencies>

    <!-- 省略一些打包相关的配置 -->
</project>

2.2 启动 2 个服务端 (注册中心)

在父模块里面新建一个子模块, 模块名 eureka-server
在子模块引入 Eureka 服务端需要的依赖

<dependencies>
    <!-- eureka 服务端的依赖-->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
    </dependency>
</dependencies>

在启动类上加上注解 @EnableEurekaServer

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

在 src/main/resources 里面新建 3 个配置文件, 分别是 application.yml, application-8081.yml, application-8081.yml
在 application.yml 里面加上这 2 个配置

# eureka 服务端的通用配置
spring:
  application:
    name: server-eureka

eureka:
  instance:
    instance-id: ${spring.application.name}:${server.port}

在 application-8081.yml 里面加上这 2 个配置

# eureka 服务端 1 的配置
server:
  port: 8081
eureka:
  instance:
    hostname: eureka-8081.com
  client:
    service-url:
      defaultZone: http://eureka-8082.com:8082/eureka/

在 application-8082.yml 里面加上这 2 个配置

# eureka 服务端 1 的配置
server:
  port: 8082
eureka:
  instance:
    hostname: eureka-8082.com
  client:
    service-url:
      defaultZone: http://eureka-8081.com:8081/eureka/

在电脑的 hosts 文件里面添加这 2 行映射

127.0.0.1 eureka-8081.com
127.0.0.1 eureka-8082.com

为了让我们的子模块能够启动为 2 个服务端, 需要我们做一下启动的配置

Idea 找到右上角的这个

点一下左边的 +, 找到 SpringBoot 项, 配置一下下面的三项

(如果 Program arguments 没有的话, 可以在绿色区域搜索添加)

Program arguments 配置的内容为 --spring.profiles.active=8081, 作用是启动这个 SpringBoot 应用时使用8081 环境, 也就是对应 application-8081.yml 里面的配置

同理, 在配置多一条 8082 环境的启动命令, 这样子模块就能启动 2 个程序了

2.3 搭建 1 个服务提供方

在父模块里面新建一个子模块, 模块名 client-provider
在模块里面添加如下依赖

<!-- eureka 服务端的依赖-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>

<!-- web 功能的支持, 没有这个 客户端就会启动完就结束程序 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

然后在启动类上加上注解 @EnableEurekaClient

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

同样在 src/main/resources 里面新建 1 个配置文件, application.yml
在 application.yml 里面加上这 2 个配置

spring:
  application:
    name: client-provider

server:
  port: 9091

eureka:
  instance:
    instance-id: ${spring.application.name}:${server.port}
  client:
    service-url:
      # 向服务端的注册地址
      defaultZone: http://eureka-8081.com:8081/eureka/,http://eureka-8082.com:8082/eureka

服务提供方新增一个的 Rest Api

@RestController
public class ProviderController {

    @GetMapping("/server/{num}")
    public String service(@PathVariable("num")int num) {
        String resp = "服务提供端收到了消息:" + num;
        return resp;
    }
}

依次启动服务端 (注册中心), 服务提供方

至此, 我们的环境就搭好了, 这次没有创建服务调用方。
这里直接采用网关调用服务提供方的方式, 也就是说, 我们的网关就是服务调用方。

3 Gateway 开始使用

在父模块里面新建一个子模块, 模块名 gateway-service

在模块里面添加如下依赖

<dependencies>

    <!-- 引入 eureka 的客户端, 让其可以被 eureka 服务端, 也就是注册中心进行观察  -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
    </dependency>

    <!-- gateway 是基于 netty + webflux 实现的, 所以本身已经支持 web 功能, 可以不用 web 相关的依赖 -->
    <dependency>
        <groupId>org.springframework.cloud</groupId>
        <artifactId>spring-cloud-starter-gateway</artifactId>
    </dependency>
</dependencies>

在启动类添加注解 @EnableEurekaClient 即可

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

在 application.yml 里面如下配置

spring:
  application:
    name: gateway-service
  cloud:
      gateway:
        # 配置路由规则, 访问当前网关的 /server/* 会转发请求到 http://localhost:9091/server/*
        routes:
        # 路由Id, 需要唯一
        - id: server.route
          uri: http://localhost:9091
          predicates:
          - Path=/server/*
server:
  port: 10101

eureka:
  instance:
    instance-id: ${spring.application.name}:${server.port}
  client:
    service-url:
      # 向服务端的注册地址
      defaultZone: http://eureka-8081.com:8081/eureka/,http://eureka-8082.com:8082/eureka

如果不想通过配置的方式进行配置, 也可以通过代码的方式进行配置, 声明如下的配置类

@Configuration
public class RouteConfigruation {
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {

        // 配置了一个 id 为 second_route, 访问 /second/* 会被重定向到 http://localhost:9091/second/*
        return builder.routes()
                .route("second_route", r -> r.path("/second/*").uri("http://localhost:9091/second/*"))
                .build();
    }
}

启动网关服务, 访问 http://localhost:10101/server/123, 可以收到响应: 服务提供端收到了消息:123

4 Gateway 的路由规则

上面的例子, 通过配置路径的方式进行路由, 也就是通过配置 Path 的方式进行配置。而 Gateway 还支持很多配置, 进行路由的配置

关键字	作用	示例
Path	请求路径匹配, 也是一个正则	- Path=/server/{num}
After	请求在指定的时间后	- After=2018-01-20T06:06:06+08:00[Asia/Shanghai]
Before	请求在指定的时间前	- Before=2018-01-20T06:06:06+08:00[Asia/Shanghai]
Between	请求在指定的时间内	- Between=2018-01-20T06:06:06+08:00[Asia/Shanghai], 2019-01-20T06:06:06+08:00[Asia/Shanghai]
Cookie	请求必须带某个 key 的 Cookie, value 是一个正则表达式	- Cookie=key, regularExpression
Header	请求头必须带某个 key, value 是一个正则表达式	- Header=X-Request-Id, \d+
Host	请求来至于对应的主机, 才做处理, 通过正则配置	- Host=**.baidu.com
Mehtod	请求的方式限制	-Method=GET
Query	请求包括指定的请求参数, 同时支持指定参数(正则设置)的匹配	- Query=arg 或者 - Query=key, regularExpression
RemoteAddr	请求来自于某个 Ip	- RemoteAddr=192.168.1.1/24

上面的规则不仅可以单独使用, 也可以进行组合使用

SpringCloud Config 简单使用

2019-10-20 Lcn29

框架使用 SpringCloud

SpringCloud-Hystrix简单使用

2019-10-05 Lcn29

框架使用 SpringCloud