Spring Cloud系列教程(十六):下一代网关服务Gateway-入门篇(Finchley版本)

官网文档: https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/

一.什么是Spring Cloud Gateway

来自官方文档的一句话: Spring Cloud Gateway提供了一个在Spring生态系统之上构建的API网关,包括:Spring 5,Spring Boot 2和Project Reactor。Spring Cloud Gateway旨在提供一种简单而有效的方法来路由到API,并为它们提供跨领域的关注,例如:安全性,监视/指标和弹性。并且从引入的spring-cloud-starter-gateway依赖信息可见,Spring Cloud Gateway底层是基于SpringBoot2.x、Project Reactor和Spring5 WebFlux响应式驱动编程构建,而Spring5底层又是基于netty异步实现,可谓性能不一般啊。

由于响应式编程的特性,Spring WebFlux和Reactor底层需要支持异步的运行环境,比如Netty和Undertow;也可以运行在支持异步I/O的Servlet 3.1的容器之上,比如Tomcat(8.0.23及以上)和Jetty(9.0.4及以上)。而且Spring Cloud Gateway底层默认通过netty启动,所以在使用Gateway网关组件时,无需引入Tomcat容器组件;

二. Spring Cloud Gateway能解决什么问题

在这里插入图片描述
网关具有身份认证与安全、审查与监控、动态路由、负载均衡、缓存、请求分片与管理、静态响应处理等功能。当然最主要的职责还是与“外界联系”,起到一个门户的作用。

总结一下,网关应当具备以下功能:

性能: API 高可用,负载均衡,容错机制。
安全: 权限身份认证、脱敏,流量清洗,后端签名(保证全链路可信调用),黑名单(非法调用的限制)。
日志: 日志记录,一旦涉及分布式,全链路跟踪必不可少。
缓存: 数据缓存。
监控: 记录请求响应数据,API 耗时分析,性能监控。
限流: 流量控制,错峰流控,可以定义多种限流规则。
灰度: 线上灰度部署,可以减小风险。
路由: 动态路由规则。

三. 生产上网关和Nginx搭配部署

1、前端页面调用接口请求Nginx服务器,如果是静态资源,则返回Nginx上缓存的资源

2、Nginx负载均衡调用后端的网关(网关服务多台部署,高可用)

3、网关做身份验证,服务路由,日志记录等等操作,

4、网关调用业务接口后,返回业务数据到页面。

四. 开始实践

在这里插入图片描述

五. 网关服务springcloud-api-gateway

5.1 创建maven工程,pom.xml文件

 <!--SpringBoot依赖版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
        <relativePath/>
    </parent>

    <!--项目编码、jdk版本、SpringCloud版本定义-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    </properties>

    <!--声明管理SpringCloud版本依赖信息-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <dependencies>
        <!-- SpringBoot整合Gateway -->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-gateway</artifactId>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>

5.2 配置网关路由

Spring Cloud Gateway 网关路由有两种配置方式:

  • 在配置文件yml 中配置
  • 通过@Bean自定义 RouteLocator,在启动主类 Application中配置

这两种方式是等价的,建议使用 yml方式进配置。

1. application.yml形式

#端口号
server:
  port: 8015
#定义服务名称
spring:
  application:
    name: api-gateway   # 应用名称
  cloud:
    gateway:
      # 路由规则
      routes:
        #通过Path匹配路由
        - id: product-service        # 路由 ID,唯一
          uri: http://127.0.0.1:8016  # 目标 URI,路由到接口http://127.0.0.1:8015/product/getProductInfo
          predicates:                # 断言(判断条件)
            - Path=/product/**       # 匹配对应 URL 的请求,将匹配到的请求追加在目标 URI 之后

#Gateway日志级别
logging:
  level:
    org.springframework.cloud.gateway: debug

对上述字段含义解释一下:

  • id: 我们自定义的路由 ID,保持唯一
  • uri: 目标服务地址
  • predicates: 路由条件,Predicate 接受一个输入参数,返回一个布尔值结果。该接口包含多种默认方法来将 Predicate 组合成其他复杂的逻辑(比如:与,或,非)。
  • filters: 过滤规则,本示例暂时没用。

上述配置是当请求:http://127.0.0.1:8015/product/getProductInfo时,会通过product匹配到路由,通过IP+Port,自动转发到http://127.0.0.1:8016 所在的服务机器,然后拼接http://127.0.0.1:8016 +/product/getProductInfo,组成一个完整的请求地址,请求到Product服务接口: http://127.0.0.1:8015/product/getProductInfo,因此网关暴露的接口地址并非真实的API接口地址,在网关层会进行过滤转发。

2. 通过@Bean自定义RouteLocator形式

package com.thinkingcao.gateway.route;

import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.route.RouteLocator;
import org.springframework.cloud.gateway.route.builder.RouteLocatorBuilder;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @desc:  java写法路由配置
 * @author: cao_wencao
 * @date: 2020-06-30 14:28
 */
@Slf4j
@Configuration
public class ProductRouteLocator{
    @Bean
    public RouteLocator customRouteLocator(RouteLocatorBuilder builder) {
        return builder.routes()
                .route("product-service", r -> r.path("/product/**")
                        .uri("http://127.0.0.1:8016"))
                .build();
    }
}

上面配置类等同于yml形式配置,解释如下

id: 定义一个idproduct-service
path: 定义一个path匹配/product/**
uri: 转发的urihttp://127.0.0.1:8016

5.3 启动类

package com.thinkingcao.gateway;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

/**
 * @desc:  Api Gateway网关
 * @author: cao_wencao
 * @date: 2020-06-23 13:07
 */
@SpringBootApplication
public class AppGateway {
    public static void main(String[] args) {
        SpringApplication.run(AppGateway.class, args);
    }
}

六. 商品服务springcloud-product-service

6.1 创建maven项目,pom依赖如下

 <!--SpringBoot依赖版本-->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
        <relativePath/>
    </parent>

    <!--项目编码、jdk版本、SpringCloud版本定义-->
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
        <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    </properties>

    <!--声明管理SpringCloud版本依赖信息-->
    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

    <!--依赖信息-->
    <dependencies>
        <!-- SpringBoot整合Web组件 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!--Lombok简化代码插件-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>

    </dependencies>

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

6.2 application.yml

server:
  port: 8016
#定义服务名称
spring:
  application:
    name: product-service

6.3 商品服务接口

/**
 * @desc:   商品服务
 * @author: cao_wencao
 * @date: 2020-06-28 10:34
 */
@RestController
@RequestMapping("/product")
public class ProductController {
    @RequestMapping("/getProductInfo")
    public Map<String,String> getProductInfo(){
        Map<String,String> productsMap = new HashMap<>();
        productsMap.put("productNo","111");
        productsMap.put("productName","荔枝");
        productsMap.put("productDesc","一骑红尘妃子笑,无人知是荔枝来");
        productsMap.put("productPrice","11.0");
        productsMap.put("productWeight","10.0");
        return productsMap;
    }
}

6.4 启动类

/**
 * @desc:   商品服务
 * @author: cao_wencao
 * @date: 2020-06-23 13:17
 */
@SpringBootApplication
public class AppProduct{
    public static void main(String[] args) {
        SpringApplication.run(AppProduct.class,args);
    }
}

七. 运行测试

访问http://127.0.0.1:8015/product/getProductInfo,路由转发到http://127.0.0.1:8016/product/getProductInfo
在这里插入图片描述

八. 源码

源码:https://github.com/Thinkingcao/SpringCloudLearning/tree/master/springcloud-first-gateway

下一篇: Spring Cloud系列教程(十七):下一代网关服务Gateway-谓词篇(Finchley版本)

Thinkingcao CSDN认证博客专家 Java Spring Boot 架构
CSDN2019年度博客之星、博客专家,专注架构、Java、SpringBoot、SpringCloud、Spring、微服务、分布式等领域
©️2020 CSDN 皮肤主题: 编程工作室 设计师: CSDN官方博客 返回首页
实付0元
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、C币套餐、付费专栏及课程。

余额充值