程序地带

SpringBoot项目,如何优雅的把接口参数中的空白值替换为null值?


问题发生

我们公司代码生成的时候,查询列表统一都是使用了setEntity() ,查询写法如下:


public List<BasReservoirArea> selectList(BasReservoirArea basReservoirArea) {
QueryWrapper<BasReservoirArea> where = new QueryWrapper<>();
where.setEntity(basReservoirArea);
return baseMapper.selectList(where);
}

 


查询的方法是Get方法:


前端是通过url加参数传过来的,如果有一个参数值为空的时候,由于setEntity() 并不过滤空白,执行sql的时候 会把""作为参数去当做查询条件,查询就出现了问题:SpringBoot项目,如何优雅的把接口参数中的空白值替换为null值?SpringBoot项目,如何优雅的把接口参数中的空白值替换为null值?


于是我就想把空白转换为null来解决这个问题了。


初始解决

一开始自然而然想到在setEntity之前先判断, 如果BasReservoirArea这个实例有字段的值是空白就设置为null


//1.对象转map
Map<Object, Object> map = MapUtil.beanToMap(test);
//2.移除空值
MapUtil.removeNullValue(map);
//3.map转回对象
Test entity = JSON.parseObject(JSON.toJSONString(map), Test.class);

 


用到的工具类如下


/**
* 将对象属性转化为map结合
*/
public static <T> Map<Object, Object> beanToMap(T bean) {
Map<Object, Object> map = new HashMap<>();
if (bean != null) {
BeanMap beanMap = BeanMap.create(bean);
for (Object key : beanMap.keySet()) {
map.put(key, beanMap.get(key));
}
}
return map;
}
/**
* 移除map中的value空值
*
* @param map
* @return
*/
public static void removeNullValue(Map map) {
Set set = map.keySet();
for (Iterator iterator = set.iterator(); iterator.hasNext(); ) {
Object obj = (Object) iterator.next();
Object value = (Object) map.get(obj);
remove(value, iterator);
}
}

 


问题解决了。


优化

由于感觉上面的解决方案不够专业,不够优雅,所以先寻找更好的解决办法,在后端接收参数值的时候,如果接收的是空白,直接设置为null, 这样就不需要再次转换了。


解决问题首先要考虑两种情况,一种是前端通过Get请求,路径上带参数;另一种是Post请求,带着Request报文。


Post请求报文体

由于笔者熟悉Post中报文体的转换,知道是MappingJackson2HttpMessageConverter结合Jackson实现报文体转换为实例的,而且也研究过Jackson, 所以解决办法如下


创建一个针对于String.class的Jackson的反序列类:


public class StringDescrializer extends JsonDeserializer<String> {
@Override
public String deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {
String value = jsonParser.getValueAsString();
if (value == null || "".equals(value.trim())) {
return null;
}
return value;
}
}

 


创建一个MappingJackson2HttpMessageConverter  Bean:


@Bean
@Primary
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
//设置解析JSON工具类
ObjectMapper objectMapper = new ObjectMapper();
objectMapper.getSerializerProvider().setNullValueSerializer(
new JsonSerializer<Object>() {
@Override
public void serialize(Object value, JsonGenerator jsonGenerator, SerializerProvider serializerProvider) throws IOException {
jsonGenerator.writeString("");
}
}
);
SimpleModule simpleModule = new SimpleModule();
simpleModule.addDeserializer(String.class, new StringDescrializer());
//注册自定义的StringDescrializer
//registerModules函数可以注册多个Module
objectMapper.registerModule(simpleModule);
//忽略未知属性 防止解析报错
objectMapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
jsonConverter.setObjectMapper(objectMapper);
List<MediaType> list = new ArrayList<>();
list.add(MediaType.APPLICATION_JSON_UTF8);
jsonConverter.setSupportedMediaTypes(list);
return jsonConverter;
}

 


对于Post报文体来说,测试成功了。


Get路径带参数

上面的解决方法不适用于Get方法路径带参数的情况,所以需要另外想办法了。


由于我使用过@InitBinder注解,知道可以注入自定义的PropertyEditor, 在Editor里面可以自定义格式或者返回值,于是,自定义一个StringEditor来处理空白的问题:、


public class StringEditor extends PropertyEditorSupport {
//setAsText完成字符串到具体对象类型的转换,
@Override
public void setAsText(String text) throws IllegalArgumentException {
if (text == null || "".equals(text.trim())) {
text = null;
}
setValue(text);
}
//getAsText完成具体对象类型到字符串的转换。
@Override
public String getAsText() {
if (getValue() != null) {
return getValue().toString();
}
return null;
}
}

 


想要全局controller共享这个Databinder:


@ControllerAdvice
public class GlobalControllerAdiviceController {
//WebDataBinder是用来绑定请求参数到指定的属性编辑器,可以继承WebBindingInitializer
//来实现一个全部controller共享的dataBiner
@InitBinder
public void dataBind(WebDataBinder binder) {
///給指定类型注册类型转换器操作
binder.registerCustomEditor(String.class, new StringEditor());
}
}

 


对于Get路径带参数来说,测试也成功了


思考

解决完问题后,还是觉得不够优雅,觉得spring 应该会考虑到这种情况,终于在spring 的文档中查阅到StringTrimmerEditor(https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-beans) 可以实现「Get」方法时参数去除空格:


SpringBoot项目,如何优雅的把接口参数中的空白值替换为null值?


只不过这个editor缺省没有注册,需要手工注册。


@ControllerAdvice
public class GlobalControllerAdiviceController {
//WebDataBinder是用来绑定请求参数到指定的属性编辑器,可以继承WebBindingInitializer
//来实现一个全部controller共享的dataBiner Java代码
@InitBinder
public void dataBind(WebDataBinder binder) {
///注册
binder.registerCustomEditor(String.class, new StringTrimmerEditor(true));
}
}

 


注意,StringTrimmerEditor构造方法中有一个参数,如果传入true,则会将空白转换为null. 这样前面写的StringEditor就不用了,spring 已经帮我们写好了。


对于「Post」报文体来说,实际上我只需要改变的是「Jackson ObjectMapper」,不需要自定义整个MappingJackson2HttpMessageConverter  ,只需要自定义Jackson ObjectMapper.百度了一下,果然有同学已经有了解决方案:


@Bean
public Jackson2ObjectMapperBuilderCustomizer jackson2ObjectMapperBuilderCustomizer() {
return new Jackson2ObjectMapperBuilderCustomizer() {
@Override
public void customize(Jackson2ObjectMapperBuilder jacksonObjectMapperBuilder) {
jacksonObjectMapperBuilder
.deserializerByType(String.class, new StdScalarDeserializer<String>(String.class) {
@Override
public String deserialize(JsonParser jsonParser, DeserializationContext ctx)
throws IOException {
// 重点在这儿:如果为空白则返回null
String value = jsonParser.getValueAsString();
if (value == null || "".equals(value.trim())) {
return null;
}
return value;
}
});
}
};
}

 


把上面的自定义StringDescrializer和MappingJackson2HttpMessageConverter去掉, 只保留上面的就行。


后记

好多问题,其实spring 都已经提供了解决方案,但是spring体系目前太庞大了,所以好多API和功能都不为人知。所以碰上问题就记录下来是个很好的习惯


推荐好文

强大,10k+点赞的 SpringBoot 后台管理系统竟然出了详细教程!


分享一套基于SpringBoot和Vue的企业级中后台开源项目,代码很规范!


能挣钱的,开源 SpringBoot 商城系统,功能超全,超漂亮!


版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://www.cnblogs.com/javazhiyin/p/14276066.html

随机推荐

pcl(23)点云投影

pcl(23)点云投影

#include<iostream>#include<pcl/io/pcd_io.h>#include<pcl/point_types.h>#include<...

清流激湍,孤帆去悠悠 阅读(341)

Linux基础指令操作总结——持续更新~

文章目录常用Linux指令操作常用文件操作关机/重启/注销磁盘和进程系统信息资源磁盘和分区网络用户查看CPU信息(型号)常用Linux指令操作Linux命令一直以来都是用时...

笑里笑外~ 阅读(115)

File 文件 watch

https://www.xncoding.com/2017/09/21/java/watchservice.html...

qq_27787681 阅读(810)

windows入门Elasticsearch(es)之4:插件

常用的es操作list查询插件elasticsearch-pluginlist添加插件installelasticsearch-plugininstall插件名字下面说说分词插件有哪些:...

小黑雷 阅读(201)

《操作系统》课程设计任务书

一、题目      在阅读Linux操作系统源代码的基础上完成三个主要Project。题目可在A类或者B类中任性其一,C类必作,也可自主命题。二、设计目的和要求操作系统原理...

Starzkg 阅读(127)

mysql连接无权限

如果你想连接你的MySQL的时候发生这个错误:ERROR1130:Host'192.168.1.3'isnotallowedtoconnecttothismysqlser...

彼岸笙箫 阅读(739)