Java 自定义注解

1.注解说明：参考文档如下

Annotation是从JDK5.0开始引入的新技术。
• Annotation的作用：
– 不是程序本身，可以对程序作出解释。
– 可以被其他程序(比如：编译器等)读取。(注解信息处理流程，是注解和注释的重大区别。如果没有注解信息处理流程，则注解毫无意义)
• Annotation的格式：
– 注解是以“@注释名”在代码中存在的，还可以添加一些参数值，例如：@SuppressWarnings(value="unchecked")。
• Annotation在哪里使用?
– 可以附加在package, class, method, field等上面，相当于给它们添加了额外的辅助信息，我们可以通过反射机制编程实现对这些元数据的访问。

2.自定义注解
• 使用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口
• 要点：
– @interface用来声明一个注解
• 格式为：
– public @interface 注解名 {定义体}
– 其中的每一个方法实际上是声明了一个配置参数。
– 方法的名称就是参数的名称
– 返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）
– 可以通过default来声明参数的默认值。
– 如果只有一个参数成员，一般参数名为value
• 注意：注解元素必须要有值。我们定义注解元素时，经常使用空字符串、0作为默认值。也经常使用负数(比如：-1)表示不存在的含义

3.Java内置常用注解

   @Override，表示当前的方法定义将覆盖超类中的方法。

   @Deprecated，使用了注解为它的元素编译器将发出警告，因为注解@Deprecated是不赞成使用的代码，被弃用的代码。

   @SuppressWarnings，关闭不当编译器警告信息。

 4.元注解

元注解的作用就是负责注解其他注解。 Java定义了4个标准的meta-annotation类型，它们被用来提供对其它 annotation类型作说明。
• 这些类型和它们所支持的类在java.lang.annotation包中可以找到
– @Target：用于描述注解的使用范围（即:被描述的注解可以用在什么地方）

     注解（annotation）可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在注解类型的声明中使用了target可更加明晰其修饰的目标。取值(ElementType)有：

ElementType.ANNOTATION_TYPE 可以应用于注释类型。

ElementType.CONSTRUCTOR 可以应用于构造函数。

ElementType.FIELD 可以应用于字段或属性。

ElementType.LOCAL_VARIABLE 可以应用于局部变量。

ElementType.METHOD 可以应用于方法级注释。

ElementType.PACKAGE 可以应用于包声明。

ElementType.PARAMETER 可以应用于方法的参数。

ElementType.TYPE 可以应用于类的任何元素。

ElementType.TYPE_PARAMETER//Type parameter declaration@since 1.8

ElementType.TYPE_USE//Use of a type@since 1.8

– @Retention：表示需要在什么级别保存该注释信息，用于描述注解的生命周期

RetentionPoicy.SOURCE:在源文件中有效（即源文件保留）

RetentionPoicy.CLASS:在class文件中有效（即class保留）

RetentionPoicy.RUNTIME:在运行时有效（即运行时保留）

– @Documented:将注解包含在Javadoc中
– @Inherited:允许子类继承父类中的注解

5.自定义注解实现

注解只有一个成员时，按规范写成value()。如果不设置默认值，那么使用注解时必须要传值。

只有类可以被注解，接口或者抽象类并不能被注解。

package com.stu.java.annotation;

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

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface StuField {
    String name();
    String type();
    int length();
}

package com.stu.java.annotation.bean;

import com.stu.java.annotation.StuField;
public class EmailUser {
    @StuField(name="name",type="varchar",length=16)
    private String name；
}

package com.stu.java.annotation;

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
public class Test {

    public static void main(String[] args) {
        try {
            Class<?> clazz=Class.forName("com.stu.java.annotation.bean.EmailUser");
            //获得类的属性的注解
            Field field=clazz.getDeclaredField("name");
            StuField stuField=field.getAnnotation(StuField.class);
            System.out.println(stuField.name()+"/"+stuField.type());
        } catch (Exception e) {
            e.printStackTrace();
        }

    }

}