Spring Boot WebFlux WebFilter 过滤器

JAVA herman 288浏览

webflux 有人把它称作反应式编程,也有人把它称作响应式编程,还有人把它称作函数式编程。不管称作哪种方式,它都是一种趋势!

结合前面的4篇文章,我们今天来学习 webflux 的过滤器 WebFilter!

WebFilter 是一个接口。里面只定义了一个方法,Mono<Void> filter(ServerWebExchange var1, WebFilterChain var2); 所以,我们要使用 WebFilter 只需要实现这一个方法即可。

我们先来看一个主要的实现代码:

@Configuration
@Order(-1)
public class XttblogWebFilter implements WebFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange serverWebExchange, WebFilterChain webFilterChain) {

        ServerHttpRequest request =  serverWebExchange.getRequest();

        //获取请求http头xttblog_token值
        String token = request.getHeaders().getFirst("xttblog_token");
        System.out.println("xttblog_token =" + token);

        //添加请求属性key和value
        serverWebExchange.getAttributes().put("url", "www.xttblog.com");

        /*过滤器链的概念都是类似的,调用过滤器链的filter方法将请求转到下一个filter,如果该filter是最后一  个filter,那就转到
        该请求对应的handler,也就是controller方法或函数式endpoint */
        return webFilterChain.filter(serverWebExchange);
    }

}

这段代码很简单,我们主要是想获取请求中 header 的第一个参数 xttblog_token,打印出这个参数并在请求中放入一个url属性。

ServerWebExchange 是 WebFlux 的一个服务交换器。从它里面可以获得 ServerHttpRequest 和 ServerHttpResponse。

被拦截进行数据处理后,如果要放行就最后调用 WebFilterChain 中的 filter 即可。如果要拦截跳转到指定页面,返回一个 Mono 即可。

WebFlux 非常的简单,处理过滤器的方式也和 SpringMVC 有些类似。

@Order 注解是表示过滤器的执行顺序。数值越小,越先执行!

下面我们再看一个处理登录过滤 token 的例子:

public class AuthFilter implements WebFilter {
    @Override
    public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
        ServerHttpRequest request =  exchange.getRequest();
        //ServerHttpResponse response =  exchange.getResponse();

        String token = request.getHeaders().getFirst("token");
        if(null == token){
                /*http头中没有appKey,修改请求的目标url为/auth/error
                  request.mutate返回一个请求构建器(builder design pattern),path方法修改请求的url,build方法返回新的request
               */
            ServerHttpRequest authErrorReq = request.mutate().path("/auth/error").build();
            //erverWebExchange.mutate类似,构建一个新的ServerWebExchange
            ServerWebExchange authErrorExchange = exchange.mutate().request(authErrorReq).build();
            return chain.filter(authErrorExchange);
        } else{ // 业余草:www.xttblog.com
            return chain.filter(exchange);
        }
    }
}

获取请求中的 token 参数,如果为空则跳转到认证失败的页面,否则放行。

注意,这个示例中,没有@Order注解,过滤器的执行顺序将按实现类的全限定类名(含有包名)的字典序升序排列进行执行。

实际应用中 WebFilter 的逻辑比这复杂的多,但是实现思路是一致的。需要源码的朋友扫描下方微信公众号,关注“业余草”,回复:“webflux”给你整个教程的所有源码,进行免费下载!

业余草公众号

最后,欢迎关注我的个人微信公众号:业余草(yyucao)!可加QQ1群:135430763(2000人群已满),QQ2群:454796847,QQ3群:187424846。QQ群进群密码:xttblog,想加微信群的朋友,可以微信搜索:xmtxtt,备注:“xttblog”,添加助理微信拉你进群。备注错误不会同意好友申请。再次感谢您的关注!后续有精彩内容会第一时间发给您!原创文章投稿请发送至532009913@qq.com邮箱。商务合作可添加助理微信进行沟通!

本文原文出处:业余草: » Spring Boot WebFlux WebFilter 过滤器