最近学习spring5的时候,发现好像多了一些新的注解,于是乎想好好看看这些注解到底是怎么实现的,但是奈何自己连基础的元注解都还是一知半解,所以还是万丈高楼平地起,一切以基础为重。下面就来说说jdk自带的元注解,与新手朋友们分享也为自己填一个坑。
1.什么是元注解
元注解就是一种基本注解,它能够应用到其它的注解上面。所有的注解都会基于元注解。或者换句话说元注解就是给我们自定义注解用的。
2.元注解有哪几种
目前 jdk1.8 拥有的元注解5种,分别是:
元注解 | 用处 | 取值 |
---|---|---|
@Retention | 表明了这个注解的的存活时间。 |
|
@Documented | 它的作用是能够将注解中的元素包含到 Javadoc 中去。 | |
@Target | Target 是目标的意思,指定了注解运用的地方。 |
|
@Inherited | Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。 | 子类就继承了超类的注解 |
@Repeatable | Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。 | 被Repeatable修饰的注解可以重复的修饰某个元素。 |
前三种都比较好理解,后面两种我给举个例子看看:
@Inherited:继承
我们先自定义一个注解
@Inherited
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyAnnotation {
}
//ClassA使用此注解,ClassB 继承 ClassA,相当于ClassB也具有此注解
@MyAnnotation
public class ClassA {
}
public class ClassB extends ClassA {
}
@Repeatable:重复
这里有个概念:容器注解,且看下文
//容器注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface MyRepeatables {
MyRepeatable [] value();//按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解,注意value它是数组;
}
//使用@Repeatable将@MyRepeatable变成可重复的
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(MyRepeatables.class)
public @interface MyRepeatable {
String role();
}
//测试
@MyRepeatable(role = "PM")
@MyRepeatable(role = "PA")
@MyRepeatable(role = "PC")
public class Test {
}
3.注解的属性
先提几个概念:
- 注解只有成员变量,没有方法。
- 注解的成员变量就是以“无形参的方法”形式来声明。
- 方法名定义了该成员变量的名字,其返回值既是该成员变量的类型。
自定义一个Person注解
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Person {
String name();
int age();
}
上面代码定义了 Person这个注解中拥有 name 和 age 两个属性。在使用的时候,我们应该给它们进行赋值。
赋值的方式如下形式,多个属性之前用 ,隔开。
@Person(age=20,name="java")
public class Test {
}
需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。
注解中属性可以有默认值,默认值需要用 default 关键值指定。比如:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Person{
public int age() default 20;
public String name() default "php";
}
相当于
@Person()
public class Test {
}
因为有默认值,所以无需要再在 @Person 后面的括号里面进行赋值了,这一步可以省略。
另外,还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接接属性值填写到括号内。
@Target(ElementType.PARAMETER)
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {
String value();
}
上面代码中,Check 这个注解只有 value 这个属性。所以可以这样应用。
@Check("hi")
int a;
这和下面的效果是一样的
@Check(value="hi")
int a;
最后,还需要注意的一种情况是一个注解没有任何属性。比如
public @interface Perform {}
那么在应用这个注解的时候,括号都可以省略。
@Perform
public void testMethod(){}
4.Java 预置的注解
其实Java 语言本身已经提供了几个现成的非元注解的注解。
@Deprecated
这个元素是用来标记过时的元素,想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。
@Override
这个大家很熟悉了,提示子类要复写父类中被 @Override 修饰的方法。
@SuppressWarnings
阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。
@SafeVarargs
参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。
@FunctionalInterface
函数式接口注解,这个是 Java 1.8 版本引入的新特性。函数式编程很火,所以 Java 8 也及时添加了这个特性。
函数式接口 (Functional Interface) 就是一个具有一个方法的普通接口。
比如
@FunctionalInterface
public interface Runnable {
/**
* When an object implementing interface <code>Runnable</code> is used
* to create a thread, starting the thread causes the object's
* <code>run</code> method to be called in that separately executing
* thread.
* <p>
* The general contract of the method <code>run</code> is that it may
* take any action whatsoever.
*
* @see java.lang.Thread#run()
*/
public abstract void run();
}
我们进行线程开发中常用的 Runnable 就是一个典型的函数式接口,上面源码可以看到它就被 @FunctionalInterface 注解。
可能有人会疑惑,函数式接口标记有什么用,这个原因是函数式接口可以很容易转换为 Lambda 表达式。这是另外的主题了,有兴趣的同学请自己搜索相关知识点学习。
参考博文:https://jingyan.baidu.com/article/a3761b2bf05f661576f9aaf3.html