spring-boot-validator参数校验系列(3)--------自定义校验注解-阿里云开发者社区

开发者社区> SevenSun> 正文

spring-boot-validator参数校验系列(3)--------自定义校验注解

简介: 根据自己的业务规则实现自定义校验注解
+关注继续查看

前言

目录

spring-boot-validator参数校验系列(1)--------基本参数校验

spring-boot-validator参数校验系列(2)--------分组校验

spring-boot-validator参数校验系列(3)--------自定义校验注解

spring-boot-validator参数校验系列(4)--------自定义参数校验异常


一、为什么要自定义注解?

因为常见的注解满足不了我们的业务需求,比如,我们限制某个属性只能是固定的值!

二、如何实现

(1)首先完成基本校验spring-boot-validator参数校验系列(1)--------基本参数校验

(2)创建自定义注解

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.*;

/**
 * @Description : 自定义校验注解
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD,ElementType.PARAMETER})

//FixedValidatorClass 为执行判断逻辑实现类!
@Constraint(validatedBy = FixedValidatorClass.class)
public @interface Fixed {

    String[] value() default {};

    String message() default "请输入合法值!";

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

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

(3)创建注解判断逻辑类


import javax.validation.ConstraintValidator;
import javax.validation.ConstraintValidatorContext;
import java.util.Arrays;
import java.util.Objects;

/**
 * 状态标记校验器
 */
public class FixedValidatorClass implements
    //Fixed为我们自定的注解,查看ConstraintValidator可知,
    第一个泛型参数必须继承Annotation,也就是必须是个注解
    第二个参数为此注解支持的校验类型,可以理解为@Fixed注解中的value返回类型
    ConstraintValidator<Fixed,Object> {
    
    private String[] values;
    
    //初始化参数
    @Override
    public void initialize(Fixed fixed) {
        //根据用户填写的value值,来初始化此属性只支持的值!
        this.values = fixed.value();
    }

    
    @Override
    public boolean isValid(Object value, ConstraintValidatorContext context) {
        //具体的判断逻辑
        //是否为null,以及初始化值中是否包传入的值.
        //false表示校验失败,参数不合法!
        return Objects.isNull(value) 
        || Arrays.asList(values).contains(String.valueOf(value));
    }

}

(3)属性上增加自定义注解

我们的"老用户"了

@Data
public class MyPerson {

    @NotBlank(message = "id不可为空!",groups = {Update.class})
    private String id;

    @Size(max = 8,min = 1, message = "用户名超出长度范围!")
    private String name;

    //这里以性别为例,只能输入0(女),1(男)
    @Fixed(value = {"0","1"},groups = {Insert.class,Update.class},message = "请输入合法值!")
    @NotNull
    private Integer sex;
    
}

Controller代码,注意@Validated 位置,看过校验系列文章第一篇的老读者,应该知道这个注解可以写在类上面的,但是经测试,卸载类上,不生效,具体原因尚不清楚,使用时注意下!

    @RequestMapping("/custom")
    public void custom(@RequestBody @Validated MyPerson myPerson){
        log.info("校验通过,用户信息为: {}",myPerson);
    }


PostMan访问

image.png

后台输出

image.png

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
springboot自定义错误页面
springboot自定义错误页面 1.加入配置: @Bean public EmbeddedServletContainerCustomizer containerCustomizer() { return (contain...
1262 0
SpringBoot-02-之参数传递
一:url传参 1.get方式Url传参:@PathVariable ////------get方式Url传参 @GetMapping({"/id/{the_Param}"}) public String id(@PathV...
982 0
springMVC对jsp页面的数据进行校验
一. 使用注解校验 a) 引入校验依赖包 javax.validation validation-api 2.0.0.Final org.
1318 0
Springboot自定义异常处理
1.自定义异常类 import lombok.Data; @Data public class UserException extends RuntimeException { private Long id; public UserException(Long id) { super("user not exist"); this.
1213 0
spring mvc各种参数在jsp和action之间的传递
SpringMVC的各种参数绑定方式   1. 基本数据类型(以int为例,其他类似): Controller代码: @RequestMapping("saysth.do") public void test(int count) { } 表单代码: &lt;form action="saysth.do" method="post"&gt; &lt;
1006 0
hibernate自定义校验Valid
步骤: 1.定义注解: import javax.validation.Constraint; import javax.validation.Payload; import java.lang.annotation.
984 0
使用OpenApi弹性释放和设置云服务器ECS释放
云服务器ECS的一个重要特性就是按需创建资源。您可以在业务高峰期按需弹性的自定义规则进行资源创建,在完成业务计算的时候释放资源。本篇将提供几个Tips帮助您更加容易和自动化的完成云服务器的释放和弹性设置。
11890 0
Spring MVC url提交参数和获取参数
普通URL提交参数 该格式url为:url.do?param1=mahc&param2=8888.00 需要在上文中的HelloController对象添加方法如下: ? 1 2 3 4 5 6 7 8 9 10 11 /**      *...
573 0
SpringBoot-08-之统一化json输出与自定义异常捕获
为及时了解异常,以及避免返回的json格式不统,将每次请求的结果都返还一样的形式。 此处统一为:{"code":响应代号码,"msg":信息,"data":数据} 具体效果如下: result--format.
1287 0
+关注
SevenSun
技术创造美好生活!
23
文章
2
问答
文章排行榜
最热
最新
相关电子书
更多
《2021云上架构与运维峰会演讲合集》
立即下载
《零基础CSS入门教程》
立即下载
《零基础HTML入门教程》
立即下载