提交表单，要写点严谨的代码，前后台验证是少不了的，前台页面可以使用JQuery等插件进行验证，后台验证，如果一句一句地判断，那太苦力了，特别是对于一个复杂的表单，后期的维护也是个很大的问题。
javax.validation使用注解便可实现既轻松又优雅的验证，维护起来也特别方便。下面就来看看如何使用javax.validation验证吧，为了方便测试，再省点页面上的代码，这里使用了swagger-ui来代替前台页面提交数据，下面直接上代码。

添加依赖

首先，在pom.xml文件中引入必要的架包；

  1. <dependency>
  2.   <groupId>org.springframework.boot</groupId>
  3.   <artifactId>spring-boot-starter-web</artifactId>
  4. </dependency>
  5. <!-- swagger RESTful API 文档 -->
  6. <dependency>
  7.   <groupId>io.springfox</groupId>
  8.   <artifactId>springfox-swagger2</artifactId>
  9.   <version>2.9.2</version>
  10. </dependency>
  11. <!-- swagger ui  -->
  12. <dependency>
  13.   <groupId>io.springfox</groupId>
  14.   <artifactId>springfox-swagger-ui</artifactId>
  15.   <version>2.2.2</version>
  16. </dependency>       
  17. <!-- javax.validation -->
  18. <dependency>
  19.   <groupId>javax.validation</groupId>
  20.   <artifactId>validation-api</artifactId>
  21. </dependency>
  22. <!-- com.fasterxml -->
  23. <dependency>
  24.   <groupId>com.fasterxml.jackson.core</groupId>
  25.   <artifactId>jackson-databind</artifactId>
  26.         </dependency>

备注：架包加了不少，每个架包在后面都有特别的用处；

创建测试类

第二步，创建一个测试实体类，把验证注解加上去；

  1. import java.math.BigDecimal;
  2. import java.util.Date;
  4. import javax.validation.constraints.AssertTrue;
  5. import javax.validation.constraints.DecimalMax;
  6. import javax.validation.constraints.Digits;
  7. import javax.validation.constraints.Email;
  8. import javax.validation.constraints.Max;
  9. import javax.validation.constraints.Min;
  10. import javax.validation.constraints.NotBlank;
  11. import javax.validation.constraints.NotEmpty;
  12. import javax.validation.constraints.NotNull;
  13. import javax.validation.constraints.Null;
  14. import javax.validation.constraints.Past;
  15. import javax.validation.constraints.Pattern;
  16. import javax.validation.constraints.Size;
  18. import org.hibernate.validator.constraints.Length;
  19. import org.hibernate.validator.constraints.Range;
  20. import org.springframework.format.annotation.DateTimeFormat;
  22. import com.example.demo.validator.Mobile;
  23. import com.fasterxml.jackson.annotation.JsonFormat;
  25. import io.swagger.annotations.ApiModel;
  26. import io.swagger.annotations.ApiModelProperty;
  28. /**
  29.  * 用户实体类
  30.  * @author clown
  31.  * @Date
  32.  */
  33. @ApiModel(value = "用户信息")
  34. public class UserInfo {
  36.     @NotNull(message = "用户uid不能为空！")
  37.     private String userUid;
  39.     @NotEmpty(message = "用户密码不能为空！")
  40.     @Size(min=6, max=15,message="密码长度必须在 6 ~ 15 字符之间！")
  41.     @Pattern(regexp="^[a-zA-Z0-9|_]+$",message="密码必须由字母、数字、下划线组成！")
  42.     private String userPwd;
  44.     @NotBlank(message = "用户名不能为空")
  45.     @Size(min=2, max=20,message="用户名必须在 2 ~ 20 字符之间！")
  46.     private String userName;
  48.     @Range(min=1, max=100,message="编码必须在 1 ~ 100 之间！")
  49.     private int code;
  51.     @Min(value=0,message="最小必须是0")
  52.     @Max(value=1,message="最大不能超过1")
  53.     private Byte sex;
  55.     private String familyAddr;
  57.     @Mobile
  58.     @ApiModelProperty(value = "用户手机号码")
  59.     private String mobile;
  61.     @Email(message = "邮箱格式错误！")
  62.     @Length(min=5, max=100,message="邮箱必须在 5 ~ 100 字符之间！")
  63.     private String email;       
  65.     private String idCard;
  67.     @DateTimeFormat(pattern="yyyy-MM-dd")
  68.     @JsonFormat( pattern="yyyy-MM-dd", timezone = "GMT+8")
  69.     @Past(message="不能大于当前年月日")
  70.     private Date birthday;
  72.     @NotNull(message="家庭金额不能为空！")
  73.     @Digits(integer=5, fraction=2, message="家庭资金必须是5位整，2位小数！")
  74.     @ApiModelProperty(value = "家庭金额")
  75.     private Double familyMonney;
  77.     @AssertTrue(message="状态必须正常！")
  78.     @ApiModelProperty(value = "身体健康状态")
  79.     private boolean status;
  81.     @Null(message="初始金额必须为空！")
  82.     private Double originMonney;
  84.     @DecimalMax(value="999999999.00",message="我的金额不能超过999999999.00")
  85.     private BigDecimal myMoney;
  87.     /**get、set 方法省略**/
  88. }

注意：上面的注解大部分都是javax.validation架包里面的；
@ApiModel、@ApiModelProperty是swagger-ui里面的注解；
@DateTimeFormat(pattern=”yyyy-MM-dd”) 来自于org.springframework.format.annotation.DateTimeFormat，这个注解也很常用，主要用来接收前台传过来的格式化的日期；
@JsonFormat(pattern=”yyyy-MM-dd”, timezone = “GMT+8”)来自于com.fasterxml.jackson.annotation.JsonFormat，这个注解也很常用，主要是把后台的日期类型的数据转换成格式化过的字符串数据。

加入自定义注解

第三步，在上面的实体类中，@Mobile是自定义的注解，在这里实现如下；

  1. import java.lang.annotation.ElementType;
  2. import java.lang.annotation.Retention;
  3. import java.lang.annotation.RetentionPolicy;
  4. import java.lang.annotation.Target;
  6. import javax.validation.Constraint;
  7. import javax.validation.Payload;
  9. /**
  10.  * 验证手机号码的注解类
  11.  * @author clown
  12.  * @Date
  13.  */
  14. @Target({ElementType.METHOD, ElementType.FIELD})
  15. @Retention(RetentionPolicy.RUNTIME)
  16. @Constraint(validatedBy=MobileValidator.class)  //对应的验证实现类
  17. public @interface Mobile { 
  19.     //默认提示
  20.     String message() default "手机号码格式错误！"; 
  22.     Class<?>[] groups() default {}; 
  24.     Class<? extends Payload>[] payload() default {}; 
  26. }
  28. import java.util.regex.Pattern;
  30. import javax.validation.ConstraintValidator;
  31. import javax.validation.ConstraintValidatorContext;
  33. import org.springframework.util.StringUtils;
  35. /**
  36.  * 验证手机号码的实现类
  37.  * @author 程就人生
  38.  * @Date
  39.  */
  40. public class MobileValidator implements ConstraintValidator<Mobile, String> { 
  42.     //验证手机的正则表达式
  43.     private String mobileReg = "^1(3|4|5|7|8|9)\\d{9}$";
  45.     private Pattern mobilePattern = Pattern.compile(mobileReg); 
  47.     public void initialize(Mobile mobile) {
  49.     } 
  51.     public boolean isValid(String value, ConstraintValidatorContext arg1) {
  52.        //为空时，不进行验证
  53.        if (StringUtils.isEmpty(value))
  54.            return true;
  56.        //返回匹配结果
  57.        return mobilePattern.matcher(value).matches();
  59.     } 
  61. }


在这里，手机号码的验证是自定义验证，也是用的比较多的验证，所以独立了出来，其他的验证，可以根据需要判断是否需要独立，这样方便后期的维护。

增加swagger配置

第四步，增加swagger-ui的配置；

  1. import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
  2. import org.springframework.context.annotation.Bean;
  3. import org.springframework.context.annotation.Configuration;
  5. import springfox.documentation.builders.ApiInfoBuilder;
  6. import springfox.documentation.builders.PathSelectors;
  7. import springfox.documentation.builders.RequestHandlerSelectors;
  8. import springfox.documentation.service.ApiInfo;
  9. import springfox.documentation.spi.DocumentationType;
  10. import springfox.documentation.spring.web.plugins.Docket;
  11. import springfox.documentation.swagger2.annotations.EnableSwagger2;
  13. /**
  14.  * @author clown
  15.  * @Date
  16.  */
  17. @Configuration
  18. @EnableSwagger2
  19. @ConditionalOnProperty(name = "swagger.enable", havingValue = "true")
  20. //@Profile({"dev","test"}) 
  21. public class Swagger2 {
  23.     @SuppressWarnings("deprecation")
  24.     @Bean
  25.     public Docket createRestApi() {
  26.         ApiInfo apiInfo = new ApiInfoBuilder()
  27.                 .title("验证测试接口文档")
  28.                 .description("App服务接口文档，严格遵循RESTful API设计规范。")
  29.                 .contact("程就人生")
  30.                 .version("1.0")
  31.                 .build();
  33.         return new Docket(DocumentationType.SWAGGER_2)
  34.                 .apiInfo(apiInfo)
  35.                 .select()
  36.                  //以扫描包的方式
  37.                 .apis(RequestHandlerSelectors.basePackage("com.example.demo.controller"))
  38.                 .paths(PathSelectors.any())
  39.                 .build();
  40.     }
  41. }
  43. import org.springframework.context.annotation.Bean;
  44. import org.springframework.context.annotation.Configuration;
  45. import org.springframework.web.filter.HttpPutFormContentFilter;
  46. import org.springframework.web.servlet.config.annotation.EnableWebMvc;
  47. import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
  48. import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
  50. /**
  51.  * 允许访问swagger的静态页面
  52.  * @author 程就人生
  53.  * @Date
  54.  */
  55. @SuppressWarnings("deprecation")
  56. @Configuration
  57. @EnableWebMvc
  58. public class WebMvcConfig extends WebMvcConfigurerAdapter{
  60. //  @Value("${spring.servlet.multipart.location}")
  61. //  private String uploadPath;
  63.   /**
  64.    * PUT方式提交，无法获取参数
  65.    * @return
  66.    */
  67.   @Bean
  68.   public HttpPutFormContentFilter httpPutFormContentFilter() {
  69.       return new HttpPutFormContentFilter();
  70.   }
  72.   @Override
  73.   public void addResourceHandlers(ResourceHandlerRegistry registry){
  75.       //测试环境图片地址映射,映射成url就可以访问的
  76.      // registry.addResourceHandler("/images/**").addResourceLocations("file:" + uploadPath);
  78.       registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
  79.       registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
  81.   }  
  82. }

注意：在application.properties配置文件中加上 swagger.enable=true，不然swagger-ui.html页面访问不了。

创建测试Controller

第五步，创建一个Controller，可以通过url访问，这里采用Restful命名风格；

  1. import org.slf4j.Logger;
  2. import org.slf4j.LoggerFactory;
  3. import org.springframework.validation.BindingResult;
  4. import org.springframework.validation.annotation.Validated;
  5. import org.springframework.web.bind.annotation.PostMapping;
  6. import org.springframework.web.bind.annotation.RequestMapping;
  7. import org.springframework.web.bind.annotation.RestController;
  9. import com.example.demo.entity.UserInfo;
  11. import io.swagger.annotations.Api;
  12. import io.swagger.annotations.ApiOperation;
  14. /**
  15.  * 用户测试用例
  16.  * @author clown
  17.  * @Date
  18.  */
  19. @Api(tags = "用户信息", description = "UserInfoController")
  20. @RestController
  21. @RequestMapping("/userInfo")
  22. public class UserInfoController {
  24.     private static Logger log = LoggerFactory.getLogger(UserInfoController.class);
  26.     @PostMapping
  27.     @ApiOperation(value = "新增",notes="用户信息", httpMethod="POST")
  28.     public UserInfo addUserInfo(@Valid UserInfo userInfo, BindingResult errors){
  29.         //对表单进行验证
  30.         if (errors.hasErrors()){
  31.            //对错误集合进行遍历,有的话,直接放入map集合中
  32.             errors.getFieldErrors().forEach(p->{
  33.                throw new RuntimeException(p.getDefaultMessage());
  34.            });
  35.         }
  36.         log.info("全部验证通过~！");
  37.         return userInfo;
  38.     }
  39. }

最后，启动项目访问测试
image.png
输入值
image.png
测试结果