Java高级进阶-注解

什么是注解

注解是用来对Java代码进行注释和解释的一种标识，这种标识同时可以被用来传递参数和信息，它的本质是元数据，即代码的元数据。简单来说，我们可以将注解理解成标签，标签有自己的格式和属性，注解也是一样。

注解的作用

• 生成文档
• 跟踪代码依赖性，实现替代配置文件功能，减少配置。
• 在编译时进行格式检查，如@Overload

注解分类及使用

• 元注解：用来对其它注解进行注解.Java5.0定义了四个标准的meta-annotation类型来对其它注解进行说明。

  • @Target（ElementType）
    • @Target说明了Annotation所修饰的对象范围：Annotation可被用于 packages、types（类、接口、枚举、Annotation类型）、类型成员（方法、构造方法、成员变量、枚举值）、方法参数和本地变量（如循环变量、catch参数）。在Annotation类型的声明中使用了target可更加明晰其修饰的目标。

      作用：用于描述注解的使用范围。

      ElementType取值有：
      1.CONSTRUCTOR:用于描述构造器
      2.FIELD:用于描述域
      3.LOCAL_VARIABLE:用于描述局部变量
      4.METHOD:用于描述方法
      5.PACKAGE:用于描述包
      6.PARAMETER:用于描述参数
      7.TYPE:用于描述类、接口(包括注解类型) 或enum声明
      参考代码：

    @Retention(value={ElementType.FIELD,ElementType.METHOD})
    Public @interface SimpleAnnotation{
         String value();
    }
  

  • @Retention（RetentionPolicy）
    • @Retention定义了该annotation保留时间的长短；某些annotation仅出现在源代码中，而被编译器丢弃，而另一些却被编译在class文件中；编译在class文件中的Annotation可能会被虚拟机忽略，而另一些在class被装载时将被读取（请注意并不影响class的执行，因为Annotation与class在使用上是被分离的）。使用这个meta-Annotation可以对 Annotation的“生命周期”限制。

    作用：表示需要在什么级别保存该注释信息，用于描述注解的生命周期（即：被描述的注解在什么范围内有效）

    RetentionPolicy取值：
    1.SOURCE:在源文件中有效（即源文件保留）
    2.CLASS:在class文件中有效（即class保留）
    3.RUNTIME:在运行时有效（即运行时保留）
    参考代码：

    @Retention(value=RetentionPolicy.RUNTIME)
    Public @interface SimpleAnnotation{
         String value();
    }
  

  • @Documented
    • @Documented用于描述其它类型的annotation应该被作为被标注的程序成员的公共API，因此可以被例如javadoc此类的工具文档化。Documented是一个标记注解，没有成员。
  • @Inherited
    • @inherited用来标记某个类是继承的，被他自己的子类所继承；类并不从它所实现的接口继承annotation，方法并不从它所重载的方法继承annotation。
      参考代码：

  @Inherited
  public @interface Greeting {
    public enum FontColor{ BULE,RED,GREEN};
    String name();
    FontColor fontColor() default FontColor.GREEN;
  }
  

• jdk注解
  jdk注解用处广泛，在我们编写程序时，我们常常会遇到一些编译时的错误无法解决，很可能是因为没有遵循一些java规范，这时通过注解我们就可以很清晰的找到编译可能出错点，根据注解对应的规则进行修改。

  • @override
    • 重写注解，一般放在方法上，标示该方法一定要重写父类的方法方能通过编译。
  • @overload
    • 重载注解，用于方法重载说明，编译通过必须遵循重载规则。
  • @Deprecated
    • 过时的，一般用来指示某个方法或者变量命名已经过时，将会有新的方法代替。
  • @SupressWarnings
    • 用来去除编译时产生的警告，例如泛型的使用不当，类型转换错误，对象的强转是会产生一些警告，这是通过注解可以将这些警消除，方便我们更好的完善代码。

• 自定义注解

自定义注解格式

public @interface 注解名{
  定义体
}

用@interface自定义注解时，自动继承了java.lang.annotation.Annotation接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。@interface用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过default来声明参数的默认值。

自定义注解注解参数支持数据类型

• 四类八种数据类型
• String
• enum
• class
• Annotation

注意：自定义注解参数值不可为空，必须是确定的，当只有一个值时，用value作为名字。自定义注解只能被public和默认的权限修饰符所修饰。

另外，自定义注解通常会用来传参，在自定义的注解中放入值，然后通过反射获取所有注解值在传递到某些方法中。在学习javaweb项目过程中，配置servlet文件时可以用注解直接进行配置，最后在注解中的值就是访问的url，这个值就是作为参数进行传递。
参考代码：

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

@Target(value={ElementType.FIELD,ElementType.TYPE,ElementType.METHOD})
@Retention(value=RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
    String name();  
    String value(); //用来创建参数
}

package com.annotation;

@MyAnnotation(name="kevin", value = "576")
public class User {
    @MyAnnotation(name = "Jack", value = "123")
    private String username;
    private String password;
    public User() {
        super();
    }
    public User(String username, String password) {
        super();
        this.username = username;
        this.password = password;
    }
    @MyAnnotation(name = "tom", value = "456")
    public String getUsername() {
        return username;
    }
    public void setUsername(String username) {
        this.username = username;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    @Override
    public String toString() {
        return "User [username=" + username + ", password=" + password + "]";
    }
}

import java.lang.annotation.Annotation;
import java.lang.reflect.Field;

public class AnnotationTest {

    public static void main(String[] args) throws NoSuchFieldException, SecurityException {
        // TODO Auto-generated method stub
        User user = new User();
        Class clazz = user.getClass(); 
        Annotation[] annotation = clazz.getAnnotations();//获取类中所有注解
        for (Annotation annotation2 : annotation) {      //进行遍历
            System.out.println(annotation2.annotationType());
        }
        Field field = clazz.getDeclaredField("username");  //获取指定属性上的注解并得到值
        MyAnnotation annotation1 = field.getAnnotation(MyAnnotation.class);
        System.out.println(annotation1.value());
    }
}

注解处理器

有待补充。。。。