参数校验 关于spring-boot-starter-validation解释

前言

  • jdk javax.validation包下的接口
  • hibernate validation实现类
  • spring-boot validation实现类

一、jdk javax.validation?

  • 就是一个规范, 所有实现类必须是线程安全的, 提供以下注解, 但并不提供实现


    20201208153453342.png
  • 提供实现接口
public interface ConstraintValidator<A extends Annotation, T> {

二、hibernate validation

  • 实现了jdk Validator接口以及ExecutableValidator接口
public class ValidatorImpl implements Validator, ExecutableValidator {
  • 也新增了一批注解


    20201208155006608.png
  • 提供接口实现:


    20201208155210226.png

三 spring-boot-starter-validation

  • 定义Validator以及SmartValidator接口, 添加了hibernate的包, 提供@Validated支持spring环境,支持验证组的规范, 支持在spring mvc的环境中使用,提供了一系列的工厂类, 以及适配器;

四 使用

一 基本使用:
@RestController
public class UserController {

    @RequestMapping
    public Response<Object> login(@Validated UserLogin user) {
        return Response.builder().code(200).message("ok").data("ok").build();
    }
}
@Data
public class UserLogin {

    @NotBlank
    @Size(max = 10)
    private String username;

    private String password;
}
二 新增自定义注解
@Documented
@Constraint(validatedBy = {GenderValidator.class})
@Target({ElementType.METHOD, ElementType.FIELD})
@Retention(RetentionPolicy.RUNTIME)
public @interface GenderValidation {

    String message() default "性别取值范围不对";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}

public class GenderValidator implements ConstraintValidator<GenderValidation, String> {
    @Override
    public boolean isValid(String value, ConstraintValidatorContext context) {
        if (value == null) {
            return false;
        }
        return value.equals("男") || value.equals("女");
    }

    @Override
    public void initialize(GenderValidation constraintAnnotation) {

    }
}
@Data
public class UserLogin {

    @NotBlank
    @Size(max = 10)
    private String username;

    private String password;

    // 添加注解, 用以启用自定义注解校验
    @GenderValidation
    private String gender;
}
三 自定义Validator
@Configuration
public class UserValidator implements Validator {


    @Override
    public boolean supports(Class<?> clazz) {
        return clazz.equals(UserLogin2.class);
    }

    @Override
    public void validate(Object target, Errors errors) {
        ValidationUtils.rejectIfEmpty(errors, "username", "username.empty");
        ValidationUtils.rejectIfEmpty(errors, "password", "password.empty");
        UserLogin2 userLogin2 = (UserLogin2) target;
        System.out.println(userLogin2);
    }
}

@RestController
public class UserController extends ValidationInitController {
    @Autowired
    private UserValidator userValidator;

    @InitBinder
    public void initBinder(WebDataBinder dataBinder) {
        dataBinder.setValidator(userValidator);
    }
    @RequestMapping("/login")
    public Response<Object> login(@Validated @RequestBody UserLogin2 user) {
        return Response.builder().code(200).message("ok").data("ok").build();
    }
}

@Data
@ToString
public class UserLogin2 {

    private String username;

    private String password;
}

四 分组校验
@Data
@ToString
public class UserLogin4 {

    @NotNull(groups = {UserUpdate.class}, message = "userId not null")
    private Integer userId;

    private String username;

    private String password;

    public interface UserInsert extends Default {
    }

    public interface UserUpdate extends Default {
    }
}

@RestController
public class UserController {

    @RequestMapping("/user/insert")
    public Response<Object> userInsert(@Validated(UserLogin4.UserInsert.class) @RequestBody UserLogin4 user) {
        return Response.builder().code(200).message("ok").data("ok").build();
    }

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