Java注解元数据注解分类内置注解和自定义注解

jiezi

5 年前

大家好，我是乐字节的小乐，上次说过了 Java 多态的 6 大特性 | 乐字节，接下来我们来看看 Java 编程里的注解。

Java 注解有以下几个知识点：

元数据
注解的分类
内置注解
自定义注解
注解处理器
Servlet3.0

本文先介绍前面 4 个知识点：元数据、注解的分类、内置注解、自定义注解。

注解是 Java 1.5 引入的，目前已被广泛应用于各种 Java 框架，如 Hibernate，Jersey，

Spring。注解相当于是一种嵌入在程序中的元数据，可以使用注解解析工具或编译器对

其进行解析，也可以指定注解在编译期或运行期有效。

在注解诞生之前，程序的元数据存在的形式仅限于 java 注释或 javadoc，但注解可以提

供更多功能，它不仅包含元数据，还能作用于运行期，注解解析器能够使用注解决定处

理流程。

Annotation(注解)就是 Java 提供了一种元程序中的元素关联任何信息和任何元数据

(metadata)的途径和方法。Annotation 是一个接口，程序可以通过反射来获取指定

程序元素的 Annotation 对象，然后通过 Annotation 对象来获取注解里面的元数据。

注解 API 非常强大，被广泛应用于各种 Java 框架，如 Spring，Hibernate，JUnit。

元数据从 metadata 一词译来，就是“关于数据的数据”的意思，即描述数据的结构信息。元数据的功能作用有很多，比如：你可能用过 Javadoc 的注释自动生成文档。这就是元数据功能的一种。总的来说，元数据可以用来创建文档，跟踪代码的依赖性，执行编译时格式检查，代替已有的配置文件。

在 Java 中元数据以标签的形式存在于 Java 代码中，元数据标签的存在并不影响程序代码的编译和执行，被用来生成其它的文件或只在运行时知道被运行代码的描述信息。

其作用如下:

①生成文档：这是最常见的，也是 java 最早提供的注解。常用的有 @param @return 等;

② 跟踪代码依赖性，实现替代配置文件功能。常见的是 spring 2.5 开始的基于注解配置。作用就是减少配置。现在的框架基本都使用了这种配置来减少配置文件的数量。;

③在编译时进行格式检查。如 @override 放在方法前，如果你这个方法并不是覆盖了超类方法，则编译时就能检查出。

根据注解参数的个数:

1)、标记注解: 一个没有成员定义的 Annotation 类型被称为标记注解。

2)、单值注解: 只有一个值

3)、完整注解: 拥有多个值

根据注解使用方法和用途:

1)、JDK 内置系统注解

2)、元注解

3)、自定义注解

JavaSE 中内置三个标准注解，定义在 java.lang 中：

限定重写父类方法，若想要重写父类的一个方法时，需要使用该注解告知编译器我们正在重写一个方法。如此一来，当父类的方法被删除或修改了，编译器会提示错误信息；或者该方法不是重写也会提示错误。

public interface Car {void run();
}
class QQ implements Car{
    @Override
    public void run() {}
}
class Bmw implements Car{
    @Override
    void run() {}
}

QQ 类编译不会有任何问题，Bmw 类在编译的时候会提示相应的错误。父类中省略了 public abstract 修饰符。@Override 注解只能用于方法，不能用于其他程序元素。

标记已过时，当我们想要让编译器知道一个方法已经被弃用 (deprecate) 时，应该使用这个注解。Java 推荐在 javadoc 中提供信息，告知用户为什么这个方法被弃用了，以及替代方法是什么；

/**
 *  Deprecated --> 该方法过时(有更好的解决方案)
 * @author Administrator
 */
public class TestDeprecated {
    @Deprecated
    public int test(){System.out.println("TestDeprecated.test()");
        return 0;
    }
    public void test(int a){System.out.println("TestDeprecated.test(int)");
    }
}

抑制编译器警告，该注解仅仅告知编译器，忽略它们产生了特殊警告。如：在 java 泛型中使用原始类型。其保持性策略 (retention policy) 是 SOURCE，在编译器中将被丢弃。

@interface: 用来声明一个注解。注解类里的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型。可以通过 default 来声明参数的默认值。

@interface Simple{
// 这里定义了一个空的注解，它能干什么呢？我也不知道，但他能用。后面有补充
}

/**
 * SuppressWarnings 压制警告
 * @author Administrator
 */
public class TestSuppressWarnings {public static void main(String[] args) {@SuppressWarnings("unused")
        List<String> list =new ArrayList<String>();}
    @SuppressWarnings("rawtypes") // 没有定义范型
    public static List test(){return new ArrayList();
    }
}

元注解的作用就是负责注解其他注解。Java5.0 定义了 4 个标准的 meta-annotation 类型，它们被用来提供对其它 annotation 类型作说明。Java5.0 定义的元注解有四个，

这些类型和它们所支持的类在 java.lang.annotation 包中可以找到。

@Target

用于描述注解的使用范围（即：被描述的注解可以用在什么地方）。表示支持注解的程序元素的种类，一些可能的值有 TYPE, METHOD, CONSTRUCTOR, FIELD 等等。如果 Target 元注解不存在，那么该注解就可以使用在任何程序元素之上。

取值 (ElementType) 有：

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

此时在空注解中加入 @Target 元注解如:

// 此注解只能用在方法上
@Target(ElementType.METHOD)
@interface TestMethod {}
@Retention

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

取值 (RetentionPoicy) 有：

1.SOURCE: 在源文件中有效（即源文件保留）
2.CLASS: 在 class 文件中有效（即 class 保留）
3.RUNTIME: 在运行时有效（即运行时保留）

此时在上述注解中加入 @Retention 元注解如:

// 此注解可以用于注解类、接口(包括注解类型) 或 enum 声明
@Target(ElementType.TYPE)
// 该注解运行时有效。注解处理器可以通过反射，获取到该注解的属性值，从而去做一些运行时的逻辑处理
@Retention(RetentionPolicy.RUNTIME)
@interface TestRn{
}

@Documented

表示使用该注解的元素应被 javadoc 或类似工具文档化，它应用于类型声明，类型声明的注解会影响客户端对注解元素的使用。如果一个类型声明添加了 Documented 注解，那么它的注解会成为被注解元素的公共 API 的一部分，@Documented 是一个标记注解。

// 可以被例如 javadoc 此类的工具文档化
@Documented
@interface TestDoc{
}
@Inherited

表示一个注解类型会被自动继承，如果用户在类声明的时候查询注解类型，同时类声明中也没有这个类型的注解，那么注解类型会自动查询该类的父类，这个过程将会不停地重复，直到该类型的注解被找到为止，或是到达类结构的顶层（Object）。

// 被子类继承的注解
@Inherited
@interface TestInheri{}

使用 @interface 自定义注解时，自动继承了 java.lang.annotation.Annotation 接口，由编译程序自动完成其他细节。在定义注解时，不能继承其他的注解或接口。

⑴定义注解格式：

@interface 用来声明一个注解，其中的每一个方法实际上是声明了一个配置参数。方法的名称就是参数的名称，返回值类型就是参数的类型（返回值类型只能是基本类型、Class、String、enum）。可以通过 default 来声明参数的默认值。

public @interface 注解名{定义体 s}

⑵注解参数(即方法)

注解里面的每一个方法实际上就是声明了一个配置参数，其规则如下:

①修饰符

只能用 public 或默认 (default) 这两个访问权修饰，默认为 default

②类型

注解参数只支持以下数据类型：

基本数据类型（int,float,boolean,byte,double,char,long,short)；

String 类型；

Class 类型；

enum 类型；

Annotation 类型;

以上所有类型的数组

③命名

对取名没有要求，如果只有一个参数成员, 最好把参数名称设为 ”value”, 后加小括号。

④参数

注解中的方法不能存在参数

⑤默认值

可以包含默认值，使用 default 来声明默认值。

⑶实例如下

/*
 * 码农定义注解
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface Programmer{String value() default "马云";
}
/**
 * 码农类型注解
 * @author peida
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface ProgrammerType {
    /**
     * 类型枚举  程序猿 射鸡师
     */
    public enum CoderType{MONKEYS,LION,CHOOK};
    /**
     * 颜色属性
     */
    CoderType type() default CoderType.MONKEYS;}
/**
 * 码农制造厂
 * @author Administrator
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@interface ProgrammerProductor {
    /**
     * 厂家编号
     * @return
     */
    public int id() default -1;
    /**
     * 厂家名称
     * @return
     */
    public String name() default "shsxt"; 
    /**
     * 厂家地址
     * @return
     */
    public String address() default "上海";}
/**
 * 注解使用
*/
class Coder{@Programmer("老裴")
        private String coderName;
        @ProgrammerType(type=CoderType.MONKEYS)
        private String coderType;
        @ProgrammerProductor(id=1,name="程序猿乐园",address="荣乐东路")
        private String coderProductor;
        public String getCoderName() {return coderName;}
        public void setCoderName(String coderName) {this.coderName = coderName;}
        public String getCoderType() {return coderType;}
        public void setCoderType(String coderType) {this.coderType = coderType;}
        public String getCoderProductor() {return coderProductor;}
        public void setCoderProductor(String coderProductor) {this.coderProductor = coderProductor;}    
}

乐字节原创，转载请注明出处

Java注解元数据注解分类内置注解和自定义注解

一、注解简介

二、元数据 metadata

三、注解的分类

四、内置注解

1、@Override

2、@Deprecated

3、@SuppressWarnings

五、自定义注解

1、简单入门

2、元注解

3、深入自定义注解