Spring Webflux —— 源码阅读之 handler 包

最新推荐文章于 2024-06-18 16:06:20 发布
最新推荐文章于 2024-06-18 16:06:20 发布
阅读量819 收藏
点赞数

点击上方“芋道源码”，选择“置顶公众号”

技术文章第一时间送达！

源码精品专栏

 


摘要: 原创出处 https://www.jianshu.com/p/23ee4b77c160 「一颗懒能」欢迎转载，保留摘要，谢谢！

  • AbstractHandlerMapping

  • 接口

提供包括抽象基类在内的HandlerMapping实现。

先扔一张整体的diagram类图：

640
img

simoleUrlHandlerMapping.jpg

AbstractHandlerMapping

HandlerMapping实现的抽象基类。

接口

  • java.lang.Object

  • org.springframework.context.support.ApplicationObjectSupport

    • org.springframework.web.reactive.handler.AbstractHandlerMapping

实现了HandlerMapping, Ordered

    public abstract class AbstractHandlerMapping extends
    ApplicationObjectSupport implements HandlerMapping, Ordered {



private static final WebHandler REQUEST_HANDLED_HANDLER = exchange -> Mono.empty();


private int order = Integer.MAX_VALUE;  // default: same as non-Ordered

private final PathPatternParser patternParser;

private final UrlBasedCorsConfigurationSource globalCorsConfigSource;

private CorsProcessor corsProcessor = new DefaultCorsProcessor();


public AbstractHandlerMapping() {
      this.patternParser = new PathPatternParser();
      this.globalCorsConfigSource = new UrlBasedCorsConfigurationSource(this.patternParser);
}

查找给定请求的handler，如果找不到特定的请求，则返回一个空的Mono。这个方法被getHandler（org.springframework.web.server.ServerWebExchange）调用。

在CORS 预先请求中，该方法应该返回一个匹配，而不是预先请求的请求，而是基于URL路径的预期实际请求，从“Access-Control-Request-Method”头，以及“Access-Control-Request-Headers”头的HTTP方法，通过 getcorsconfiguration获得CORS配置来允许通过，

如果匹配到一个handler，就返回Mono

protected abstract Mono<?> getHandlerInternal(ServerWebExchange exchange);

检索给定handle的CORS配置。

@Nullable
protected CorsConfiguration getCorsConfiguration(Object handler, ServerWebExchange exchange) {
    if (handler instanceof CorsConfigurationSource) {
        return ((CorsConfigurationSource) handler).getCorsConfiguration(exchange);
    }
    return null;
}

抽象类实现的主要的具体方法,来获得具体的Handle，实现了HandlerMapping中的getHandler，Mono<Object> getHandler(ServerWebExchange exchange);

@Override
public Mono<Object> getHandler(ServerWebExchange exchange) {
    return getHandlerInternal(exchange).map(handler -> {
        if (CorsUtils.isCorsRequest(exchange.getRequest())) {
            CorsConfiguration configA = this.globalCorsConfigSource.getCorsConfiguration(exchange);
            CorsConfiguration configB = getCorsConfiguration(handler, exchange);
            CorsConfiguration config = (configA != null ? configA.combine(configB) : configB);
            if (!getCorsProcessor().process(config, exchange) ||
                    CorsUtils.isPreFlightRequest(exchange.getRequest())) {
                return REQUEST_HANDLED_HANDLER;
            }
        }
        return handler;
    });
}

AbstractUrlHandlerMapping

基于URL映射的HandlerMapping实现的抽象基类。

接口

  • java.lang.Object

  • org.springframework.context.support.ApplicationObjectSupport

    • org.springframework.web.reactive.handler.AbstractHandlerMapping

    • org.springframework.web.reactive.handler.AbstractUrlHandlerMapping

支持直接匹配，例如注册的“/ test”匹配“/ test”，以及各种ant样式匹配，例如， “/ test *”匹配“/ test”和“/ team”，“/ test / *”匹配“/ test”下的所有路径， 。有关详细信息，请参阅PathPattern javadoc。

将搜索所有路径模式以查找当前请求路径的最具体匹配。最具体的模式定义为使用最少捕获变量和通配符的最长路径模式。

private final Map<PathPattern, Object> handlerMap = new LinkedHashMap<>();

返回注册路径模式和handle的只读视图，这些注册路径模式和handle可能是一个实际的handle实例或延迟初始化handle的bean名称。

public final Map<PathPattern, Object> getHandlerMap() {
    return Collections.unmodifiableMap(this.handlerMap);
}

我们可以再看到下面这两个方法实现了handle的注册，会把所有的路径映射，和handle实例放在handlerMap中

protected void registerHandler(String[] urlPaths, String beanName)
        throws BeansException, IllegalStateException {

    Assert.notNull(urlPaths, "URL path array must not be null");
    for (String urlPath : urlPaths) {
        registerHandler(urlPath, beanName);
    }
}


protected void registerHandler(String urlPath, Object handler)
        throws BeansException, IllegalStateException {

    Assert.notNull(urlPath, "URL path must not be null");
    Assert.notNull(handler, "Handler object must not be null");
    Object resolvedHandler = handler;

    // Parse path pattern
    urlPath = prependLeadingSlash(urlPath);
    PathPattern pattern = getPathPatternParser().parse(urlPath);
    if (this.handlerMap.containsKey(pattern)) {
        Object existingHandler = this.handlerMap.get(pattern);
        if (existingHandler != null) {
            if (existingHandler != resolvedHandler) {
                throw new IllegalStateException(
                        "Cannot map " + getHandlerDescription(handler) + " to [" + urlPath + "]: " +
                        "there is already " + getHandlerDescription(existingHandler) + " mapped.");
            }
        }
    }

    // Eagerly resolve handler if referencing singleton via name.
    if (!this.lazyInitHandlers && handler instanceof String) {
        String handlerName = (String) handler;
        if (obtainApplicationContext().isSingleton(handlerName)) {
            resolvedHandler = obtainApplicationContext().getBean(handlerName);
        }
    }

    // Register resolved handler
    this.handlerMap.put(pattern, resolvedHandler);
    if (logger.isInfoEnabled()) {
        logger.info("Mapped URL path [" + urlPath + "] onto " + getHandlerDescription(handler));
    }
}

预处理映射的路径，如果不以/开头就加上/

private static String prependLeadingSlash(String pattern) {
    if (StringUtils.hasLength(pattern) && !pattern.startsWith("/")) {
        return "/" + pattern;
    }
    else {
        return pattern;
    }
}

在这一步的时候开始获取内部的handle，查找给定请求的handle，如果找不到特定的请求，则返回一个空的Mono。

    @Override
public Mono<Object> getHandlerInternal(ServerWebExchange exchange) {
    PathContainer lookupPath = exchange.getRequest().getPath().pathWithinApplication();
    Object handler;
    try {
        handler = lookupHandler(lookupPath, exchange);
    }
    catch (Exception ex) {
        return Mono.error(ex);
    }

    if (handler != null && logger.isDebugEnabled()) {
        logger.debug("Mapping [" + lookupPath + "] to " + handler);
    }
    else if (handler == null && logger.isTraceEnabled()) {
        logger.trace("No handler mapping found for [" + lookupPath + "]");
    }

    return Mono.justOrEmpty(handler);
}

获取到handle的类，先获取请求的url地址，调用lookupHandler(lookupPath, exchange)去找这个handle。

@Nullable
protected Object lookupHandler(PathContainer lookupPath, ServerWebExchange exchange)
        throws Exception {

    return this.handlerMap.entrySet().stream()
            .filter(entry -> entry.getKey().matches(lookupPath))
            .sorted((entry1, entry2) ->
                    PathPattern.SPECIFICITY_COMPARATOR.compare(entry1.getKey(), entry2.getKey()))
            .findFirst()
            .map(entry -> {
                PathPattern pattern = entry.getKey();
                if (logger.isDebugEnabled()) {
                    logger.debug("Matching pattern for request [" + lookupPath + "] is " + pattern);
                }
                PathContainer pathWithinMapping = pattern.extractPathWithinPattern(lookupPath);
                return handleMatch(entry.getValue(), pattern, pathWithinMapping, exchange);
            })
            .orElse(null);
}

在这里又调用了handleMatch(entry.getValue(), pattern, pathWithinMapping, exchange)来匹配handle，验证过后，然后设置到ServerWebExchange中最后返回。

private Object handleMatch(Object handler, PathPattern bestMatch, PathContainer pathWithinMapping,
        ServerWebExchange exchange) {

    // Bean name or resolved handler?
    if (handler instanceof String) {
        String handlerName = (String) handler;
        handler = obtainApplicationContext().getBean(handlerName);
    }

    validateHandler(handler, exchange);

    exchange.getAttributes().put(BEST_MATCHING_HANDLER_ATTRIBUTE, handler);
    exchange.getAttributes().put(BEST_MATCHING_PATTERN_ATTRIBUTE, bestMatch);
    exchange.getAttributes().put(PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, pathWithinMapping);

    return handler;
}

SimpleUrlHandlerMapping

HandlerMapping的实现，来把url请求映射到对应的request handler的bean

支持映射到bean实例和映射到bean名称;非单例的handler需要映射到bean名称。

“urlMap”属性适合用bean实例填充处理程序映射。可以通过java.util.Properties类接受的形式，通过“映射”属性设置映射到bean名称，如下所示：

/welcome.html=ticketController

/show.html=ticketController

语法是PATH = HANDLER_BEAN_NAME。如果路径不是以斜杠开始的，则给它自动补充一个斜杠。

支持直接匹配，例如注册的“/ test”匹配“/ test”，以及各种ant样式匹配，例如， “/ test *”匹配“/ test”和“/ team”，“/ test / *”匹配“/ test”下的所有路径， 。有关详细信息，请参阅PathPattern javadoc。

接口

  • java.lang.Object

  • org.springframework.context.support.ApplicationObjectSupport

    • org.springframework.web.reactive.handler.SimpleUrlHandlerMapping

    • org.springframework.web.reactive.handler.AbstractHandlerMapping

    • org.springframework.web.reactive.handler.AbstractUrlHandlerMapping

private final Map<String, Object> urlMap = new LinkedHashMap<>();


程序启动遍历的时候把加载到的所有映射路径，和handle设置到urlMap
public void setUrlMap(Map<String, ?> urlMap) {
    this.urlMap.putAll(urlMap);
}

获得所有的urlMap，允许urlMap访问URL路径映射，可以添加或覆盖特定条目。
public Map<String, ?> getUrlMap() {
    return this.urlMap;
}


初始化程序上下文，除了父类的初始化，还调用了registerHandler
@Override
public void initApplicationContext() throws BeansException {
    super.initApplicationContext();
    registerHandlers(this.urlMap);
}

开始注册handler，注册urlMap中为相应路径指定的所有的handler。
如果handler不能注册，抛出 BeansException
如果有注册的handler有冲突，比如两个相同的，抛出java.lang.IllegalStateException

protected void registerHandlers(Map<String, Object> urlMap) throws BeansException {
    if (urlMap.isEmpty()) {
        logger.warn("Neither 'urlMap' nor 'mappings' set on SimpleUrlHandlerMapping");
    }
    else {
        for (Map.Entry<String, Object> entry : urlMap.entrySet()) {
            String url = entry.getKey();
            Object handler = entry.getValue();
            // Prepend with slash if not already present.
            if (!url.startsWith("/")) {
                url = "/" + url;
            }
            // Remove whitespace from handler bean name.
            if (handler instanceof String) {
                handler = ((String) handler).trim();
            }
            registerHandler(url, handler);
        }
    }
}

这里调用的registerHandler(url, handler)就是刚刚抽象类AbstractUrlHandlerMapping中的registerHandler方法

666. 彩蛋

如果你对 Spring Webflux 感兴趣，欢迎加入我的知识星球一起交流。


如果你对 Dubbo 感兴趣，欢迎加入我的知识星球一起交流。

640?

知识星球



目前在知识星球（https://t.zsxq.com/2VbiaEu）更新了如下 Dubbo 源码解析如下：

01. 调试环境搭建
02. 项目结构一览
03. 配置 Configuration
04. 核心流程一览

05. 拓展机制 SPI

06. 线程池

07. 服务暴露 Export

08. 服务引用 Refer

09. 注册中心 Registry

10. 动态编译 Compile

11. 动态代理 Proxy

12. 服务调用 Invoke

13. 调用特性 

14. 过滤器 Filter

15. NIO 服务器

16. P2P 服务器

17. HTTP 服务器

18. 序列化 Serialization

19. 集群容错 Cluster

20. 优雅停机

21. 日志适配

22. 状态检查

23. 监控中心 Monitor

24. 管理中心 Admin

25. 运维命令 QOS

26. 链路追踪 Tracing

...
一共 60 篇++


源码不易↓↓↓↓↓

点赞支持老艿艿↓↓

芋道源码
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
WebFlux SpringBoot下启动流程源码解析
gening4014的博客
12-06 651
SpringBoot下WebFlux启动流程源码解析
异步环境下请求处理的核心 -Spring Boot + Spring WebFlux 的 WebHandler
q1472750149的博客
11-25 929
我们创建的简易网关，外层的服务容器其实就是基于 Netty 和 Project Reactor 的容器，我们跳过这些，直接进入 Spring Boot 相关的处理逻辑。我们只需要知道，请求和其对应的响应，会被外层的容器封装成为 ServerHttpRequest request 和 ServerHttpResponse response(都在 org.springframework.http.server.reactive 这个包下)。 然后，会交由 WebHandler 进行处理。WebHandler
Spring WebFlux 源码分析(1)-服务启动流程
谈谈1974
11-26 2426
文章目录1. WebFlux 介绍2. WebFlux 服务启动流程 1. WebFlux 介绍 2. WebFlux 服务启动流程
WebFlux的过滤器
最新发布
2301_80126922的博客
06-18 268
在 Spring WebFlux 中，的调用不会立即执行请求处理逻辑，而是返回一个描述请求处理流程的Mono<Void>。实际的请求处理和定义的操作逻辑会在返回的Mono<Void>被框架订阅时执行。这种方式符合响应式编程的非阻塞特性，能够有效地提高系统的并发性能和响应速度。
springboot源码-webflux（上）
ainilzb的博客
08-05 302
参考文章： Spring WebFlux 官网：https://docs.spring.io/spring/docs/current/spring-framework-reference/web-reactive.html 响应式web框架，弥补springboot响应式编程的短板。 同步阻塞式IO模型：BIO 异步非阻塞式IO模型：AIO Spring WebFlux默认使用netty服务器。 ...
Spring-web-HandlerMethodReturnValueHandler
文天大人
09-22 1043
怀念二抱三抱
spring webflux demo
07-24
**Spring WebFlux 演示项目** Spring WebFlux 是 Spring Framework 的一个模块，它引入了一种响应式编程模型，用于构建非阻塞式的Web应用程序。与传统的基于Servlet的Spring MVC不同，WebFlux旨在优化性能，提高...
springwebflux的demo
05-06
**Spring WebFlux 概述** Spring WebFlux 是 Spring Framework 的一部分，它引入了一种反应式编程模型，用于构建高度可伸缩、非阻塞的 Web ...通过阅读和分析项目源码，你将掌握Spring WebFlux的核心概念和实践技巧。
webFlux：SpringwebFlux
02-08
【Spring WebFlux：新一代反应式编程框架】 Spring WebFlux是Spring框架的一个重要扩展，它引入了对反应式编程模型的支持，旨在处理高并发、低延迟的Web应用。Spring WebFlux是Spring Framework 5.0及以上版本的一...
spring-webflux实战.zip
11-01
2. **RouterFunction和HandlerFunction**：在Spring WebFlux中，路由和处理逻辑由RouterFunction和HandlerFunction组合实现。RouterFunction负责根据HTTP请求路径匹配合适的HandlerFunction，后者则处理具体的业务...
Spring Webflux 响应式编程 (二) - WebFlux编程实战
10-09
在本篇中，我们将深入探讨Spring Webflux的响应式编程模型，这是Spring框架的一个重要扩展，旨在提供非阻塞、事件驱动的Web服务开发能力。WebFlux是Spring Framework 5.0引入的新特性，它支持反应式编程，能够更好地...
spring-webflux-research:Springwebflux研究
04-29
What is WebFlux framework WebFlux framework是Spring5第一代响应式编程框架。 架构上spring-webflux与spring-webmvc同级，是spring-webmvc的替代方案，底层网络模型脱离Servlet Api，采用了基于NIO的网络编程框架，支持包括Tomcat，Jetty，Netty等。 spring-webflux依然沿用了与spring-webmvc相同的Controller注解和路由方式，对于旧项目迁移至新项目中带来了便利。 中间层的业务代码由Reactive Stream方式管理，Reactive Streams默认采用Reactor框架，同时还支持另一款相对庞大的Reactive Stream框架RxJava。 可以说WebFlux框架是非常灵活的，选择WebFlux作为响应式异步网络编程是明智的选择。 WebFl
Spring Web : HandlerMethodReturnValueHandler
Details Inside Spring
08-20 296
概述 HandlerMethodReturnValueHandler是Spring Web提供的一个策略接口，该类对象用于处理控制器方法的返回值。该接口定义了两个方法 : boolean supportsReturnType(MethodParameter returnType) 检测该返回值是否被支持，通常是根据返回值的类型或者注解来判断；只有被支持的返回值类型才能被该HandlerMeth...
spring-web HandlerAdapter 源码分析
JellyfishMIX 的博客
05-09 683
HandlerAdapter 存在的原因是, 处理器(handler)的实现有多种，例如实现 Controller 接口，实现 HttpRequestHandler 接口，或者使用 @RequestMapping 注解将方法作为一个处理器等。导致 springMVC 无法直接执行这个处理器，所以这里需要一个适配器(adapter)，由它去执行处理器(handler)。
你的响应阻塞了没有？--Spring-WebFlux源码分析
02-19 398
1. Spring WebFlux是什么？ Spring WebFlux是Spring Framework 5.0中引入的新的反应式Web框架。 与Spring MVC不同，它不需要Servlet API，完全异步和非阻塞， 并通过Reactor项目实现Reactive Streams规范。 并且可以在诸如Netty，Undertow和Servlet 3.1+容器的服务器上运行。Rea...
JavaWeb学习之——Spring篇之HandlerMapping
chuandie7960的博客
01-15 720
1.HandlerMapping HandlerMapping接口只有一个方法 HandlerExecutionChain getHandler(HttpServletRequest request) throws Exception; 就是根据Reuqest返回HandlerExec...
Spring Web : HandlerMethodReturnValueHandler 实现类清单
Details Inside Spring
08-19 305
jar包org.springframework:spring-web:5.1.5.RELEASE java包org.springframework.web.method.annotation MapMethodProcessor – Map类型返回值 ModelAttributeMethodProcessor – 方法使用注解@ModelAttribute时的返回值，或者为非简单类型的返回值...
Spring总结—SpringWebFlux
sx17860543449的博客
03-24 1417
SpringWebFlux基本概念 （1）是Spring5添加的新的模块，用于web开发的，功能和SpringMVC类似的，WebFlux使用当前一种比较流行响应式编程出现的框架。 （2）使用web框架，比如SpringMVC，这些基于servlet容器 WebFlux是一种异步非阻塞的框架，异步非阻塞的框架在Servlet3.1以后才支持，核心是基于Reactor的相关Api实现的。 （3）解释什么是异步非阻塞 异步和同步 阻塞和非阻塞 上面都是针对对象不一样 异步和同步针对调用者，调用者发送请求，.
Webflux快速入门
weixin_34192732的博客
07-13 193
　　SpringWebflux是SpringFramework5.0添加的新功能，WebFlux本身追随当下最火的Reactive Programming而诞生的框架，那么本篇就来简述一下这个框架到底是做什么的 一、关于WebFlux 　　我们知道传统的Web框架，比如说：struts2，springmvc等都是基于Servlet API与Servlet容器基础之上运行的，在Servlet3....
Spring WebFlux
06-09
Spring WebFlux是Spring框架的响应式编程模型，用于构建基于异步非阻塞流的Web应用程序。它支持使用Reactor库的Mono和Flux类型来处理请求和响应，并提供了响应式的Web编程模型。它基于Netty服务器，可以在高并发和高吞吐量的情况下提供更好的性能和可伸缩性。 Spring WebFlux提供了一个注解驱动的Web编程模型，可以使用@Controller和@RestController注解来定义控制器，使用@RequestMapping注解来定义请求映射。它还提供了函数式编程模型，可以使用RouterFunction和HandlerFunction来定义路由和处理函数。 Spring WebFlux还提供了许多用于处理请求和响应的类和接口，例如ServerRequest和ServerResponse。它还支持使用WebClient来进行异步非阻塞的HTTP客户端请求。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值