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

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

核心点

1、实现接口

org.springframework.web.method.support.HandlerMethodArgumentResolver

supportsParameter 方法根据当前方法参数决定是否需要应用当前这个参数解析器

resolveArgument 执行具体的解析过程

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

添加到Spring容器中

3、实现

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

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

动手实现

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

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

1、实现

org.springframework.web.method.support.HandlerMethodArgumentResolver

public class QueryParamArgumentResolver implements HandlerMethodArgumentResolver {

/**

* 判断当前参数是否需要解析，该解析器用来解析参数类型为List

*

* @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 ParameterizediPpEdType) {

ParameterizedType parameterizedType = (ParameterizedType) genericType;

Type actualTypeArgument = parameterizedType.getActualTypeArguments()[0];

return actualTypeArgument.getTypeName().equals(QueryParam.class.getName());

}

}

return false;

}

/**

* 将前端参数名称为{@link ContextKey#queryParams}的字符串值解析为List，用于查询

*

* @param parameter

* @param mavContainer

* @param webRequest

* @param binderFactory

* @return

* @throws Exception

*/

@Override

public List 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 params = jsonUtil.getInstance()

.readValue(queryParamsStr, new TypeReference>() {

@Override

public Type getType() {

return super.getTyphttp://e();

}

});

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 resolvers) {

resolvers.add(queryParamArgumentResolver());

}

}

项目实例

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

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

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

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

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

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。