AI 助理
文档备案控制台
开发者社区 冰河技术 文章 正文

SA实战 ·《SpringCloud Alibaba实战》第13章-服务网关：项目整合SpringCloud Gateway网关 上

2022-05-15 316
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介： SA实战 ·《SpringCloud Alibaba实战》第13章-服务网关：项目整合SpringCloud Gateway网关

大家好，我是冰河~~

一不小心《SpringCloud Alibaba实战》专栏都更新到第13章了，再不上车就跟不上了，小伙伴们快跟上啊！

注意：本项目完整源码加入 冰河技术 知识星球即可获取，文末有优惠券。

在《SpringCloud Alibaba实战》专栏前面的文章中，我们实现了用户微服务、商品微服务和订单微服务之间的远程调用，并且实现了服务调用的负载均衡。也基于阿里开源的Sentinel实现了服务的限流与容错，并详细介绍了Sentinel的核心技术与配置规则，同时，简单介绍了服务网关，并对SpringCloud Gateway的核心架构进行了简要说明 。今天，我们就正式在项目中整合SpringCloud Gateway网关

本章总览

图片.png

章节概述

今天，我们就在项目中整合SpringCloud Gateway来为项目增加API网关，同时，会将SpringCloud Gateway与Sentinel进行整合实现网关的限流能力。说干就干，小伙伴们跟上发车速度。

项目整合网关

我们需要在项目中增加一个服务网关模块shop-gateway，在服务网关模块中实现网关的能力。此时，我们的项目中就会有用户微服务、商品微服务、订单微服务和服务网关。

图片.pngimage.gif

新建网关模块

在项目中新建shop-gateway模块，新增网关模块后项目的结构如下图所示。

image.gif图片.png

初步整合SpringCloud Gateway

（1）在服务网关shop-gateway模块的pom.xml文件中添加如下依赖。

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

（2）在服务网关shop-gateway模块的resources目录下新建application.yml文件，并在文件中添加如下配置信息。

server:
  port: 10001
spring:
  application:
    name: server-gateway
  cloud:
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            allowedOrigins: "*"
            allowedMethods: "*"
            allowCredentials: true
            allowedHeaders: "*"
      routes:
        - id: user-gateway
          uri: http://localhost:8060
          order: 1
          predicates:
            - Path=/server-user/**
          filters:
            - StripPrefix=1
        - id: product-gateway
          uri: http://localhost:8070
          order: 1
          predicates:
            - Path=/server-product/**
          filters:
            - StripPrefix=1
        - id: order-gateway
          uri: http://localhost:8080
          order: 1
          predicates:
            - Path=/server-order/**
          filters:
            - StripPrefix=1

我们重点来看下 spring.cloud.gateway 节点下的配置。

  • globalcors：此节点下的配置是为了解决SpringCloud Gateway跨域的问题。
  • routes：表示一个路由数组，可以在此节点下配置多个路由信息。
  • id：当前路由的唯一标识。
  • order：路由的优先级，数字越小表示优先级越高。
  • predicates：网关断言，也就是路由转发的条件，也是一个数组，可以配置多个路由转发条件。
  • Path：当客户端请求的路径满足Path的规则时，进行路由转发操作。
  • filters：网关过滤器，在过滤器中可以修改请求的参数和header信息，以及响应的结果和header信息，网关过滤器也是一个数组，可以配置多个过滤规则。
  • StripPrefix：网关在进行路由转发之前，会去掉1层访问路径。

（3）在服务网关shop-gateway模块的io.binghe.shop包下新建GatewayStarter类，表示服务网关的启动类，源码如下所示。

/**
 * @author binghe (公众号：冰河技术)
 * @version 1.0.0
 * @description 服务网关启动类
 */
@SpringBootApplication
public class GatewayStarter {
    public static void main(String[] args){
        SpringApplication.run(GatewayStarter.class, args);
    }
}

（4）由于之前项目中整合了Nacos和Sentinel，所以，在启动项目前，要分别启动Nacos和Sentinel。

  • 进入到Nacos的bin目录下，输入如下命令启动Nacos。
startup.cmd -m standalone
  • 进入Sentinel Jar包所在的目录，输入如下命令启动Sentinel。
java -Dserver.port=8888 -Dcsp.sentinel.dashboard.server=localhost:8888 -Dproject.name=sentinel-dashboard -jar sentinel-dashboard-1.8.4.jar

（5）分别启动用户微服务、商品微服务、订单微服务和服务网关。

（6）通过服务网关访问用户微服务，在浏览器中输入http://localhost:10001/server-user/user/get/1001，如下所示。

image.gif图片.png

用户微服务返回的原始数据如下所示。

{
  "id": 1001,
  "username": "binghe",
  "password": "c26be8aaf53b15054896983b43eb6a65",
  "phone": "13212345678",
  "address": "北京"
}

可以看到，通过服务网关能够正确访问到用户微服务。

（7）通过服务网关访问商品微服务，在浏览器中输入http://localhost:10001/server-product/product/get/1001，如下所示。

image.gif图片.png

商品微服务返回的原始数据如下所示。

{
  "id": 1001,
  "proName": "华为",
  "proPrice": 2399,
  "proStock": 100
}

可以看到，通过服务网关能够正确访问到商品微服务。

（8）通过服务网关访问订单微服务，在浏览器中输入http://localhost:10001/server-order/order/test_sentinel，如下所示。

图片.pngimage.gif

可以看到，通过服务网关能够正确访问到订单微服务。

网关整合Nacos

在初步整合SpringCloud Gateway中，我们在服务网关模块的application.yml文件中硬编码配置了服务转发的地址，如下所示。

  • 硬编码用户微服务地址
uri: http://localhost:8060
  • 硬编码商品微服务地址
uri: http://localhost:8070
  • 硬编码订单微服务地址
uri: http://localhost:8080

这里，我们将网关整合Nacos实现从Nacos注册中心获取转发的服务地址。

（1）在服务网关shop-gateway模块的pom.xml文件中继续添加如下依赖。

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>

（2）在服务网关shop-gateway模块的启动类io.binghe.shop.GatewayStarter上添加@EnableDiscoveryClient注解，如下所示。

/**
 * @author binghe (公众号：冰河技术)
 * @version 1.0.0
 * @description 服务网关启动类
 */
@SpringBootApplication
@EnableDiscoveryClient
public class GatewayStarter {
    public static void main(String[] args){
        SpringApplication.run(GatewayStarter.class, args);
    }
}

（3）将application.yml备份一份，命名为application-simple.yml，并修改application.yml配置文件，修改后的文件如下所示。

server:
  port: 10001
spring:
  application:
    name: server-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            allowedOrigins: "*"
            allowedMethods: "*"
            allowCredentials: true
            allowedHeaders: "*"
      discovery:
        locator:
          enabled: true
      routes:
        - id: user-gateway
          uri: lb://server-user
          order: 1
          predicates:
            - Path=/server-user/**
          filters:
            - StripPrefix=1
        - id: product-gateway
          uri: lb://server-product
          order: 1
          predicates:
            - Path=/server-product/**
          filters:
            - StripPrefix=1
        - id: order-gateway
          uri: lb://server-order
          order: 1
          predicates:
            - Path=/server-order/**
          filters:
            - StripPrefix=1

上述配置中增加了Nacos相关的配置，如下所示。

spring:
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848

新增了让SpringCloud Gateway可以发现Nacos中的服务配置，如下所示。

Spring:
  cloud:
    gateway:
      discovery:
        locator:
          enabled: true

另外，将硬编码的服务转发地址修改成从Nacos中按照名称获取微服务地址，并按照负载均衡策略分发。

  • 从Nacos中获取用户微服务
uri: lb://server-user
  • 从Nacos中获取商品微服务
uri: lb://server-product
  • 从Nacos中获取订单微服务
uri: lb://server-order

其中，lb指的是从Nacos中按照微服务的名称获取微服务地址，并按照负载均衡的策略分发。使用lb从Nacos中获取微服务时，遵循如下的格式。

lb://微服务名称

微服务的名称就是各个微服务在application.yml文件中配置的服务名称。

spring:
  application:
    name: 服务名称

（4）分别启动用户微服务、商品微服务、订单微服务和服务网关。

（5）通过服务网关访问用户微服务，在浏览器中输入http://localhost:10001/server-user/user/get/1001，如下所示。

image.gif图片.png

用户微服务返回的原始数据如下所示。

{
  "id": 1001,
  "username": "binghe",
  "password": "c26be8aaf53b15054896983b43eb6a65",
  "phone": "13212345678",
  "address": "北京"
}

可以看到，通过服务网关能够正确访问到用户微服务。

（6）通过服务网关访问商品微服务，在浏览器中输入http://localhost:10001/server-product/product/get/1001，如下所示。

图片.pngimage.gif

商品微服务返回的原始数据如下所示。

{
  "id": 1001,
  "proName": "华为",
  "proPrice": 2399,
  "proStock": 100
}

可以看到，通过服务网关能够正确访问到商品微服务。

（7）通过服务网关访问订单微服务，在浏览器中输入http://localhost:10001/server-order/order/test_sentinel，如下所示。

图片.pngimage.gif

可以看到，通过服务网关能够正确访问到订单微服务。

网关整合Nacos最简配置

SpringCloud Gateway整合Nacos后，可以不用手动指定其他微服务的名称来从Nacos中获取微服务的地址。接下来，我们就来实现SpringCloud Gateway网关整合Nacos的最简配置。

（1）将application.yml备份一份，命名为application-nacos.yml，并修改application.yml配置文件，修改后的文件如下所示。

server:
  port: 10001
spring:
  application:
    name: server-gateway
  cloud:
    nacos:
      discovery:
        server-addr: 127.0.0.1:8848
    gateway:
      globalcors:
        cors-configurations:
          '[/**]':
            allowedOrigins: "*"
            allowedMethods: "*"
            allowCredentials: true
            allowedHeaders: "*"
      discovery:
        locator:
          enabled: true

可以看到，在application.yml文件中，去掉了spring.cloud.gateway.routes 节点及其下面的所有配置。

（2）分别启动用户微服务、商品微服务、订单微服务和服务网关。

（3）通过服务网关访问用户微服务，在浏览器中输入http://localhost:10001/server-user/user/get/1001，如下所示。

图片.png

用户微服务返回的原始数据如下所示。

{
  "id": 1001,
  "username": "binghe",
  "password": "c26be8aaf53b15054896983b43eb6a65",
  "phone": "13212345678",
  "address": "北京"
}

可以看到，通过服务网关能够正确访问到用户微服务。

（4）通过服务网关访问商品微服务，在浏览器中输入http://localhost:10001/server-product/product/get/1001，如下所示。

image.gif图片.png

商品微服务返回的原始数据如下所示。

{
  "id": 1001,
  "proName": "华为",
  "proPrice": 2399,
  "proStock": 100
}

可以看到，通过服务网关能够正确访问到商品微服务。

（5）通过服务网关访问订单微服务，在浏览器中输入http://localhost:10001/server-order/order/test_sentinel，如下所示。

图片.pngimage.gif

可以看到，通过服务网关能够正确访问到订单微服务。

注意：SpringCloud Gateway整合Nacos最简配置时，通过网关访问微服务的格式如下所示。

http(s)://网关IP:网关端口/访问的目标微服务名称/接口地址


文章标签：
负载均衡
Java
微服务
负载均衡
Nacos
SpringCloudAlibaba
Sentinel
API
关键词：
springcloud Gateway
Gateway网关
springcloud项目
Gateway服务
网关服务
相关实践学习
每个IT人都想学的“Web应用上云经典架构”实战
本实验从Web应用上云这个最基本的、最普遍的需求出发，帮助IT从业者们通过“阿里云Web应用上云解决方案”，了解一个企业级Web应用上云的常见架构，了解如何构建一个高可用、可扩展的企业级应用架构。
技术小达人
目录
相关文章
weixin_836869520
|
监控 负载均衡 Java
深入理解Spring Cloud中的服务网关
深入理解Spring Cloud中的服务网关
weixin_836869520
535 0
AI研究者手札
|
存储 JavaScript 开发工具
基于HarmonyOS 5.0（NEXT）与SpringCloud架构的跨平台应用开发与服务集成研究【实战】
本次的.HarmonyOS Next ，ArkTS语言，HarmonyOS的元服务和DevEco Studio 开发工具，为开发者提供了构建现代化、轻量化、高性能应用的便捷方式。这些技术和工具将帮助开发者更好地适应未来的智能设备和服务提供方式。
AI研究者手札
406 8
基于HarmonyOS 5.0（NEXT）与SpringCloud架构的跨平台应用开发与服务集成研究【实战】
nine很菜
|
JSON Java 测试技术
SpringCloud2023实战之接口服务测试工具SpringBootTest
SpringBootTest同时集成了JUnit Jupiter、AssertJ、Hamcrest测试辅助库，使得更容易编写但愿测试代码。
nine很菜
573 3
何雨晨
|
XML Java 数据格式
如何使用 Spring Cloud 实现网关
如何使用 Spring Cloud 实现网关
何雨晨
443 3
互联网课堂
|
JSON 前端开发 Java
SpringCloud怎么搭建GateWay网关&统一登录模块
本文来分享一下，最近我在自己的项目中实现的认证服务，目前比较简单，就是可以提供一个公共的服务，专门来处理登录请求，然后我还在API网关处实现了登录拦截的效果，因为在一个博客系统中，有一些地址是可以不登录的，比方说首页；也有一些是必须登录的，比如发布文章、评论等。所以，在网关处可以支持自定义一些不需要登录的地址，一些需要登录的地址，也可以在网关处进行校验，如果未登录，可以返回JSON格式的出参，前端可以进行相关处理，比如跳转到登录页面等。
互联网课堂
915 4
聚娃科技开发者团队
|
负载均衡 Java 开发者
Spring Cloud实战：构建分布式系统解决方案
Spring Cloud实战：构建分布式系统解决方案
聚娃科技开发者团队
277 1
聚娃科技开发者团队
|
监控 负载均衡 Java
深入理解Spring Cloud中的服务网关
深入理解Spring Cloud中的服务网关
聚娃科技开发者团队
307 0
好奇的菜鸟
|
Java API 开发者
Spring Cloud Gateway中的GlobalFilter：构建强大的API网关过滤器
Spring Cloud Gateway中的GlobalFilter：构建强大的API网关过滤器
好奇的菜鸟
1297 0
游客cjle3qpbn6lw6
|
11月前
|
负载均衡 Dubbo Java
Spring Cloud Alibaba与Spring Cloud区别和联系？
Spring Cloud Alibaba与Spring Cloud区别和联系？
游客cjle3qpbn6lw6
1978 0
喜欢猪猪
|
12月前
|
人工智能 SpringCloudAlibaba 自然语言处理
SpringCloud Alibaba AI整合DeepSeek落地AI项目实战
在现代软件开发领域，微服务架构因其灵活性、可扩展性和模块化特性而受到广泛欢迎。微服务架构通过将大型应用程序拆分为多个小型、独立的服务，每个服务运行在其独立的进程中，服务与服务间通过轻量级通信机制（通常是HTTP API）进行通信。这种架构模式有助于提升系统的可维护性、可扩展性和开发效率。
喜欢猪猪
4303 2

热门文章

最新文章

  • 1
    在阿里云Kubernetes上运行SpringCloud示例PiggyMetrics
  • 2
    spring cloud心跳检测自我保护（EMERGENCY! EUREKA MAY BE INCORRECTLY CLAIMING INSTANCES ARE UP WHEN THEY'RE NOT. RENEWALS ARE LESSER THAN THRESHOLD AND HENCE THE
  • 3
    [Spring Cloud Tutorial翻译系列二]Spring Cloud Config Server与git集成
  • 4
    （七）整合spring cloud云服务架构 - common-service 项目构建过程
  • 5
    SpringCloud Alibaba实战（8：使用OpenFeign服务调用）
  • 6
    Spring Cloud Stream 使用延迟消息实现定时任务（RabbitMQ）
  • 7
    SpringCloud Feign报错Method has too many Body parameters
  • 8
    java B2B2C Springcloud电子商务平台源码------Hystrix的缓存使用
  • 9
    java版spring cloud+spring boot 社交电子商务平台-Ribbon设计原理
  • 10
    手把手教你Spring Cloud集成Seata TCC模式（上）
  • 1
    【阿里云云原生专栏】云原生下的API管理：阿里云API Gateway的应用场景与优势
    348
  • 2
    【设计模式】JAVA Design Patterns——API Gateway（API网关模式）
    339
  • 3
    Springboot解决跨域问题方案总结(包括Nginx，Gateway网关等)
    1875
  • 4
    解决Spring Cloud整合Nacos与Gateway的探险之旅
    841
  • 5
    网关大解密：探索Spring Cloud Alibaba中Gateway的奥秘
    840
  • 6
    jetbrains-gateway远端开发
    382
  • 7
    springcloud5-服务网关zuul及gateway
    441
  • 8
    GateWay实现原理
    201
  • 9
    spring-gateway 基于 nacos 配置文件的动态路由
    410
  • 10
    spring-gateway基于数据库 + nacos 的动态路由
    430

    • 相关课程

    更多
  • 微服务+全栈在线教育实战项目演练（SpringCloud Alibaba+SpringBoot）

    • 相关电子书

    更多
  • 搭建基于SpringCloud的微服务应用
  • 低代码开发师（初级）实战教程
  • 阿里巴巴DevOps 最佳实践手册
    • 下一篇
    第五届伏魔挑战赛如约来袭，诚邀各路高手来战！