SpringBoot项目实用功能之实现自定义参数解析器

 更新时间:2021年08月18日 10:03:53   作者:DDF_YiChen  
这篇文章主要介绍了SpringBoot项目实用功能之实现自定义参数解析器,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

核心点

1、实现接口

org.springframework.web.method.support.HandlerMethodArgumentResolver
  • supportsParameter 方法根据当前方法参数决定是否需要应用当前这个参数解析器
  • resolveArgument 执行具体的解析过程

2、将自实现的参数解析器类

添加到Spring容器中

3、实现

org.springframework.web.servlet.config.annotation.WebMvcConfigurer

接口addArgumentResolvers方法,将自己的参数解析器加入到列表中

动手实现

有点懒,也不想直接找一个例子了,之前正好写过一个,允许前端定义查询表达式,可以让前端自定义查询字段查询条件和查询值,然后进行and和or的组合,那么就每个条件就是一个查询对象,多个的话就组成一个查询对象列表对象,这里只展示思路,就补贴实际的类的代码了。

简单说明一下, 这个参数解析器是用来解析List<QueryParam>这个形式的参数类型的。

1、实现

org.springframework.web.method.support.HandlerMethodArgumentResolver
public class QueryParamArgumentResolver implements HandlerMethodArgumentResolver {
    /**
     * 判断当前参数是否需要解析,该解析器用来解析参数类型为List<QueryParam>
     *
     * @param parameter
     * @return
     */
    @Override
    public boolean supportsParameter(MethodParameter parameter) {
        boolean isList = List.class.equals(parameter.getParameterType());
        if (isList) {
            Type genericType = parameter.getGenericParameterType();
            if (genericType instanceof ParameterizedType) {
                ParameterizedType parameterizedType = (ParameterizedType) genericType;
                Type actualTypeArgument = parameterizedType.getActualTypeArguments()[0];
                return actualTypeArgument.getTypeName().equals(QueryParam.class.getName());
            }
        }
        return false;
    }
    /**
     * 将前端参数名称为{@link ContextKey#queryParams}的字符串值解析为List<QueryParam>,用于查询
     *
     * @param parameter
     * @param mavContainer
     * @param webRequest
     * @param binderFactory
     * @return
     * @throws Exception
     */
    @Override
    public List<QueryParam> resolveArgument(MethodParameter parameter, ModelAndViewContainer mavContainer,
            NativeWebRequest webRequest, WebDataBinderFactory binderFactory) throws Exception {
        String queryParamsStr = webRequest.getParameter(ContextKey.queryParams.name());
        if (StrUtil.isBlank(queryParamsStr)) {
            return Collections.emptyList();
        }
        final List<QueryParam> params = JsonUtil.getInstance()
                .readValue(queryParamsStr, new TypeReference<List<QueryParam>>() {
                    @Override
                    public Type getType() {
                        return super.getType();
                    }
                });
        if (CollectionUtil.isNotEmpty(params)) {
            for (QueryParam param : params) {
                if (param.getRelative() == null) {
                    param.setRelative(QueryParam.Relative.AND);
                }
                if (param.getOp() == null) {
                    param.setOp(QueryParam.Op.EQ);
                }
            }
        }
        return params;
    }
}

2、在配置类中注册当前自定义的参数解析器

这里采用直接实现org.springframework.web.servlet.config.annotation.WebMvcConfigurer接口,通过增加@Configuration注解,即充当了配置类,又可以实现添加webmvc功能的接口

@Configuration
public class CoreWebConfig implements WebMvcConfigurer {
    /**
     * 注册解析器
     *
     * @return
     */
    @Bean
    public QueryParamArgumentResolver queryParamArgumentResolver() {
        return new QueryParamArgumentResolver();
    }
    
    /**
     * 配置自定义参数解析器
     *
     * @param resolvers
     */
    @Override
    public void addArgumentResolvers(List<HandlerMethodArgumentResolver> resolvers) {
        resolvers.add(queryParamArgumentResolver());
    }
}

项目实例

在某些对外的接口中,可能会存在这样一种情况

相同的一个接口,即需要满足对方用Content-Type: application/json这种格式传输,那么对应的后台接口就需要用@RequestBody来注解参数;还有一些老的用户用application/x-www-form-urlencoded这种传参的话,那么后台参数一定不能使用@RequestBody来注释参数,因为这两种请求方式对应的后台的参数解析器是不一样的。

那么如果我们想要相同的写法,两种参数都支持的话,就需要自定义参数解析器了。

当然需要明确一点,这个自定义的参数解析器和其它可能会有点不一样,因为其实对应的两种参数解析,SpringMVC都有了自己对应的参数解析器,我们现在只是在前面拦截一层,根据根据Content-Type做一层转发,最后还是委托给对应的参数解析器来完成这个工作。

关于这一块,之前写过一篇文章了,可以参考自定义参数解析器同一个参数支持多种Content-Type

好了,以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • spring简单MVC实现方法(URL映射及其参数使用、查询(id、其他参数)、增加)

    spring简单MVC实现方法(URL映射及其参数使用、查询(id、其他参数)、增加)

    这篇文章主要介绍了spring简单MVC实现方法(URL映射及其参数使用、查询(id、其他参数)、增加),方法参数使用包括在无注解下获取参数,使用@RequestParam 获取参数的方法,每种方法讲解的非常详细,需要的朋友可以参考下
    2024-01-01
  • struts2实现简单文件下载功能

    struts2实现简单文件下载功能

    这篇文章主要为大家详细介绍了struts2实现简单文件下载功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01
  • Spring Boot集成Swagger接口分类与各元素排序问题

    Spring Boot集成Swagger接口分类与各元素排序问题

    这篇文章主要介绍了Spring Boot集成Swagger接口分类与各元素排序问题,首先我们需要对Swagger中的接口也就是以Controller 层作为第一级梯度进行组织的,Controller在我们实际开发中,与其他具体接口之间是存在一对多的关系,本文给大家介绍的非常详细,需要的朋友参考下吧
    2023-10-10
  • IDEA配置tomcat的方法、IDEA配置tomcat运行web项目详解

    IDEA配置tomcat的方法、IDEA配置tomcat运行web项目详解

    这篇文章主要介绍了IDEA配置tomcat的方法、IDEA配置tomcat运行web项目详解,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2023-07-07
  • JAVA泛型的继承和实现、擦除原理解析

    JAVA泛型的继承和实现、擦除原理解析

    这篇文章主要介绍了JAVA泛型的继承和实现、擦除原理解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2019-11-11
  • 详解Java中的日期类

    详解Java中的日期类

    这篇文章主要介绍了Java中的日期类的相关资料,帮助大家更好的利用Java处理时间,感兴趣的朋友可以了解下
    2020-10-10
  • Mybatis-Plus开发提速器mybatis-plus-generator-ui详解

    Mybatis-Plus开发提速器mybatis-plus-generator-ui详解

    这篇文章主要介绍了Mybatis-Plus开发提速器mybatis-plus-generator-ui,本文简要介绍一款基于Mybatis-Plus的代码自助生成器,文章通过实例集成的方式来详细讲解mybatis-plus-generator-ui,从相关概念到实际集成案例,以及具体的扩展开发介绍,需要的朋友可以参考下
    2022-11-11
  • Java的CGLIB动态代理深入解析

    Java的CGLIB动态代理深入解析

    这篇文章主要介绍了Java的CGLIB动态代理深入解析,CGLIB是强大的、高性能的代码生成库,被广泛应用于AOP框架,它底层使用ASM来操作字节码生成新的类,为对象引入间接级别,以控制对象的访问,需要的朋友可以参考下
    2023-11-11
  • 深入分析JAVA 建造者模式

    深入分析JAVA 建造者模式

    这篇文章主要介绍了JAVA 建造者模式的的相关资料,文中讲解非常详细,代码帮助大家更好的理解和学习,感兴趣的朋友可以了解下
    2020-06-06
  • Java版微信公众号支付开发全过程

    Java版微信公众号支付开发全过程

    这篇文章主要介绍了Java版微信公众号支付开发全过程,本文通过实例相结合给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2018-07-07

最新评论