SpringMVC MethodArgumentResolver的作用与实现

 更新时间:2023年04月11日 10:42:17   作者:这堆干货有点猛  
这篇文章主要介绍了SpringMVC MethodArgumentResolver的作用与实现,MethodArgumentResolver采用一种策略模式,在Handler的方法被调用前,Spring MVC会自动将HTTP请求中的参数转换成方法参数

昨天的文章我们学习 MethodArgumentResolver ,它是采用一种策略模式,在 Handler 的方法被调用前,将 HTTP 请求中的参数转换成 Handler 方法的参数,今天我们将学习另外一种组件 MethodReturnValueHandler,用于将 Handler 返回的数据转换为 HTTP 响应。

作用

在Spring MVC中,当一个控制器方法执行完成后,它会返回一个数据对象,这个数据对象可以是任何类型,如对象、集合、数组、字符串等等。MethodReturnValueHandler 就是负责将这个数据对象转换为HTTP响应的。

源码实现

在Spring MVC中,MethodReturnValueHandler 是一个接口,它有多个实现类,每个实现类都可以处理不同类型的数据对象。下面是一个简单的 MethodReturnValueHandler 的实现类示例:

public class MyReturnValueHandler implements MethodReturnValueHandler {
    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        return returnType.getParameterType().equals(MyData.class);
    }
    @Override
    public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception {
        MyData myData = (MyData) returnValue;
        // do something with myData
        HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class);
        response.getWriter().write("hello world");
    }
}

这个实现类可以将 MyData 类型的数据对象转换为 HTTP 响应。

supportsReturnType 方法用于判断该实现类是否支持处理指定类型的返回值。

handleReturnValue 方法用于将数据对象转换为 HTTP 响应。

在Spring MVC中,MethodReturnValueHandler 由 RequestMappingHandlerAdapter 类负责管理。

RequestMappingHandlerAdapter 会维护一个 MethodReturnValueHandler 列表,当控制器方法执行完成后,它会遍历这个列表,找到第一个支持处理当前返回值类型的 MethodReturnValueHandler,并调用它的 handleReturnValue 方法。

public class RequestMappingHandlerAdapter extends AbstractHandlerMethodAdapter {
    private final List<MethodReturnValueHandler> returnValueHandlers = new ArrayList<>();
    @Override
    public void afterPropertiesSet() {
        super.afterPropertiesSet();
        this.returnValueHandlers.add(new MyReturnValueHandler());
    }
    @Override
    public boolean supportsReturnType(MethodParameter returnType) {
        for (MethodReturnValueHandler handler : this.returnValueHandlers) {
            if (handler.supportsReturnType(returnType)) {
                return true;
            }
        }
        return false;
    }
    @Override
    protected ModelAndView handleInternal(HttpServletRequest request, HttpServletResponse response, HandlerMethod handlerMethod) throws Exception {
        Object returnValue = handlerMethod.getMethod().invoke(handlerMethod.getBean(), handlerMethod.getMethodParameters());
        MethodParameter returnType = handlerMethod.getReturnType();
        for (MethodReturnValueHandler handler : this.returnValueHandlers) {
            if (handler.supportsReturnType(returnType)) {
                ModelAndViewContainer mavContainer = new ModelAndViewContainer();
                handler.handleReturnValue(returnValue, returnType, mavContainer, new ServletWebRequest(request, response));
                return mavContainer.getModelAndView();
            }
        }
        return null;
    }
}

在 RequestMappingHandlerAdapter 的 afterPropertiesSet 方法中,我们可以向returnValueHandlers 列表中添加自定义的 MethodReturnValueHandler 实现类。

supportsReturnType 方法用于判断当前返回值类型是否有对应的 MethodReturnValueHandler实 现类可以处理。

handleInternal 方法会在控制器方法执行完成后调用,它会根据返回值类型查找对应的 MethodReturnValueHandler 实现类,并调用它的 handleReturnValue 方法将数据对象转换为HTTP响应。

总结

MethodReturnValueHandler 是Spring MVC 中的一个拦截器,它的作用是根据方法的返回值,将数据转换为HTTP响应。

在Spring MVC中,MethodReturnValueHandler 由 RequestMappingHandlerAdapter 类负责管理。它会维护一个 MethodReturnValueHandler 列表,在控制器方法执行完成后,它会遍历这个列表,找到第一个支持处理当前返回值类型的 MethodReturnValueHandler,并调用它的handleReturnValue 方法。

我们可以自定义 MethodReturnValueHandler 实现类来处理特定类型的返回值。

到此这篇关于SpringMVC MethodArgumentResolver的作用与实现的文章就介绍到这了,更多相关SpringMVC MethodArgumentResolver内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 解决kafka消息堆积及分区不均匀的问题

    解决kafka消息堆积及分区不均匀的问题

    这篇文章主要介绍了解决kafka消息堆积及分区不均匀的问题,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-09-09
  • SpringAop源码及调用过程概述

    SpringAop源码及调用过程概述

    这篇文章主要介绍了SpringAop源码及调用过程概述,Spring AOP(面向切面编程)是Spring框架的一个重要特性,它提供了一种在程序运行期间动态地将额外的行为织入到代码中的方式,需要的朋友可以参考下
    2023-10-10
  • idea运行tomcat报错找不到catalina.bat,系统找不到指定的文件问题

    idea运行tomcat报错找不到catalina.bat,系统找不到指定的文件问题

    这篇文章主要介绍了idea运行tomcat报错找不到catalina.bat,系统找不到指定的文件问题,具有很好的参考价值,希望对大家有所帮助,
    2023-11-11
  • mybatis postgresql 批量删除操作方法

    mybatis postgresql 批量删除操作方法

    PostgreSQL是一种特性非常齐全的自由软件的对象-关系型数据库管理系统(ORDBMS),这篇文章主要介绍了mybatis postgresql 批量删除操作,需要的朋友可以参考下
    2020-02-02
  • Thymeleaf 3.0 自定义标签方言属性的实例讲解

    Thymeleaf 3.0 自定义标签方言属性的实例讲解

    这篇文章主要介绍了Thymeleaf 3.0 自定义标签方言属性的实例讲解,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-09-09
  • Mybatis分页的4种方式实例

    Mybatis分页的4种方式实例

    这篇文章主要介绍了Mybatis分页的4种方式实例,包括数组分页,sql分页,拦截器分页,RowBounds分页,需要的朋友可以参考下
    2022-04-04
  • Spring循环依赖的解决方法详解

    Spring循环依赖的解决方法详解

    Spring的解决循环依赖是有前置条件的,要解决循环依赖我们首先要了解Spring Bean对象的创建过程和依赖注入的方式。依赖注入方式,我之前的博客有所分享,大家可以在看本篇文章之前进行一下小小的回顾
    2022-08-08
  • SpringBoot Schedule调度任务的动态管理

    SpringBoot Schedule调度任务的动态管理

    Scheduled定时任务是Spring boot自身提供的功能,所以不需要引入Maven依赖包,下面这篇文章主要给大家介绍了关于SpringBoot通过@Scheduled实现定时任务以及问题解决的相关资料,需要的朋友可以参考下
    2023-02-02
  • SpringBoot中的声明式事务+切面事务+编程式事务详解

    SpringBoot中的声明式事务+切面事务+编程式事务详解

    这篇文章主要介绍了SpringBoot中的声明式事务+切面事务+编程式事务详解,事务管理对于企业应用来说是至关重要的,当出现异常情况时,它也可以保证数据的一致性,需要的朋友可以参考下
    2023-08-08
  • LeetCode 动态规划之矩阵区域和详情

    LeetCode 动态规划之矩阵区域和详情

    这篇文章主要介绍了LeetCode 动态规划之矩阵区域和详情,文章基于Java的相关资料展开对LeetCode 动态规划的详细介绍,需要的小伙伴可以参考一下
    2022-04-04

最新评论