Osheep

时光不回头,当下最重要。

由浅入深 带你了解 JAVA 注解

在学习注解之前,我首先来讲一讲学习注解的好处,不管下面看不看,先打个鸡血先。不过确定的是,在正常 JAVA 开发中,自己写注解是比较少的,更多的情况就是使用第三方库的注解,正因为如此,大多数开发者对于注解仅仅停留在会用的地步。试想一下,当大多数人都不会的时候你会,那么你是不是就超越的大部分人。除此之外,我还总结学习注解的3大好处:

  1. 能够读懂别人写的代码,特别是框架相关的代码;
  2. 让编程更加简洁,代码更加清晰;
  3. 让别人高看一眼,装逼利器;

说完了这些,下面就开始真干货了。

注解概念

JDK 5中引入了源代码中的注解(annotation)这一机制。 注解使得Java源代码中不但可以包含功能性的实现代码,还可以添加元数据。 注解的功能类似于代码中的注释,所不同的是注解不是提供代码功能的说明,而是实现程序功能的重要组成部分。

Java中常见注解

对于常见注解,单单看在开发 JAVA 时 IDE 弹出的那些注解就能了解到,对于JDK 的注解,我们是要非常熟悉才行。

JDK自带注解

  • @Override
  • @Deprecated
  • @Suppvisewarnings

常见第三方注解

  • Spring

    • @Autowired
    • @Service
    • @Repository
  • Mybatis

    • @InsertProvider
    • @UpdateProvider
    • @Options

注解的分类

按照运行机制分类

  • 源码注解 (注解只在源码中存在,编译成.class文件就不存在了)
  • 编译时注解 (注解在源码和.class文件中都存在,上面的3个JDK注解都是编译时注解)
  • 运行时注解 (在运行阶段还起作用,甚至会影响运行逻辑的注解,例如 @Autowired

按照来源分类

  • 来自JDK的注解
  • 来自第三方的注解
  • 自定义注解

元注解

给注解使用的注解

自定义注解

下面是一个典型的注解声明,大家先看个大概,下面会对定义注解的注意事项做个说明:

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface Description {
    String desc();
    String author();
    int age() default 18;
}
  1. 使用@interface关键字定义注解
  2. 成员(变量)以无参数无异常方式声明
  3. 可以用default为成员指定一个默认值
  4. 注解中成员的类型是受限制的,合法的类型包括基本数据类型以及 StringClassAnnotationEnumeration
  5. 如果注解只有一个成员,则成员名应该为value(),在使用时可以忽略成员名和赋值号(=
  6. 注解类可以没有成员,没有成员的注解称为标识注解
  7. 元注解,用于对注解进行的注解,例如Description注解上面的4个注解

常用元注解

Target

标识注解的作用域,作用域有以下几种,几乎包含了 JAVA 所有的类型:

  1. ElementType.CONSTRUCTOR:构造方法
  2. ElementType.FIELD:字段
  3. ElementType.LOCAL_VARIABLE:局部变量
  4. ElementType.METHOD:方法
  5. ElementType.PACKAGE:包
  6. ElementType.PARAMETER: 参数
  7. ElementType.TYPE:类、接口

例如上面例子中标识了Description可以用于对方法和类或接口进行注解:

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

Retention

标识注解的生命周期,有以下3种值:

  1. RetentionPolicy.SOURCE:只在源码显示,编译时会丢弃
  2. RetentionPolicy.CLASS:编译时会记录到class文件中,运行时会忽略
  3. RetentionPolicy.RUNTIME:运行时存在,可以通过反射读取

例如上面的例子中标识了Description可以记录到class文件中,但在运行时会忽略:

@Retention(RetentionPolicy.CLASS)

Inherited

标识性元注解,标识该注解允许子类进行继承。注意这里可不是注解的继承,注解之间也没有继承什么的。这里指的是如果一个类(不是接口)声明上使用了这个注解,那么当它的一个子类继承该类时,也会拥有与父类一样拥有该注解。

Documented

标识在生成 JAVA DOC 时会包含该注解

使用自定义注解

使用注解的语法:

@<注解名>(<成员名1>=<成员值1>, <成员名1>=<成员值1>, <成员名1>=<成员值1>, ...)

其中的成员名则对应了注解里的成员,例子:

@Description(desc="description", author="swifter", age=18)
public String getColor() {
    return "red";
}

上面只是个简单的例子,下面给出一个注解的详细使用方式,这也是在正常开发中会使用到的方式。对于注解,上面的代码中已经给出了一个声明,下面就写两个类来使用该注解。通过这两个例子,怎么使用注解就显而易见了。

第一个类 Person

@Description(desc="person interface", author="swifter")
public abstract class Person {
    @Description(desc="method getName", author="swifter")
    abstract String getName();
    abstract void doSomething();
}

第二个类 Child 继承自 Person

public class Child extends Person {

    @Override
    @Description(desc="child method getName", author="swifter")
    public String getName() {
        return "get child";
    }

    @Override
    public void doSomething() {
        System.out.println("do something in child class");
    }
}

解析注解

既然已经定义了注解,那么就应该考虑如何在代码中解析这个注解了。解析注解就是通过反射获取类、函数或成员上的运行时注解信息,从而实现动态控制程序运行的逻辑。
解析主要方式就是通过反射的途径,通过Class对象来获取注解,并拿到注解的字段再进行操作。例如下面的例子:

Class<Child> clazz = Child.class;

if(clazz.isAnnotationPresent(Description.class)) {
    Description description = clazz.getAnnotation(Description.class);
    System.out.println(description.desc()+" : "+description.author());
}

Method[] methods = clazz.getMethods();
for(Method method : methods) {
    if(method.isAnnotationPresent(Description.class)) {
        Description description = method.getAnnotation(Description.class);
        System.out.println(description.desc()+" : "+description.author());
    }
}

运行之后客户端会给出如下结果:

person interface : swifter
child method getName : swifter

其中第一行显示的是类上面的注解信息,第二行则显示的是方法上的注解信息。对于这两个注解的对象,在代码中可以看到,都是通过反射的形式拿到的。虽然说反射的方式在效率上比较慢,但是想想注解带来的优点,掌握注解还是有很大必要的。

点赞