「java参数检验注解」java自定义注解实现数据校验

博主：adminadmin 2022-12-10 14:00:09 68

今天给各位分享java参数检验注解的知识，其中也会对java自定义注解实现数据校验进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

SpringBoot Validation参数校验 详解自定义注解规则和分组校验

Hibernate Validator 是 Bean Validation 的参考实现 。Hibernate Validator 提供了 JSR 303 规范中所有内置 constraint 的实现，除此之外还有一些附加的 constraint

在日常开发中，Hibernate Validator经常用来验证bean的字段，基于注解，方便快捷高效。

在SpringBoot中可以使用@Validated，注解Hibernate Validator加强版，也可以使用@Valid原来Bean Validation java版本

Bean Validation 中内置的 constraint

colgroup style="box-sizing: border-box;"col style="box-sizing: border-box;"col style="box-sizing: border-box;"/colgroup

Hibernate Validator 附加的 constraint

message支持表达式和EL表达式 ，比如message = "姓名长度限制为{min}到{max} ${1+2}")

想把错误描述统一写到properties的话，在classpath下面新建

ValidationMessages_zh_CN.properties文件(注意value需要转换为unicode编码)，然后用{}格式的占位符

hibernate补充的注解中，最后3个不常用，可忽略。

主要区分下@NotNull @NotEmpty @NotBlank 3个注解的区别：

如果同一个参数，需要在不同场景下应用不同的校验规则，就需要用到分组校验了。比如：新注册用户还没起名字，我们允许name字段为空，但是在更新时候不允许将名字更新为空字符。

分组校验有三个步骤：

自定义的Update分组接口继承了Default接口。校验注解(如： @NotBlank)和@validated默认其他注解都属于Default.class分组，这一点在

javax.validation.groups.Default注释中有说明

在编写Update分组接口时，如果继承了Default，下面两个写法就是等效的：

@Validated({Update.class}),@Validated({Update.class,Default.class})

如果Update不继承Default，@Validated({Update.class})就只会校验属于Update.class分组的参数字段

如果 UserVO 类中增加一个 OrderVO 类的属性，而 OrderVO 中的属性也需要校验，就用到递归校验了，只要在相应属性上增加@Valid注解即可实现（对于集合同样适用）

validation 为我们提供了这么多特性，几乎可以满足日常开发中绝大多数参数校验场景了。但是，一个好的框架一定是方便扩展的。有了扩展能力，就能应对更多复杂的业务场景，毕竟在开发过程中，唯一不变的就是变化本身。 Validation允许用户自定义校验

实现很简单，分两步：

注意:message用于显示错误信息这个字段是必须的，groups和payload也是必须的

@Constraint(validatedBy = {

HandsomeBoyValidator.class})用来指定处理这个注解逻辑的类

注意这里验证逻辑我抽出来单独写了一个工具类，ValidatorUtil

我自定义了补充了很多验证器，包括日期验证，枚举验证，手机号验证，金额验证

自定义校验注解使用起来和内置注解无异，在需要的字段上添加相应注解即可

使用 Validation API 进行参数效验步骤整个过程如下图所示，用户访问接口，然后进行参数效验 ，如果效验通过，则进入业务逻辑，否则抛出异常，交由全局异常处理器进行处理

全局异常出来请参考我这篇文章SpringBoot优雅的全局异常处理

使用自定义注解做参数必填的校验

import java.lang.annotation.ElementType;

import java.lang.annotation.Retention;

import java.lang.annotation.RetentionPolicy;

import java.lang.annotation.Target;

@Target(ElementType.FIELD)

@Retention(RetentionPolicy.RUNTIME)

public @interface ParamsRequired {

/**

    * 必须参数

    * @return

    */

    boolean requrie()default true;

}

public class BaseDto {

public boolean validate(Object obj)throws Exception {

Field[] fields = obj.getClass().getDeclaredFields();

    for (Field field : fields) {

if(field.isAnnotationPresent(ParamsRequired.class)) {

ParamsRequired paramsRequired = field.getAnnotation(ParamsRequired.class);

            if(paramsRequired.requrie()) {

// 如果类型是String

                if (field.getGenericType().toString().equals("class java.lang.String")) {// 如果type是类类型，则前面包含"class "，后面跟类名

                    // 拿到该属性的getter方法

                    Method m = obj.getClass().getMethod("get" + getMethodName(field.getName()));

                    String val = (String) m.invoke(obj);// 调用getter方法获取属性值

                    if(StringUtils.isEmpty(val)) {

throw new ApiException(field.getName() +"属性,不能为空!");

                    }

}else if (field.getGenericType().toString().equals("class java.lang.Integer")) {// 如果type是类类型，则前面包含"class "，后面跟类名

                    Method m = obj.getClass().getMethod("get" + getMethodName(field.getName()));

                    Integer val = (Integer) m.invoke(obj);// 调用getter方法获取属性值

                    if(StringUtils.isEmpty(val)) {

throw new ApiException(field.getName() +"属性,不能为空!");

                    }

}

// 设置字段可访问（必须，否则报错）

                field.setAccessible(true);

                Class curFieldType = field.getType();

                // 集合List元素

                if (List.class.equals(curFieldType)) {

// 当前集合的泛型类型

                    Type genericType = field.getGenericType();

                    if (null == genericType) {

continue;

                    }

if (genericTypeinstanceof ParameterizedType) {

    Method m = obj.getClass().getMethod("get" + getMethodName(field.getName()));

                        List objectList =  (List) m.invoke(obj);// 调用getter方法获取属性值

                        if (!ObjectUtils.isEmpty(objectList)) {

                            //循环遍历获取到数据

                            for (int i =0; i objectList.size(); i++) {

                                //递归循环查找

                                validate(objectList.get(i));

                            }

                    }

                }

            }

        }

    }

}

return true;

}

/**

* 把一个字符串的第一个字母大写、效率是最高的、

*/

private StringgetMethodName(String fildeName)throws Exception{

byte[] items = fildeName.getBytes();

    items[0] = (byte) ((char) items[0] -'a' +'A');

    return new String(items);

}

}

public class Student extends BaseDto {

@ParamsRequired

private String name;//姓名

private String gender;//性别

@ParamsRequired

private String age;//年龄

}

@Test

public void test11(){

Student  s=new Student();

s.setName="111";

try {

    s.validate(s);

}catch (Exception e) {

    e.printStackTrace();

    System.out.println(e.getMessage());

}

}

java开发中常用的注解有哪些

Java 注解全面解析，学习java做一个java工程师不但待遇高，而且前途无可限量。为什么这样说呢？因为java程序语言作为最流行的计算机开发语言之一，几乎所有的系统、软件、app、网页等都是需要用到java的。

1.基本语法

注解定义看起来很像接口的定义。事实上，与其他任何接口一样，注解也将会编译成class文件。

@Target(ElementType.Method)

@Retention(RetentionPolicy.RUNTIME)

public @interface Test {}

除了@符号以外，@Test的定义很像一个空的接口。定义注解时，需要一些元注解（meta－annotation），如@Target和@Retention

@Target用来定义注解将应用于什么地方（如一个方法或者一个域）

@Retention用来定义注解在哪一个级别可用，在源代码中（source），类文件中（class）或者运行时（runtime）

在注解中，一般都会包含一些元素以表示某些值。当分析处理注解时，程序可以利用这些值。没有元素的注解称为标记注解（marker annotation）

四种元注解，元注解专职负责注解其他的注解，所以这四种注解的Target值都是ElementType.ANNOTATION_TYPE

注解 说明

@Target 表示该注解可以用在什么地方，由ElementType枚举定义

CONSTRUCTOR：构造器的声明

FIELD：域声明（包括enum实例）

LOCAL_VARIABLE：局部变量声明

METHOD：方法声明

PACKAGE：包声明

PARAMETER：参数声明

TYPE：类、接口（包括注解类型）或enum声明

ANNOTATION_TYPE：注解声明（应用于另一个注解上）

TYPE_PARAMETER：类型参数声明（1.8新加入）

TYPE_USE：类型使用声明（1.8新加入）

PS：当注解未指定Target值时，此注解可以使用任何元素之上，就是上面的类型

@Retention 表示需要在什么级别保存该注解信息，由RetentionPolicy枚举定义

SOURCE：注解将被编译器丢弃（该类型的注解信息只会保留在源码里，源码经过编译后，注解信息会被丢弃，不会保留在编译好的class文件里）

CLASS：注解在class文件中可用，但会被VM丢弃（该类型的注解信息会保留在源码里和class文件里，在执行的时候，不会加载到虚拟机（JVM）中）

RUNTIME：VM将在运行期也保留注解信息，因此可以通过反射机制读取注解的信息（源码、class文件和执行的时候都有注解的信息）

PS：当注解未定义Retention值时，默认值是CLASS

@Documented 表示注解会被包含在javaapi文档中

@Inherited 允许子类继承父类的注解

2. 注解元素

– 注解元素可用的类型如下：

– 所有基本类型（int,float,boolean,byte,double,char,long,short）

– String

– Class

– enum

– Annotation

– 以上类型的数组

如果使用了其他类型，那编译器就会报错。也不允许使用任何包装类型。注解也可以作为元素的类型，也就是注解可以嵌套。

元素的修饰符，只能用public或default。

– 默认值限制

编译器对元素的默认值有些过分挑剔。首先，元素不能有不确定的值。也就是说，元素必须要么具有默认值，要么在使用注解时提供元素的值。

其次，对于非基本类型的元素，无论是在源代码中声明，还是在注解接口中定义默认值，都不能以null作为值。这就是限制，这就造成处理器很难表现一个元素的存在或缺失状态，因为每个注解的声明中，所有的元素都存在，并且都具有相应的值。为了绕开这个限制，只能定义一些特殊的值，例如空字符串或负数，表示某个元素不存在。

@Target(ElementType.Method)

@Retention(RetentionPolicy.RUNTIME)

public @interface MockNull {

public int id() default -1;

public String description() default “”;

}

3. 快捷方式

何为快捷方式呢？先来看下springMVC中的Controller注解

@Target({ElementType.TYPE})

@Retention(RetentionPolicy.RUNTIME)

@Documented

@Component

public @interface Controller {

String value() default “”;

}

可以看见Target应用于类、接口、注解和枚举上，Retention策略为RUNTIME运行时期，有一个String类型的value元素。平常使用的时候基本都是这样的：

@Controller(“/your/path”)

public class MockController { }

这就是快捷方式，省略了名－值对的这种语法。下面给出详细解释：

注解中定义了名为value的元素，并且在应用该注解的时候，如果该元素是唯一需要赋值的一个元素，那么此时无需使用名－值对的这种语法，而只需在括号内给出value元素所需的值即可。这可以应用于任何合法类型的元素，当然了，这限制了元素名必须为value。

4. JDK1.8注解增强

TYPE_PARAMETER和TYPE_USE

在JDK1.8中ElementType多了两个枚举成员，TYPE_PARAMETER和TYPE_USE，他们都是用来限定哪个类型可以进行注解。举例来说，如果想要对泛型的类型参数进行注解：

public class AnnotationTypeParameter@TestTypeParam T {}

那么，在定义@TestTypeParam时，必须在@Target设置ElementType.TYPE_PARAMETER，表示这个注解可以用来标注类型参数。例如：

@Target(ElementType.TYPE_PARAMETER)

@Retention(RetentionPolicy.RUNTIME)

public @interface TestTypeParam {}

ElementType.TYPE_USE用于标注各种类型，因此上面的例子也可以将TYPE_PARAMETER改为TYPE_USE，一个注解被设置为TYPE_USE，只要是类型名称，都可以进行注解。例如有如下注解定义：

@Target(ElementType.TYPE_USE)

@Retention(RetentionPolicy.RUNTIME)

public @interface Test {}

那么以下的使用注解都是可以的:

List@Test Comparable list1 = new ArrayList();

List? extends Comparable list2 = new ArrayList@Test Comparable();

@Test String text;

text = (@Test String)new Object();

java.util. @Test Scanner console;

console = new java.util.@Test Scanner(System.in);

PS：以上@Test注解都是在类型的右边，要注意区分1.8之前的枚举成员，例如：

@Test java.lang.String text;

在上面这个例子中，显然是在进行text变量标注，所以还使用当前的@Target会编译错误，应该加上ElementType.LOCAL_VARIABLE。

@Repeatable注解

@Repeatable注解是JDK1.8新加入的，从名字意思就可以大概猜出他的意思（可重复的）。可以在同一个位置重复相同的注解。举例：

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface Filter {

String [] value();

}

如下进行注解使用:

@Filter({“/admin”,”/main”})

public class MainFilter { }

换一种风格:

@Filter(“/admin”)

@Filter(“/main”)

public class MainFilter {}

在JDK1.8还没出现之前，没有办法到达这种“风格”，使用1.8，可以如下定义@Filter：

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

@Repeatable(Filters.class)

public @interface Filter {

String value();

}

@Target(ElementType.TYPE)

@Retention(RetentionPolicy.RUNTIME)

public @interface Filters {

Filter [] value();

}

实际上这是编译器的优化，使用@Repeatable时告诉编译器，使用@Filters来作为收集重复注解的容器，而每个@Filter存储各自指定的字符串值。

JDK1.8在AnnotatedElement接口新增了getDeclaredAnnotationsByType和getAnnotationsByType，在指定@Repeatable的注解时，会寻找重复注解的容器中。相对于，getDeclaredAnnotation和getAnnotation就不会处理@Repeatable注解。举例如下：

@Filter(“/admin”)

@Filter(“/filter”)

public class FilterClass {

public static void main(String[] args) {

ClassFilterClass filterClassClass = FilterClass.class;

Filter[] annotationsByType = filterClassClass.getAnnotationsByType(Filter.class);

if (annotationsByType != null) {

for (Filter filter : annotationsByType) {

System.out.println(filter.value());

}

}

System.out.println(filterClassClass.getAnnotation(Filter.class));

}

}

日志如下:

/admin

/filter

null

望采纳！

Java 什么是注解及注解原理详细介绍

1、注解是针对Java编译器的说明。

可以给Java包、类型(类、接口、枚举)、构造器、方法、域、参数和局部变量进行注解。Java编译器可以根据指令来解释注解和放弃注解，或者将注解放到编译后的生成的class文件中，运行时可用。

2、注解和注解类型

注解类型是一种特殊的接口类型，注解是注解注解类型的一个实例。

注解类型也有名称和成员，注解中包含的信息采用键值对形式，可以有0个或多个。

3、Java中定义的一些注解：

@Override 告诉编译器这个方法要覆盖一个超类方法，防止程序员覆盖出错。

@Deprecated 这个标识方法或类(接口等类型)过期，警告用户不建议使用。

@SafeVarargs JDK7新增，避免可变参数在使用泛型化时候警告”执行时期无法具体确认参数类型“，当然，也可以用@SuppressWarnings来避免检查，显然后者的抑制的范围更大。

@SuppressWarnings(value={"unchecked"}) 抑制编译警告，应用于类型、构造器、方法、域、参数以及局部变量。 value是类型数组，有效取值为：

all, to suppress all warnings

boxing, to suppress warnings relative to boxing/unboxing operations

cast, to suppress warnings relative to cast operations

dep-ann, to suppress warnings relative to deprecated annotation

deprecation, to suppress warnings relative to deprecation

fallthrough, to suppress warnings relative to missing breaks in switch statements

finally, to suppress warnings relative to finally block that don't return

hiding, to suppress warnings relative to locals that hide variable

incomplete-switch, to suppress warnings relative to missing entries in a switch statement (enum case)

javadoc, to suppress warnings relative to javadoc warnings

nls, to suppress warnings relative to non-nls string literals

null, to suppress warnings relative to null analysis

rawtypes, to suppress warnings relative to usage of raw types

restriction, to suppress warnings relative to usage of discouraged or forbidden references

serial, to suppress warnings relative to missing serialVersionUID field for a serializable class

static-access, to suppress warnings relative to incorrect static access

static-method, to suppress warnings relative to methods that could be declared as static

super, to suppress warnings relative to overriding a method without super invocations

synthetic-access, to suppress warnings relative to unoptimized access from inner classes

unchecked, to suppress warnings relative to unchecked operations

unqualified-field-access, to suppress warnings relative to field access unqualified

unused, to suppress warnings relative to unused code and dead code

4、注解的定义

使用 @interface 关键字声明一个注解

public @interface MyAnnotation1

注解中可以定义属性

String name default “defval”;

value是注解中的特殊属性

注解中定义的属性如果名称为 value， 此属性在使用时可以省写属性名

例如，声明一个注解：

@Retention(RetentionPolicy.RUNTIME)

public @interface MyAnno1 {

String msg();

int value();

}

java注解怎么验证参数和签名

一般接口为了安全需要，都会这么做。可能你的思路还不明确。我的做法是这样的，双方约定好，参数按特定顺序排列，比如按首字母的顺序排列，如url:;b=sd2354c=4signature=XXXXXXXXXXXX(signature为传入的签名)，你拿到入参后，将参数串a=wersdb=sd2354c=4按你们约定的签名规则，自己用md5加签一次，然后和入参的signature值对比，以确认调用者是否合法，这就是接口签名验证的思路。

希望有帮到你，记得采纳。

如何使用java validation api进行参数校验

JAVA中通过Hibernate-Validation进行参数验证

在开发JAVA服务器端代码时，我们会遇到对外部传来的参数合法性进行验证，而hibernate-validator提供了一些常用的参数校验注解，我们可以拿来使用。

1.maven中引入hibernate-validator对应的jar：

dependency

groupIdorg.hibernate/groupId

artifactIdhibernate-validator/artifactId

version4.3.1.Final/version

/dependency

2.在Model中定义要校验的字段（即该字段不能为空，并且最大长度为14）：

import javax.validation.constraints.Size;

import org.hibernate.validator.constraints.NotEmpty;

public class PayRequestDto {

/**

* 支付完成时间

**/

@NotEmpty(message="支付完成时间不能空")

@Size(max=14,message="支付完成时间长度不能超过{max}位")

private String payTime;

public String getPayTime() {

return payTime;

}

public void setPayTime(String payTime) {

this.payTime = payTime;

}

}

3.定义Validation工具类：

import java.util.Set;

import javax.validation.ConstraintViolation;

import javax.validation.Validation;

import javax.validation.Validator;

import org.hibernate.validator.HibernateValidator;

import com.atai.framework.lang.AppException;

public class ValidationUtils {

/**

* 使用hibernate的注解来进行验证

*

*/

private static Validator validator = Validation

.byProvider(HibernateValidator.class).configure().failFast(true).buildValidatorFactory().getValidator();

/**

* 功能描述: br

* 〈注解验证参数〉

*

* @param obj

* @see [相关类/方法](可选)

* @since [产品/模块版本](可选)

*/

public static T void validate(T obj) {

SetConstraintViolationT constraintViolations = validator.validate(obj);

// 抛出检验异常

if (constraintViolations.size() 0) {

throw new AppException("0001", String.format("参数校验失败:%s", constraintViolations.iterator().next().getMessage()));

}

}

}

4.在代码中调用工具类进行参数校验：

ValidationUtils.validate(requestDto);

以下是对hibernate-validator中部分注解进行描述：

@AssertTrue 用于boolean字段，该字段只能为true

@AssertFalse 该字段的值只能为false

@CreditCardNumber 对信用卡号进行一个大致的验证

@DecimalMax 只能小于或等于该值

@DecimalMin 只能大于或等于该值

@Digits(integer=,fraction=) 检查是否是一种数字的整数、分数,小数位数的数字

@Email 检查是否是一个有效的email地址

@Future 检查该字段的日期是否是属于将来的日期

@Length(min=,max=) 检查所属的字段的长度是否在min和max之间,只能用于字符串

@Max 该字段的值只能小于或等于该值

@Min 该字段的值只能大于或等于该值

@NotNull 不能为null

@NotBlank 不能为空，检查时会将空格忽略

@NotEmpty 不能为空，这里的空是指空字符串

@Null 检查该字段为空

@Past 检查该字段的日期是在过去

@Pattern(regex=,flag=) 被注释的元素必须符合指定的正则表达式

@Range(min=,max=,message=) 被注释的元素必须在合适的范围内

@Size(min=, max=) 检查该字段的size是否在min和max之间，可以是字符串、数组、集合、Map等

@URL(protocol=,host,port) 检查是否是一个有效的URL，如果提供了protocol，host等，则该URL还需满足提供的条件

@Valid 该注解主要用于字段为一个包含其他对象的集合或map或数组的字段，或该字段直接为一个其他对象的引用，这样在检查当前对象的同时也会检查该字段所引用的对象

关于java参数检验注解和java自定义注解实现数据校验的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。

The End

发布于：2022-12-10，除非注明，否则均为首码项目网原创文章，转载请注明出处。

标签：