今天,我们来说说spring cloud如何配置gateway(基于nacos)
gateway有什么用?简单的用处就是路由转发、鉴权、日志记录、限流控制等,更具体的可以自行去官网了解。
首先,先上项目结构图,让大家有个简单的了解:
待会我们会把上图3个项目都开启,这样生产者、消费者、gateway路由网关都会注册到nacos注册管理中心上,这就我们才能测试gateway路由网关是否生效。
生产者、消费者项目如何配置,可以看我往期的博客:点击这里
我们这里简单说下gateway路由网关如何配置,先创建gateway的pom:
<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>com.tony</groupId>
<artifactId>cloud</artifactId>
<version>0.0.1-SNAPSHOT</version>
</parent>
<groupId>com.tony</groupId>
<artifactId>cloud-gateway</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>cloud-gateway</name>
<description>Demo project for Spring Boot</description>
<properties>
<java.version>1.8</java.version>
</properties>
<dependencies>
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-webflux</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-loadbalancer</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>2.4.5</version>
</plugin>
</plugins>
</build>
</project>
因为gateway要注册到nacos,所以要引用以上的依赖, spring-boot-starter-test 这个不引用也可以。
接着,我们来配置下gateway路由网关项目的properties,这里推荐用yml的格式去配置,因为这样可以方便用于自定义路由,如下所示:
server:
port: 5000
spring:
application:
name: gateway-test
cloud:
nacos:
discovery:
server-addr: 192.168.1.216:8848
gateway:
# 自动发现并注册微服务到Nacos
discovery:
locator:
enabled: true
# 请求服务名配置为小写
lower-case-service-id: true
routes:
- id: provider
uri: lb://provider
predicates:
- Path=/provider-demo/**
filters:
- StripPrefix=1
- id: consumer
uri: lb://consumer
predicates:
- Path=/consumer-demo/**
filters:
- StripPrefix=1
这里简单说明下,spring.cloud.gateway.discover.locator.enabled 该属性是开启自动发现并注册服务到nacos, 简单来说,就是能被nacos扫描发现的服务(打了注解@EnableDiscoveryClient 的服务),我们都会自动给他创建对应路由(route)。 spring.cloud.gateway.discover.locator.lower-case-service-id 该属性是以小写的形式配置服务名到nacos
通常来说,开启了自动发现并注册服务配置,我们就能用使用gateway路由网关了,因为已经自动给对应微服务创建对应路由了,但是有些老旧项目,调用接口的形式不是简单的:/项目名/** , 而是/项目名/api/**,类似于这样的调用方式, 需要我们自定义路由的形式,创建该服务路由,spring.cloud.gateway.routes是我们自定义路由的配置。
我们来看第一个自定义route:
id指的是在nacos注册平台上的名字
uri指的是要把接口分发给哪个服务(以lb://xxx的形式,会把拦截到的接口路由给nacos上注册的xxx服务)或对应的url(http://xxxx.xx.com)
predicates指的是断言,就是说会拦截什么样规则的接口,(Path=/provider-demo/**)指的是会拦截调用接口路径为/provider-dmo/**的接口
filters指的是过滤器,我们可以指过滤指定类型的接口、指定时间段才会拦截接口等等,很多有趣的功能,都能在filters这里配置。 (StripPrefix=1)这个值是与(Path=/provider-demo/**)对应配置的,因为拦截到该规则的接口后,会路由到对应的微服务provider,在这个服务上调用对应的接口, 因此要把前面这段(provider-demo)截取掉,因为在provider服务里,是不用调用该前缀的(变为/**)。
最后,我们要给gateway路由网关入口,打入@EnableDiscoveryClient注解,这样才能被nacos发现,如下图:
package com.tony.cloudgateway;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
@SpringBootApplication
@EnableDiscoveryClient
public class CloudGatewayApplication {
public static void main(String[] args) {
SpringApplication.run(CloudGatewayApplication.class, args);
}
}
所有配置完成了,我们把所有服务都启动,然后测试,看看是否能成功路由。
老样子,先进去nacos管理页面,查看各服务是否已经成功注册上,如下图:
我们可以看到服务都被成功注册上了,接下来,我们测试下,gateway为服务自动配置的路由是否能路由成功。
我们以gateway 路由的形式调用接口, 可以看到,当调用consumer/** 的接口时,会被拦截,然后分发到consumer服务上,去调用对应的接口。
下面,我们来测试下自定义路由是否成功
可以看到,我们同样以路由的形式调用接口,当调用consumer-demo/** 的接口时,会被拦截,然后分发到consumer服务上,去调用对应的接口。
搞定,下班走人,这就是gateway路由网关的简单配置,想做鉴权、日志管理等功能,得自定义过滤器filter 实现GlobalFilter, 但这又是另外一篇文章了,有空再写。
对你有帮助的话,点个赞再走呗。