2. 程式人生 > 其它 >SpringMVC引數校驗（針對`@RequestBody`返回`400`）

SpringMVC引數校驗（針對`@RequestBody`返回`400`）

阿新 • • 發佈：2022-05-04

SpringMVC引數校驗（針對@RequestBody返回400）

From https://ryan-miao.github.io/2017/05/20/spring400/

前言

習慣別人幫忙做事的結果是自己不會做事了。一直以來，spring幫我解決了程式執行中的各種問題，我只要關心我的業務邏輯，設計好我的業務程式碼，返回正確的結果即可。直到遇到了400。

spring返回400的時候通常沒有任何錯誤提示，當然也通常是引數不匹配。這在引數少的情況下還可以一眼看穿，但當引數很大是，排除引數也很麻煩，更何況，既然錯誤了，為什麼指出來原因呢。好吧，springmvc把這個權力交給了使用者自己。

springmvc異常處理

最開始的時候也想過自己攔截會出異常的method來進行異常處理，但顯然不需要這麼做。spring提供了內嵌的以及全域性的異常處理方法，基本可以滿足我的需求了。

1. 內嵌異常處理

如果只是這個controller的異常做單獨處理，那麼就適合繫結這個controller本身的異常。

具體做法是使用註解@ExceptionHandler.

在這個controller中新增一個方法，並新增上述註解，並指明要攔截的異常。

@RequestMapping(value = "saveOrUpdate", method = RequestMethod.POST)
public String saveOrUpdate(HttpServletResponse response, @RequestBody Order order){
    CodeMsg result = null;
    try {
        result = orderService.saveOrUpdate(order);
    } catch (Exception e) {
        logger.error("save failed.", e);
        return this.renderString(response, CodeMsg.error(e.getMessage()));
    }
    return this.renderString(response, result);
}

@ResponseBody
@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(HttpMessageNotReadableException.class)
public CodeMsg messageNotReadable(HttpMessageNotReadableException exception, HttpServletResponse response){
    LOGGER.error("請求引數不匹配。", exception);
    return CodeMsg.error(exception.getMessage());
}

這裡saveOrUpdate是我們想要攔截一樣的請求，而messageNotReadable則是處理異常的程式碼。 @ExceptionHandler(HttpMessageNotReadableException.class)表示我要攔截何種異常。在這裡，由於springmvc預設採用jackson作為json序列化工具，當反序列化失敗的時候就會丟擲HttpMessageNotReadableException異常。具體如下：

{
  "code": 1,
  "msg": "Could not read JSON: Failed to parse Date value '2017-03-' (format: "yyyy-MM-dd HH:mm:ss"): Unparseable date: "2017-03-" (through reference chain: com.test.modules.order.entity.Order["serveTime"]); nested exception is com.fasterxml.jackson.databind.JsonMappingException: Failed to parse Date value '2017-03-' (format: "yyyy-MM-dd HH:mm:ss"): Unparseable date: "2017-03-" (through reference chain: com.test.modules.order.entity.Order["serveTime"])",
  "data": ""
}

這是個典型的jackson反序列化失敗異常，也是造成我遇見過的400原因最多的。通常是日期格式不對。

另外，@ResponseStatus(HttpStatus.BAD_REQUEST)這個註解是為了標識這個方法返回值的HttpStatus code。我設定為400，當然也可以自定義成其他的。

2. 批量異常處理

看到大多數資料寫的是全域性異常處理，我覺得對我來說批量更合適些，因為我只是希望部分controller被攔截而不是全部。

springmvc提供了@ControllerAdvice來做批量攔截。

第一次看到註釋這麼少的原始碼，忍不住多讀幾遍。

Indicates the annotated class assists a "Controller".

表示這個註解是服務於Controller的。

Serves as a specialization of {@link Component @Component}, allowing for implementation classes to be autodetected through classpath scanning.

用來當做特殊的Component註解，允許使用者掃描發現所有的classpath。

It is typically used to define {@link ExceptionHandler @ExceptionHandler},
 * {@link InitBinder @InitBinder}, and {@link ModelAttribute @ModelAttribute}
 * methods that apply to all {@link RequestMapping @RequestMapping} methods.

典型的應用是用來定義xxxx.

One of {@link #annotations()}, {@link #basePackageClasses()},
 * {@link #basePackages()} or its alias {@link #value()}
 * may be specified to define specific subsets of Controllers
 * to assist. When multiple selectors are applied, OR logic is applied -
 * meaning selected Controllers should match at least one selector.

這幾個引數指定了掃描範圍。

the default behavior (i.e. if used without any selector),
 * the {@code @ControllerAdvice} annotated class will
 * assist all known Controllers.

預設掃描所有的已知的的Controllers。

Note that those checks are done at runtime, so adding many attributes and using
 * multiple strategies may have negative impacts (complexity, performance).

注意這個檢查是在執行時做的，所以注意效能問題，不要放太多的引數。

說的如此清楚，以至於用法如此簡單。

@ResponseBody
@ControllerAdvice("com.api")
public class ApiExceptionHandler extends BaseClientController {
    private static final Logger LOGGER = LoggerFactory.getLogger(ApiExceptionHandler.class);

    /**
     *
     * @param exception UnexpectedTypeException
     * @param response
     * @return
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(UnexpectedTypeException.class)
    public CodeMsg unexpectedType(UnexpectedTypeException exception, HttpServletResponse response){
        LOGGER.error("校驗方法太多，不確定合適的校驗方法。", exception);
        return CodeMsg.error(exception.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public CodeMsg messageNotReadable(HttpMessageNotReadableException exception, HttpServletResponse response){
        LOGGER.error("請求引數不匹配。", exception);
        return CodeMsg.error(exception.getMessage());
    }

    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(Exception.class)
    public CodeMsg ex(MethodArgumentNotValidException exception, HttpServletResponse response){
        LOGGER.error("請求引數不合法。", exception);
        BindingResult bindingResult = exception.getBindingResult();
        String msg = "校驗失敗";
        return new CodeMsg(CodeMsgConstant.error, msg, getErrors(bindingResult));
    }

    private Map<String, String> getErrors(BindingResult result) {
        Map<String, String> map = new HashMap<>();
        List<FieldError> list = result.getFieldErrors();
        for (FieldError error : list) {
            map.put(error.getField(), error.getDefaultMessage());
        }
        return map;
    }
}

3. Hibernate-validate

使用引數校驗如果不catch異常就會返回400. 所以這個也要規範一下。

3.1 引入hibernate-validate
<dependency>  
   <groupId>org.hibernate</groupId>  
   <artifactId>hibernate-validator</artifactId>  
   <version>5.0.2.Final</version>  
</dependency>
<mvc:annotation-driven validator="validator" />
<bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean">
  <property name="providerClass" value="org.hibernate.validator.HibernateValidator"/>
  <property name="validationMessageSource" ref="messageSource"/>
</bean>
3.2 使用
  1. 在實體類欄位上標註要求 public class AlipayRequest { @NotEmpty private String out_trade_no; private String subject; @DecimalMin(value = "0.01", message = "費用最少不能小於0.01") @DecimalMax(value = "100000000.00", message = "費用最大不能超過100000000") private String total_fee; /** * 訂單型別 */ @NotEmpty(message = "訂單型別不能為空") private String business_type; //.... }
  2. controller裡新增@Valid 
@RequestMapping(value = "sign", method = RequestMethod.POST)
    public String sign(@Valid @RequestBody AlipayRequest params
    ){
        ....
    }

3.錯誤處理 前面已經提到，如果不做處理的結果就是400,415. 這個對應Exception是MethodArgumentNotValidException,也是這樣：

@ResponseStatus(HttpStatus.BAD_REQUEST)
@ExceptionHandler(Exception.class)
public CodeMsg ex(MethodArgumentNotValidException exception, HttpServletResponse response){
    LOGGER.error("請求引數不合法。", exception);
    BindingResult bindingResult = exception.getBindingResult();
    String msg = "校驗失敗";
    return new CodeMsg(CodeMsgConstant.error, msg, getErrors(bindingResult));
}

private Map<String, String> getErrors(BindingResult result) {
    Map<String, String> map = new HashMap<>();
    List<FieldError> list = result.getFieldErrors();
    for (FieldError error : list) {
        map.put(error.getField(), error.getDefaultMessage());
    }
    return map;
}

返回結果：

{
  "code": 1,
  "msg": "校驗失敗",
  "data": {
    "out_trade_no": "不能為空",
    "business_type": "訂單型別不能為空"
  }
}

大概有這麼幾個限制註解：

/**
 * Bean Validation 中內建的 constraint       
 * @Null   被註釋的元素必須為 null       
 * @NotNull    被註釋的元素必須不為 null       
 * @AssertTrue     被註釋的元素必須為 true       
 * @AssertFalse    被註釋的元素必須為 false       
 * @Min(value)     被註釋的元素必須是一個數字，其值必須大於等於指定的最小值       
 * @Max(value)     被註釋的元素必須是一個數字，其值必須小於等於指定的最大值       
 * @DecimalMin(value)  被註釋的元素必須是一個數字，其值必須大於等於指定的最小值       
 * @DecimalMax(value)  被註釋的元素必須是一個數字，其值必須小於等於指定的最大值       
 * @Size(max=, min=)   被註釋的元素的大小必須在指定的範圍內       
 * @Digits (integer, fraction)     被註釋的元素必須是一個數字，其值必須在可接受的範圍內       
 * @Past   被註釋的元素必須是一個過去的日期       
 * @Future     被註釋的元素必須是一個將來的日期       
 * @Pattern(regex=,flag=)  被註釋的元素必須符合指定的正則表示式       
 * Hibernate Validator 附加的 constraint       
 * @NotBlank(message =)   驗證字串非null，且長度必須大於0       
 * @Email  被註釋的元素必須是電子郵箱地址       
 * @Length(min=,max=)  被註釋的字串的大小必須在指定的範圍內       
 * @NotEmpty   被註釋的字串的必須非空       
 * @Range(min=,max=,message=)  被註釋的元素必須在合適的範圍內 
 */

相關推薦

SpringMVC引數校驗（針對`@RequestBody`返回`400`）

SpringMVC引數校驗（針對@RequestBody返回400） From https://ryan-miao.github.io/2017/05/20/spring400/

Nest.js引數校驗和自定義返回資料格式詳解

0x0 引數校驗 引數校驗大部分業務是使用 Nest.js 中的管道 方法實現，具體可以查閱文件 。不過編寫過程中遇到一些問題，雖然文件講得比較晦澀。

SpringBoot第七集：異常處理與整合JSR303校驗（2020最新最易懂）

SpringBoot第七集：異常處理與整合JSR303校驗（2020最新最易懂） 一.SpringBoot全域性異常

springboot全域性異常處理（傳入引數校驗）

1.匯入依賴 <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-validation</artifactId>

Spring Boot 引數校驗註解（自整理，不停的測試更新）

首先我們只使用java官方的 javax.validation.constraints ，足以使用了，不使用spring boot 自身的，自身的與官方的一致，可能會有擴充套件，但是還得引入包，麻煩，只用官方的就行了。

Spring 引數校驗詳解

前言 JCP JCP 全稱 Java社群程式 (Java Community Process,JCP)。 JCP 是一個開放性的國際技術標準組織，職責是發展和更新 Java 技術規範。由24個成員組成的執行委員會則是該組織的最高決策機構，負責規劃 Java 的技

引數校驗 Hibernate-Validator

需求 在 RESTful 的介面服務中，會有各種各樣的入參，我們不可能完全不做任何校驗就直接進入到業務處理的環節，通常我們會有一個基礎的資料驗證的機制，待這些驗證過程完畢，結果無誤後，引數才會進入到正式的業務處

AOP + Aviator 實現引數校驗

在開發過程中，始終避免不了的是校驗引數，引數的校驗和業務程式碼耦合在一起，程式碼變得越來越臃腫，影響後期的維護，程式碼也不夠優美。

如何對protobuf生成的Java物件進行引數校驗

前言 時隔幾月在部落格方面，筆者並沒有想寫文的衝動，不過最近筆者負責一個新服務的開發，在過程中使用了protobuf相關技術。開發完成之後，由於在引數校驗這塊使用了大量的if-else進行校驗，造成code review過程中

SpringBoot中通過實現WebMvcConfigurer引數校驗的方法示例

在Spring5.0和SpringBoot2.0中廢棄了WebMvcConfigurerAdapter類。 現有兩種解決方案 1 直接實現WebMvcConfigurer （官方推薦）

Springboot使用@Valid 和AOP做引數校驗及日誌輸出問題

專案背景 最近在專案上對接前端的的時候遇到了幾個問題 1.經常要問前端要請求引數

SpringMVC 資料校驗例項解析

這篇文章主要介紹了SpringMVC 資料校驗例項解析,文中通過示例程式碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下

spring boot validation引數校驗例項分析

本文例項講述了spring boot validation引數校驗。分享給大家供大家參考，具體如下：

SpringBoot中的異常處理與引數校驗的方法實現

兄弟們好，這次來跟老鐵交流兩個問題，異常和引數校驗，在說引數校驗之前我們先來說異常處理吧，因為後面引數的校驗會牽扯到異常處理這塊的內容。

C# 9.0 新特性預覽 - 空引數校驗

C# 9.0 新特性預覽 - 空引數校驗 前言 隨著 .NET 5 釋出日期的日益臨近，其對應的 C# 新版本已確定為 C# 9.0，其中新增加的特性（或語法糖）也已基本鎖定，本系列文章將向大家展示它們。

如何在spring boot中進行引數校驗示例詳解

上文我們討論了spring-boot如何去獲取前端傳遞過來的引數，那傳遞過來總不能直接使用，需要對這些引數進行校驗，符合程式的要求才會進行下一步的處理，所以本篇文章我們主要討論spring-boot中如何進行引數校驗。

C# .net framework .net core 3.1 請求引數校驗, DataAnnotations, 自定義引數校驗

前言 在實際應用場景中我們常常要對介面的入參進行校驗,例如分頁大小是否正確,必填引數是否已經填寫等等.

JSR303校驗（分組校驗，自定義校驗）

JSR303校驗（分組校驗，自定義校驗） JSR303的使用： 使用步驟： 1.新增依賴 2.在entity類的屬性上添加註解

API安全(五)-引數校驗

1、為什麼要做資料校驗 　　要保證系統的安全性，健壯性，資料校驗必不可少，校驗引數的合法性，不能因為前端或者其它呼叫段因為引數傳的不對導致我們的系統報錯。

詳解SpringBoot中的引數校驗(專案實戰)

Java後端發工作中經常會對前端傳遞過來的引數做一些校驗，在業務中還要丟擲異常或者不斷的返回異常時的校驗資訊,充滿了if-else這種校驗程式碼,在程式碼中相當冗長。例如說，使用者註冊時，會校驗手機格式的正確性，使