【java】实现自定义注解校验——方法一

最新推荐文章于 2025-06-18 21:31:04 发布
原创 最新推荐文章于 2025-06-18 21:31:04 发布 · 3k 阅读 · 9 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#java #开发语言 #笔记

本文介绍了如何实现自定义注解进行字段校验，包括创建注解类、元注解的使用、校验逻辑的工具类以及在DTO中的应用实例。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

自定义注解校验的实现步骤：

1.创建注解类，编写校验注解，即类似@NotEmpty注解
2.编写自定义校验的逻辑实体类，编写具体的校验逻辑。(这个类可以实现ConstraintValidator这个接口，让注解用来校验)
3.开启使用自定义注解进行校验。

第一种实现自定义注解的方式：

一、创建注解类：

1、创建类时，选择Annotation类型

在这里插入图片描述

2、编写注解类

编写注解类时，需要用到元注解来规定注解的实现方式等；

package cn.hsa.bis.api.common.utils;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * @Description 基础校验注解
 * @Author chenzz
 * @create 2020/3/6 19:43
 */
//Target注解是指定当前自定义注解可以使用在哪些地方，这里仅仅让他可以使用在字段上；
@Target(ElementType.FIELD)
//指定当前注解保留到运行时；
@Retention(RetentionPolicy.RUNTIME)
public @interface ValiInfo {

    /**
     * 最小长度
     */
    int minLen() default 0;

    /**
     * 最大长度
     */
    int maxLen() default 2147483647;

    /**
     * 非空校验
     */
    boolean notBlank() default false;

    /**
     * 字典校验
     */
    String codeType() default "";

    /**
     * 非法字符校验
     * 特殊字符：ascii码表中除字母、数字外的所有字符，顿号（、），间隔号(·)
     */
    String illegalCharRegExp() default ".*[\\x00-\\x2f\\x3a-\\x40\\x5b-\\x60\\x7b-\\x7f\\u3001\\u00b7]+.*";

    /**
     * 正则校验
     */
    String regexp() default "";

    /**
     * 字段含义
     */
    String mean() default "";

    /**
     * 汉字校验
     */
    String regexpChinese() default "";
}

3、元注解 (编写注解类时，必须要明白的)

刚创建出来的注解是不能使用的。因为我们不知道注解应该加在什么地方，在什么时间生效，所以就引出来元注解的概念。元注解就是注解的注解(有点绕口令的感觉)。专门用来注解注解类型。
java的元注解：@Target，@Retention，@Documented，@Inherited

@Target直接指明了该注解生效的位置，该参数没有default值，必填。参数是一个枚举类型
在这里插入图片描述

@Retention指明了注解生效的阶段
在这里插入图片描述
@Documented
当我们用javaDoc生成API文档时，是否将该注解记录到API文档中。
@Inherited
这个注解是说，我们的注解是否需要被子类继承。是发生在子类和父类之间的一种注解。

注意：当我们的注解作用域是Element.TYPE时，我们定义在类上的注解可以被子类继承。但是如果我们注解的作用域是Element.METHOD时，并且父类的该方法被子类重写，那作用在父类的注解不会被子类继承。所以如果我们在接口的方法中定义的注解，永远不会被实现类继承，因为实现类一定会重写接口中的方法。

二、自定义注解校验逻辑的实现：

这里有两种实现方式，
一种是当注解仅仅作用在字段(属性)上生效时：可以在工具类中编写方法进行逻辑校验；
另一种是当注解作用在方法上生效时，可以使用@Constraint注解，指明了校验类，进行校验；

这里只实现第一种。

第一种：当自定义注解仅仅作用在字段上生效时，在工具类中编写方法进行逻辑校验(在工作中用的比较多)

public class ToolUtils {
    /**
     * 对象基础格式校验，针对带有valiInfo注解的属性
     * @param obj
     * @param ignoreFields 忽略校验的字段
     * @return: java.lang.StringBuffer
     * @author: chenzz
     * @date: 2020/4/22 23:36
     */
    public static StringBuffer valiObjStringField(Object obj, String[] ignoreFields) {
        StringBuffer errMsg = new StringBuffer();
        try {
            Set<String> ignoreFieldSet = new HashSet<>();
            ignoreFieldSet.add("class");
            if (null != ignoreFields) {
                for (String field : ignoreFields) {
                    if (StringUtils.isNotBlank(field)) {
                        ignoreFieldSet.add(field);
                    }
                }
            }
            PropertyDescriptor[] propertyDescriptors = BeanUtils.getPropertyDescriptors(obj.getClass());
            for (PropertyDescriptor targetPd : propertyDescriptors) {
                if (ignoreFieldSet.contains(targetPd.getName())) {
                    continue;
                }
                Method readMethod = targetPd.getReadMethod();
                if (!Modifier.isPublic(readMethod.getDeclaringClass().getModifiers())) {
                    readMethod.setAccessible(true);
                }
                Object value = readMethod.invoke(obj);
                ValiInfo valiInfo = obj.getClass().getDeclaredField(targetPd.getName()).getAnnotation(ValiInfo.class);
                if (null == valiInfo) {
                    continue;
                }
                String mean = valiInfo.mean();
                if (StringUtils.isBlank(mean)) {
                    mean = targetPd.getName();
                }
                // 空置校验
                boolean isBlank = null == value || StringUtils.isBlank(value.toString());
                if (valiInfo.notBlank()) {
                    if (isBlank) {
                        errMsg.append(String.format("【%s】不能为空；", mean));
                        continue;
                    }
                } else {
                    if (isBlank) {
                        continue;
                    }
                }
                // 如果是字符串才进行下面的校验
                if (!(value instanceof String)) {
                    continue;
                }
                String strValue = value.toString();
                // 长度校验 最小长度为0
                int len = strValue.length();
                if (len < valiInfo.minLen()) {
                    errMsg.append(String.format("【%s（%s）】长度不能小于%d个字符；", mean, strValue, valiInfo.minLen()));
                    continue;
                }
                // 最大长度为2147483647
                if (len > valiInfo.maxLen()) {
                    errMsg.append(String.format("【%s（%s）】长度不能超过%d个字符；", mean, strValue, valiInfo.maxLen()));
                    Method writeMethod = targetPd.getWriteMethod();
                    if (!Modifier.isPublic(writeMethod.getDeclaringClass().getModifiers())) {
                        writeMethod.setAccessible(true);
                    }
                    writeMethod.invoke(obj, strValue.substring(0, valiInfo.maxLen() - 1));
                    continue;
                }
                if (strValue.matches(valiInfo.illegalCharRegExp())) {
                    errMsg.append(String.format("【%s（%s）】中不能包含特殊字符；", mean, strValue));
                    continue;
                }
                if (StringUtils.isNotBlank(valiInfo.regexp()) && !strValue.matches(valiInfo.regexp())) {
                    errMsg.append(String.format("【%s（%s）】格式校验不通过；", mean, strValue));
                    continue;
                }
                // 校验是否存在汉字
                if (StringUtils.isNotBlank(valiInfo.regexpChinese())) {
                    char c[] = strValue.toCharArray();
                    Pattern pattern = Pattern.compile(valiInfo.regexpChinese());
                    boolean flag = false;
                    for (int i = 0; i < c.length; i++) {
                        Matcher matcher = pattern.matcher(String.valueOf(c[i]));
                        if (matcher.matches()) {
                            flag = true;
                        }
                    }
                    if (flag) {
                        errMsg.append(String.format("【%s（%s）】入参存在汉字；", mean, strValue));
                        continue;
                    }
                }
                // 码值校验
                if (StringUtils.isNotBlank(valiInfo.codeType())) {
                    if (DictUtil.isNotDict(valiInfo.codeType().toUpperCase(), strValue)) {
                        errMsg.append(String.format("【%s（%s）】不在代码表中；", mean, strValue));
                    }
                }
            }
            return errMsg;
        } catch (IllegalAccessException e) {
            throw new BisException(BusinessConst.CALL_FAIL_TYPE_JC, "对象数据格式校验失败!");
        } catch (InvocationTargetException e) {
            throw new BisException(BusinessConst.CALL_FAIL_TYPE_JC, "对象数据格式校验失败!");
        } catch (NoSuchFieldException e) {
            throw new BisException(BusinessConst.CALL_FAIL_TYPE_JC, "对象数据格式校验失败!");
        }
    }
}

三、使用自定义注解：

自定义校验注解在代码中的应用

1、在dto中使用：

@Data
public class PsnInsureInfoQueryDTO implements Serializable {
    private static final long serialVersionUID = -3173331123860803536L;

    /**
     * 缴费开始年月
     */
    @ValiInfo(mean = "缴费开始", minLen = 6, maxLen = 6, regexp = RegexpConst.REGEXP_YM)
    private String begnYm;

    /**
     * 单位编号
     */
    @ValiInfo(mean = "单位编号", minLen = 1, maxLen = 40, illegalCharRegExp = RegexpConst.ILLEGAL_CHAR_REGEXP_EMPNO, regexpChinese = RegexpConst.REGEXP_CHINESE)
    private String empNo;

    /**
     * 险种类型
     */
    @ValiInfo(mean = "险种类型", minLen = 1, maxLen = 3, codeType = "INSUTYPE", regexpChinese = RegexpConst.REGEXP_CHINESE)
    private String insutype;

    /**
     * 统筹区编码
     */
    @ValiInfo(mean = "统筹区编码", minLen = 6, maxLen = 6, codeType = "ADMDVS_PLC", regexpChinese = RegexpConst.REGEXP_CHINESE)
    private String poolarea;

    /**
     * 参保状态
     */
    @ValiInfo(mean = "参保状态", minLen = 1, maxLen = 3, codeType = "PSN_INSU_STAS", regexpChinese = RegexpConst.REGEXP_CHINESE)
    private String psnInsuStas;

    /**
     * 人员编号
     */
    @ValiInfo(mean = "人员编号", minLen = 1, maxLen = 36, notBlank = true, regexpChinese = RegexpConst.REGEXP_CHINESE, illegalCharRegExp = RegexpConst.ILLEGAL_CHAR_REGEXP_PSNNO)
    private String psnNo;
}

2、在代码中，通过调用valiObjStringField方法来进行校验：

//control层的方法
public ResultVO insertHmcYcx(@RequestBody HmcinfoDTO hmcinfoDTO){
    //.......其它逻辑
    
    //调用方法，进行自定义注解的校验
    String errorMsg = ToolUtils.valiObjStringField(hmcinfoDTO).toString();
    if (StringUtils.isNotBlank(errorMsg)) {
        log.info(errorMsg);
        return new ResultVO(errorMsg);
    }
    //.......其它逻辑
    ResultVO vo = hmcBPO.insertHmc(hmcinfoDTO);
    return vo;
}
【Java实战】使用自定义注解实现参数校验详解
~~~~~~~BUG FLY~~~~~~~~~
04-19 3761
由于实际开发中遇到大量相同的条件参数验证，不想写重复代码及让代码看起来更加优雅简洁，所以决定使用自定义注解进行参数校验Java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能，注解相关类都包含在java.lang.annotation包中其中参数校验的注解来自三方面，分别是javax.validation:validation-api，对应包javax.validation.constraints。
注解方式对常见参数进行校验 java
учёба
10-24 1516
在进行接口请求时，需要对入参进行校验，如下这时候便需要使用下面的这些注解，快速校验了。
java 自定义注解校验实体类属性
weixin_38860401的博客
09-09 1055
【代码】java 自定义注解校验实体类属性。
Spring Validation自定义校验完整指南：从基础到高级实践
最新发布
llwszx的博客
06-18 1594
在Java Web开发中，参数校验是保证系统安全性和数据一致性的重要环节。Spring Validation框架提供了强大的内置校验功能，但面对复杂的业务规则，我们需要通过自定义校验来实现更灵活的验证逻辑。本文将深入解析Spring Validation自定义校验的核心原理与实战技巧，帮助开发者构建健壮的校验体系。
Java 自定义校验注解详解
菜鸟记录
07-11 4246
⏹Java 自定义校验注解详解
通过自定义spring invalidator注解校验数据合法性
Neo.Yang的专栏
09-20 1741
在项目中经常会对用户输入的数据，或者外部导入的数据做合法性检查。在spring boot框架的服务中可以使用invalidator注解对数据做合法性，安全性做校验。下面给一个样例说明如何自定注解实现校验逻辑。 一、定义校验属性字符串长度的注解 package com.elon.springbootdemo.manager.invalidator; import java.lang.annotat...
Java自定义校验注解
pig_boss的博客
08-29 1427
​ JSR303 是一套JavaBean参数校验的标准，它定义了很多常用的校验注解，我们可以直接将这些注解加在我们JavaBean的属性上面(面向注解编程的时代)，就可以在需要校验的时候进行校验了,在SpringBoot中已经包含在starter-web中,再其他项目中可以引用依赖,并自行调整版本--springboot 新版本需要validation启动器-->当框架提供的注解无法满足我们的需求时，我们就可以自定义注解进行校验。
java 自定义注解验证
02-23
java 自定义注解验证 可自己添加所需要的注解，本案例中只写了三个自定义注解类 本案例只花了半天时间，如有不好之处请多提提意见。谢谢！
自定义校验注解
lgy_lucky的博客
11-18 1474
API开发中经常会遇到一些对请求数据进行验证的情况，这时候如果使用注解就有两个好处。 一是验证逻辑和业务逻辑分离，代码清晰； 二是验证逻辑可以轻松复用，只需要在要验证的地方加上注解就可以。 以后开发过程中，关于参数合法性的校验，如果有已实现的注解（例如@NotNull、@NotEmpty等）可以直接使用，没有现成的可用，尽量使用自定义注解，使得业务逻辑与校验分离，校验逻辑复用，代码结构清晰。 需求：接收一个Student对象，并希望对象里的age域的值是奇数。下面以此需求为例，解析自定义校验注解。
Java 自定义验证注解
Carry_Z的博客
06-01 261
Java 自定义验证注解
java实现自定义校验注解
abc1932513663的博客
11-28 1036
java自定义校验注解 是元注解，可以修饰其他注解，可以修饰其他注解，如果一注解没有被@Documented修饰，最终生成的文档中不会带此注解。
JAVA中通过自定义注解进行数据验证的方法
08-27
java 自定义注解验证可自己添加所需要的注解，下面这篇文章主要给大家介绍了关于JAVA中通过自定义注解进行数据验证的相关资料，文中通过示例代码介绍的非常详细，需要的朋友可以参考借鉴，下面随着小编来一起学习学习吧
自定义校验注解框架(validator)
04-18
自定义注解参数校验框架，根据项目开发中参数校验情况手写一套框架，供大家学习参考使用。可以直接运用在项目中，如果漏洞请留言，小编会第一时间修复，如果好用请给个好评，谢谢。
Java 自定义注解实现简单的白名单 入参出参打印等
weixin_45330393的博客
08-08 392
Java 自定义注解实现简单的白名单 入参出参打印等 AOP
JAVA——通过自定义注解实现每次程序启动时，自动扫描被注解的方法，获取其路径及访问该路径所需的权限并写入数据库
weixin_56039103的博客
09-20 3216
在需要扫描的微服务项目中新建一个自定义注解，因为这里定义的注解用于鉴权，因此给该注解取名叫做MyAccessControlAnnotation//@Retention--用于指定注解保留范围：SOURCE源码 --> CLASS字节码 --> RUNTIME运行 @Retention(RetentionPolicy . RUNTIME) //@Target--用于标记这个注解应该是哪种 Java 成员，METHOD用于放方法头上 @Target({
Validation--自定义校验
m0_52228992的博客
01-13 606
这边以State为例，创建注解参考@NotEmpty设计我们的注解////Class
springboot通过自定义注解实现AOP角色权限校验
崔向阳@李晓的博客
04-02 2462
通过SpringBoot自定义注解实现AOP角色权限校验之前，首先先要了解一下注解的基本知识： Annotation是Java重要的组成部分，从J2SE 5.0时代就已经存在了。在我们的代码中，我们随处可以看到许多注解，例如@Autowired、@Override、@Service。这些注解我们可能非常熟悉，但是注解的作用、工作原理、工作方式以及我们如何自定义注解，我们可能并不熟悉。下面将逐步介...
【java】实现自定义注解校验——方法二
m0_46459413的博客
11-07 1247
如图是我们自定义的一个年龄注解，message是该注解校验失败时的提示信息，default是默认值，我们可以重写该提示信息。下面两行代码是自定义注解需要加上的，这里不作研究。这里有两种实现方式，一种是当注解仅仅作用在字段(属性)上生效时：可以在工具类中编写方法进行逻辑校验；另一种：使用@Constraint注解，指明了校验类，进行校验，这里只实现第二种。自定义校验注解在代码中的应用////Class
springboot自定义数据校验注解
02-06
### 创建和使用自定义数据校验注解 在 Spring Boot 中实现自定义数据校验注解涉及几个主要步骤，包括创建约束注解、编写验证逻辑以及应用该注解到需要校验的地方。 #### 定义自定义注解 首先，需定义一个新的注解用于标记待检验的属性。此操作可通过 `Constraint` 和其他元注解完成： ```java import javax.validation.Constraint; import javax.validation.Payload; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Target; @Target({ ElementType.FIELD, ElementType.METHOD }) @Retention(RetentionPolicy.RUNTIME) @Constraint(validatedBy = MyCustomValidator.class) // 指定对应的验证器类 public @interface MyCustom { String message() default "Invalid value"; Class<?>[] groups() default {}; Class<? extends Payload>[] payload() default {}; } ``` 上述代码片段展示了如何声明名为 `MyCustom` 的新注解[^1]。 #### 实现 ConstraintValidator 接口 接着要为这个新的注解提供具体的验证行为，这通常意味着扩展 `ConstraintValidator<A,T>` 类型并重写其方法： ```java import javax.validation.ConstraintValidator; import javax.validation.ConstraintValidatorContext; public class MyCustomValidator implements ConstraintValidator<MyCustom, String> { @Override public void initialize(MyCustom constraintAnnotation) {} @Override public boolean isValid(String value, ConstraintValidatorContext context) { if (value == null || "".equals(value.trim())) return false; // Add custom validation logic here. return true; // Replace with actual condition check } } ``` 这段程序说明了怎样构建一个简单的字符串有效性检查函数[^2]。 #### 应用自定义注解于实体或 DTO 属性之上 一旦完成了前面两步的工作，则可以直接把刚刚建立好的注解放置在任何希望执行相应规则的位置上： ```java public class UserDTO { private Long id; @MyCustom(message="The username must be valid.") private String userName; // Getters and setters... } ``` 这里展示了一个假设性的场景——即对用户名进行了额外的有效性检测[^3]。 #### 配置与测试 最后一步就是确保应用程序上下文中包含了必要的 Bean 来处理这些新增加的功能；对于大多数情况而言，默认配置已经足够支持基本功能。可以通过单元测试来确认一切正常运作： ```java @SpringBootTest class CustomValidationTests { @Autowired Validator validator; @Test void testValidUserDto(){ UserDTO user = new UserDTO(); Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); assertFalse(violations.isEmpty()); } @Test void testInValidUserDto(){ UserDTO user = new UserDTO(); user.setUserName("validUsername"); Set<ConstraintViolation<UserDTO>> violations = validator.validate(user); assertTrue(violations.isEmpty()); } } ``` 以上示例演示了如何利用 JUnit 测试框架来进行简单有效的集成测试[^4]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值