java注释:
Java注释用于为Java代码提供元数据。 作为元数据,注释不直接影响代码的执行,但实际上有些注释可以用于此目的。 Java注释已从Java5添加到Java中。
理解评论的前提:
我认为评论是标签
这是java 5.0版中开始引入的概念,类似于Java的class和接口
这么说不得不说是评论中的基础元评论。
元注释:元注释是可以附加在注释上的注释。 这意味着元注释是基本注释,但可以应用于其他注释。
如果不理解,则认为元评论也是标签,但它是一种特殊的标签,其作用和目的是向其他一般标签说明。
元标记有@Retention、@Documented、@Target、@Inherited、@Repeatable 5这5种。
@Retention
Retention的英语意思是保存期间的意思。 说明将@Retention应用于评论时,该评论的生存时间。
这些值包括:
RetentionPolicy.SOURCE注释仅在源代码阶段保留,并在编译器编译时被丢弃和忽略。
RetentionPolicy.CLASS注释仅在编译时保留,而不加载到JVM中。
RetentionPolicy.RUNTIME注释在程序运行时保留并加载到JVM中,以便在程序运行时检索。
我们这样可以加深理解。 @Retention向标签说明时,它指定了发布这个标签的时间。 @Retention相当于在标签上添加一个时间戳,表示贴上标签的时间。
@ retention (retention policy.runtime ) public @ interfacetestannotation {
}
@Documented
wmddn,这个元注释一定与文档有关。 可以将注释中的元素包含在Javadoc中。
@Target
Target是目标的意思,@Target指定评论的运用场所。
这样,某个评论发表@Target评论时,可以理解为该评论限定了运用的场景。
从类比到标签,标签本来是想在哪里投稿,想在哪里投稿,但是由于@Target的存在,只能投稿到方法、类、方法参数等,投稿场所变得非常具体。 @Target具有以下值
ElementType.ANNOTATION_TYPE可以为注释添加注释
ElementType.CONSTRUCTOR可以对生成方法进行注释
ElementType.FIELD可以对属性添加注释
ElementType.LOCAL_VARIABLE可以对局部变量进行注释
ElementType.METHOD可以对方法进行注释
ElementType.PACKAGE可以对包进行注释
ElementType.PARAMETER可以为方法中的参数添加注释
ElementType.TYPE可以对类、接口和枚举等类型进行注释
@Inherited
Inherited表示继承,但并不意味着注释本身可以继承,如果超类对@Inherited注释的注释进行注释,则表示该子类未应用于任何注释
是抽象的故事。 用代码说明。
@Inherited
@ retention (retention policy.runtime ) )。
@interface Test {}
@Test
公共类a { }
公共类b extends a { }
评论Test用@Inherited修饰,之后a类用Test进行评论,b类继承a,b类也有Test的评论。
@Repeatable
Repeatable当然是可重复的意思。 @Repeatable是Java 1.8中首次添加的,因此是一个新特性。
什么样的评论会被多次应用? 通常,注释的值可以同时有多个。
@interface Persons {
人员[ ] value (;
}
@repeatable(Persons.class ) )。
@interface Person{
字符串角色(default );
}
@Person(role='Artist ' ) ) ) ) ) ) ) ) ) ) ) )。
@person(role='coder ' ) ) ) ) ) ) ) ) ) )。) ) ) @person(role='coder ' ) ) ) ) ) ) ) ) ) person )
@person(role='pm ) ) ) ) ) ) ) ) ) ) ) )。
public class SuperMan{
}
注意上面的代码,@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。
什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解。
@interface Persons {
Person[] value();
}
按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组。
如果不好理解的话,可以这样理解。Persons 是一无限的小蘑菇的标签,上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签。
我们可能对于 @Person(role=”PM”) 括号里面的内容感兴趣,它其实就是给 Person 这个注解的 role 属性赋值为 PM ,大家不明白正常,马上就讲到注解的属性这一块。
注解的属性
注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)public @interfaceTestAnnotation {intid();
String msg();
}
上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候,我们应该给它们进行赋值。
赋值的方式是在注解的括号内以 value=”” 形式,多个属性之前用 ,隔开。
需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。
注解中属性可以有默认值,默认值需要用 default 关键值指定。比如:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)public @interfaceTestAnnotation {public int id() default -1;public String msg() default "Hi";
}
TestAnnotation 中 id 属性默认值为 -1,msg 属性默认值为 Hi。
它可以这样应用。
@TestAnnotation()
public class Test {}
因为有默认值,所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了,这一步可以省略。
最后,还需要注意的一种情况是一个注解没有任何属性。比如
public @interface Perform {}
那么在应用这个注解的时候,括号都可以省略。
java 预置的注解
学习了上面相关的知识,我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。
@Override
这个大家应该很熟悉了,提示子类要复写父类中被 @Override 修饰的方法
@SuppressWarnings
阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。
@SuppressWarnings("deprecation")public voidtest1(){
Hero hero= newHero();
hero.say();
hero.speak();
}
还有一些就不一一列举了
自定义注解
自定义注解可以理解为:注解自己的注解
建造自己的注解
1 importjava.lang.annotation.RetentionPolicy;2
3 @Retention(RetentionPolicy.RUNTIME)4 public @interfaceExecute {5
6 }
用它注解一些方法
1 public classdatr {2 @Execute3 public voidd(){4 System.out.println("dddd");5 }6 @Execute7 public voida(){8 System.out.println("aaaa");9 }10 @Execute11 public voidb(){12 System.out.println("bbbb");13 }14 @Execute15 public voidc(){16 System.out.println("cccc");17 }18 @Execute19 public voide(){20 System.out.println("eeee");21 }22 }
使用Test类测试调用方法
importjava.lang.reflect.Method;public classTest {public static void main(String[] args) throwsException {
Class a= Class.forName("com.accp.entity.datr");
datr o=(datr) a.getConstructor().newInstance();for(Method arg : a.getDeclaredMethods()) {if (arg.isAnnotationPresent(Execute.class)){
arg.invoke(o);
}
}
}
}
注解与反射。
注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解
public boolean isAnnotationPresent(Class extends Annotation> annotationClass) {}
然后通过 getAnnotation() 方法来获取 Annotation 对象。
public A getAnnotation(Class annotationClass) {}
或者是 getAnnotations() 方法。
public Annotation[] getAnnotations() {}
前一种方法返回指定类型的注解,后一种方法返回注解到这个元素上的所有注解。
如果获取到的 Annotation 如果不为 null,则就可以调用它们的属性方法了。
1 @TestAnnotation()2 public classTest {3 public static voidmain(String[] args) {4 boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class);5 if( hasAnnotation ) {6 TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class);7 System.out.println("id:"+testAnnotation.id());8 System.out.println("msg:"+testAnnotation.msg());9 }10 }11 }
程序的运行结果是:
1 id:-1
2 msg:
这个正是 TestAnnotation 中 id 和 msg 的默认值。
需要注意的是,如果一个注解要在运行时被成功提取,那么 @Retention(RetentionPolicy.RUNTIME) 是必须的。
注解应用实例
注解运用的地方太多了,如:
JUnit 这个是一个测试框架,典型使用方法如下:
1 public classExampleUnitTest {2 @Test3 public void addition_isCorrect() throwsException {4 assertEquals(4, 2 + 2);5 }6 }
还有例如ssm框架等运用了大量的注解。
总结
如果注解难于理解,你就把它类同于标签,标签为了解释事物,注解为了解释代码。
注解的基本语法,创建如同接口,但是多了个 @ 符号。
注解的元注解。
注解的属性。
注解主要给编译器及工具类型的软件用的。
注解的提取需要借助于 Java 的反射技术,反射比较慢,所以注解使用时也需要谨慎计较时间成本。