SpringBoot項(xiàng)目如何把接口參數(shù)中的空白值替換為null值(推薦)

更新時間：2021年01月14日 11:41:47 作者：Java知音號

這篇文章主要介紹了SpringBoot項(xiàng)目如何把接口參數(shù)中的空白值替換為null值(推薦),本文給大家介紹的非常詳細(xì)，對大家的學(xué)習(xí)或工作具有一定的參考借鑒價值，需要的朋友可以參考下

問題發(fā)生

我們公司代碼生成的時候，查詢列表統(tǒng)一都是使用了setEntity() ，查詢寫法如下：

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

查詢的方法是Get方法：

前端是通過url加參數(shù)傳過來的，如果有一個參數(shù)值為空的時候，由于setEntity() 并不過濾空白，執(zhí)行sql的時候會把""作為參數(shù)去當(dāng)做查詢條件，查詢就出現(xiàn)了問題：

于是我就想把空白轉(zhuǎn)換為null來解決這個問題了。

初始解決

一開始自然而然想到在setEntity之前先判斷, 如果BasReservoirArea這個實(shí)例有字段的值是空白就設(shè)置為null

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

用到的工具類如下

/**
* 將對象屬性轉(zhuǎn)化為map結(jié)合
*/
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);
 }
}

問題解決了。

優(yōu)化

由于感覺上面的解決方案不夠?qū)I(yè)，不夠優(yōu)雅，所以先尋找更好的解決辦法，在后端接收參數(shù)值的時候，如果接收的是空白，直接設(shè)置為null, 這樣就不需要再次轉(zhuǎn)換了。

解決問題首先要考慮兩種情況，一種是前端通過Get請求，路徑上帶參數(shù)；另一種是Post請求，帶著Request報文。

Post請求報文體

由于筆者熟悉Post中報文體的轉(zhuǎn)換，知道是MappingJackson2HttpMessageConverter結(jié)合Jackson實(shí)現(xiàn)報文體轉(zhuǎn)換為實(shí)例的，而且也研究過Jackson, 所以解決辦法如下

創(chuàng)建一個針對于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;
  }
}

創(chuàng)建一個MappingJackson2HttpMessageConverter Bean:

@Bean
@Primary
public MappingJackson2HttpMessageConverter mappingJackson2HttpMessageConverter() {
 MappingJackson2HttpMessageConverter jsonConverter = new MappingJackson2HttpMessageConverter();
 //設(shè)置解析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函數(shù)可以注冊多個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路徑帶參數(shù)

上面的解決方法不適用于Get方法路徑帶參數(shù)的情況，所以需要另外想辦法了。

由于我使用過@InitBinder注解，知道可以注入自定義的PropertyEditor, 在Editor里面可以自定義格式或者返回值，于是，自定義一個StringEditor來處理空白的問題：、

public class StringEditor extends PropertyEditorSupport {
  //setAsText完成字符串到具體對象類型的轉(zhuǎn)換，
  @Override
  public void setAsText(String text) throws IllegalArgumentException {
    if (text == null || "".equals(text.trim())) {
      text = null;
    }
    setValue(text);
  }

  //getAsText完成具體對象類型到字符串的轉(zhuǎn)換。
  @Override
  public String getAsText() {
    if (getValue() != null) {
      return getValue().toString();
    }
    return null;
  }
}

想要全局controller共享這個Databinder:

@ControllerAdvice
public class GlobalControllerAdiviceController {
  //WebDataBinder是用來綁定請求參數(shù)到指定的屬性編輯器，可以繼承WebBindingInitializer
  //來實(shí)現(xiàn)一個全部controller共享的dataBiner 
  @InitBinder
  public void dataBind(WebDataBinder binder) {
    ///給指定類型注冊類型轉(zhuǎn)換器操作
    binder.registerCustomEditor(String.class, new StringEditor());
  }
}

對于Get路徑帶參數(shù)來說，測試也成功了

思考

解決完問題后，還是覺得不夠優(yōu)雅，覺得spring 應(yīng)該會考慮到這種情況，終于在spring 的文檔中查閱到StringTrimmerEditor（https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-beans）可以實(shí)現(xiàn)「Get」方法時參數(shù)去除空格：

只不過這個editor缺省沒有注冊，需要手工注冊。

@ControllerAdvice
public class GlobalControllerAdiviceController {
  //WebDataBinder是用來綁定請求參數(shù)到指定的屬性編輯器，可以繼承WebBindingInitializer
  //來實(shí)現(xiàn)一個全部controller共享的dataBiner Java代碼
  @InitBinder
  public void dataBind(WebDataBinder binder) {
    ///注冊
    binder.registerCustomEditor(String.class, new StringTrimmerEditor(true));
  }
}

注意，StringTrimmerEditor構(gòu)造方法中有一個參數(shù)，如果傳入true,則會將空白轉(zhuǎn)換為null. 這樣前面寫的StringEditor就不用了，spring 已經(jīng)幫我們寫好了。

對于「Post」報文體來說，實(shí)際上我只需要改變的是「Jackson ObjectMapper」，不需要自定義整個MappingJackson2HttpMessageConverter ，只需要自定義Jackson ObjectMapper.百度了一下，果然有同學(xué)已經(jīng)有了解決方案：

@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 {
              // 重點(diǎn)在這兒:如果為空白則返回null
              String value = jsonParser.getValueAsString();
              if (value == null || "".equals(value.trim())) {
                return null;
              }
              return value;
            }
          });
    }
  };
}

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

后記

好多問題，其實(shí)spring 都已經(jīng)提供了解決方案，但是spring體系目前太龐大了，所以好多API和功能都不為人知。所以碰上問題就記錄下來是個很好的習(xí)慣

到此這篇關(guān)于SpringBoot項(xiàng)目如何優(yōu)雅的把接口參數(shù)中的空白值替換為null值的文章就介紹到這了,更多相關(guān)SpringBoot空白值替換為null值內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: