SpringBoot 自定义参数解析器 So Easy!

网站建设3年前发布
7 00

在一个 Web 请求中,参数我们无非就是放在地址栏或者请求体中,个别请求可能放在请求头中。,放在地址栏中,我们可以通过如下方式获取参数:,放在请求体中,如果是 key/value 形式,我们可以通过如下方式获取参数:,如果是 JSON 形式,我们则通过如果如下方式获取到输入流,然后解析成 JSON 字符串,再通过 JSON 工具转为对象:,如果参数放在请求头中,我们可以通过如下方式获取:,如果你用的是 Jsp/Servlet 那一套技术栈,那么参数获取无外乎这几种方式。,如果用了 SpringMVC 框架,有的小伙伴们可能会觉得参数获取方式太丰富了,各种注解如 @RequestParam、@RequestBody、@RequestHeader、@PathVariable,参数可以是 key/value 形式,也可以是 JSON 形式,非常丰富!但是,「无论多么丰富,最底层获取参数的方式无外乎上面几种。」,那有小伙伴要问了,SpringMVC 到底是怎么样从 request 中把参数提取出来直接给我们用的呢?例如下面这个接口:,我们都知道 name 参数是从 HttpServletRequest 中提取出来的,到底是怎么提取出来的?这就是松哥今天要和大家分享的话题。,为了搞清楚这个问题,我们先来自定义一个参数解析器看看。,自定义参数解析器需要实现 HandlerMethodArgumentResolver 接口,我们先来看看该接口:,这个接口中就两个方法:,自定义参数解析器只需要实现该接口即可。,假设我现在有这样一个需求(实际上在 Spring Security 中获取当前登录用户名非常方便,这里只是为了该案例而做,勿抬杠):,假设我现在系统安全框架使用了 Spring Security(对 Spring Security 不熟悉的小伙伴,可以在公众号江南一点雨后台回复 ss,有教程),如果我在接口的参数上添加了 @CurrentUserName 注解,那么该参数的值就是当前登录的用户名,像下面这样:,要实现这个功能,非常 easy,首先我们自定义一个 @CurrentUserName 注解,如下:,这个注解没啥好解释的。,接下来我们自定义参数解析器 CurrentUserNameHandlerMethodArgumentResolver,如下:,最后,我们再将自定义的参数解析器配置到 HandlerAdapter 中,配置方式如下:,至此,就算配置完成了。,接下来启动项目,用户登录成功后,访问 /hello 接口,就可以看到返回当前登录用户数据了。,这就是我们自定义的一个参数类型解析器。可以看到,非常 Easy。,在 SpringMVC 中,默认也有很多 HandlerMethodArgumentResolver 的实现类,他们处理的问题也都类似,松哥再给大家举个例子。,如果我们在项目中使用了 Spring Security,我们可以通过如下方式获取当前登录用户信息:,即直接在当前接口的参数中添加 Principal 类型的参数即可,该参数描述了当前登录用户信息,这个用过 Spring Security 的小伙伴应该都知道。,那么这个功能是怎么实现的呢?当然就是 PrincipalMethodArgumentResolver 在起作用了!,我们一起来看下这个参数解析器:,supportsParameter:这个方法主要是判断参数类型是不是 Principal,如果参数类型是 Principal,就支持。,resolveArgument:这个方法的逻辑很简单,首先获取原生的请求,再从请求中获取 Principal 对象返回即可。,是不是很简单,有了这个,我们就可以随时加载到当前登录用户信息了。,松哥再给大家举个例子:,这个接口很多小伙伴可能都写过,使用 Map 去接收前端传来的参数,那么这里用到的参数解析器就是 RequestParamMapMethodArgumentResolver。,supportsParameter:参数类型是 Map,并且使用了@RequestParam​ 注解,并且@RequestParam 注解中没有配置 name 属性,就可以使用该参数解析器。,resolveArgument:具体解析分为两种情况:MultiValueMap 和其他 Map,前者中又分三种情况:MultipartFile、Part 或者其他普通请求,前两者可以处理文件上传,第三个就是普通参数。如果是普通 Map,则直接获取到原始请求参数放到一个 Map 集合中返回即可。,前面和大家聊的都是几种简单的情况,还有复杂的如 PathVariableMethodArgumentResolver 和 RequestParamMethodArgumentResolver 松哥以后再和大家详细聊。

© 版权声明

相关文章