Spring Boot實際應用講解(三):表單驗證

文/ZYRzyr
原文鏈接:http://www.reibang.com/p/a2b4e61b5532

本文提綱
一士袄、表單驗證實例
二鸟召、驗證注解說明
三怜校、最后

本文運行環(huán)境

Ubuntu 16.04 LTS
JDK 8 +
IntelliJ IDEA ULTIMATE 2017.2
Maven 3.5.0
Spring Boot 1.5.8.RELEASE

一、表單驗證實例

表單驗證鹰贵,即校驗用戶提交的數(shù)據(jù)的合理性晴氨,如是否為空,數(shù)據(jù)長度碉输,數(shù)據(jù)類型等等籽前,好的驗證,能防止垃圾數(shù)據(jù)的產(chǎn)生敷钾。

1.1 新建類實體類

package com.zyr.demo.domain;

import javax.validation.constraints.Min;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Size;

public class User {

    @NotNull(message = "用戶名不能為空")       
    @Size(min = 1, message = "用戶名不能為空") //字符串必須有此注解枝哄,否則無法驗證傳的值
    private String name;

    @NotNull(message = "年齡不能為空")
    @Min(value = 18, message = "必須是成年人")
    private Integer age;

    @NotNull(message = "密碼不能為空")
    @Size(min = 6, max = 15, message = "密碼長度為6—15位") 
    private String password;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public Integer getAge() {
        return age;
    }

    public void setAge(Integer age) {
        this.age = age;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                ", password='" + password + '\'' +
                '}';
    }
}

1.2 新建Controller

package com.zyr.demo.controller;

import com.zyr.demo.domain.User;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;

import javax.validation.Valid;

@RestController
public class UserController {

    @PostMapping("/signUp")  //POST請求方式
    public String signUp(@Valid User user, BindingResult bindingResult) {
        System.out.println("name=" + user.getName());
        System.out.println("age=" + user.getAge());
        System.out.println("password=" + user.getPassword());

        if (bindingResult.hasErrors()) {
            return bindingResult.getFieldError().getDefaultMessage();
        }

        return "success";
    }
}
  1. signUpPOST請求參數(shù)即為User類中的字段名:nameage阻荒,password挠锥。Spring Boot會將其自動組合成User實例;
  2. @Valid:表示該參數(shù)需要進行驗證侨赡,驗證點即為上面User類中的字段上的各注解蓖租;
  3. BindingResult:此參數(shù)包含錯誤信息,即User字段注解中的message羊壹;
  4. signUp方法打印請求參數(shù)的值蓖宦,若未通過驗證則返回錯誤信息,錯誤信息即User類字段注解中的message油猫,若驗證成功直接返回success稠茂。

1.3 測試

新建測試類UserControllerTest(此處未寫完所有測試用例):

package com.zyr.demo.controller;

import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;

@RunWith(SpringRunner.class)
@SpringBootTest
@AutoConfigureMockMvc
public class UserControllerTest {

    @Autowired
    private MockMvc mockMvc;

    @Test
    public void testSignUp_success() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.post("/signUp")
                .param("name", "Bob")
                .param("age", "20")
                .param("password", "123456"))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("success"));
    }

    @Test
    public void testSignUp_name_null() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.post("/signUp")
                .param("name", "")
                .param("age", "20")
                .param("password", "123456"))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("用戶名不能為空"));
    }

    @Test
    public void testSignUp_age_error() throws Exception {
        mockMvc.perform(MockMvcRequestBuilders.post("/signUp")
                .param("name", "Bob")
                .param("age", "10")
                .param("password", "123456"))
                .andExpect(MockMvcResultMatchers.status().isOk())
                .andExpect(MockMvcResultMatchers.content().string("必須是成年人"));
    }
}

運行測試用例,全部成功情妖,說明正確睬关。

二、驗證注解說明

除了上面User類使用的注解鲫售,還有其它很多類型的注解:

注解 作用
@AssertFalse 驗證boolean對象是否是false
@AssertTrue 驗證boolean對象是否是true
@DecimalMax 驗證 NumberString 對象是否小等于指定的值共螺,小數(shù)存在精度
@DecimalMin 驗證 NumberString 對象是否大等于指定的值,小數(shù)存在精度
@Digits 驗證NumberString的構(gòu)成是否合法
@Past 驗證DateCalendar對象是否在當前時間之前
@Future 驗證DateCalendar對象是否在當前時間之后
@Max 驗證NumberString對象是否小等于指定的值
@Min 驗證NumberString對象是否小等于指定的值
@NotNull 驗證對象不為空
@Null 驗證對象為空
@Pattern 驗證String對象是否符合正則表達式的規(guī)則
@Size 驗證對象(Array,Collection,Map,String)長度是否在給定的范圍之內(nèi)

三情竹、最后

本文介紹了Spring Boot是如何使用注解,就能方便的進行表單驗證的匀哄。

本文代碼已上傳至我的GitHub倉庫秦效,進入以后將branches切換為3-FormValidate即可看見。

前篇:
Spring Boot實際應用講解(一):Hello World
Spring Boot實際應用講解(二):配置詳解

后續(xù)將推出以下文章涎嚼,敬請關(guān)注阱州!

Spring Boot實際應用講解(四):RESTful API
Spring Boot實際應用講解(五):AOP之請求日志
Spring Boot實際應用講解(六):MySQL + Spring-data-jpa(Hibernate)
Spring Boot實際應用講解(七):統(tǒng)一異常處理
Spring Boot實際應用講解(八):MySQL + Mybatis
Spring Boot實際應用講解(九):MySQL + Mybatis + Redis

文中若有錯之處,還請各位批評指正法梯,謝謝苔货!

原文作者/ZYRzyr
原文鏈接:http://www.reibang.com/p/a2b4e61b5532

請進入這里獲取授權(quán):https://101709080007647.bqy.mobi

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末犀概,一起剝皮案震驚了整個濱河市,隨后出現(xiàn)的幾起案子夜惭,更是在濱河造成了極大的恐慌姻灶,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件诈茧,死亡現(xiàn)場離奇詭異产喉,居然都是意外死亡,警方通過查閱死者的電腦和手機敢会,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進店門曾沈,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人鸥昏,你說我怎么就攤上這事塞俱。” “怎么了吏垮?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵障涯,是天一觀的道長。 經(jīng)常有香客問我惫皱,道長像樊,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任旅敷,我火速辦了婚禮生棍,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘媳谁。我一直安慰自己涂滴,他們只是感情好,可當我...
    茶點故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布晴音。 她就那樣靜靜地躺著柔纵,像睡著了一般。 火紅的嫁衣襯著肌膚如雪锤躁。 梳的紋絲不亂的頭發(fā)上搁料,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天,我揣著相機與錄音系羞,去河邊找鬼郭计。 笑死,一個胖子當著我的面吹牛椒振,可吹牛的內(nèi)容都是我干的昭伸。 我是一名探鬼主播,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼澎迎,長吁一口氣:“原來是場噩夢啊……” “哼庐杨!你這毒婦竟也來了选调?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤灵份,失蹤者是張志新(化名)和其女友劉穎仁堪,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體各吨,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡枝笨,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了揭蜒。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片横浑。...
    茶點故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖屉更,靈堂內(nèi)的尸體忽然破棺而出徙融,到底是詐尸還是另有隱情,我是刑警寧澤瑰谜,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布欺冀,位于F島的核電站,受9級特大地震影響萨脑,放射性物質(zhì)發(fā)生泄漏隐轩。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一渤早、第九天 我趴在偏房一處隱蔽的房頂上張望职车。 院中可真熱鬧,春花似錦鹊杖、人聲如沸悴灵。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽积瞒。三九已至,卻和暖如春登下,著一層夾襖步出監(jiān)牢的瞬間茫孔,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工被芳, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留银酬,地道東北人。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓筐钟,卻偏偏與公主長得像,于是被迫代替她去往敵國和親赋朦。 傳聞我的和親對象是個殘疾皇子篓冲,可洞房花燭夜當晚...
    茶點故事閱讀 44,979評論 2 355