SpringMVC,SpringBoot快速驗(yàn)證參數(shù)是否完整 基于@Valid注解

前言

在接口開發(fā)中,經(jīng)常是需要對(duì)傳入?yún)?shù)完整性進(jìn)行驗(yàn)證的,或者對(duì)手機(jī)號(hào)格式進(jìn)行驗(yàn)證等但狭,而一般不了解@Valid注解之前窥岩,都是通過自己封裝方法來驗(yàn)證甲献,都是一堆if else集合,這樣判斷對(duì)于代碼結(jié)構(gòu)很不友好颂翼,開發(fā)效率也不高晃洒,使用@Valid注解可以快速的對(duì)參數(shù)進(jìn)行驗(yàn)證慨灭,并且可以通過抓取全局異常,從而實(shí)現(xiàn)統(tǒng)一返回

引用

@Valid是使用hibernate validation的時(shí)候使用,其中java的jsr303聲明了這類接口球及,hibernate-validator對(duì)其進(jìn)行了實(shí)現(xiàn)

在進(jìn)行maven整合時(shí)氧骤,需要引入的依賴

 <dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.13.Final</version>
</dependency>

一般情況下早已被其他框架引入了,只是在不存在的時(shí)候需要進(jìn)行引用一下吃引,@Valid只是驗(yàn)證參數(shù)是否符合要求筹陵,但是具體參數(shù)需要符合什么要求,還是需要其他注解來標(biāo)志驗(yàn)證規(guī)則

驗(yàn)證規(guī)則標(biāo)簽

@Null 驗(yàn)證對(duì)象是否為null

@NotNull 驗(yàn)證對(duì)象是否不為null, 無法查檢長度為0的字符串

@NotBlank 檢查約束字符串是不是Null還有被Trim的長度是否大于0,只對(duì)字符串,且會(huì)去掉前后空格.

@NotEmpty 檢查約束元素是否為NULL或者是EMPTY.

@AssertTrue 驗(yàn)證 Boolean 對(duì)象是否為 true

@AssertFalse 驗(yàn)證 Boolean 對(duì)象是否為 false

@Size(min=, max=) 驗(yàn)證對(duì)象(Array,Collection,Map,String)長度是否在給定的范圍之內(nèi)

@Length(min=, max=) 驗(yàn)證字符串長度是否在給定的范圍之內(nèi)

@Past 驗(yàn)證 Date 和 Calendar 對(duì)象是否在當(dāng)前時(shí)間之前

@Future 驗(yàn)證 Date 和 Calendar 對(duì)象是否在當(dāng)前時(shí)間之后

@Pattern 驗(yàn)證 String 對(duì)象是否符合正則表達(dá)式的規(guī)則

@Min 驗(yàn)證 Number 和 String 對(duì)象是否大等于指定的值

@Max 驗(yàn)證 Number 和 String 對(duì)象是否小等于指定的值

@DecimalMax 被標(biāo)注的值必須不大于約束中指定的最大值. 這個(gè)約束的參數(shù)是一個(gè)通過BigDecimal定義的最大值的字符串表示.小數(shù)存在精度

@DecimalMin 被標(biāo)注的值必須不小于約束中指定的最小值. 這個(gè)約束的參數(shù)是一個(gè)通過BigDecimal定義的最小值的字符串表示.小數(shù)存在精度

@Digits 驗(yàn)證 Number 和 String 的構(gòu)成是否合法

@Digits(integer=,fraction=) 驗(yàn)證字符串是否是符合指定格式的數(shù)字镊尺,interger指定整數(shù)精度朦佩,fraction指定小數(shù)精度。

@Range(min=, max=) 驗(yàn)證元素是否在合適的范圍內(nèi)

@Email 驗(yàn)證是否是郵件地址庐氮,如果為null,不進(jìn)行驗(yàn)證语稠,算通過驗(yàn)證。

使用

在需要驗(yàn)證的類屬性上添加相應(yīng)的注解弄砍,如:

import lombok.Data;
import org.hibernate.validator.constraints.NotBlank;

@Data
public class LoginVO {

    @NotBlank
    private String username;
    @NotBlank
    private String password;
}

在SpringMVC控制層中使用@Valid注解進(jìn)行驗(yàn)證,并判斷是否有異常

@PostMapping("login")
public String login(@Valid LoginVO vo, Errors errors){
    if (errors.hasErrors()) {
        List<FieldError> list = errors.getFieldErrors();
        StringBuffer sb = new StringBuffer("參數(shù):");
        for(FieldError error : list){
             sb.append(error.getField()).append(",");
         }
         sb.append("不符合要求");
         return sb.toString();
     }
     return "驗(yàn)證通過";
}

當(dāng)然上面Controller層的代碼非常容易重復(fù)仙畦,畢竟差不多的方法都需要驗(yàn)證參數(shù),所以為了方面和簡潔代碼音婶,可以通過抓取全局異常的方式返回提示信息

全局異常處理

通過配置全局異常處理方法议泵,抓取BindException,返回異常提示信息

import com.wxkingbos.patrol.model.WebResult;
import org.springframework.validation.BindException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

/**
 * 全局異常處理器
 * Created by Raye on 2019-04-15
 */
@ControllerAdvice
public class ExceptionControllerAdvice {

    @ExceptionHandler(BindException.class)
    @ResponseBody
    public String bindExceptionHandler(BindException ex){
        if(ex.hasErrors()){
            List<FieldError> list = ex.getFieldErrors();
            StringBuffer sb = new StringBuffer("參數(shù):");
            for(FieldError error : list){
                sb.append(error.getField()).append(",");
            }
            sb.append("不符合要求");
            return sb.toString();
        }
        return ex.getMessage();
    }
}

同理桃熄,也可以采用此方法抓取其他全局異常先口,進(jìn)行異常日志捕捉獲取其他異常提示,另外以上全局異常配置只有在Springboot項(xiàng)目上運(yùn)行過瞳收,因?yàn)楝F(xiàn)在項(xiàng)目差不多都是基于Springboot構(gòu)建的了碉京,所以也沒有在非Springboot上面測(cè)試過可行性

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市螟深,隨后出現(xiàn)的幾起案子谐宙,更是在濱河造成了極大的恐慌,老刑警劉巖界弧,帶你破解...
    沈念sama閱讀 217,734評(píng)論 6 505
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件凡蜻,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡垢箕,警方通過查閱死者的電腦和手機(jī)划栓,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,931評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來条获,“玉大人忠荞,你說我怎么就攤上這事。” “怎么了委煤?”我有些...
    開封第一講書人閱讀 164,133評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵堂油,是天一觀的道長。 經(jīng)常有香客問我碧绞,道長府框,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,532評(píng)論 1 293
  • 正文 為了忘掉前任讥邻,我火速辦了婚禮迫靖,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘计维。我一直安慰自己,他們只是感情好撕予,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,585評(píng)論 6 392
  • 文/花漫 我一把揭開白布鲫惶。 她就那樣靜靜地躺著,像睡著了一般实抡。 火紅的嫁衣襯著肌膚如雪欠母。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,462評(píng)論 1 302
  • 那天吆寨,我揣著相機(jī)與錄音,去河邊找鬼。 笑死牍氛,一個(gè)胖子當(dāng)著我的面吹牛吧碾,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播辣卒,決...
    沈念sama閱讀 40,262評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼掷贾,長吁一口氣:“原來是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來了荣茫?” 一聲冷哼從身側(cè)響起想帅,我...
    開封第一講書人閱讀 39,153評(píng)論 0 276
  • 序言:老撾萬榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎啡莉,沒想到半個(gè)月后港准,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,587評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡咧欣,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,792評(píng)論 3 336
  • 正文 我和宋清朗相戀三年浅缸,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片魄咕。...
    茶點(diǎn)故事閱讀 39,919評(píng)論 1 348
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡疗杉,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情烟具,我是刑警寧澤梢什,帶...
    沈念sama閱讀 35,635評(píng)論 5 345
  • 正文 年R本政府宣布,位于F島的核電站朝聋,受9級(jí)特大地震影響嗡午,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜冀痕,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,237評(píng)論 3 329
  • 文/蒙蒙 一荔睹、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧言蛇,春花似錦僻他、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,855評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至婿斥,卻和暖如春劝篷,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背民宿。 一陣腳步聲響...
    開封第一講書人閱讀 32,983評(píng)論 1 269
  • 我被黑心中介騙來泰國打工娇妓, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人活鹰。 一個(gè)月前我還...
    沈念sama閱讀 48,048評(píng)論 3 370
  • 正文 我出身青樓哈恰,卻偏偏與公主長得像,于是被迫代替她去往敵國和親志群。 傳聞我的和親對(duì)象是個(gè)殘疾皇子蕊蝗,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,864評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容

  • 第5章 引用類型(返回首頁) 本章內(nèi)容 使用對(duì)象 創(chuàng)建并操作數(shù)組 理解基本的JavaScript類型 使用基本類型...
    大學(xué)一百閱讀 3,233評(píng)論 0 4
  • ORA-00001: 違反唯一約束條件 (.) 錯(cuò)誤說明:當(dāng)在唯一索引所對(duì)應(yīng)的列上鍵入重復(fù)值時(shí),會(huì)觸發(fā)此異常赖舟。 O...
    我想起個(gè)好名字閱讀 5,317評(píng)論 0 9
  • 1. 簡介 1.1 什么是 MyBatis 蓬戚? MyBatis 是支持定制化 SQL、存儲(chǔ)過程以及高級(jí)映射的優(yōu)秀的...
    笨鳥慢飛閱讀 5,520評(píng)論 0 4
  • ??引用類型的值(對(duì)象)是引用類型的一個(gè)實(shí)例。 ??在 ECMAscript 中石洗,引用類型是一種數(shù)據(jù)結(jié)構(gòu)幢泼,用于將數(shù)...
    霜天曉閱讀 1,054評(píng)論 0 1
  • 國家電網(wǎng)公司企業(yè)標(biāo)準(zhǔn)(Q/GDW)- 面向?qū)ο蟮挠秒娦畔?shù)據(jù)交換協(xié)議 - 報(bào)批稿:20170802 前言: 排版 ...
    庭說閱讀 10,967評(píng)論 6 13