网关Gateway:
Spring Cloud Gateway旨在为微服务架构提供一种简单而有效的统一的API路由管理方式。网关作为流量的入口,常用功能包括路由转发、权限校验、限流控制等。当请求到达网关,网关利用断言来判定这次的请求是否符合某个路由规则,如果符合了就按这个路由规则路由到指定地方。在路由过程中要经过指定Filter进行过滤。
原理
客户端发送请求到gateway,由gateway handler mapping进行路由,发送到gateway web handler。这个handler处理请求相关的filter链。filter分“pre”和“post”两种处理逻辑。
Spring Cloud Gateway 里明确的区分了 Router 和 Filter,并且一个很大的特点是内置了非常多的开箱即用功能,并且都可以通过 SpringBoot 配置或者手工编码链式调用来使用。
比如内置了 10 种 Router,使得我们可以直接配置一下就可以随心所欲的根据 Header、或者 Path、或者 Host、或者 Query 来做路由。
比如区分了一般的 Filter 和全局 Filter,内置了 20 种 Filter 和 9 种全局 Filter,也都可以直接用。当然自定义 Filter 也非常方便。
Gateway怎么用
说白了 Predicate 就是为了实现一组匹配规则,方便让请求过来找到对应的 Route 进行处理,接下来我们接下 Spring Cloud GateWay 内置几种 Predicate 的使用。
gateway本身分成三个组件:
· Route 路由:gateway的基本构建模块。它由ID、目标URI、断言集合和过滤器集合组成。如果聚合断言结果为真,则匹配到该路由。
· Predicate 断言:这是一个Java 8 Function Predicate。输入类型是 Spring Framework ServerWebExchange。这允许开发人员可以匹配来自HTTP请求的任何内容,例如Header或参数。
· Filter 过滤器:这些是使用特定工厂构建的 Spring FrameworkGatewayFilter实例。所以可以在返回请求之前或之后修改请求和响应的内容。
Gateway的网关配置方式(这里采用Method 路由断言 Factory)
1.application.yml配置文件方式实现
新建一个子模块,在该模块的pom.xml文件中导入gateway依赖:
<?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">
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.1.4.RELEASE</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.naixin</groupId>
<artifactId>Gateway</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>Gateway</name>
<description>Gateway网关</description>
<modelVersion>4.0.0</modelVersion>
<properties>
<java.version>1.8</java.version>
<spring-cloud.version>Greenwich.RELEASE</spring-cloud.version>
</properties>
<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>
<!--geteway-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
<version>2.2.0.RELEASE</version>
</dependency>
<!--nacos-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
<version>2.1.0.RELEASE</version>
</dependency>
<!--引入nacos config-->
<dependency>
<groupId>com.alibaba.cloud</groupId>
<artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
<version>2.1.0.RELEASE</version>
</dependency>
<!--lombok-->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.14</version>
<scope>provided</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>2.1.4.RELEASE</version><!-- 使用的SpringBoot版本号 -->
</plugin>
</plugins>
</build>
</project>
在application.yml配置类文件中添加以下配置:
这段yml配置内容比较多:
确定该服务的端口号8990。
确定了application.name为GATEWAY。
开启从注册中心动态创建路由的功能,利用微服务名进行路由。
定义了两段路由,每段路由标明:id,uri和Predicate。
将该服务注册进nacos的服务列表。
server:
port: 8990
spring:
application:
name: GATEWAY
cloud:
nacos:
discovery:
server-addr: 192.168.8.150:8848
gateway:
routes:
- id: service-Sentinal
uri: http://10.10.197.42:8077
predicates:
- Path=/sen/getSentinalTop #断言,路径相匹配的进行路由
bootstrap.properties 配置:
# 远端配置中心
spring.cloud.nacos.config.server-addr=192.168.8.150:8848
# 使用nacos中哪个namespace
spring.cloud.nacos.config.namespace=51a76986-3d85-4d97-9562-6cb816f6db61
# 使用nacos中哪个组
spring.cloud.nacos.config.group=GATEWAY
# 使用nacos中哪个dataId 1.name+文件后缀 2.文件名+env+后缀
spring.cloud.nacos.config.name=gateway-prod
spring.cloud.nacos.config.file-extension=yml
启动类:
package com.naixin.Gateway;
import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.core.env.Environment;
import java.net.InetAddress;
/**
* @EnableDiscoveryClient注解 注册道nacos
*/
@SpringBootApplication
@EnableDiscoveryClient
@Slf4j
public class GatewayApplication {
public static void main(String[] args) throws Exception {
ConfigurableApplicationContext application = SpringApplication.run(GatewayApplication.class, args);
Environment env = application.getEnvironment();
log.info("\n----------------------------------------------------------\n\t" +
"Application '{}' is running! Access URLs:\n\t" +
"Login: \thttp://{}:{}/\n\t" +
"----------------------------------------------------------",
env.getProperty("spring.application.name"),
InetAddress.getLocalHost().getHostAddress(),
env.getProperty("server.port"),
InetAddress.getLocalHost().getHostAddress(),
env.getProperty("server.port"));
log.info("╭フ哇、內誰說↘生活萁拾狠简单濄勒今天鹫是明天⊕_⊙");
}
}
两个服务都启动:
查看一下nacos 控制台:
访问一下 地址:
正常访问:
通过网关访问:
更多断言方式:
Spring Cloud Gateway 2.1.0 中文官网文档
2.GateWay配置类方式实现
在启动类同级目录创建config 文件夹,然后创建GateWayConfig 配置类。
package com.naixin.Gateway;
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;
/**
* gateway 配置路由第二种方式 代码
* @author lgn
* @version 1.0
* @date 2021/12/21 11:43
*/
@Configuration
public class GateWayConfig {
/**
* 代码中注入 RouteLocator 的Bean
* @param routeLocatorBuilder
* @return
*/
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder){
RouteLocatorBuilder.Builder routes =routeLocatorBuilder.routes();
routes.route("path_route",r ->
r.path("/guonei")
.uri("https://news.baidu.com/guonei"));
return routes.build();
}
@Bean
public RouteLocator customRouteLocator2(RouteLocatorBuilder routeLocatorBuilder){
RouteLocatorBuilder.Builder routes =routeLocatorBuilder.routes();
routes.route("path_route",r ->
r.path("/guoji")
.uri("https://news.baidu.com/guoji"));
return routes.build();
}
}
测试,访问连接,访问成功
http://10.10.197.42:8990/guoji
http://10.10.197.42:8990/guonei