7.從零搭建WebApi接口開發(fā)框架-請求參數(shù)校驗

日常開發(fā)中,前端會對請求參數(shù)進行校驗,為了保證請求參數(shù)的格式正確,也需要在服務(wù)端做參數(shù)校驗。
服務(wù)端參數(shù)校驗用的是Hibernate-validator框架,利用簡單注解實現(xiàn)。

實體類增加校驗注解

這里以登錄為例進行說明:

public class LoginDto {
    @NotNull
    private String username;//賬號
    @NotNull
    @Length(min = 6, message = "密碼格式錯誤")
    private String password;//密碼
//set get省略

}

這一塊用的注解來實現(xiàn),比較簡單,具體注解的使用說明如下:

| @Null | 被注釋的元素必須為 null |
| @NotNull | 被注釋的元素必須不為 null |
| @AssertTrue | 被注釋的元素必須為 true |
| @AssertFalse | 被注釋的元素必須為 false |
| @Min(value) | 被注釋的元素必須是一個數(shù)字,其值必須大于等于指定的最小值 |
| @Max(value) | 被注釋的元素必須是一個數(shù)字,其值必須小于等于指定的最大值 |
| @DecimalMin(value) | 被注釋的元素必須是一個數(shù)字,其值必須大于等于指定的最小值 |
| @DecimalMax(value) | 被注釋的元素必須是一個數(shù)字,其值必須小于等于指定的最大值 |
| @Size(max, min) | 被注釋的元素的大小必須在指定的范圍內(nèi) |
| @Digits (integer, fraction) | 被注釋的元素必須是一個數(shù)字,其值必須在可接受的范圍內(nèi) |
| @Past | 被注釋的元素必須是一個過去的日期 |
| @Future | 被注釋的元素必須是一個將來的日期 |
| @Pattern(value) | 被注釋的元素必須符合指定的正則表達式 |

2. Hibernate Validator 附加的 constraint

| @Email | 被注釋的元素必須是電子郵箱地址 |
| @Length(min=, max=)
| 被注釋的字符串的大小必須在指定的范圍內(nèi) |
| @NotEmpty | 被注釋的字符串的必須非空 |
| @Range(min=, max=) | 被注釋的元素必須在合適的范圍內(nèi) |
| @NotBlank|被注釋的字符串的必須非空|

controller增加@valid注解
在需要校驗的請求controller方法中,增加@valid注解,校驗要獲取的對象字段,如下圖:


@valid注解.png

在controllerAdvice中增加參數(shù)校驗異常的統(tǒng)一攔截

 /**
     * 攔截@Valid請求參數(shù)驗證不通過的異常
     *
     * @param request   request
     * @param response  response
     * @param exception 驗證不通過的異常
     * @return 執(zhí)行結(jié)果
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ResponseBody
    @Order(0)
    public JsonResult handler(HttpServletRequest request, HttpServletResponse response, MethodArgumentNotValidException exception) {
        logger.info("請求的參數(shù)不正確", exception);
        logException(request);
        String validation_message;
        BindingResult bindingResult = exception.getBindingResult();
        if (bindingResult != null && bindingResult.getFieldError() != null) {
            validation_message = bindingResult.getFieldError().getDefaultMessage();
        } else {
            validation_message = exception.getMessage();
        }
        logger.info("參數(shù)錯誤信息:" + validation_message);
        return new JsonResult(false, GlobalReturnCode.PARAM_ERROR, validation_message);
    }

這里有個@Order(0)注解,參數(shù)校驗首先進行做,后續(xù)再做默認(rèn)系統(tǒng)異常攔截。比如校驗失敗提示如下圖:

格式校驗.png

格式校驗比較簡單,但是生產(chǎn)項目中必不可少,防范外部攻擊的主要手段之一。

源碼下載

本例子詳細(xì)源碼

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容