一文助你了解java注解到底是怎么回事
一、注解简介
Java注解用于为Java代码提供元数据。
元数据是指用来描述数据的数据,通俗一点,就是描述代码间关系,或者代码与其它资源(例如数据库表)之间内在联系的数据。在一些技术框架中,如Struts、hibernate就不知不觉用到了元数据。对于Struts来说,元数据指的是struts-config.xml;对hibernate来说就是hbm文件。以上阐述的几种元数据都是基于xml文件的或者其他形式的单独配置文件。这样表示有些不便之处。1、与被描述的文件分离,不利于一致性的维护;2、所有这样的文件都是ASCII文件,没有显式的类型支持。基于元数据的广泛使用,JDK5.0引入了Annotation的概念来描述元数据。在Java中,元数据以标签的形式存在于Java代码中,元数据标签的存在并不影响程序代码的编译和执行。简而言之,言而总之,注解就是标签的意思。
二、如何创建注解
package com.guor.ClientNew;
public @interface MyAnnotation {
// 定义公共的final静态属性
int age = 25;
// 定义公共的抽象方法
String name();
}
三、元注解
1、@Retention
Retention,中文释义保留期的意思
当@Retention应用到注解上的时候,它解释说明了这个注解的生命周期。
RetentionPolicy.SOURCE 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。
RetentionPolicy.CLASS 注解只被保留到编译进行的时候,它并不会被加载到JVM中。
RetentionPolicy.RUNTIME 注解可以保留到程序运行的时候,它会被加载到JVM中。
2、@Documented
3、@Target
标明注解运用的地方。
ElementType.ANNOTATION_TYPE 可以给一个注解进行注解
ElementType.CONSTRUCTOR 可以给构造方法进行注解
ElementType.FIELD 可以给属性进行注解
ElementType.LOCAL_VARIABLE 可以给局部变量进行注解
ElementType.METHOD 可以给方法进行注解
ElementType.PACKAGE 可以给一个包进行注解
ElementType.PARAMETER 可以给一个方法内的参数进行注解
ElementType.TYPE 可以给一个类型进行注解,比如类、接口、枚举
4、@Inherited
5、@Repeatable
Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。
什么样的注解会多次应用呢?通常是注解的值可以同时取多个。
在生活中一个人往往是具有多种身份,如果我把每种身份当成一种注解该如何使用???
先声明一个Persons类用来包含所有的身份
public Persons {
Person[] value();
}
(Persons.class)
public Person{
String role() default "";
}
public class Man {
String name="";
}
public static void main(String[] args) {
Annotation[] annotations = Man.class.getAnnotations();
System.out.println(annotations.length);
Persons p1=(Persons) annotations[0];
for(Person t:p1.value()){
System.out.println(t.role());
}
}
if(Man.class.isAnnotationPresent(Persons.class)) {
Persons p2=Man.class.getAnnotation(Persons.class);
for(Person t:p2.value()){
System.out.println(t.role());
}
}
四、注解的属性
(ElementType.TYPE)
(RetentionPolicy.RUNTIME)
public TestAnnotation {
int id();
String msg();
}
public class Test {
}
(ElementType.TYPE)
(RetentionPolicy.RUNTIME)
public TestAnnotation {
public int id() default -1;
public String msg() default "哪吒";
}
public class Test {}
public @interface Check {
String value();
}
@Check("hi")
int a;
@Check(value="hi")
int a;
public @interface Perform {}
public void testMethod(){}
五、Java自带的注解
学习了上面相关的知识,我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。
1、@Override
这个大家应该很熟悉了,提示子类要复写父类中被 @Override 修饰的方法
2、@Deprecated
加上这个注解之后,表示此方法或类不再建议使用,调用时会出现删除线,但不代表不能用,只是说,不推荐使用,因为有更好的方法可以调用。
那么直接删掉不就完了?
因为在一个项目中,工程比较大,代码比较多,而在后续的开发过程中,可能之前的某个方法实现的并不是很合理,这个时候要重新写一个方法,而之前的方法还不能随便删,因为别的地方可能在调用它,所以加上这个注解,就OK啦!
3、@SuppressWarning
4、@SafeVarargs
参数安全类型注解。
它的目的是提醒开发者不要用参数做一些不安全的操作,它的存在会阻止编译器产生unchecked这样的警告。
在声明具有模糊类型(比如:泛型)的可变参数的构造函数或方法时,Java编译器会报unchecked警告。鉴于这种情况,如果程序猿断定声明的构造函数和方法的主体no problem,可使用@SafeVarargs进行标记,这样Java编译器就不会报unchecked警告了!
5、@FunctionalInterface
Java 8为函数式接口引入了一个新注解@FunctionalInterface,主要用于编译级错误检查,加上该注解,当你写的接口不符合函数式接口定义的时候,编译器会报错。
它们主要用在Lambda表达式和方法引用(实际上也可认为是Lambda表达式)上。
如定义了一个函数式接口如下:
interface GreetingService
{
void sayMessage(String message);
}
GreetingService greetService1
= message -> System.out.println("Hello " + message);
六、注解的使用场景
1、注解的官方释义
注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。
2、注解的用处
① 提供信息给编译器:编译器可以利用注解来探测错误或警告信息
② 编译阶段时的处理:软件工具可以利用注解信息来生成代码、HTML文档或其它响应处理。
③ 运行时的处理:某些注解可以在程序运行时接受代码的提取。
值得注意的是,注解不是代码本身的一部分。
3、注解的用法举例
public class ExampleUnitTest {
public void addition_isCorrect() throws Exception {
assertEquals(4, 2 + 2);
}
}
七、注解的本质
注解本质是一个继承了Annotation的特殊接口,其具体实现类是Java运行时生成的动态代理类。通过代理对象调用其自定义注解的方法,最终调用的是AnnotationInvocationHandler的invoke方法,该方法会从memberValues这个map中索引出对应的值,而memberValues的来源是Java常量池。