从0到1学SpringCloud之SpringCloud gateway网关路由配置示例详解

 更新时间:2023年04月04日 10:29:18   作者:月夜烛峰  
Spring Cloud Gateway的目标提供统一的路由方式且基于Filter 链的方式提供了网关基本的功能, 例如:安全、监控、指标和限流 ,这篇文章主要介绍了从0到1学SpringCloud之SpringCloud gateway网关路由配置示例详解,需要的朋友可以参考下

一、前言

微服务中经常用到gateway作为网关,它有什么作用,怎么使用?

Spring Cloud Gateway的目标提供统一的路由方式且基于Filter 链的方式提供了网关基本的功能, 例如:安全、监控、指标和限流 。

Spring Cloud Gateway的通信框架使用的是Netty。

特点:

1、动态路由:能够匹配任何请求属性

2、可以对路由指定Predicate(断言)和Filter(过滤器) :

predicate,可以理解为匹配条件;filter,可以理解为拦截器。

3、集成Hystrix的断路器功能

4、集成SpringCloud服务发现功能

5、请求限流功能

6、支持路径重写

二、代码演示

1、配置文件

为了更好的理解,我们先配置几个请求路径

yml格式配置如下:

server:
  port: 9999
#服务名称
spring:
  application:
    name: zhufeng-gateway-config
  cloud:
    nacos:
      config:
        server-addr: ${spring.cloud.nacos.discovery.server-addr}
      discovery:
         server-addr: 127.0.0.1:8848
    gateway:
      routes:
        - id: zhufeng-web-user  # 请求 http://localhost:9999/user/info 会转发到 zhufeng-web-user 服务
          uri: lb://zhufeng-web-user  #在服务注册中心找服务名为 zhufeng-web-user 的服务
          predicates:
            - Path=/user/info  # 设置路由断言,当请求 /user/info 时进行转发
        - id: zhufeng-web-msg  # 请求 http://localhost:9999/route/msg/info 会转发到 zhufeng-web-msg 服务
          uri: lb://zhufeng-web-msg
          predicates:
            - Path=/route/msg/info  # 设置路由断言,当请求 /msg/info 时进行转发
          filters:
            - StripPrefix=1  # 前缀, 在当前路径匹配中表示去掉第一个前缀 /route

配置说明:

1、定义gateway的端口为9999

2、注册中心使用nacos

3、配置路由规则:

        请求 http://localhost:9999/user/info 会转发到 zhufeng-web-user 服务

        请求 http://localhost:9999/route/msg/info 会转发到 zhufeng-web-msg 服务

如果使用的是properties配置文件,则需要对数组的配置进行转换:

#服务端口
server.port=9999
#服务名称
spring.application.name=zhufeng-gateway-config
# 请求 http://localhost:9999/user/info 会转发到 zhufeng-web-user 服务
spring.cloud.gateway.routes[0].id=zhufeng-web-user
# 在服务注册中心找服务名为 zhufeng-web-user 的服务
spring.cloud.gateway.routes[0].uri=lb://zhufeng-web-user
# 设置路由断言,当请求 /user/info 时进行转发
spring.cloud.gateway.routes[0].predicates[0]=Path=/user/info
# 请求 http://localhost:9999/msg/info 会转发到 zhufeng-web-msg 服务
spring.cloud.gateway.routes[1].id=zhufeng-web-msg
# 在服务注册中心找服务名为 zhufeng-web-msg 的服务 #lb://zhufeng-web-msg
spring.cloud.gateway.routes[1].uri=lb://zhufeng-web-msg
# 设置路由断言,当请求 /msg/info 时进行转发
spring.cloud.gateway.routes[1].predicates[0]=Path=/route/msg/info
# 前缀, 在当前路径匹配中表示去掉第一个前缀 /route
spring.cloud.gateway.routes[1].filters[0]=StripPrefix=1

2、pom依赖

使用的微服务的版本信息如下:

 <spring-boot.version>2.3.7.RELEASE</spring-boot.version>
<spring-cloud.version>Hoxton.SR12</spring-cloud.version>
<spring-cloud-alibaba.version>2.2.7.RELEASE</spring-cloud-alibaba.version>

<dependencies>
	<!--gateway 网关依赖,内置webflux 依赖 -->
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-gateway</artifactId>
	</dependency>
 
	<!--断路器依赖 -->
	<dependency>
		<groupId>com.alibaba.cloud</groupId>
		<artifactId>spring-cloud-alibaba-sentinel-gateway</artifactId>
	</dependency>
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
	</dependency>
	<dependency>
		<groupId>com.alibaba.csp</groupId>
		<artifactId>sentinel-datasource-extension</artifactId>
	</dependency>
 
	<dependency>
		<groupId>org.springframework.cloud</groupId>
		<artifactId>spring-cloud-starter-sleuth</artifactId>
	</dependency>
</dependencies>

注意:

如果nacos使用的不是2.x版本,需要从spring-cloud-starter-alibaba-nacos-discovery中移除默认nacos-client版本,替换方式如下:

<!--注册中心客户端 -->
<dependency>
	<groupId>com.alibaba.cloud</groupId>
	<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
	<exclusions>
		<!--移除默认版本,默认为2.x版本-->
		<exclusion>
			<groupId>com.alibaba.nacos</groupId>
			<artifactId>nacos-client</artifactId>
		</exclusion>
	</exclusions>
</dependency>
 
<dependency>
	<groupId>com.alibaba.nacos</groupId>
	<artifactId>nacos-client</artifactId>
	<version>1.4.3</version>
</dependency>

启动类:

package com.zhufeng.gateway.config;
 
import org.springframework.boot.SpringApplication;
import org.springframework.cloud.client.SpringCloudApplication;
 
/**
 * @ClassName: GatewayConfigApplication
 * @Description 网关启动类
 * @author 月夜烛峰
 * @date 2022/7/22 20:11
 */
@SpringCloudApplication
public class GatewayConfigApplication {
 
	public static void main(String[] args) throws Exception {
		SpringApplication.run(GatewayConfigApplication.class, args);
	}
 
}

 3、创建微服务

创建两个微服务 zhufeng-web-user 、 zhufeng-web-msg

在zhufeng-web-user创建Controller:

package com.zhufeng.web.controller;

import com.alibaba.fastjson.JSONObject;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @ClassName: UserController
 * @Description User路由测试
 * @author 月夜烛峰
 * @date 2022/7/22 20:01
 */
@RestController
@RequestMapping("user")
public class UserController {
 
    @RequestMapping("info")
    public String userInfo(){
        JSONObject userJson = new JSONObject();
        userJson.put("id","user1001");
        userJson.put("name","月夜烛峰");
        return userJson.toJSONString();
    }
}

配置文件:

#服务端口
server.port=8081
#服务名称
spring.application.name=zhufeng-web-user

在 zhufeng-web-msg 创建对应Controller 

package com.zhufeng.web.controller;
 
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
 
/**
 * @ClassName: MsgController
 * @Description 消息路由测试
 * @author 月夜烛峰
 * @date 2022/7/22 20:33
 */
@RequestMapping("msg")
@RestController
public class MsgController {
 
    @RequestMapping("info")
    public String showInfo() {
        return "good luck~";
    }
}

配置文件:

#服务端口
server.port=8080
#服务名称
spring.application.name=zhufeng-web-msg

分别启动网关微服务、zhufeng-web-user、zhufeng-web-msg

进入nacos控制台,可以看到已经注册成功。

三、请求测试

1、微服务请求转发

zhufeng-gateway-config微服务只有一个启动类,没有其它代码,所有的请求会根据路由规则进行转发。

请求 http://localhost:9999/user/info 会转发到 zhufeng-web-user 服务

请求 http://localhost:9999/route/msg/info 会转发到 zhufeng-web-msg 服务 

转发到 zhufeng-web-user 的路由规则 比较好理解,就是根据请求路径进行转发,但是在zhufeng-web-msg微服务中,我们并没有配置  route  的请求前缀,但依然可以转发到 MsgController , 这是因为gateway通过过滤器 filters 属性 StripPrefix=1 去掉了第一个uri前缀。

如果设置 StripPrefix=2 ,则会去掉前面两个前缀

原uri /route/msg/info  转换为  /info

2、第三方请求转发

网关中配置的都是我们自己的微服务,如果请求的服务并没有注册到我们nacos中,或者请求的服务为第三方,该如何处理?

在gateway中新增配置项,properties格式如下:

spring.cloud.gateway.routes[2].id=zhufeng-route-zhufeng
#请求 http://localhost:9999/route/yyzhufeng 会转发到 https://www.csdn.net/
spring.cloud.gateway.routes[2].uri=https://www.csdn.net/
spring.cloud.gateway.routes[2].predicates[0]=Path=/route/yyzhufeng
# 前缀, 在当前路径匹配中表示去掉前两个前缀 /route/yyzhufeng
spring.cloud.gateway.routes[2].filters[0]=StripPrefix=2

请求 http://localhost:9999/route/yyzhufeng 会转发到 https://www.csdn.net/

到此这篇关于从0到1学SpringCloud之SpringCloud gateway网关路由配置示例详解的文章就介绍到这了,更多相关SpringCloud gateway网关路由内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 彻底理解Spring注解@Autowired实现原理

    彻底理解Spring注解@Autowired实现原理

    这篇文章主要为大家详细的介绍了Spring注解@Autowired实现的原理,缜密的逻辑分析,实践应用示例操作说明,让大家彻底的理解Spring注解@Autowired背后实现原理
    2022-03-03
  • Spring中的@ControllerAdvice三种用法详解

    Spring中的@ControllerAdvice三种用法详解

    这篇文章主要介绍了Spring中的@ControllerAdvice三种用法详解,加了@ControllerAdvice的类为那些声明了(@ExceptionHandler、@InitBinder或@ModelAttribute注解修饰的)方法的类而提供的<BR>专业化的@Component,以供多个Controller类所共享,需要的朋友可以参考下
    2024-01-01
  • idea搭建ssh框架的超详细教程

    idea搭建ssh框架的超详细教程

    这篇文章主要介绍了idea搭建ssh框架的超详细教程,本文通过图文实例代码相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-03-03
  • Java中的@Repeatable注解的作用详解

    Java中的@Repeatable注解的作用详解

    这篇文章主要介绍了Java中的@Repeatable注解的作用详解,@Repeatable注解是用来标注一个注解在同一个地方可重复使用的一个注解,使被他注释的注解可以在同一个地方重复使用,需要的朋友可以参考下
    2024-01-01
  • Springboot HTTP如何调用其他服务

    Springboot HTTP如何调用其他服务

    这篇文章主要介绍了Springboot HTTP如何调用其他服务,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-01-01
  • java实现批量导入.csv文件到mysql数据库

    java实现批量导入.csv文件到mysql数据库

    这篇文章主要为大家详细介绍了java实现批量导入.csv文件到mysql数据库,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2019-08-08
  • IDEA配置Maven教程的超详细讲解版

    IDEA配置Maven教程的超详细讲解版

    IntelliJ IDEA是当前最流行的Java IDE(集成开发环境)之一,也是业界公认最好用的Java开发工具之一,这篇文章主要给大家介绍了关于IDEA配置Maven教程的超详细讲解版,需要的朋友可以参考下
    2023-11-11
  • Java 类与对象超基础讲解

    Java 类与对象超基础讲解

    类(class)和对象(object)是两种以计算机为载体的计算机语言的合称。对象是对客观事物的抽象,类是对对象的抽象。类是一种抽象的数据类型
    2022-03-03
  • idea新建springboot项目pom文件报错问题及解决

    idea新建springboot项目pom文件报错问题及解决

    这篇文章主要介绍了idea新建springboot项目pom文件报错问题及解决方案,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-04-04
  • Java 中普通代码块,构造代码块,静态代码块区别及代码示例

    Java 中普通代码块,构造代码块,静态代码块区别及代码示例

    这篇文章主要介绍了Java 中普通代码块,构造代码块,静态代码块区别及代码示例的相关资料,需要的朋友可以参考下
    2017-01-01

最新评论