概念作用参考链接:https://blog.csdn.net/rain_web/article/details/102469745
详细应用参考链接:https://www.cnblogs.com/crazymakercircle/p/11704077.html
1. 概述
1.1 Gateway简介
Spring Cloud Gateway是Spring Cloud的一个全新项目,基于Spring 5.0+Spring Boot 2.0和Project Reactor等技术开发的网关,它旨在为微服务架构提供一种简单有效的统一的API路由管理方式。
Spring Cloud Gateway是基于WebFlux框架实现的,而WebFlux框架底层则使用了高性能的Reactor模式通信框架Netty。
Spring Cloud Gateway的目标提供统一的路由方式且基于Filter链的方式提供了网关基本的功能,如:安全、监控/指标、和限流。
Spring Cloud Gateway底层使用了高性能的通信框架Netty。
1.2 Gateway特性
- 基于Spring Framework 5,Project Reactor和Spring Boot 2.0。
- 集成Hystrix断路器。
- 集成Spring Cloud DiscoveryClient。
- Predicates和Filters作用于特定路由,易于编写的Predicates和Filters。
- 具备一些网关的高级功能:动态路由、限流、路径重写
1.3 Gateway职能
1.4 Gateway分类与功能
1.5 Gateway在SpringCloud架构中的位置
1.6 Gateway三大核心概念
web请求,通过一些匹配条件,定位到真正的服务节点。并在这个转发过程的前后,进行一些精细化控制。
predicate就是我们的匹配条件;
而filter,就可以理解为一个无所不能的拦截器。有了这两个元素,再加上目标uri,就可以实现一个具体的路由了
1.7 Gateway工作流程
客户端向 Spring Cloud Gateway 发出请求。然后在 Gateway Handler Mapping 中找到与请求相匹配的路由,将其发送到 Gateway Web Handler。
Handler 再通过指定的过滤器链来将请求发送到我们实际的服务执行业务逻辑,然后返回。
过滤器之间用虚线分开是因为过滤器可能会在发送代理请求之前(“pre”)或之后(“post”)执行业务逻辑。
Filter在“pre”类型的过滤器可以做参数校验、权限校验、流量监控、日志输出、协议转换等,
在“post”类型的过滤器中可以做响应内容、响应头的修改,日志的输出,流量监控等有着非常重要的作用。
2. 动态路由
2.1 新建cloud-provider-payment8008模块
2.1.1 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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>cloud2020</artifactId>
<groupId>com.springcloud</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>cloud-provider-payment8008</artifactId>
<dependencies>
<!--Eureka客户端-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!-- web -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!-- 热部署 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
</dependencies>
</project>
2.1.2 yml文件
server:
port: 8008
spring:
application:
name: cloud-payment-service
eureka:
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://localhost:7001/eureka
2.1.3 启动类
package com.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class PaymentMain8008 {
public static void main(String[] args) {
SpringApplication.run(PaymentMain8008.class,args);
}
}
2.1.4 控制器
package com.springcloud.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class PaymentController {
@Value("${server.port}")
private String port;
@GetMapping("/payment/get/{id}")
public String get(@PathVariable("id") int id){
return "id:"+id+",端口:"+port;
}
@GetMapping("/payment/find/{id}")
public String find(@PathVariable("id") int id){
return "id:"+id+",端口:"+port;
}
}
2.2 新建cloud-provider-payment8009模块
代码跟cloud-provider-payment8008一样,只是端口不同
2.3 新建cloud-gateway9527模块
2.3.1 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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>cloud2020</artifactId>
<groupId>com.springcloud</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>cloud-gateway9527</artifactId>
<dependencies>
<!-- 注意不能引入web依赖,否则启动会报错 -->
<!--gateway-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-gateway</artifactId>
</dependency>
<!--eureka-client-->
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<!-- 引入自己定义的api通用包,可以使用Payment支付Entity -->
<dependency>
<groupId>com.springcloud</groupId>
<artifactId>cloud-api-commons</artifactId>
<version>${project.version}</version>
</dependency>
<!--一般基础配置类-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-devtools</artifactId>
<scope>runtime</scope>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
</project>
2.3.2 yml文件
server:
port: 9527
spring:
application:
name: cloud-gateway-service
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由的功能,利用微服务名进行路由
# 最终转发地址:uri域名主机及前面部分+路由域名主机后面部分
routes:
- id: payment_route #路由的ID,没有固定规则但要求唯一,建议配合服务名
# uri: http://localhost:8008 #匹配后提供服务的路由地址,只会替换域名主机,其他部分写了也不会替换
uri: lb://CLOUD-PAYMENT-SERVICE # 使用负载均衡方式动态调用服务地址
predicates:
- Path=/payment/get/** # 断言,路径相匹配的进行路由
- id: payment_route2
# uri: http://localhost:8008
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/find/**
eureka:
client:
service-url:
register-with-eureka: true
fetch-registry: true
# Gateway必须设置defaultZone的值
defaultZone: http://eureka7001.com:7001/eureka
2.3.3 启动类
package com.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@SpringBootApplication
@EnableEurekaClient
public class GatewayMain9527 {
public static void main(String[] args) {
SpringApplication.run(GatewayMain9527.class,args);
}
}
2.4 测试
启动7001
启动8008
启动8009
启动9527
访问http://localhost:9527/payment/get/1
2.5 使用代码方式编写路由
package com.springcloud.config;
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;
@Configuration
public class GatewayConfig {
@Bean
public RouteLocator baiduRouteLocator(RouteLocatorBuilder builder) {
RouteLocatorBuilder.Builder routes = builder.routes();
routes.route("baidu_route", r -> r.path("/guoji")
.uri("http://news.baidu.com"));
return routes.build();
}
}
3. Predicate的使用
参考:https://www.cnblogs.com/crazymakercircle/p/11704077.html
4. Filter的使用
参考:https://www.cnblogs.com/crazymakercircle/p/11704077.html
4.1 自定义过滤器
package com.springcloud.filter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cloud.gateway.filter.GatewayFilterChain;
import org.springframework.cloud.gateway.filter.GlobalFilter;
import org.springframework.core.Ordered;
import org.springframework.http.HttpStatus;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;
import reactor.core.publisher.Mono;
import java.util.Date;
@Component
@Slf4j
public class MyGatewayFilter implements GlobalFilter, Ordered
{
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain)
{
String username = exchange.getRequest().getQueryParams().getFirst("username");
if (username == null) {
log.info("用户未登录,无权访问。");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);
// 结束请求
return exchange.getResponse().setComplete();
}
// 请求转发到下一个过滤器
return chain.filter(exchange);
}
@Override
public int getOrder()
{
return 0;
}
}