@SpringQueryMap注解的使用方法

后端 潘老师 2个月前 (12-18) 66 ℃ (0) 扫码查看

本文主要讲解关于@SpringQueryMap注解的使用方法相关内容,让我们来一起学习下吧!

@SpringQueryMap 是 Spring Framework 中的一个注解,主要用于将 Java Map 对象转化为查询参数,常用于 WebClient 的请求中。它可以将多个查询参数添加到 HTTP 请求中,简化了手动构建查询参数的过程。

具体用法如下:

  1. 在发送 HTTP 请求的代码中,创建一个 Map 对象,将需要作为查询参数的键值对放入该 Map 对象中。
  2. 在 WebClient 的请求方法中,使用 uri 方法指定请求的 URL,并将 Map 对象作为参数传递给该方法。
  3. 在传递给 uri 方法的参数前,使用 @SpringQueryMap 注解进行标注。

Spring Framework 会自动扫描并识别 @SpringQueryMap 注解,并将 Map 对象中的键值对转换为查询参数,附加到 URL 后面。

@SpringQueryMap,简单来说就是将实体转化为表单数据,比如

{
    "username" : "zhangsan",
    "passwd" : "******"
}

通过@SpringQueryMap标注之后呢,会变成这样子

url?username=zhangsan&passwd=******

注意:被@SpringQueryMap注解的对象只能有一个。因为不能保证多个对象中是否会存在相同的属性名,这是值得注意的一点。

  1. 单实体入参数

feign调用方

@GetMapping(value = "/xx/xxxx")
ApiResponse<SysUserQueryResponse> query(@SpringQueryMap SysUserQueryRequest queryRequest);

被调用方

@GetMapping
@Operation(summary = "查询 用户")
public ApiResponse<SysUserQueryResponse> query(SysUserQueryRequest queryRequest) {
    return ApiResponse.ok(sysUserReadModelRepo.query(queryRequest));
}
  1. 多实体入参数

错误的方式:以下这两种方式都是错误的,都是只能生效一个实体的传参数feign调用方

@GetMapping(value = "/xx/xxxx")
ApiPageResponse<SysUserQueryResponse> query(@RequestParam Pagination pagination, @SpringQueryMap SysUserQueryRequest queryRequest);

@GetMapping(value = "/xx/xxxx")
ApiPageResponse<SysUserQueryResponse> query(@SpringQueryMap Pagination pagination, @SpringQueryMap SysUserQueryRequest queryRequest);

正确的方式:

根据上面的结论,可知只会生效一个实体的传参,其原因是因为get方式只能是表单提交的,不能通过body传输,如果这两个实体存在相同的属性,就会出现问题,所以就默认不会取第二个实体来传参数。

解决方法也很简单,将这两个实体都转为map,放到一个map中即可,再次提醒这两个实体中不能存在相同的属性名,否则出现参数覆盖情况

feign调用方

## 实体转map,使用阿里巴巴库的JSON类
Map<String, Object> param = JSON.parseObject(JSON.toJSONString(Pagination), Map.class);
Map<String, Object> param1 = JSON.parseObject(JSON.toJSONString(SysUserQueryRequest), Map.class);
param.addAll(param1);

## 以param作为参数传递
@GetMapping(value = "/xx/xxxx")
ApiPageResponse<SysUserQueryResponse> query(@SpringQueryMap Map<String, Object> param);

被调用方,无需用map接收,可以随意对象,只需要对应上属性名和类型即可

@GetMapping
@Operation(summary = "分页查询 用户")
public ApiPageResponse<SysUserQueryResponse> query(Pagination pagination, @Valid SysUserQueryRequest queryRequest) {
    return ApiPageResponse.ok(pagination, sysUserReadModelRepo.query(pagination, queryRequest));
}

以上就是关于@SpringQueryMap注解的使用方法相关的全部内容,希望对你有帮助。欢迎继续关注潘子夜个人博客,学习愉快哦!


版权声明:本站文章,如无说明,均为本站原创,转载请注明文章来源。如有侵权,请联系博主删除。
本文链接:https://www.panziye.com/back/12599.html
喜欢 (0)
请潘老师喝杯Coffee吧!】
分享 (0)
用户头像
发表我的评论
取消评论
表情 贴图 签到 代码

Hi,您需要填写昵称和邮箱!

  • 昵称【必填】
  • 邮箱【必填】
  • 网址【可选】