服务器之家:专注于服务器技术及软件下载分享
分类导航

PHP教程|ASP.NET教程|Java教程|ASP教程|编程技术|正则表达式|C/C++|IOS|C#|Swift|Android|VB|R语言|JavaScript|易语言|vb.net|

服务器之家 - 编程语言 - Java教程 - SpringBoot项目实用功能之实现自定义参数解析器

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

2021-11-23 13:32DDF_YiChen Java教程

这篇文章主要介绍了SpringBoot项目实用功能之实现自定义参数解析器,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教

核心点

1、实现接口

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

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

添加到Spring容器中

3、实现

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

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

动手实现

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

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

1、实现

?
1
org.springframework.web.method.support.HandlerMethodArgumentResolver
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
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功能的接口

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
@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

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

原文链接:https://blog.csdn.net/yichen0429/article/details/115417188

延伸 · 阅读

精彩推荐
  • Java教程Java中Socket设置连接超时的代码分享

    Java中Socket设置连接超时的代码分享

    在我们日常连接中,如果超时时长过长的话,在开发时会影响测试,下面这篇文章主要给大家分享了关于Java中Socket设置连接超时的代码,需要的朋友可以参...

    Juwend1552020-11-18
  • Java教程Spring Boot启动banner定制的步骤详解

    Spring Boot启动banner定制的步骤详解

    这篇文章主要给大家介绍了关于Spring Boot启动banner定制的相关资料,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,...

    杨高超10832021-04-10
  • Java教程spring data jpa开启批量插入、批量更新的问题解析

    spring data jpa开启批量插入、批量更新的问题解析

    这篇文章主要介绍了spring data jpa开启批量插入、批量更新问题,本文通过图文实例相结合给大家介绍的非常详细,需要的朋友可以参考下...

    曲高终和寡6972021-10-27
  • Java教程Java Web实现文件下载和乱码处理方法

    Java Web实现文件下载和乱码处理方法

    文件上传和下载是web开发中常遇到的问题。今天小编给大家分享下Java Web实现文件下载和乱码处理方法的相关资料,需要的朋友可以参考下...

    mrr6342020-06-24
  • Java教程Java实现二分查找算法实例分析

    Java实现二分查找算法实例分析

    这篇文章主要介绍了Java实现二分查找算法,实例分析了二分查找算法的原理与相关实现技巧,具有一定参考借鉴价值,需要的朋友可以参考下 ...

    tolcf3022019-12-30
  • Java教程Maven项目继承实现过程图解

    Maven项目继承实现过程图解

    这篇文章主要介绍了Maven项目继承实现过程图解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下...

    护花使者1952020-08-05
  • Java教程Java基础详解之面向对象的那些事儿

    Java基础详解之面向对象的那些事儿

    这篇文章主要介绍了Java基础之面向对象那些事儿,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有很好的帮助,需要的朋友可以参考下...

    小叶要暴富8722021-09-10
  • Java教程微信开发协议小结

    微信开发协议小结

    通过本教程给大家分享微信开发协议小结的相关知识,非常不错,具有一定的参考借鉴价值,感兴趣的朋友一起看看吧 ...

    飞翔_企鹅3842020-07-02