注解是Java引入的一项提供了一种结构化的,并且具有类型检查能力的新功能,这使得程序员能够为代码加入元数据,而不会导致代码杂乱且难以阅读。
自从java有了注解,使得spring等框架变的更受欢迎了,它使我们的编码体验发生了巨大改变。
java中有一些自带的注解,例如@Override,@SuppressWarnings等,但是,很多小伙伴不知道如何创建注解,这里我们就来了解一下。
假如我们要创建一个@helloworld的注解,首先需要:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {}
其中需要使用元注解(即定义注解的注解,这是jdk定义好的)定义此注解的基本信息。@Target用来定义此注解将应用于什么地方(方法或域)。@Rectetion用来定义该注解在哪一个级别可用,SOURCE(在源代码中),CLASS(类文件),RUNTIME(运行时)。
在空注解的基础上加入两个类似方法的定义:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface UseCase {
public int id();
public String description() default "no description";
}
public class PasswordUtils {
@UseCase(id = 47,description = "密码必须包含数字")
public boolean vaPass(String pass){
return (pass.matches("\\w*\\d\\w*"));
}
@UseCase(id = 48)
public String enPass(String pass){
return new StringBuilder(pass).reverse().toString();
}
@UseCase(id = 49,description = "新密码不能等于使用过的密码")
public boolean checkNPass(List<String> prevPass,String pass) {
return !prevPass.contains(pass);
}
public static void main(String[] args) {
PasswordUtils pu = new PasswordUtils();
pu.vaPass("123");
}
}
注解的元素在使用时表现为名-值对的形式,如果没有使用id或description,那么将会用到其默认值(default)。id没有默认值,应该是不能没有值的。
元注解
java里面目前内置了四种元注解,专职负责注解其他的注解,一般程序员会定义自己的注解,并编写自己的处理器来处理它们。
四种元注解
编写注解处理器
使用注解时很重要的一个部分就是创建与使用注解处理器。我们可以使用反射这类工具,java 还提供了一个外部工具apt来帮助程序员解析带有注解的java源代码。
一个简单的注解处理器
public class UseCaseTracker {
public static void
trackUseCases(List<Integer> useCases,Class<?> cl) {
for(Method m : cl.getDeclaredMethods()) {
UseCase uc = m.getAnnotation(UseCase.class);
if(uc != null) {
System.out.println("Found Use Case:" + uc.id()
+" " +uc.description());
useCases.remove(new Integer(uc.id()));
}
}
for(int i : useCases) {
System.out.println("Warning: Missing use case-" + i);
}
}
public static void main(String[] args) {
List<Integer> useCases = new ArrayList<Integer>();
Collections.addAll(useCases, 47,48,49,50);
trackUseCases(useCases, PasswordUtils.class);
}
}
getDeclaredMethods()方法返回类的方法。
getAnnotation()方法返回指定类型的注解对象,在本文中就是UseCase。如果被注解的方法上没有该类型的注解,则返回null值。