关注“Java后端技术全栈”

回复“000”获取大量电子书

本文次要内容如下：

背景

当初曾经处于注解流行时代，注解@Override ，这个注解是再相熟不过了，还有@Controller、@RequestMapping、@Service.....

注解曾经是作为一个开发中必备的技能了。

如果在面试中被问到注解，说不出个123，就只能回去等告诉了。

什么是注解？

注解annotation是JavaSE5.0中新增性能。能够了解为注解是一种标记，这种标记能够在编译、类加载、运行时被读取，并执行相应的解决。

它能够增加到程序的任何元素上：包申明、类型申明、构造方法、一般办法、成员变量、参数。

注解的老大：

 package java.lang.annotation;    //是个接口    public interface Annotation {            boolean equals(Object obj);        int hashCode();         String toString();         //获取注解类型        Class<? extends Annotation> annotationType();    }

JDK自带为咱们提供了元注解，上面就来聊聊JDK的元注解。

元注解有哪些？

JDK为咱们提供五个元注解，位于java.lang.annotation 包目录下。别离为：

  • @Retention
  • @Target
  • @Documented
  • @Inherited
  • @Repeatable
Retention注解

字面翻译：

该注解就是定义该注解是作用于什么阶段。

编译、类加载、运行（应用最多）

注解源码：

 @Documented    @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.ANNOTATION_TYPE)    public @interface Retention {        /**         * Returns the retention policy.         * @return the retention policy         */        RetentionPolicy value();    }

保留策略

 package java.lang.annotation;    public enum RetentionPolicy {         SOURCE,         CLASS,         RUNTIME    }

SOURCE：只在Java源代码中，编译器编译的时候会把它间接抛弃。

CLASS：编译器将注解记录在.class文件中。当运行Java程序时，JVM不能获取注解信息。这是默认值。

RUNTIME：编译器将注解记录在.class文件中。当运行Java程序时，JVM也能获取注解信息。程序能够通过反射获取注解信息。

留神：如果应用该注解的时候必须指定value的值。

Target注解

字面意义为指标，上面来看看器源码：

 @Documented    @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.ANNOTATION_TYPE)    public @interface Target {        //元素类型        ElementType[] value();    }    public enum ElementType {         TYPE,         FIELD,         METHOD,         PARAMETER,         CONSTRUCTOR,         LOCAL_VARIABLE,         ANNOTATION_TYPE,         PACKAGE,         /** @since 1.8*/        TYPE_PARAMETER,        /** @since 1.8*/        TYPE_USE    }

Target注解是在申明创立一个注解的时候，批示该注解能够作用于程序中的哪些元素。

它里边也蕴含一个名为value的成员变量，value成员变量的值有如下几种

  • ANNOTATION_TYPE：指定以后注解只能润饰其它注解
  • CONSTRUCTOR：指定以后注解只能润饰构造方法
  • FIELD：指定以后注解只能润饰成员变量
  • LOCAL_VARIABLE：指定以后注解只能润饰局部变量
  • METHOD：指定以后注解只能润饰办法
  • PACKAGE：指定以后注解只能润饰包
  • PARAMETER：指定以后注解只能润饰参数
  • TYPE：指定以后注解能够润饰类，接口，其它注解，枚举等类型

比如说：罕用的Spring的注解@Controller，是用来作用于类上的。

Documented 注解

字面意义就是文档。@Documented用于形容其它类型的annotation应该被作为被标注的程序成员的公共API，因而能够被例如javadoc此类的工具文    档化。Documented是一个标记注解，没有成员 。

@Documented@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.ANNOTATION_TYPE)public @interface Documented {}

次要是用来生成文档的，工作中基本上很少应用，作为理解就能够了。

Inherited 注解

字面意义：

@Inherited注解是在申明创立一个注解的时候，指定该注解将具备继承性。

Inherited 源码：

 @Documented    @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.ANNOTATION_TYPE)    public @interface Inherited {    }

如果某个类应用了该注解@Xx，则其子类也将主动被此注解@Xx所润饰。

应用模板：

 @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.TYPE)    @Inherited    public @interface A {            }    @A    public class Base {            }    //Sub也带有@A    public class Sub extends Base {    }
Repeatable注解

@Repeatable元注解，顾名思义，反复注解，就是在申明创立注解的时候，指定该注解能够被同一个程序元素屡次应用。这是JDK8新增的注解，反复注解只是一种简单化写法，这种简单化写法是一种假象。多个反复注解其实会被作为“容器”注解的value成员变量的数组元素。

比方上面Spring中注解ComponentScan：

 @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.TYPE)    @Documented    @Repeatable(ComponentScans.class)    public @interface ComponentScan {    }        @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.TYPE)    @Documented    public @interface ComponentScans {     ComponentScan[] value();    }

应用案例

 import org.springframework.context.annotation.Bean;    import org.springframework.context.annotation.ComponentScan;    import org.springframework.context.annotation.ComponentScans;        @ComponentScans(value = {            @ComponentScan(value = "com.tian.pakage0"),            @ComponentScan(value = "com.tian.pakage1")})    public class MainConfig {        @Bean        public User person() {            return new User();        }    }

根本注解

注解必须应用工具来解决，工具负责提取注解中蕴含的元数据，工具还会依据这些元数据减少额定的性能。上面咱们先来理解一下5个根本注解的用法。

  • Override
  • SafeVarargs
  • SuppressWarnings
  • FunctionalInterface
  • Deprecated

上面咱们就来说说这五个注解。

Override

用于标识办法，标识该办法属于重写父类的办法 。

 //只能用于办法上    @Target(ElementType.METHOD)    //源码中编译时就会应用    @Retention(RetentionPolicy.SOURCE)    public @interface Override {    }

此注解外表是重写父类的办法，只能用于办法上，并且用于编译阶段，咱们在开发的时候，如果注解使用不当，在源码编译时立马就会做出提醒。

SafeVarargs

@SafeVarargs注解是在JDK7中引入的。此注解实用于承受varargs参数的final和static办法或构造函数。此注解用于确保办法不会对其varargs参数执行不平安的操作。从Java9开始，@SafeVarargs注解也实用于公有实例办法。

@SafeVarargs源码

 @Documented    @Retention(RetentionPolicy.RUNTIME)    @Target({ElementType.CONSTRUCTOR, ElementType.METHOD})    public @interface SafeVarargs {}

应用案例

如果不应用此注解

public class SafevarargsTest {    public static void main(String[] args) {        // 传递可变参数，参数是泛型汇合        display(10, 20, 30);        // 传递可变参数，参数是非泛型汇合        display("10", 20, 1000L); // 会有编译正告    }    public static <T> void display(T... array) {        for (T arg : array) {            System.out.println(arg.getClass().getName() + ":" + arg);        }    }}

display办法会提醒

如果咱们给这个办法增加此注解后

下面的代码在可变参数display前增加了@SafeVarargs注解，当然也能够应用 @SuppressWarnings("unchecked") 注解，可是，两者相比拟来说的话@SafeVarargs注解更适宜。

留神：@SafeVarargs注解不适用于非static或非final申明的办法，对于未声明为static或final的办法，如果，要克制unchecked正告，能够应用@SuppressWarnings注解。

SuppressWarnings

用于有抉择的敞开编译器对类、办法、成员变量、变量初始化的正告。

 @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})    @Retention(RetentionPolicy.SOURCE)    public @interface SuppressWarnings {        String[] value();    }

编译期间就会做出提醒，应用范畴也是比拟宽泛，能够实用于类、接口、枚举、办法、字段等。

咱们开发过程中见过最多的应该是汇合存放数据的时候，比方上面的例子。

然而如果咱们把第一行代码正文放开。

这样就不会提醒了。

FunctionalInterface

JDK8新增注解。@FunctionalInterface标记在接口上，“函数式接口”是指仅仅只蕴含一个形象办法的接口。

源码

 @Documented    @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.TYPE)    public @interface FunctionalInterface {}

1、该注解只能标记在”有且仅有一个形象办法”的接口上。

2、JDK8接口中的静态方法和默认办法，都不算是形象办法。

3、接口默认继承java.lang.Object，所以如果接口显示申明笼罩了Object中办法，那么也不算形象办法。

4、该注解不是必须的，如果一个接口合乎”函数式接口”定义，那么加不加该注解都没有影响。加上该注解可能更好地让编译器进行查看。如果编写的不是函数式接口，然而加上了@FunctionInterface，那么编译器会报错。

5、@FunctionalInterface 注解的interface。它的特点是其中只有一个子类必须要实现的abstract办法。

应用场景

Callable、Runnable等就有应用到。

 @FunctionalInterface    public interface Callable<V> {        V call() throws Exception;    }    @FunctionalInterface    public interface Runnable {        public abstract void run();    }
Deprecated

用于标识办法或类，标识该类或办法已过期，倡议不要应用 。

 @Documented    @Retention(RetentionPolicy.RUNTIME)    @Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})    public @interface Deprecated {    }

应用范畴就想到宽泛了，构造方法、字段、办法等。

留神：只是提醒过期了，不倡议应用，不代表不能用，然而咱们如果想用某个应用此注解标记的办法或者类的时候，倡议找找有没有替换计划，切实没有替换计划，搞清楚为什么它会被设置成过期，使用不当可能会对咱们的程序造成你意想不到问题，也可能会挖坑。

自定义注解

终于来到自定义了，上面咱们来自定义一个注解。

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

格局
 public @interface 注解名 {定义体}
案例

自定义咱们的注解

 @Documented    @Retention(RetentionPolicy.RUNTIME)    @Target(ElementType.METHOD)    public @interface  MyInterface {        String value() default "";    }

应用阶段为运行阶段，指标是在办法上。定义一个属性value默认值为空字符串。

上面咱们就来应用咱们定义的注解。

 import java.lang.reflect.Method;        public class InterfaceDemo {            //@MyInterface("老田自定义的注解")         //@MyInterface        @MyInterface(value = "老田自定义的注解")        public void test() {            // TODO:        }            public static void main(String[] args) {            InterfaceDemo interfaceDemo = new InterfaceDemo();            Class<?> clazz = interfaceDemo.getClass();            Method[] methods = clazz.getMethods();            for (Method method : methods) {                if ("test".contentEquals(method.getName())) {                    System.out.println("办法名称= " + method.getName());                    MyInterface myInterface = method.getAnnotation(MyInterface.class);                    System.out.println("办法上的注解= " + myInterface);                    System.out.println("枚举值= " + myInterface.value());                }            }        }    }

如果没有指定value的值，那就应用默认值，value两种形式赋值：

 @MyInterface("老田自定义的注解")    @MyInterface(value = "老田自定义的注解")

而后咱们运行下面的代码，输入后果为：

以上咱们就搞定了自定义注解以及应用，获取属性值。

注解是一般类还是接口？

应用javap查看咱们自定义的注解.class文件内容。

这里Annotation是接口：

 public interface Annotation {    }

那么证实，咱们自定义的注解是extend接口Annotation，由此可知注解就是接口。

自定义注解留神点

解参数的可反对数据类型：

  • 所有根本数据类型（int,float,boolean,byte,double,char,long,short)
  • String类型
  • Class类型
  • enum类型
  • Annotation类型
  • 以上所有类型的数组

Annotation类型外面的参数该怎么设定：

  • 只能用public或默认(default)这两个拜访权润饰.例如,String value();这里把办法设为defaul默认类型。
  • 参数成员只能用根本类型byte,short,char,int,long,float,double,boolean八种根本数据类型 和 String,Enum,Class,annotations等数据类型,以及这一些类型的数组.例如,String value();这里的参数成员就为String。
  • 如果只有一个参数成员,最好把参数名称设为"value",后加小括号.例:上面的例子FruitName注解就只有一个参数成员。

如何获取注解？

共有以下五种形式：

  1. 获取类上的注解：Class类的getAnnotation()
  2. 获取办法上的注解：Method类的getAnnotation()
  3. 获取字段上的注解：Field类的 getAnnotation()
  4. 获取构造方法上的注解：Constructor类的getAnnotation()
  5. 获取包上的注解：Package类的getAnnotation()

如果此元素上存在指定的正文类型，则此办法返回该元素的正文，否则返回null。从下面的的集中形式中发现，都是应用getAnnotation()办法获取的，置信大多数人都能猜到为什么都是同一个办法名称。

上面就来说说Java中注解获取的鼻祖：

java.lang.reflect.AnnotatedElement

此接口所有办法

看看AnnotatedElement类图：

发现后面说的获取注解的类，全副都实现了AnnotatedElement接口。

所以程序通过反射获取了某个类的AnnotatedElement对象之后，程序就能够调用该对象的办法。

如下四个个办法来拜访Annotation信息：

「getAnnotation」

返回该程序元素上存在的、指定类型的注解，如果该类型注解不存在，则返回null。

「getAnnotations」

返回该程序元素上存在的所有注解。

「isAnnotationPresent」

判断该程序元素上是否包指定类型的注解，存在则返回true，否则返回false。

「getDeclaredAnnotations」

返回间接存在于此元素上的所有正文。与此接口中的其余办法不同，该办法将疏忽继承的正文。（如果没有正文间接存在于此元素上，则返回长度为零的一个数组。）该办法的调用者能够随便批改返回的数组；这不会对其余调用者返回的数组产生任何影响

总结

为什么要学习注解？元注解有哪些？根本注解有哪些？如何自定义注解？注解是一般类还是接口？自定义注解须要留神些什么？获取获取注解？

参考:

qqe2.com/java/post/1853.html cnblogs.com/peida/archive/2013/04/24/3036689.html

举荐浏览

面试被问：5 亿整数的大文件，排个序 ？

String s = new String("111")会创立几个对象？

面试系列：说说hashCode和equals办法

7种启动Spring Boot我的项目的形式