当前位置：首页 > news >正文

SpringCloud系列（40）--SpringCloud Gateway的Filter的简介及使用

news 2025/6/30 11:07:52

前言：在上一节中我们介绍了SpringCloud Gateway各种Route Predicate的作用，而在本节中我们将介绍SpringCloud Gateway的Filter。

1、SpringCloud GatewayFilter的相关知识

生命周期：

(1)pre（业务逻辑之前）

(2)post（业务逻辑之后）

种类：

(1)GatewayFilter

共31种，详细见官方文档（都有官方模板，我这里不叙述了）：

https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#gatewayfilter-factories

(2)GlobalFilter

共10种，详细见官方文档（都有官方模板，我这里不叙述了）：

https://cloud.spring.io/spring-cloud-static/spring-cloud-gateway/2.2.1.RELEASE/reference/html/#global-filters

2、自定义Filter

(1)新建一个名为filter的包

效果图：

(2)新建一个名为MyLogGateWayFilter的类

效果图：

3、编写MyLogGateWayFilter类的内容

package com.ken.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 MyLogGateWayFilter implements GlobalFilter, Ordered {@Overridepublic Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {log.info("com in MyLogGateWayFilter:" + new Date());String username = exchange.getRequest().getQueryParams().getFirst("username");if(username == null) {log.info("用户名为null，非法用户");exchange.getResponse().setStatusCode(HttpStatus.NOT_ACCEPTABLE);return exchange.getResponse().setComplete();}//把这次请求通过的exchange继续传下去到下一个过滤器return chain.filter(exchange);}/*** 加载过滤器的顺序，值越小优先级越高* @return*/@Overridepublic int getOrder() {return 0;}
}

application.yml内容如下，可以作为参考内容

server:port: 9527
spring:application:name: cloud-gatewaycloud:gateway:discovery:locator:enabled: true #开启从注册中心动态创建路由的功能，利用微服务名进行路由routes:#路由的ID，没有同定规则但要求唯一，建议配合服务名- id: payment_routh#断言，对与路径相匹配的进行路由，即对http://localhost:8001/payment/get/**下的路径进行路由predicates:- Path=/payment/get/**#匹配后提供服务的路由地址#uri: http://localhost:8001#匹配后提供服务的路由地址，lb://表示基于服务注册的负载均衡，lb是loadbalance的缩写uri: lb://cloud-payment-service#路由的ID，没有同定规则但要求唯一，建议配合服务名- id: payment_routh2#断言，对与路径相匹配的进行路由，即对http://localhost:8001/payment/lb/**下的路径进行路由predicates:- Path=/payment/lb/**#匹配后提供服务的路由地址#uri: http://localhost:8001#匹配后提供服务的路由地址，lb://表示基于服务注册的负载均衡，lb是loadbalance的缩写uri: lb://cloud-payment-serviceeureka:instance:hostname: cloud-gateway-serviceclient:#表示是否将自己注册进Eureka Server里，默认为trueregister-with-eureka: true#是否从Eureka Server抓取已有的注册信息，默认为true，单节点无所谓，集群必须设置为true才能配合ribbon使用负载均衡fetch-registry: trueservice-url:defaultZone: http://eureka7001.com:7001/eureka/