java注解基础

    java注解在实际代码编写中有很强大的作用，当它与反射机制相结合使用时，其优雅的解决方案也令我折服，在此对Java注解做个笔记摘要，以下内容大部分来自阅读《java编程思想》，如果你想了解的更清楚，建议直接阅读这本书。

    

注解也称为元数据，它为我们在代码中添加信息提供了一种形式化的方法，是我们的某个时刻可以很方便的使用这些带有注解的数据。

  注解语法还是比较简单的，除@符号之外，基本与java固有语法一致。JavaSE5内置了三种，定义在java.lang中的注解：

• @Override,这是一个编译时注解，表示当前的方法定义将覆盖超类中的方法。如果你不小心拼写错误，或者方法签名对不上被覆盖的方法，编译器就会发出错误提示。
• @Deprecated，如果程序员使用了注解为它的元素，那么编译器会发出警告信息。
• @suppressWarnings,关闭不当的编译器警告信息。在JavaSE5之前版本中，也可以使用该注解，不过会被忽略不起作用。

• @SafeVarargs，JDK 7 专门为抑制“堆污染”警告提供的。

除了上面内置的几种标准注解，Java还有四种元注解，元注解专职负责注解其他类型：

• @Retention

注解的值一共有三种：

1. RetentionPolicy.SOURCE : 注解只存在于源码中，不会存在于.class文件中，在编译时会被忽略掉
2. RetentionPolicy.CLASS：注解只存在于.class文件中，在编译期有效，但是在运行期会被忽略掉，这也是默认范围
3. RetentionPolicy.RUNTIME：在运行期有效，JVM在运行期通过反射获得注解信息

• @Target

注解用来约束自定义注解可以注解Java的哪些元素，有以下几种：

1. ElementType.CONSTRUCTOR构造器的声明。
2. ElementType.FIELD域声明（包括enum实例）
3. ElementType.LOCAL_VARIABLE局部变量声明
4. ElementType.METHOD方法声明
5. ElementType.PACKAGE包声明
6. ElementType.PARAMETER参数声明
7. ElementType.TYPE类，接口（包括注解类型）或enum声明

• @Documented

将此注解包含在Javadoc中。

• @Inherited

允许子类继承父类中的注解。

 

    下面给出实际的一些代码demo。假设有个场景，你想跟踪项目中的用例，以便更好的跟踪项目进度以及在修改业务逻辑时更好维护，你可以定义一个简单的注解。

package annotation;

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


@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)

public @interface UseCase {
    public int id();
    public String description() default "no description";
}

在下面的类中有三个被注解的用例：

package annotation;

import java.util.List;

public class PasswordUtils {
    @UseCase(id = 1, description = "password must contain at least one numeric")
    public boolean validatePassword(String password) {
        return (password.matches("\\w*\\d\\w*"));
    }

    @UseCase(id = 2)
    public String encryptPassword(String password) {
        return new StringBuilder(password).reverse().toString();
    }

    @UseCase(id = 3, description = "new password can't equal previously used ones ")
    public boolean checkForNewPassword(List<String> prevPasswords, String password) {
        return !prevPasswords.contains(password);
    }
}

在上面的代码都写完之后你还需要写一个注解处理器来处理，要不然注解也不会自己发挥作用。这里就要结合java的反射机制一起使用，下面你将看到它的强大与优美之处。

package annotation;

//import org.junit.jupiter.api.Test;

import java.lang.reflect.Method;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;

public class UseCaseTracker {
    public static void trackUseCases(List<Integer> useCases, Class<?> cl) {
        //获取对应类的声明的方法数组
        for (Method m : cl.getDeclaredMethods()) {
            //使用getAnnotation传入参数获取对应注解信息
            UseCase useCase = m.getAnnotation(UseCase.class);
            if (useCase != null) {
                System.out.println("Found use case : " + useCase.id() + " " + useCase.description());

                //从List移除找到的对应id的元素
                useCases.remove(new Integer(useCase.id()));
            }
        }

        //打印没找到的对应id
        for (int i : useCases) {
            System.out.println("usecase can't found id : " + i);
        }
    }

    public static void main(String[] args) {
        List<Integer> useCases = new ArrayList<>();
        Collections.addAll(useCases, 1, 2, 3, 4);
        trackUseCases(useCases, PasswordUtils.class);

    }


}

下面是输出信息：

至此你可以看到上面追踪了用例，并打印的信息了。这就是一个注解的简单使用例子了，麻雀虽小，五脏俱全，你也可以简单试下。

转载于:https://my.oschina.net/itazi/blog/1815987