優化Spring Boot中HttpServletRequest參數處理的實用工具類
在Spring Boot應用中，我們經常需要對HttpServletRequest中的參數進行處理，以滿足特定的業務需求或增強系統的安全性。本文介紹了一個實用的工具類——ParameterRequestWrapper，通過該類，我們可以更方便地對請求參數進行定制化處理。
1. 背景
在實際項目中，我們經常會遇到對請求參數進行特殊處理的需求，例如去除空字符串參數、處理JSON格式的POST請求等。為了更靈活地處理這些情況，我們創建了ParameterRequestWrapper類，它繼承自HttpServletRequestWrapper，并在構造方法中對請求參數進行了初始化和定制化處理。
2. 功能介紹
2.1 參數去空格處理
在處理頁面提交的參數時，有時會出現空字符串參數，如果不進行處理，這些空字符串可能會對SQL查詢等操作產生不良影響。為了解決這個問題，我們在modifyParameterValues方法中去除了頁面提交的空字符串參數，確保參數的有效性。
public void modifyParameterValues() {
// 去除頁面提交出現的空字符串參數，防止SQL查詢默認帶進去，當作參數，造成頁面列表不展示
params.entrySet().removeIf(e -> "".equals(e.getValue()[0]));
Set<String> set = params.keySet();
for (String key : set) {
String[] values = params.get(key);
values[0] = values[0].trim();
params.put(key, values);
}
}2.2 JSON格式的POST請求處理
對于POST請求，特別是JSON格式的POST請求，我們通過重寫getInputStream方法，將請求中的JSON參數進行處理，去除兩端空格，并輸出日志，方便調試。
@Override
public ServletInputStream getInputStream() throws IOException {
// 非json類型，直接返回
if (!super.getHeader(HttpHeaders.CONTENT_TYPE).equalsIgnoreCase(MediaType.APPLICATION_JSON_VALUE)) {
return super.getInputStream();
}
// 為空，直接返回
String json = IOUtils.toString(super.getInputStream(), StandardCharsets.UTF_8);
if (StringUtils.isEmpty(json)) {
return super.getInputStream();
}
log.info("去除POST請求數據兩端的空格前參數：" + json);
Map<String, Object> map = StringJsonUtils.jsonStringToMap(json);
log.info("去除POST請求數據兩端的空格后參數：" + JSON.toJSONString(map));
ByteArrayInputStream bis = new ByteArrayInputStream(JSON.toJSONString(map).getBytes(StandardCharsets.UTF_8));
return new MyServletInputStream(bis);
}使用示例
要使用ParameterRequestWrapper，只需在Controller中將HttpServletRequest替換為該類的實例即可，如下所示：
@PostMapping("/example
public ResponseEntity<String> example(ParameterRequestWrapper request) {
// 處理定制化的HttpServletRequest，可以直接使用request.getParameter等方法
// ...
return ResponseEntity.ok("Success");
}通過這樣的替換，我們就可以在請求到達Controller之前對參數進行定制化處理，更好地適應項目的需求。
4. 總結
ParameterRequestWrapper是一個簡單而實用的工具類，通過對HttpServletRequest的定制化處理，能夠滿足一些特殊場景下的需求。在實際項目中，根據具體情況，我們可以進一步擴展該類，以滿足更復雜的參數處理需求。希望這個工具類能夠幫助到開發者更方便地處理請求參數，提升項目的可維護性和靈活性。
