Java-注解介绍

2020-02-16 Java Java 0 Comments

1. 什么是注解

Java 的官方文档是这么介绍的:

Annotations, a form of metadata, provide data about a program that is not part of the program itself. Annotations have no direct effect on the operation of the code they annotate.
Annotations have a number of uses, among them:
Information for the compiler : Annotations can be used by the compiler to detect errors or suppress warnings.
Compile-time and deployment-time processing : Software tools can process annotation information to generate code, XML files, and so forth.
Runtime processing : Some annotations are available to be examined at runtime.

翻译过来就是：注解是一种元数据形式，它可以为程序提供数据，但这些数据并不是程序本身的一部分。注解对代码的执行并没有任何直接的影响。注解通常有以下几个使用场景：

为编译器提供信息：注解可以被编译器用来检查错误，或者忽略警告。
编译时和发布时处理：一些软件工具可以通过处理注解信息来生成代码，xml 文件等。
运行时处理：有些注解可以在运行时被使用。

说实话，我看了这个解析，觉得跟没说一样，我个人认为，比较糟糕的技术文档主要特征之一就是：用专业名词来介绍专业名词。对于一个不知道注解是什么东西的人，你跟他说元数据，这不是扯蛋嘛。
在经过学习，整理，并自已运用注解实现了一个简易的 ORM　框架之后，我才明白了注解是什么，它的使用场景是什么。我个人的理解：注解是一种标签(tag)系统，　这里我们用博客文章来作类比。如果这篇文章是代码程序，我给这篇文章打了一个标签 Java，那么这个 Java 标签我们就可以理解为一个注解。一篇文章可以打多个标签，一段代码，也可以使用多个注解。标签本身对这篇文章没有任何影响，但我可以根据标签来对文章进行分类。注解本身对代码也没有任何影响，但我们要以编写注解处理器来处理注解生成代码或者其他处理。

2. 注解的使用场景

注解的使用可以说是无处不在，如果你是 Java　语言的使用者，我相信你一定用过。下面根据官方文档列举的几个场景举些例子。

为编译器提供信息

public class MainActivity extends AppCompatActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
    }
}

这个 @Override 就是一个给编译器提供信息的注解了，我们常见的还有 @Deprecated, @SuppressWarnings　等。

1. 编译时自动生成代码或者数据
  这种场景用得比较少，　一般是出于性能考虑，　因为运行时处理注解的话是要使用反射的，反射的性能比较差，为了尽可能的提高性能，所以把注解的处理放在编译期处理。Android 的　ORM　框架 GreenDao 就是一个典型。

运行时处理
这种使用场景就比较广泛了，
比如 ORM 框架 LiteOrm

@Table("test_model")
public class TestModel {
    // 指定自增，每个对象需要有一个主键
    @PrimaryKey(AssignType.AUTO_INCREMENT)
    private int id;
    // 非空字段
    @NotNull
    private String name;
    //忽略字段，将不存储到数据库
    @Ignore
    private String password;
    // 默认为true，指定列名
    @Default("true")
    @Column("login")
    private Boolean isLogin;
}

比如 Android View 注入框架 Butter Knife

class ExampleActivity extends Activity {
  @BindView(R.id.user) EditText username;
  @BindView(R.id.pass) EditText password;
  @BindString(R.string.login_error) String loginErrorMessage;
  @OnClick(R.id.submit) void submit() {
    // TODO call server...
  }
  @Override public void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);
    setContentView(R.layout.simple_activity);
    ButterKnife.bind(this);
    // TODO Use fields...
  }
}

web 服务开发的应用就更多了，这里就不列举了。我们只需要知道注解是一种很有用的工具就行。

3. 注解的基本用法

还是以一个简单的小 Demo 开始：

package qiushao.net;

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

//创建一个注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Table {
    String name();
    int version() default 1;
}

//使用这个注解
@Table(name = "person")
class Person {
    public int id;
    public String name;
}

public class App {
    //注解的解析处理
    public static void save(Object obj) throws NoSuchFieldException, IllegalAccessException {
        //通过反射获取注解信息，如果这个 obj 上有注解的话，返回对应的注解实例，没有的话，返回 null
        Class<?> claz = obj.getClass();
        Table table = claz.getAnnotation(Table.class);
        if (null == table) {
            System.out.println("no Table annotation on this object");
            return;
        }
        System.out.println("there is annotation on this object");
        System.out.println("table name = " + table.name() + ", table version = " + table.version());

        Field[] fields = claz.getFields();
        for (Field field : fields) {
            String fieldName = field.getName();
            Object fieldValue = field.get(obj);
            System.out.println(fieldName + " = " + fieldValue);
        }
    }

    public static void main(String[] args) throws NoSuchFieldException, IllegalAccessException {
        Person person = new Person();
        person.id = 1;
        person.name = "qiushao";
        save(person);
    }
}

运行结果如下：

there is annotation on this object
table name = person, table version = 1
id = 1
name = qiushao

通过上面的例子，我们展示了注解的一些最基本用法，比如创建注解，使用注解，解析注解信息等。接下来我们详细的讨论注解的各种功能具体用法。

4. 注解的定义

直接使用上面的例子来分析：

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Table {
    String name();
    int version() default 1;
}

注解通过 @interface关键字进行定义。它的形式跟接口很类似，不过前面多了一个 @ 符号。上面的代码就创建了一个名字为 Table 的注解。这个注解有两个成员变量 name 和 version。注解的成员变量定义形式跟普通的 java 类成员定义有点差别。它的定义形式为：变量类型　变量名() [default value];，感觉是同时定义了一个变量和一个与变量同名的方法，这一点可以从后面获取注解的成员变量信息用法(table.name())看出来。

@Target　@Retention　这两个叫做元注解。具体作用下面来介绍。

5. 元注解

元注解是可以注解到注解上的注解，或者说元注解是一种基本注解，它能够应用到其它的注解上面。元注解有@Retention、@Documented、@Target、@Inherited、@Repeatable，下面我们一一介绍。

5.1 @Retention

Retention 的英文意为保留期的意思。当 @Retention 应用到一个注解上的时候，它解释说明了这个注解的的存活时间。它的取值如下：

RetentionPolicy.SOURCE :注解只在源码阶段保留，在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS :注解只被保留到编译进行的时候，它并不会被加载到 JVM 中。
RetentionPolicy.RUNTIME :注解可以保留到程序运行的时候，它会被加载进入到 JVM 中，所以在程序运行时可以获取到它们。

5.2 @Target

Target 是目标的意思，@Target 指定了注解可以被使用的地方。它的取值如下：

ElementType.ANNOTATION_TYPE :可以给一个注解进行注解
ElementType.CONSTRUCTOR :可以给构造方法进行注解
ElementType.FIELD :可以给成员变量进行注解
ElementType.LOCAL_VARIABLE :可以给局部变量进行注解
ElementType.METHOD :可以给方法进行注解
ElementType.PACKAGE :可以给一个包进行注解
ElementType.PARAMETER :可以给一个方法内的参数进行注解
ElementType.TYPE :可以给一个类型进行注解，比如类、接口、枚举

比如我们标注　@Target(ElementType.TYPE)　后，这个注解就只能对类、接口、枚举进行注解了，不能对方法或者成员变量进行注解。

5.3 @Inherited

Inherited 是继承的意思，但是它并不是说注解本身可以继承，而是说如果一个超类被 @Inherited 注解过的注解进行注解的话，那么如果它的子类没有被任何注解应用的话，那么这个子类就继承了超类的注解。说的比较抽象。show you the code:

@Inherited
@Retention(RetentionPolicy.RUNTIME)
@interface Test {}

@Test
public class A {}

public class B extends A {}

注解 Test 被 @Inherited 修饰，之后类 A 被 Test 注解，类 B 继承 A,类 B 也拥有 Test 这个注解。

5.4 @Documented

表示拥有该注解的元素可通过javadoc此类的工具进行文档化。

5.5 @Repeatable

Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的，所以算是一个新的特性。什么样的注解会多次应用呢？通常是注解的值可以同时取多个。举个例子，一个人他既是程序员又是产品经理:

package qiushao.net;
import java.lang.annotation.*;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@interface Roles {
    Role[] value();
}

@Repeatable(Roles.class)
@interface Role {
    String role();
}

@Role(role = "Programmer")
@Role(role = "Product Manager")
class Person {
    public int id;
    public String name;
}

public class App {
    public static void save(Object obj) throws NoSuchFieldException, IllegalAccessException {
        Class<?> claz = obj.getClass();
        Roles roles = claz.getAnnotation(Roles.class);
        if (null != roles) {
            System.out.println("has Roles Annotation");
            for (Role role : roles.value()) {
                System.out.println(role);
            }
        }
    }

    public static void main(String[] args) throws NoSuchFieldException, IllegalAccessException {
        Person person = new Person();
        person.id = 1;
        person.name = "qiushao";
        save(person);
    }
}

运行结果如下：

1
2
3

has Roles Annotation
@qiushao.net.Role(role=Programmer)
@qiushao.net.Role(role=Product Manager)

6. 注解的提取

从前面的例子我们看到注解信息的提取是通过反射来获取的。我们可以通过　Class, Method, Field　对象来获取注解信息，有以下这些接口：

//当存在该元素的指定类型注解，则返回true，否则返回false
boolean	isAnnotationPresent(Class<? extends Annotation> annotationClass);
//返回此元素上存在的所有注解
Annotation[] getAnnotations();
//返回直接存在于此元素上的所有注解。
Annotation[] getDeclaredAnnotations();
//当存在该元素的指定类型注解，则返回相应注解，否则返回null
T getAnnotation(Class annotationClass);

我们已经学习了反射跟注解的基本使用方法了，这两个技术是实现 ORM 框架的一个基本要求，学以致用才能更深入的理解所学到的知识，所以我们可以自己尝试写个 ORM 框架来玩玩。DBHelper，　这个是我之前学习反射跟注解时写的一个练手项目，一个 Android ORM 框架。

本文链接： http://qiushao.net/2020/02/16/Java/Java-%E6%B3%A8%E8%A7%A3%E4%BB%8B%E7%BB%8D/

版权声明： 本博客所有文章除特别声明外，均采用 CC BY 4.0 CN协议许可协议。转载请注明出处！

秋少

Android system developer