springboot使用hibernate validator校验

第一步：设置引用pom.xml文件

 

<dependency>
   <groupId>org.hibernate</groupId>
   <artifactId>hibernate-validator</artifactId>
</dependency>

或者引用

<dependency>
   <groupId>org.springframework.boot</groupId>
   <artifactId>spring-boot-starter-web</artifactId>
</dependency>spring-boot-starter-web包里面有hibernate-validator包，不需要引用hibernate validator依赖可以查看 hibernate validator  官方文档地址：  http://hibernate.org/validator/documentation/第二步骤： 写异常类

package com.hujiang.cctalk.common.exception;

import com.hujiang.basic.framework.rest.model.DataResult;
import org.springframework.validation.BindingResult;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import java.util.Date;

/**
 * @Description 全局异常处理类
 * @Auhor lichuanjie
 * @Date 2018/12/23 下午6:26
 * @Version 1.0
 **/
@ResponseBody
@ControllerAdvice
public class CcGlobleExceptionHandler {
    @ExceptionHandler(value = MethodArgumentNotValidException.class)
    public DataResult<Object> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        BindingResult bindingResult = ex.getBindingResult();
        DataResult<Object> errorResult = new DataResult<>();
        errorResult.setStatus(-40001);
        errorResult.setMessage(bindingResult.getFieldError().getDefaultMessage());
        errorResult.setTime(new Date());
        return errorResult;
    }
}

 

第三步骤：请求Request对象设置

   

package com.hujiang.cctalk.marketing.activity.support.model.dto.request.invite;

import java.util.Date;
import java.util.List;

import com.hujiang.basic.framework.rest.model.BaseUserRequest;
import lombok.Data;
import org.hibernate.validator.constraints.*;

import javax.validation.constraints.*;


/**
 * @author lichuanjie
 * @version 1.0
 * @created 2018-12-04 16:43:02
 */

@Data
public class ProductInviteCreateRequest extends BaseUserRequest<Integer> {
    @NotNull(message = "sellerId不能为空")
    private Integer sellerId;

    /**
     * 商品ID
     **/
    @NotNull(message = "商品ID不能为空")
    private Long productId;

    /**
     * 邀请名称
     **/
    @NotBlank(message = "邀请码名称不能为空")
    @Length(max = 50, message = "邀请码名称不能超过50字符")
    private String inviteName;

    /**
     * 总共
     *
     * @Range CharSequence, Collection, Map and Arrays,BigDecimal, BigInteger, CharSequence, byte, short, int, long and the respective wrappers of the primitive types
     **/
    @Range(min = 1, max = 10000, message = "邀请码数量必须1-10000")
    private Integer total;

    /**
     * 过期时间
     *
     * @Future 限制必须是一个将来的日期
     **/
    @NotNull(message = "邀请码过期时间不能为空")
    @Future(message = "邀请码过期时间必须大于当前时间")
    private Date expireDate;
    /**
     * 来源
     *
     * @NotBlank 验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的空格
     **/
    @NotBlank(message = "inviteSource不能为空")
    private String inviteSource;

    /**
     * @Past 限制必须是一个过去的日期
     */
    @Past(message = "验证date和calendar对象是否在当前时间之前")
    private Date pastDate;

    /**
     * @Max 限制必须为一个不大于指定值的数字<=
     */
    @Max(value = 100, message = "不能大于100岁！")
    private Integer maxAge;

    /**
     * @Min验证number和string对象是否大等于指定的值
     */
    @Min(value = 18, message = "必须年满18岁！")
    private Integer minAge;

    @Pattern(regexp = "[a-za-z0-9._%+-]+@[a-za-z0-9.-]+\\.[a-za-z]{2,4}", message = "patternEmail邮件格式错误")
    private String patternEmail;

    /**
     * @Email 验证注解的元素值是Email，也可以通过正则表达式和flag指定自定义的email格式
     */
    @Email(message = "输入正确的邮箱")
    private String email;

    /**
     * @NotEmpty 验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
     */
    @NotEmpty(message = "userIdList非空")
    private List<String> userIdList;

    @URL(message = "输入正确的URL地址")
    private String url;

    /**
     *
     * @Size： String, Collection, Map and arrays. Additionally supported by HV: any sub-type of CharSequence.
     */
    @Size(min = 10, max = 20,message = "密码长度必须10-20字符")
    private String passWord;
}

 

第三步骤：Controller设置
标记：@Validated 

 @RequestMapping(value = "/create", method = RequestMethod.POST)
    public DataResult<ProductInviteInfoDto> createInvite(@RequestBody @Validated ProductInviteCreateRequest request) {
        return DataResult.ok(0, "success", productInviteService.createInvite(request));
    }

 

第四补充自定义校验注解：

package com.hujiang.cctalk.miaosha.validate;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;
import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.ElementType.PARAMETER;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

@Target({TYPE, METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER })// 约束注解应用的目标元素类型(TYPE   ,METHOD, FIELD, ANNOTATION_TYPE, CONSTRUCTOR, PARAMETER等)
@Retention(RUNTIME)// 约束注解应用的时机
@Documented
@Constraint(validatedBy = { IsMobileValidator.class})// 与约束注解关联的验证器
public @interface IsMobile {

    boolean required() default true;//是否校验

    String message() default "手机号码错误"; // 约束注解验证时的输出消息

    Class<?>[] groups() default {};// 约束注解在验证时所属的组别

    Class<? extends Payload>[] payload() default {};// 约束注解的有效负载
}

 

package com.hujiang.cctalk.miaosha.validate;
import org.thymeleaf.util.StringUtils;
import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;

public class IsMobileValidator implements ConstraintValidator<IsMobile,String> {

    private boolean required = false;

    //初始化方法
    @Override
    public void initialize(IsMobile constraintAnnotation) {
        required = constraintAnnotation.required();
    }

    //校验方法
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (required == false) {
            return ValidatorUtil.isMobile(value);
        }else {
            if (StringUtils.isEmpty(value)) {
                return true;
            }
            return ValidatorUtil.isMobile(value);
        }
    }

}

 

import org.thymeleaf.util.StringUtils;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
 
/**
 * 手机号格式校验
 */
public class ValidatorUtil {
 
    //手机号格式表达式
    private static final Pattern mobile_pattern = Pattern.compile("1\\d{10}");
 
    /**
     * 校验src是否为指定的手机号格式
     * @param src 需要校验的手机号
     * @return 是指定的手机号返回true,否则false
     */
    public static boolean isMobile(String src){
        if (StringUtils.isEmpty(src)){
            return false;
        }
        Matcher m = mobile_pattern.matcher(src);
        return m.matches();
    }
}
}

 

第五：升级版本：如何设置message 抽离配置文件？可以通过加一个配置类：

package com.hujiang.cctalk.marketing.main;

import org.springframework.context.MessageSource;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.support.ReloadableResourceBundleMessageSource;
import org.springframework.validation.beanvalidation.LocalValidatorFactoryBean;

/**
 * @Description TODO
 * @Auhor lichuanjie
 * @Date 2018/12/29 下午4:28
 * @Version 1.0
 **/
@Configuration
public class BeanValidatorConfig  {

    @Bean
    public MessageSource messageSource() {
        ReloadableResourceBundleMessageSource messageSource = new ReloadableResourceBundleMessageSource();
        messageSource.setBasename("classpath:messages");
        messageSource.setDefaultEncoding("UTF-8");
        return messageSource;
    }

    @Bean
    public LocalValidatorFactoryBean validator() {
        LocalValidatorFactoryBean bean = new LocalValidatorFactoryBean();
        bean.setValidationMessageSource(messageSource());
        return bean;
    }

}

 

项目中增加一个配置文件：
ValidationMessages_zh_CN.properties
内容：

username.message.error=错误英文