Spring MVC启动之HandlerMapping作用及实现详解

目录

• 引言
• 作用
• HandlerMapping的实现
• BeanNameUrlHandlerMapping
• SimpleUrlHandlerMapping
• ControllerClassNameHandlerMapping
• DefaultAnnotationHandlerMapping
• 总结

引言

在上一篇文章中，我们介绍了 Spring MVC 的启动流程，接下来我们将发分多个篇章详细介绍流程中的重点步骤

今天我们从 HandlerMapping 开始分析，HandlerMapping 是框架中的一个非常重要的组件。它的作用是将URL请求映射到合适的处理程序（Handler）上，这样就能够实现控制器与页面之间的交互。在 Spring MVC 中，有多种不同的 HandlerMapping 实现，本文将对这些实现的作用和源码原理进行详细介绍。

作用

在 Spring MVC 框架中，HandlerMapping 是一个非常重要的组件，它的作用是将URL请求映射到相应的处理程序上。具体来说，HandlerMapping 会根据URL请求的路径、请求参数等信息，确定需要执行哪个处理程序，并将该处理程序返回给 DispatcherServlet。然后 DispatcherServlet 再将请求分配给相应的处理程序，处理程序处理完请求后，将结果返回给 DispatcherServlet，DispatcherServlet 再将结果返回给客户端。

HandlerMapping的实现

Spring MVC 框架中有多种不同的 HandlerMapping 实现，每种实现都有不同的作用和使用场景。下面将逐一介绍这些实现。

BeanNameUrlHandlerMapping

BeanNameUrlHandlerMapping 是 Spring MVC 框架中最简单的 HandlerMapping 实现，它的作用是将 URL 请求的路径映射到 Bean 的名称上。具体来说，当请求的路径与一个 Bean 的名称匹配时，BeanNameUrlHandlerMapping 会将该请求映射到对应的 Bean 上。

例如:

假设有一个名为 "/hello" 的请求

我们可以在 Spring 配置文件中定义一个名为 "helloController" 的 Bean

然后使用 BeanNameUrlHandlerMapping 将 "/hello" 请求映射到该 Bean 上

这样，当客户端发送 "/hello" 请求时，DispatcherServlet 就会将该请求分配给 "helloController" 处理。

BeanNameUrlHandlerMapping 的源码比较简单，它的核心代码如下所示：

public class BeanNameUrlHandlerMapping extends AbstractUrlHandlerMapping {
    protected Object getHandlerInternal(HttpServletRequest request) throws Exception {
        String lookupPath = getUrlPathHelper().getLookupPathForRequest(request);
        return obtainHandler(lookupPath, request);
    }
}

从代码中可以看出，BeanNameUrlHandlerMapping 实现了 AbstractUrlHandlerMapping 接口，并重写了其中的 getHandlerInternal 方法。该方法的作用是根据请求的 URL 路径查找相应的处理程序。

SimpleUrlHandlerMapping

SimpleUrlHandlerMapping 是 Spring MVC 框架中另一种常用的 HandlerMapping 实现，它的作用是将 URL 请求的路径映射到处理程序上。与 BeanNameUrlHandlerMapping 不同的是，SimpleUrlHandlerMapping 可以将一个URL请求映射到多个处理程序上。

例如:

假设有两个请求 "/hello" 和 "/world"

我们可以使用 SimpleUrlHandlerMapping 将这两个请求分别映射到不同的处理程序上。具体来说，我们可以在 Spring 配置文件中定义多个 Bean，并分别为它们设置不同的URL路径。

然后使用 SimpleUrlHandlerMapping 将这些URL路径与相应的处理程序进行映射。

这样，当客户端发送一个请求时，SimpleUrlHandlerMapping 就会根据请求的URL路径查找相应的处理程序，并将请求分配给该处理程序处理。

SimpleUrlHandlerMapping 的源码也比较简单，它的核心代码如下所示：

public class SimpleUrlHandlerMapping extends AbstractDetectingUrlHandlerMapping {
    protected Object getHandlerInternal(HttpServletRequest request) throws Exception {
        String lookupPath = getUrlPathHelper().getLookupPathForRequest(request);
        Object handler = lookupHandler(lookupPath, request);
        if (handler == null) {
            handler = getDefaultHandler();
        }
        return handler;
    }
}

从代码中可以看出，SimpleUrlHandlerMapping 同样实现了 AbstractUrlHandlerMapping 接口（在 AbstractDetectingUrlHandlerMapping 中继承），并重写了其中的 getHandlerInternal 方法。该方法的作用是根据请求的URL路径查找相应的处理程序。

ControllerClassNameHandlerMapping

ControllerClassNameHandlerMapping 是Spring MVC 框架中一种比较特殊的 HandlerMapping 实现，它的作用是将URL请求的路径映射到 Controller 类名上。具体来说，ControllerClassNameHandlerMapping 会根据请求的URL路径查找对应的 Controller 类名，并将该类返回给 DispatcherServlet，然后 DispatcherServlet 再将请求分配给该 Controller 类处理。

例如:

假设有一个名为 "/hello" 的请求

我们可以定义一个名为 HelloController的Controller 类

使用 ControllerClassNameHandlerMapping 将 "/hello" 请求映射到该类上。

这样，当客户端发送 "/hello" 请求时，ControllerClassNameHandlerMapping 就会将该请求映射到 HelloController 处理。

ControllerClassNameHandlerMapping 的源码也比较简单，它的核心代码如下所示：

public class ControllerClassNameHandlerMapping extends AbstractControllerUrlHandlerMapping {
    protected Object getHandlerInternal(HttpServletRequest request) throws Exception {
        String lookupPath = getUrlPathHelper().getLookupPathForRequest(request);
        String controllerClassName = getClassNameForUrlPath(lookupPath);
        return obtainApplicationContext().getBean(controllerClassName);
    }
}

从代码中可以看出，ControllerClassNameHandlerMapping 同样实现了 AbstractUrlHandlerMapping 接口，并重写了其中的 getHandlerInternal 方法。该方法的作用是根据请求的URL路径查找相应的 Controller 类名，并将该类返回给 DispatcherServlet。

DefaultAnnotationHandlerMapping

DefaultAnnotationHandlerMapping 是Spring MVC 框架中另一种比较常用的 HandlerMapping实 现，它的作用是将 URL 请求的路径映射到标注了 @RequestMapping 注解的方法上。

具体来说，DefaultAnnotationHandlerMapping 会扫描应用程序中所有标注了 @RequestMapping 注解的方法，并将这些方法与相应的URL路径进行映射。

然后当客户端发送一个请求时，DefaultAnnotationHandlerMapping 就会根据请求的URL路径查找相应的处理程序，并将该处理程序返回给 DispatcherServlet，然后 DispatcherServlet 再将请求分配给该处理程序处理。

例如:

假设有一个名为 "/hello" 的请求

我们可以在 Controller 类的某个方法上标注 @RequestMapping 注解

将该方法与 "/hello" 请求进行映射。

这样，当客户端发送 "/hello" 请求时，DefaultAnnotationHandlerMapping 就会将该请求映射到该方法上，然后将该方法返回给 DispatcherServlet 处理。

DefaultAnnotationHandlerMapping 的源码比较复杂，因为它需要扫描应用程序中所有标注了 @RequestMapping 注解的方法。其核心代码如下所示：

public class DefaultAnnotationHandlerMapping extends AbstractDetectingUrlHandlerMapping implements BeanFactoryAware, InitializingBean {
    private final List<RequestMappingInfoHandlerMapping> handlerMappings = new ArrayList<>();
    protected Object getHandlerInternal(HttpServletRequest request) throws Exception {
        for (RequestMappingInfoHandlerMapping hm : this.handlerMappings) {
            HandlerExecutionChain handler = hm.getHandler(request);
            if (handler != null) {
                return handler;
            }
        }
        return null;
    }
    public void afterPropertiesSet() throws Exception {
        initHandlerMethods();
    }
    protected void initHandlerMethods() {
        detectHandlerMethods();
        if (logger.isInfoEnabled()) {
            logger.info("Mapped " + this.handlerMethods.size() + " request handler methods");
        }
    }
    protected void detectHandlerMethods() {
        ...
    }
}

从代码中可以看出，DefaultAnnotationHandlerMapping 同样实现了 AbstractUrlHandlerMapping 接口，并重写了其中的 getHandlerInternal 方法。该方法的作用是根据请求的 URL 路径查找相应的处理程序。

与其他 HandlerMapping 不同的是，DefaultAnnotationHandlerMapping 还实现了 BeanFactoryAware和InitializingBean 接口，以便在初始化时扫描应用程序中所有标注了 @RequestMapping 注解的方法。

具体来说，它会调用 detectHandlerMethods 方法，对应用程序中所有标注了 @RequestMapping 注解的方法进行扫描，并将这些方法与相应的URL路径进行映射。

总结

在 Spring MVC 框架中，HandlerMapping 用于将URL请求的路径映射到相应的处理程序上。框架中提供了多种不同的 HandlerMapping 实现，包括 BeanNameUrlHandlerMapping、SimpleUrlHandlerMapping、ControllerClassNameHandlerMapping 和 DefaultAnnotationHandlerMapping 等。不同的HandlerMapping 实现方式适用于不同的应用场景。

• BeanNameUrlHandlerMapping 是最简单的HandlerMapping实现，它将 URL 请求的路径直接映射到 Bean 的名称上。
• SimpleUrlHandlerMapping 则将 URL 请求的路径与相应的处理程序进行映射。
• ControllerClassNameHandlerMapping 将 URL 请求的路径映射到 Controller 类名上。
• DefaultAnnotationHandlerMapping 则将 URL 请求的路径映射到标注了 @RequestMapping 注解的方法上。

无论是哪种 HandlerMapping 实现方式，它们都遵循相同的流程来处理请求。具体来说，它们的流程如下：

客户端发送请求到DispatcherServlet。

• DispatcherServlet根据请求的URL路径选择相应的HandlerMapping。
• HandlerMapping将请求的URL路径与相应的处理程序进行映射。
• HandlerMapping返回相应的处理程序。
• DispatcherServlet将请求交给相应的处理程序进行处理。
• 处理程序进行业务逻辑的处理，并返回相应的结果。
• DispatcherServlet将处理程序的结果进行封装，并返回给客户端。

以上就是Spring MVC启动之HandlerMapping作用及实现详解的详细内容，更多关于Spring MVC启动HandlerMapping的资料请关注我们其它相关文章！