Spring Boot实际应用讲解(三):表单验证

文/ZYRzyr
原文链接:http://www.jianshu.com/p/a2b4e61b5532

本文提纲
一、表单验证实例
二、验证注解说明
三、最后

本文运行环境

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

一、表单验证实例

表单验证,即校验用户提交的数据的合理性,如是否为空,数据长度,数据类型等等,好的验证,能防止垃圾数据的产生。

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请求参数即为User类中的字段名:nameagepasswordSpring Boot会将其自动组合成User实例;
  2. @Valid:表示该参数需要进行验证,验证点即为上面User类中的字段上的各注解;
  3. BindingResult:此参数包含错误信息,即User字段注解中的message
  4. signUp方法打印请求参数的值,若未通过验证则返回错误信息,错误信息即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 对象是否小等于指定的值,小数存在精度
@DecimalMin 验证 NumberString 对象是否大等于指定的值,小数存在精度
@Digits 验证NumberString的构成是否合法
@Past 验证DateCalendar对象是否在当前时间之前
@Future 验证DateCalendar对象是否在当前时间之后
@Max 验证NumberString对象是否小等于指定的值
@Min 验证NumberString对象是否小等于指定的值
@NotNull 验证对象不为空
@Null 验证对象为空
@Pattern 验证String对象是否符合正则表达式的规则
@Size 验证对象(Array,Collection,Map,String)长度是否在给定的范围之内

三、最后

本文介绍了Spring Boot是如何使用注解,就能方便的进行表单验证的。

本文代码已上传至我的GitHub仓库,进入以后将branches切换为3-FormValidate即可看见。

前篇:
Spring Boot实际应用讲解(一):Hello World
Spring Boot实际应用讲解(二):配置详解

后续将推出以下文章,敬请关注!

Spring Boot实际应用讲解(四):RESTful API
Spring Boot实际应用讲解(五):AOP之请求日志
Spring Boot实际应用讲解(六):MySQL + Spring-data-jpa(Hibernate)
Spring Boot实际应用讲解(七):统一异常处理
Spring Boot实际应用讲解(八):MySQL + Mybatis
Spring Boot实际应用讲解(九):MySQL + Mybatis + Redis

文中若有错之处,还请各位批评指正,谢谢!

原文作者/ZYRzyr
原文链接:http://www.jianshu.com/p/a2b4e61b5532

请进入这里获取授权:https://101709080007647.bqy.mobi

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,029评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,395评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,570评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,535评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,650评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,850评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,006评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,747评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,207评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,536评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,683评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,342评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,964评论 3 315
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,772评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,004评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,401评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,566评论 2 349