百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 热门文章 > 正文

如何实现SpringBoot Get参数忽略大小写?

bigegpt 2024-10-14 08:18 7 浏览



这篇文章是我在做业务架构中遇到到问题及解决方案,整理如下:

问题

1、业务系统混搭(net core ,Java)旧的系统api QueryString 参数不区分大小写,现转为调用Java系统API,需要区分大小写

2、URL参数太多业务实用需要绑定到POJO对象,且需要支持参数验证


方案

业务应用中QueryString参数值获取方式有:

  1. @RequestParam
  2. @ModelAttribute
  3. @BindRestParameterSimpleModel即自定义实现QueryString参数转换为业务POJO

第1,2两种方式对于QueryString参数大小写敏感,适用于调用方严格遵守约定。如果api处于过度阶段,则可能会因为参数大小写问题导致业务执行失败,典型场景是:

NET API转化为Spring API,NET API Query String是忽略大小写的,但是Spring API对参数大小写敏感的,如果API调用方传递了未遵守API约定的参数格式,则会导致调用失败,所以BindRestParameterSimpleModel解决其参数名大小写,简化绑定参数业务代码。


且先看看以上三种获取QueryString参数的代码:

/**
**BindRestParameterSimpleModel 自定义绑定QueryString参数且忽略大小写,支持参数验证
*/
@GetMapping(value = "/query")
public ResourceResponse<QueryStringDto> queryStringParse(
@BindRestParameterSimpleModel 
@Valid                                                               
QueryStringDto queryStringDto
, Errors errors) {
    ParameterAssertUtil.assertRequestFristValidated(errors);
    return ResourceResponse.ok(ObjectCopyUtils.copy(queryStringDto, QueryStringDto.class));
}

/**
**ModelAttribute spring boot 提供的API绑定参数但是区分参数名大小写
*/
@GetMapping(value = "/query2")
public ResourceResponse<QueryStringDto> queryStringParse2(
@ModelAttribute 
@Valid                                                                 
QueryStringDto queryStringDto
    , Errors errors) {
    ParameterAssertUtil.assertRequestFristValidated(errors);
    return ResourceResponse.ok(ObjectCopyUtils.copy(queryStringDto, QueryStringDto.class));
}

/**
**RequestParam spring boot提供的AI需要枚举URL参数列表且区分参数名大小写
*/
@GetMapping(value = "/query3")
public ResourceResponse<QueryStringDto> queryStringParse3(
@RequestParam                                                           
@NotEmpty(message = "uuId can't null")                                                          
String uuId,                                                             
@RequestParam                                                            
@NotNull(message = "class id can't null")                                                          
Integer classId,                                                            
@RequestParam                                                             
@NotNull(message = "users can't null")                                                            
Collection<String> users) {
    QueryStringDto queryStringDto = new QueryStringDto();
    queryStringDto.setClassId(classId);
    queryStringDto.setUuId(uuId);
    queryStringDto.setUsers(users);
    return ResourceResponse.ok(queryStringDto);
}

可以看出这三种获取QueryString参数使用都较为简单,其中@RequestParam我习惯于在QueryString参数少于等于3时使用,参数太多使用@RequestParam时代码很不优雅,@ModelAttribute使用较少,@BindRestParameterSimpleModel即自定义参数绑定,特性如下:

  1. 忽略参数名大小写
  2. 支持自定义解析参数(特别是日期类型的参数)
  3. 支持参数校验

实现BindRestParameterSimpleModel功能,需要做以下工作:

  1. 定义BindRestParameterSimpleModel注解
  2. 实现HandlerMethodArgumentResolver
  3. 注入解析程序
  4. 实现参数解析为POJO程序

实现

HandlerMethodArgumentResolver接口实现核心代码如下:

@Override
public Object resolveArgument(MethodParameter parameter
        , ModelAndViewContainer mavContainer
        , NativeWebRequest webRequest
        , WebDataBinderFactory binderFactory) throws Exception {
    HttpServletRequest request = (HttpServletRequest) 
    webRequest.getNativeRequest();
    //custom parse query string parameter to pojo
    Object obj = 
    ParameterMapUtil.mapToPojo(request.getParameterMap(), 
    parameter.getParameterType());
    //if bind failed then use default instance
    if (obj == null) {
        obj = parameter.getParameterType().newInstance();
    }
    String name = ModelFactory.getNameForParameter(parameter);
    //Object attribute = (mavContainer.containsAttribute(name) ? mavContainer.getModel().get(name) :
    //        BeanUtils.instantiateClass(parameter.getParameterType()));
    WebDataBinder binder = binderFactory.createBinder(webRequest, obj, name);
    if (binder.getTarget() != null) {
        //execute model verified
        validateIfApplicable(binder, parameter);
        if (binder.getBindingResult().hasErrors() && isBindExceptionRequired(binder, parameter)) {
            //ignore exception,ie:updateShareGroup(@RequestBody @Valid UpdateShareGroupReq req, Errors errors)
            //throw new BindException(binder.getBindingResult());
        }
    }
    // Add resolved attribute and BindingResult at the end of the model
    Map<String, Object> bindingResultModel = binder.getBindingResult().getModel();
    mavContainer.removeAttributes(bindingResultModel);
    mavContainer.addAllAttributes(bindingResultModel);
    return obj;
}

该解析程序BindRestParameterSimpleModelResolver主要实现,以下工作

  1. 调用ParameterMapUtil.mapToPojo即转换QuerString参数为POJO
  2. 调用实体验证程序

测试

测试case分别是参数合法,参数缺失,参数大小写。

http://localhost:8080/v1/query?classId=1122&uuID=33&users=3444&users=455

http://localhost:8080/v1/query?classId=1122&uuId=&users=3444&users=455

http://localhost:8080/v1/query?classid=1122&UUID=33&users=3444&users=455

均返回预期结果,通过自定义实体绑定,可以简化controller代码,满足参数名不区分大小写


资源

https://github.com/hummer-team/hummer-framework/blob/master/hummer-rest/src/main/java/com/hummer/rest/resolver/BindRestParameterSimpleModelResolver.java

注:这是我自己整合的spring boot框架,做了些“胶水”代码,在公司内部所有Java项目应用

相关推荐

得物可观测平台架构升级:基于GreptimeDB的全新监控体系实践

一、摘要在前端可观测分析场景中,需要实时观测并处理多地、多环境的运行情况,以保障Web应用和移动端的可用性与性能。传统方案往往依赖代理Agent→消息队列→流计算引擎→OLAP存储...

warm-flow新春版:网关直连和流程图重构

本期主要解决了网关直连和流程图重构,可以自此之后可支持各种复杂的网关混合、多网关直连使用。-新增Ruoyi-Vue-Plus优秀开源集成案例更新日志[feat]导入、导出和保存等新增json格式支持...

扣子空间体验报告

在数字化时代,智能工具的应用正不断拓展到我们工作和生活的各个角落。从任务规划到项目执行,再到任务管理,作者深入探讨了这款工具在不同场景下的表现和潜力。通过具体的应用实例,文章展示了扣子空间如何帮助用户...

spider-flow:开源的可视化方式定义爬虫方案

spider-flow简介spider-flow是一个爬虫平台,以可视化推拽方式定义爬取流程,无需代码即可实现一个爬虫服务。spider-flow特性支持css选择器、正则提取支持JSON/XML格式...

solon-flow 你好世界!

solon-flow是一个基础级的流处理引擎(可用于业务规则、决策处理、计算编排、流程审批等......)。提供有“开放式”驱动定制支持,像jdbc有mysql或pgsql等驱动,可...

新一代开源爬虫平台:SpiderFlow

SpiderFlow:新一代爬虫平台,以图形化方式定义爬虫流程,不写代码即可完成爬虫。-精选真开源,释放新价值。概览Spider-Flow是一个开源的、面向所有用户的Web端爬虫构建平台,它使用Ja...

通过 SQL 训练机器学习模型的引擎

关注薪资待遇的同学应该知道,机器学习相关的岗位工资普遍偏高啊。同时随着各种通用机器学习框架的出现,机器学习的门槛也在逐渐降低,训练一个简单的机器学习模型变得不那么难。但是不得不承认对于一些数据相关的工...

鼠须管输入法rime for Mac

鼠须管输入法forMac是一款十分新颖的跨平台输入法软件,全名是中州韵输入法引擎,鼠须管输入法mac版不仅仅是一个输入法,而是一个输入法算法框架。Rime的基础架构十分精良,一套算法支持了拼音、...

Go语言 1.20 版本正式发布:新版详细介绍

Go1.20简介最新的Go版本1.20在Go1.19发布六个月后发布。它的大部分更改都在工具链、运行时和库的实现中。一如既往,该版本保持了Go1的兼容性承诺。我们期望几乎所...

iOS 10平台SpriteKit新特性之Tile Maps(上)

简介苹果公司在WWDC2016大会上向人们展示了一大批新的好东西。其中之一就是SpriteKitTileEditor。这款工具易于上手,而且看起来速度特别快。在本教程中,你将了解关于TileE...

程序员简历例句—范例Java、Python、C++模板

个人简介通用简介:有良好的代码风格,通过添加注释提高代码可读性,注重代码质量,研读过XXX,XXX等多个开源项目源码从而学习增强代码的健壮性与扩展性。具备良好的代码编程习惯及文档编写能力,参与多个高...

Telerik UI for iOS Q3 2015正式发布

近日,TelerikUIforiOS正式发布了Q32015。新版本新增对XCode7、Swift2.0和iOS9的支持,同时还新增了对数轴、不连续的日期时间轴等;改进TKDataPoin...

ios使用ijkplayer+nginx进行视频直播

上两节,我们讲到使用nginx和ngixn的rtmp模块搭建直播的服务器,接着我们讲解了在Android使用ijkplayer来作为我们的视频直播播放器,整个过程中,需要注意的就是ijlplayer编...

IOS技术分享|iOS快速生成开发文档(一)

前言对于开发人员而言,文档的作用不言而喻。文档不仅可以提高软件开发效率,还能便于以后的软件开发、使用和维护。本文主要讲述Objective-C快速生成开发文档工具appledoc。简介apple...

macOS下配置VS Code C++开发环境

本文介绍在苹果macOS操作系统下,配置VisualStudioCode的C/C++开发环境的过程,本环境使用Clang/LLVM编译器和调试器。一、前置条件本文默认前置条件是,您的开发设备已...