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

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

相关文章

  • springboot整合JPA过程解析

    springboot整合JPA过程解析

    这篇文章主要介绍了springboot整合JPA过程解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-02-02
  • java实现小i机器人api接口调用示例

    java实现小i机器人api接口调用示例

    这篇文章主要介绍了java实现小i机器人api接口调用示例,需要的朋友可以参考下
    2014-04-04
  • SpringBoot整合Mybatis-Plus+Druid实现多数据源配置功能

    SpringBoot整合Mybatis-Plus+Druid实现多数据源配置功能

    本文主要讲解springboot +mybatisplus + druid 实现多数据源配置功能以及一些必要的准备及代码说明,具有一定的参考价值,感兴趣的小伙伴可以借鉴一下
    2023-06-06
  • MyBatis-plus报错Property ‘sqlSessionFactory‘ or ‘sqlSessionTemplate‘ are required的解决方法

    MyBatis-plus报错Property ‘sqlSessionFactory‘ or 

    这篇文章主要给大家介绍了MyBatis-plus 报错 Property ‘sqlSessionFactory‘ or ‘sqlSessionTemplate‘ are required的两种解决方法,如果遇到相同问题的朋友可以参考借鉴一下
    2023-12-12
  • Java 在 Word 文档中使用新文本替换指定文本的方法

    Java 在 Word 文档中使用新文本替换指定文本的方法

    这篇文章主要介绍了Java 在 Word 文档中使用新文本替换指定文本的方法,本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下
    2019-09-09
  • 锁超时发现parallelStream并行流线程上下文坑解决

    锁超时发现parallelStream并行流线程上下文坑解决

    这篇文章主要为大家介绍了锁超时发现parallelStream并行流线程上下文坑解决,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • Java调用Shell命令的方法

    Java调用Shell命令的方法

    这篇文章主要介绍了Java调用Shell命令的方法,实例分析了java调用shell命令的相关技巧,具有一定参考借鉴价值,需要的朋友可以参考下
    2015-07-07
  • SpringBoot中如何统一接口返回与全局异常处理详解

    SpringBoot中如何统一接口返回与全局异常处理详解

    全局异常处理是个比较重要的功能,一般在项目里都会用到,这篇文章主要给大家介绍了关于SpringBoot中如何统一接口返回与全局异常处理的相关资料,文中通过示例代码介绍的非常详细,需要的朋友可以参考下
    2021-09-09
  • 一文带你熟练掌握Java中的日期时间相关类

    一文带你熟练掌握Java中的日期时间相关类

    我们在开发时,除了数字、数学这样的常用API之外,还有日期时间类,更是会被经常使用,比如我们项目中必备的日志功能,需要记录异常等信息产生的时间,本文就带各位来学习一下相关的日期时间类有哪些
    2023-05-05
  • java中File类的三种创建文件夹方法总结

    java中File类的三种创建文件夹方法总结

    这篇文章主要给大家介绍了关于java中File类的三种创建文件夹方法,File类代表文件或目录路径名的抽象表达形式,通过File类提供的方法,我们可以很方便地创建文件夹,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-04-04

最新评论