@Target :修饰了该注解的使用范围 包括packager types(类,接口,枚举, Annotation类型)类型成员(方法,构造方法,成员变量,枚举值)
具体的值有:
CONSTRUCTOR: 用在描述构造器。
FIELD: 用于描述域字段
LOCAL_VARIABLE: 用于描述局部变量
METHOD: 用于描述方法
PACKAGE: 用于包
PARAMTER: 用于描述参数
TYPE: 用于描述类,接口(包括注解类型)或者enum声明
@Retention:修饰了该自定义注解被保留的时间长短,一部分注解仅出现在源代码中,一部分却被便以在class文件中,编译在class中的文件可能被虚拟机忽略掉
另一部分呢被装载时被读取。使用该注解可以对描述该注解的生命周期。具体的值有:
SOURCE:在源码中有效。
CLASS: 在class文件中有效。
RUNTIME:在运行时有效。
@Documented: 用于描述其他类型的的annotation应该被作为被标注的程序员的公共API,可以被此类的工具文档化,例如 javadoc。是一个标记注解,没有成员。
@Inherited: 元注解是一个标记注解,如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
@Inherited annotation 类型被标注过的classable的子类所继承
@interface用来声明一个注解,其中每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型只能是基本类型【int,float,boolean,double,byte,char,long,short】,class String ,enum,annotatio和类型数组。
可以通过default来声明参数的配置默认值。 参数设定时候,只能用public 或者默认的default来修饰。如果只有一个参数成员,最好把他设置为value 后加上小括号。
说到这里我们需要在说明一下,注解元素必须有确定的默认值,一般情况下使用默认的空字符串或者0,或者-1这些特殊的字符来表示,绕开了系统的约束,这也是一个习惯性的做法。
注解实例:定义了一个判断手机号是否符合大陆手机号的规则注解。
@Ducumented
@Constraint(validatedBt = CellphoneValidator.class)
@Target({METHOD,FIELD})
@Retention(RetentionPolicy.RUNTIME)
@NotEmpt
public @interface Cellphone{
String message() default "{com.yangtianrui.message is unvalid}";
Class<?>[] groups() default{};
Class<? extends Payload> [] payload() default{};
}
public class CellphoneValidator implements ConstraintValidator<Cellphone,String>{
@Autowried private ValidatorService validatorService;
@Override
public void initialize(Cellphone Cellphone){
}
@Override
public boolean isValid(String value ,ConstraintValidatorContext context){
if(StringUtils.isBlank(value)){
return false;
}
if(!validatorService.isCellphone(value)){
return true;
}
}
}
// 校验手机是否符合规则的service
@service
public class ValidatorService{
private static final Pattern PATTERN_CELLPHONE = Pattern.complile(""(^(13\\d|15[^4,\\D]|17[13678]|18\\d)\\d{8}|170[^346,\\D]\\d{7})$"");
// 校验该手机是否是大陆的手机号
public boolean isCellphone(String cellphpne){ return PATTERN_CELLPHONE.matcher(cellphpne).matches();}
}
具体用法:
在定义一个请求体的时候可以做一下判断
@Cellphone
private String newContactCellphone; // 会返回该字段是否是一个大陆手机号
具体的值有:
CONSTRUCTOR: 用在描述构造器。
FIELD: 用于描述域字段
LOCAL_VARIABLE: 用于描述局部变量
METHOD: 用于描述方法
PACKAGE: 用于包
PARAMTER: 用于描述参数
TYPE: 用于描述类,接口(包括注解类型)或者enum声明
@Retention:修饰了该自定义注解被保留的时间长短,一部分注解仅出现在源代码中,一部分却被便以在class文件中,编译在class中的文件可能被虚拟机忽略掉
另一部分呢被装载时被读取。使用该注解可以对描述该注解的生命周期。具体的值有:
SOURCE:在源码中有效。
CLASS: 在class文件中有效。
RUNTIME:在运行时有效。
@Documented: 用于描述其他类型的的annotation应该被作为被标注的程序员的公共API,可以被此类的工具文档化,例如 javadoc。是一个标记注解,没有成员。
@Inherited: 元注解是一个标记注解,如果一个使用了@Inherited修饰的annotation类型被用于一个class,则这个annotation将被用于该class的子类。
@Inherited annotation 类型被标注过的classable的子类所继承
@interface用来声明一个注解,其中每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称,返回值类型只能是基本类型【int,float,boolean,double,byte,char,long,short】,class String ,enum,annotatio和类型数组。
可以通过default来声明参数的配置默认值。 参数设定时候,只能用public 或者默认的default来修饰。如果只有一个参数成员,最好把他设置为value 后加上小括号。
说到这里我们需要在说明一下,注解元素必须有确定的默认值,一般情况下使用默认的空字符串或者0,或者-1这些特殊的字符来表示,绕开了系统的约束,这也是一个习惯性的做法。
注解实例:定义了一个判断手机号是否符合大陆手机号的规则注解。
@Ducumented
@Constraint(validatedBt = CellphoneValidator.class)
@Target({METHOD,FIELD})
@Retention(RetentionPolicy.RUNTIME)
@NotEmpt
public @interface Cellphone{
String message() default "{com.yangtianrui.message is unvalid}";
Class<?>[] groups() default{};
Class<? extends Payload> [] payload() default{};
}
public class CellphoneValidator implements ConstraintValidator<Cellphone,String>{
@Autowried private ValidatorService validatorService;
@Override
public void initialize(Cellphone Cellphone){
}
@Override
public boolean isValid(String value ,ConstraintValidatorContext context){
if(StringUtils.isBlank(value)){
return false;
}
if(!validatorService.isCellphone(value)){
return true;
}
}
}
// 校验手机是否符合规则的service
@service
public class ValidatorService{
private static final Pattern PATTERN_CELLPHONE = Pattern.complile(""(^(13\\d|15[^4,\\D]|17[13678]|18\\d)\\d{8}|170[^346,\\D]\\d{7})$"");
// 校验该手机是否是大陆的手机号
public boolean isCellphone(String cellphpne){ return PATTERN_CELLPHONE.matcher(cellphpne).matches();}
}
具体用法:
在定义一个请求体的时候可以做一下判断
@Cellphone
private String newContactCellphone; // 会返回该字段是否是一个大陆手机号