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

问题发生

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

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

查询的方法是Get方法：

前端是通过url加参数传过来的，如果有一个参数值为空的时候，由于setEntity() 并不过滤空白，执行sql的时候 会把 "" 作为参数去当做查询条件，查询就出现了问题：

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

初始解决

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

//1.对象转map
Map

用到的工具类如下

/**
* 将对象属性转化为map结合
*/
public static  Map{
 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

对于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」 方法时参数去除空格：

只不过这个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.百度了一下，果然有同学已经有了解决方案：