Java注解简单学习

Posted 2020-10-04

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Java注解简单学习相关的知识，希望对你有一定的参考价值。

注解（也被称作元数据）为我们在代码中添加信息提供了一种形式化的方法，使我们在稍后某个时刻可以很方便的使用这些数据，其在一定程度上将元数据与源代码文件结合在一起，而不是保存在外部文档中。

注解使我们可以用将来由编译器测试和验证的格式，存储程序有关的额外信息。注解可以用来生成描述符文件，甚至是新的类定义，并且有助于减轻编写“样板”代码的负担。通过使用注解，将元数据保存在Java源代码中，并利用annotation API为注解构造处理工具来读取注解。

Java目前只内置了三种标准注解，以及四种元注解。元注解专职负责注解其他注解。大多数时候，程序员都是定义自己的注解，并编写自己的注解处理器来处理他们。

技术分享

一个简单的注解例子

注解定义：

1 import java.lang.annotation.*;
2 
3 @Target(ElementType.METHOD)                    //定义注解用于什么地方
4 @Retention(RetentionPolicy.RUNTIME)          //定义注解在哪个级别可用
5 public @interface UseCase {
6   public int id();
7   public String description() default "no description";
8 }

在注解中，一般都会包含一些元素以表示某些值。当分析处理注解时，程序或工具可以利用这些值。注解的元素看起来就像接口的方法，唯一的区别就是你可以为其制定默认值。没有元素的注解成为标记注解。

使用注解：

 1 import java.util.*;
 2 
 3 public class PasswordUtils {
 4   @UseCase(id = 47, description = "Password must contain at least one numeric")
 5   public boolean validataPassword(String password) {
 6     return (password.matches("\\\\w*\\\\d\\\\w*"));
 7   }
 8     
 9   @UseCase(id = 48)
10   public String encryptPassword(String password) {
11     return new StringBuilder(password).reverse().toString();
12   }
13     
14   @UseCase(id = 49, description = "New password can‘t equal previously used ones")
15   public boolean checkForNewPassword(List<String> prevPasswords, String password) {
16     return !prevPasswords.contains(password);
17   }
18 }

注解@UseCase可以与任何修饰符共同作用于方法，例如public、static或void。从语法角度看，注解的使用方式几乎与修饰符的使用一模一样。注解的定义很像接口的定义，注解与其他任何Java接口一样，会被编译成class文件。

编写注解处理器：

 1 import java.lang.reflect.*;
 2 import java.util.*;
 3 
 4 public class UseCaseTracker {
 5   public static void trackUseCases(List<Integer> useCases, Class<?> cl) {
 6     for (Method m : cl.getDeclaredMethods()) {
 7       UseCase uc = m.getAnnotation(UseCase.class);
 8       if (uc != null) {
 9         System.out.println("Found Use Case:" + uc.id() + " " + uc.description());
10         useCases.remove(new Integer(uc.id()));            
11       }
12     }
13     for (int i : useCases) {
14       System.out.println("Warning:Missing use case-" + i);
15     }
16   }
17   public static void main(String[] args) {
18     List<Integer> useCases = new ArrayList<Integer>();
19     Collections.addAll(useCases, 47, 48, 49, 50);
20     trackUseCases(useCases, PasswordUtils.class);
21   }    
22 }