Java自定义注解

java注解是附加在代码中的一些元信息，用于一些工具在编译、运行时进行解析和使用，起到说明、配置的功能。
注解不会也不能影响代码的实际逻辑，仅仅起到辅助性的作用。包含在 java.lang.annotation 包中。

1、元注解

元注解是指注解的注解。包括 @Retention @Target @Document @Inherited四种。

1.1、@Retention: 定义注解的保留策略

@Retention(RetentionPolicy. SOURCE) //注解仅存在于源码中，在class字节码文件中不包含

@Retention(RetentionPolicy. CLASS) // 默认的保留策略，注解会在class字节码文件中存在，但运行时无法获得，

@Retention(RetentionPolicy.RUNTIME) // 注解会在class字节码文件中存在，在运行时可以通过反射获取到

1.2、@Target：定义注解的作用目标

其定义的源码为：

[java] view plain copy

1. @Documented
2. @Retention(RetentionPolicy.RUNTIME)
3. @Target(ElementType.ANNOTATION_TYPE)
4. public@interfaceTarget{
5. ElementType[]value();
6. }

@Target(ElementType.TYPE) // 接口、类、枚举、注解

@Target(ElementType.FIELD) // 字段、枚举的常量

@Target(ElementType.METHOD) // 方法

@Target(ElementType.PARAMETER) // 方法参数

@Target(ElementType.CONSTRUCTOR) // 构造函数

@Target(ElementType.LOCAL_VARIABLE) // 局部变量

@Target(ElementType.ANNOTATION_TYPE) // 注解

@Target(ElementType.PACKAGE)/ // 包

由以上的源码可以知道，他的elementType可以有多个，一个注解可以为类的，方法的，字段的等等

1.3、@Document：说明该注解将被包含在javadoc中

1.4、@Inherited：说明子类可以继承父类中的该注解

2、java 注解的自定义

下面是自定义注解的一个例子

[java] view plain copy

1. @Documented
2. @Target({ElementType.TYPE,ElementType.METHOD})
3. @Retention(RetentionPolicy.RUNTIME)
4. public@interfaceYts{
5. publicenumYtsType{util,entity,service,model}
7. publicYtsTypeclassType()defaultYtsType.util;
8. }

[java] view plain copy

1. @Documented
2. @Retention(RetentionPolicy.RUNTIME)
3. @Target(ElementType.METHOD)
4. @Inherited
5. public@interfaceHelloWorld{
6. publicStringname()default"";
7. }

@Retention(RetentionPolicy.RUNTIME)

定义的这个注解是注解会在class字节码文件中存在，在运行时可以通过反射获取到。

@Target({ElementType.TYPE,ElementType.METHOD})

因此这个注解可以是类注解，也可以是方法的注解

这样一个注解就自定义好了，当然注解里面的成员可以为基本的数据类型，也可以为数据，Object等等

3 注解是定义好了，那么怎么来得到，解析注解呢？

java的反射机制可以帮助，得到注解，代码如下：

[java] view plain copy

1. publicclassParseAnnotation{
3. publicvoidparseMethod(Classclazz)throwsIllegalArgumentException,IllegalAccessException,InvocationTargetException,SecurityException,NoSuchMethodException,InstantiationException{
4. Objectobj=clazz.getConstructor(newClass[]{}).newInstance(newObject[]{});
5. for(Methodmethod:clazz.getDeclaredMethods()){
6. HelloWorldsay=method.getAnnotation(HelloWorld.class);
7. Stringname="";
8. if(say!=null){
9. name=say.name();
10. method.invoke(obj,name);
11. }
12. Ytsyts=(Yts)method.getAnnotation(Yts.class);
13. if(yts!=null){
14. if(YtsType.util.equals(yts.classType())){
15. System.out.println("thisisautilmethod");
16. }else{
17. System.out.println("thisisaothermethod");
18. }
19. }
20. }
21. }
22. @SuppressWarnings("unchecked")
23. publicvoidparseType(Classclazz)throwsIllegalArgumentException,IllegalAccessException,InvocationTargetException{
24. Ytsyts=(Yts)clazz.getAnnotation(Yts.class);
25. if(yts!=null){
26. if(YtsType.util.equals(yts.classType())){
27. System.out.println("thisisautilclass");
28. }else{
29. System.out.println("thisisaotherclass");
30. }
31. }
32. }
34. }

前一个方法是解析得到方法注解的，后一个方法是得到类注解的

以下是测试方法类

[java] view plain copy

1. @Yts(classType=YtsType.util)
2. publicclassSayHell{
4. @HelloWorld(name="小明")
5. @Yts
6. publicvoidsayHello(Stringname){
7. if(name==null||name.equals("")){
8. System.out.println("helloworld!");
9. }else{
10. System.out.println(name+"sayhelloworld!");
11. }
12. }
13. }

[html] view plain copy

1. publicstaticvoidmain(String[]args)throwsIllegalArgumentException,IllegalAccessException,InvocationTargetException,SecurityException,NoSuchMethodException,InstantiationException{
2. ParseAnnotationparse=newParseAnnotation();
3. parse.parseMethod(SayHell.class);
4. parse.parseType(SayHell.class);
5. }

转载地址：http://blog.youkuaiyun.com/yixiaogang109/article/details/7328466

使用注解

在一般的Java开发中，最常接触到的可能就是@Override和@SupressWarnings这两个注解了。使用@Override的时候只需要一个简单的声明即可。这种称为标记注解（marker annotation ），它的出现就代表了某种配置语义。而其它的注解是可以有自己的配置参数的。配置参数以名值对的方式出现。使用 @SupressWarnings的时候需要类似@SupressWarnings({"uncheck", "unused"})这样的语法。在括号里面的是该注解可供配置的值。由于这个注解只有一个配置参数，该参数的名称默认为value，并且可以省略。而花括号则表示是数组类型。在JPA中的@Table注解使用类似@Table(name = "Customer", schema = "APP")这样的语法。从这里可以看到名值对的用法。在使用注解时候的配置参数的值必须是编译时刻的常量。

从某种角度来说，可以把注解看成是一个XML元素，该元素可以有不同的预定义的属性。而属性的值是可以在声明该元素的时候自行指定的。在代码中使用注解，就相当于把一部分元数据从XML文件移到了代码本身之中，在一个地方管理和维护。

开发注解

在一般的开发中，只需要通过阅读相关的API文档来了解每个注解的配置参数的含义，并在代码中正确使用即可。在有些情况下，可能会需要开发自己的注解。这在库的开发中比较常见。注解的定义有点类似接口。下面的代码给出了一个简单的描述代码分工安排的注解。通过该注解可以在源代码中记录每个类或接口的分工和进度情况。

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface Assignment {
    String assignee();
    int effort();
    double finished() default 0;
} 

@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型。可以通过default来声明参数的默认值。在这里可以看到@Retention和@Target这样的元注解，用来声明注解本身的行为。@Retention用来声明注解的保留策略，有CLASS、RUNTIME和SOURCE这三种，分别表示注解保存在类文件、JVM运行时刻和源代码中。只有当声明为RUNTIME的时候，才能够在运行时刻通过反射API来获取到注解的信息。@Target用来声明注解可以被添加在哪些类型的元素上，如类型、方法和域等。