SpringBoot项目：接口参数空白值如何替换为null值

缺乏、安全感 2023-10-01 22:16 13阅读 0赞

## 问题发生 ##

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

![a52d87e8fcd9ca19fc25d9fe3aff007a.png][]

查询的方法是Get方法：

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

![f02d97c6a45e0c681cb7988a372561fe.png][]

![c90950900c5fb86bde29fcdef0909443.png][]

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

## 初始解决 ##

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

![f3aa11757f8528524d29c568f2bff79e.png][]

用到的工具类如下

![5075039d26b87e4c18b9e1edcc33299f.png][]

![bb9ea633acfa48d3ba99596c14d1b130.png][]

问题解决了。

## 优化 ##

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

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

## Post请求报文体 ##

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

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

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

创建一个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来处理空白的问题：

![a7c3a883c3f8675a6fda0cca182416a2.png][]

想要全局controller共享这个Databinder:

![27f05f77eac41a838a84b03952613966.png][]

![2063991ed94a8a95750047befef1d984.png][]

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

## 思考 ##

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

![b0e95909f4d6a70201c1928f77644bcf.png][]

只不过这个editor确实没有注册，需要手工注册。

注意，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和功能都不为人知。所以碰上问题就记录下来是个很好的习惯

![cb3a65bee7984a0587fda0a860f373f7.jpeg][]

[a52d87e8fcd9ca19fc25d9fe3aff007a.png]: https://img-blog.csdnimg.cn/img_convert/a52d87e8fcd9ca19fc25d9fe3aff007a.png
[f02d97c6a45e0c681cb7988a372561fe.png]: https://img-blog.csdnimg.cn/img_convert/f02d97c6a45e0c681cb7988a372561fe.png
[c90950900c5fb86bde29fcdef0909443.png]: https://img-blog.csdnimg.cn/img_convert/c90950900c5fb86bde29fcdef0909443.png
[f3aa11757f8528524d29c568f2bff79e.png]: https://img-blog.csdnimg.cn/img_convert/f3aa11757f8528524d29c568f2bff79e.png
[5075039d26b87e4c18b9e1edcc33299f.png]: https://img-blog.csdnimg.cn/img_convert/5075039d26b87e4c18b9e1edcc33299f.png
[bb9ea633acfa48d3ba99596c14d1b130.png]: https://img-blog.csdnimg.cn/img_convert/bb9ea633acfa48d3ba99596c14d1b130.png
[a7c3a883c3f8675a6fda0cca182416a2.png]: https://img-blog.csdnimg.cn/img_convert/a7c3a883c3f8675a6fda0cca182416a2.png
[27f05f77eac41a838a84b03952613966.png]: https://img-blog.csdnimg.cn/img_convert/27f05f77eac41a838a84b03952613966.png
[2063991ed94a8a95750047befef1d984.png]: https://img-blog.csdnimg.cn/img_convert/2063991ed94a8a95750047befef1d984.png
[b0e95909f4d6a70201c1928f77644bcf.png]: https://img-blog.csdnimg.cn/img_convert/b0e95909f4d6a70201c1928f77644bcf.png
[cb3a65bee7984a0587fda0a860f373f7.jpeg]: https://img-blog.csdnimg.cn/cb3a65bee7984a0587fda0a860f373f7.jpeg