GateWay入门及使用
一、服务网关的选择
Spring Cloud Gateway is built on Spring Boot 2.x, Spring WebFlux, and Project Reactor.
Gateway是建立在这些新技术上的，使用的是WebFlus框架，底层使用了Netty通讯框架的异步非阻塞模型开发，而zuul2也还没出，所以在逐渐替代zuul。Gateway旨在提供一种简单的方式对API进行路由，提供反向代理，鉴权，日志监控熔断，限流，重试等。
GateWay的三大核心概念有：
- 路由(route)
- 断言(predicate)
- 过滤(filter)
其核心流程就是:路由转发+执行过滤链
之后学习围绕这三个内容展开
二、GateWay路由
路由是构建网络的基本模块,由id,uri一些列的断言和过滤器组成,如果断言为true则匹配该路由
1.构建GateWay网关子模块
2.改写pom文件
注:这里不能加入web和actuator模块
<dependencies>
<!--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.atguigu.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>
3.编写yml文件
server:
port: 9527
eureka:
client:
register-with-eureka: true
fetch-registry: true
service-url:
defaultZone: http://eureka7001.com:7001/eureka
instance:
hostname: cloud-gateway-service
spring:
application:
name: cloud-gateway
4.编写主方法
@SpringBootApplication
@EnableEurekaClient
@EnableDiscoveryClient
public class GatewayMain9527 {
public static void main(String[] args){
SpringApplication.run(GatewayMain9527.class,args);
}
}
5.改写yml文件设置路由
server:
port: 9527
spring:
application:
name: cloud-gateway
cloud:
gateway:
routes:
- id: payment_routh #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_routh2 #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名
uri: http://localhost:8001 #匹配后提供服务的路由地址
predicates:
- Path=/payment/lb/** # 断言，路径相匹配的进行路由
eureka:
instance:
hostname: cloud-gateway-service
client: #服务提供者provider注册进eureka服务列表内
service-url:
register-with-eureka: true
fetch-registry: true
defaultZone: http://eureka7001.com:7001/eureka
访问的时候就可以不用8001的地址而是用9527的地址去匹配,进而访问8001的地址
6.代码进行网关配置
1.官方配置
用的是lamda表达式
参考官方文档有代码编写gateway配置
RemoteAddressResolver resolver = XForwardedRemoteAddressResolver
.maxTrustedIndex(1);
...
.route("direct-route",
r -> r.remoteAddr("10.1.1.1", "10.10.1.1/24")
.uri("https://downstream1")
.route("proxied-route",
r -> r.remoteAddr(resolver, "10.10.1.1", "10.10.1.1/24")
.uri("https://downstream2")
)
2.我的配置
@Component
public class MyGateWayConfig {
@Bean
public RouteLocator customRouteLocator(RouteLocatorBuilder routeLocatorBuilder) {
RouteLocatorBuilder.Builder routes = routeLocatorBuilder.routes();//这里相当于就是配置中过的routes
//第一个参数是id,是独一无二就行,对应就是配置中的id,第二个参数是路由,断言过滤的配置
routes.route("path_route_xiaoxiao",
r-> r.path("/guonei") //这里是访问的断言,相当于配置的- Path属性
.uri("https://news.baidu.com/guonei")).build(); //这是具体要跳转的uri
//测试军事
routes.route("path_route_xiaoxiao_junshi",
r->r.path("/mil")
.uri("https://news.baidu.com/mil")).build();
return routes.build();
}
}
这里com/后面的参数要和path一致,否则无法跳转
7.开始负载均衡路由
1.改写yml文件
cloud:
gateway:
discovery:
locator:
enabled: true #开启从注册中心动态创建路由的功能，利用微服务名进行路由
routes:
- id: payment_routh #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- id: payment_routh2 #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/lb/** # 断言，路径相匹配的进行路由
首先是网址直接改成服务名,然后网络协议要改成lb开启负载均衡
三、GateWay断言
开发人员可以匹配所有的http请求中的所有内容,如果完全匹配则断言为true
1.官方文档
官方文档断言共有十一种
2.举例说明
1.时间相关
1-3这个after,before,between都是与时间相关的.
这个时间的由来可以通过一个类来获得
public class TestDemo {
@Test
public void testTime() {
ZonedDateTime zbj = ZonedDateTime.now();
System.out.println(zbj);
}
}
2.cookie
模拟请求,这里使用cmd的curl 相当于发送一个get请求
routes:
- id: payment_routh #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/get/** # 断言，路径相匹配的进行路由
- After=2020-06-25T22:59:31.396+08:00[Asia/Shanghai]
- id: payment_routh2 #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://CLOUD-PAYMENT-SERVICE
predicates:
- Path=/payment/lb/** # 断言，路径相匹配的进行路由
- After=2020-06-25T22:59:31.396+08:00[Asia/Shanghai] #断言,在此时间后才能匹配
- Cookie=uname,xiaoxiao
curl http://localhost:9527/payment/lb --cookie "uname=xiaoxiao"
3.header
- Header=X-Request-Id, \d+ # 请求头要有X-Request-Id属性并且值为整数的正则表达式
curl http://localhost:9527/payment/lb --cookie "uname=xiaoxiao" -H "X-Request-Id:123
四、GateWay过滤
指的是Spring框架中GatewayFilter的实例,可以在请求被路由前或后对请求进行修改
Spring Cloud Gateway内置了多种路由过滤器,他们都由GateWayFilter的工厂类来产生
1.GateWayFilter
参考官方文档,共有31种.
2.Global Filters
参考官方文档共有10种.
自定义全局网关过滤器
yml改写,主要是增加一个过滤器的头
- id: payment_routh2 #payment_route #路由的ID，没有固定规则但要求唯一，建议配合服务名
# uri: http://localhost:8001 #匹配后提供服务的路由地址
uri: lb://CLOUD-PAYMENT-SERVICE
filters:
- AddRequestParameter=X-Request-Id,1024 #过滤器工厂会在匹配的请求头上加一对请求头,就是id为1024的X-Request-Id
predicates:
- Path=/payment/lb/** # 断言，路径相匹配的进行路由
配置过滤器
主要是要实现接口GlobalFilter和Ordered
@Component
@Slf4j
public class MyGatewayFilter implements GlobalFilter, Ordered {
@Override
public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
log.info("******进入MyGatewayFilter"+new Date());
String uname = exchange.getRequest().getQueryParams().getFirst("uname");//从请求的查询参数中获取uname属性的值
//如果没有uname,那么错误逻辑
if(uname==null) {
log.info("*******非法用户,请重新登录");
exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);//设置状态码失败
return exchange.getResponse().setComplete();//将错误返回
}
return chain.filter(exchange);//放行
}
@Override
public int getOrder() {
return 0;
}
}
五.总结
1.学习总结
Gateway是基于异步非阻塞模型开发,用的是WebFlus框架，底层使用了Netty通讯框架的优秀框架,目前也是SpringCloud服务网关的核心组件.Gateway由路由,断言,过滤三大功能构成,在访问具体网页之前和之后都能进行检测,鉴权,包装等功能实现.
2.注意事项
- 导入了Gateway依赖就不能导入web和actuator依赖
- 相对于自己代码配置断言,yml配置断言比较便捷
3.疑惑
在自己设置过滤器的时候,如果uname为空,为什么没有打印日志,而是在日志记录是输出的是
c.n.d.s.r.aws.ConfigClusterResolver : Resolving eureka endpoints via configuration
这里日志去哪了?而且这里是否能够用到服务降级来处理没有uname的业务?
扫一扫
1032
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
