Java之api网关断言及过滤器案例讲解

目录

• 一、什么是api网关？
• 二、常见的api网关
• 三、使用步骤
  • 1.Spring Cloud Gateway
  • 2.优缺点
  • 3.传统的过滤器
  • 4.使用gateway
    • 4.1module
    • 4.2添加pom依赖
    • 4.3yaml配置
    • 4.4主程序开启注解@EnableDiscoveryClient
• 四、执行流程
• 五、断言
  • 5.1： 自定义断言
  • 5.2： 过滤器

@WebFilter(filterName="MyFliter",urlPatterns="/api/share/*")
public class MyFliter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filter 进入之前");
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("filter 进入之后");
    }

    @Override
    public void destroy() {

    }
}

//在主程序处加上注解
//@ServletComponentScan("过滤器包名")

<?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>springcloud_nacos</artifactId>
        <groupId>com.csdn</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>springcloud_gateway</artifactId>
        <dependencies>
            <!--限流算法使用redis-->
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-redis-reactive</artifactId>
            </dependency>
            <!--网关-->
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-gateway</artifactId>
            </dependency>
            <!--服务注册-->
            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-starter-alibaba-nacos-discovery</artifactId>
            </dependency>
            <dependency>
                <groupId>com.csdn</groupId>
                <artifactId>springcloud_common</artifactId>
                <version>${project.version}</version>
                <!--gateway 使用的是响应式的web编程模式  我们要把传统的web编程模型刨除-->
                <exclusions>
                    <exclusion>
                        <groupId>org.springframework.boot</groupId>
                        <artifactId>spring-boot-starter-web</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>

        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>

            </plugins>
        </build>
    </project>

server:
  port: 7000
spring:
  application:
    name: api-gateway
  cloud:
    nacos:
      discovery:
        server-addr: localhost:8848 # 将gateway注册到nacos
    gateway:
      discovery:
        locator:
          enabled: true # 让gateway从nacos中获取服务信息
      routes:
        - id: share-6002   # 只要唯一标识就行
          uri: lb://share-6002   #真是的地址
          order: 1
          predicates:      # 满足断言中的条件才理由
            - Path=/api/share/**,/admin/share/**
        - id: user-6001   # 只要唯一标识就行
          uri: lb://user-6001   #真是的地址
          order: 1
          predicates:      # 满足断言中的条件才理由
            - Path=/api/user/**,/admin/user/**

@SpringBootApplication
@EnableDiscoveryClient
public class GatewayApplication {
    public static void main(String[] args) {
        SpringApplication.run(GatewayApplication.class,args);
    }
}

package gateway.pradicate;

import com.alibaba.nacos.common.utils.StringUtils;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.cloud.gateway.handler.predicate.AbstractRoutePredicateFactory;
import org.springframework.stereotype.Component;
import org.springframework.web.server.ServerWebExchange;

import java.util.Arrays;
import java.util.List;
import java.util.function.Predicate;

@Component
public class AgeRoutePredicateFactory extends AbstractRoutePredicateFactory<AgeRoutePredicateFactory.Config> {

    // 1: 配置类,用于接收配置文件中的对应参数
    @Data
    @NoArgsConstructor
    public static class Config {
        private int minAge;//18 对应断言配置中的第一个参数
        private int maxAge;//60 对应断言配置中的第二个参数
    }
    // 2: 构造函数
    public AgeRoutePredicateFactory() {
        super(Config.class);
    }
    //3： 读取配置文件的中参数值 给他赋值到配置类中的属性上
    public List<String> shortcutFieldOrder() {
        //这个位置的顺序必须跟配置文件中的值的顺序对应
        return Arrays.asList("minAge", "maxAge");
    }
    //4： 断言逻辑
    public Predicate<ServerWebExchange> apply(Config config) {
        return new Predicate<ServerWebExchange>() {
            @Override
            public boolean test(ServerWebExchange serverWebExchange) {
                // 4.1 接收前台传入的age参数
                String ageStr = serverWebExchange.getRequest().getQueryParams().getFirst("Age");

                //4.2 先判断是否为空
                if (StringUtils.isNotEmpty(ageStr)) {
                    //3 如果不为空,再进行路由逻辑判断
                    int age = Integer.parseInt(ageStr);
                    if (age < config.getMaxAge() && age > config.getMinAge()) {
                        return true;
                    } else {
                        return false;
                    }
                }
                return false;
            }
        };
    }
}

@Component
@Slf4j
public class LogGatewayFilterFactory
        extends AbstractGatewayFilterFactory<LogGatewayFilterFactory.Config> {

    //1： 配置类 接收配置参数
    @Data
    @NoArgsConstructor
    public static class Config {
        private boolean consoleLog;
    }
    
    //2： 构造函数【固定写法】
    public LogGatewayFilterFactory() {
        super(Config.class);
    }

    //3： 读取配置文件中的参数 赋值到 配置类中
    @Override
    public List<String> shortcutFieldOrder() {
        return Arrays.asList("consoleLog");
    }

    //4： 过滤器逻辑
    @Override
    public GatewayFilter apply(Config config) {
        return new GatewayFilter() {
            Long start = System.currentTimeMillis();
            @Override
            public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {
                // 进入服务之前
                if (config.isConsoleLog()) {
                    log.info("{} 进入 {}",new Date(), exchange.getRequest().getPath());
                }
                // 调用服务 并且定义服务回来之后的逻辑
                // 注意 如果此时仅仅只是需要进入之前的验证  不需要服务执行完之后的逻辑 可以 return chain.filter(exchange)即可
                return chain.filter(exchange).then(Mono.fromRunnable(()->{
                    if (config.isConsoleLog()) {
                        Long end = System.currentTimeMillis();
                        log.info("{} 退出 {}. 共耗时：{}",new Date(), exchange.getRequest().getPath(),(end-start));
                    }
                }));

            }
        };
    }
}

//自定义全局过滤器需要实现GlobalFilter和Ordered接口														
												
@Component														
public class MyGloablFilter implements GlobalFilter, Ordered {														
														
    // 过滤逻辑														
    @Override														
    public Mono<Void> filter(ServerWebExchange exchange, GatewayFilterChain chain) {														
														
        // 1 进入之前  controller														
        System.out.println("进入之前 在 MyGloablFilter");														
        // 2 放行														
        return chain.filter(exchange).then(Mono.fromRunnable(() -> {														
            // 在回调中写 返回的逻辑  response														
            System.out.println("从controller 回来之后");														
        }));																								
        //3 回调																								
    }																									
    // 返回的数字越小 就越先起作用														
    @Override														
    public int getOrder() {														
        return 0;														
    }														
}