Java注解详解
<svg xmlns="http://www.w3.org/2000/svg" style="display: none">
<path stroke-linecap="round" d="M5,0 0,2.5 5,5z" id="raphael-marker-block" style="-webkit-tap-highlight-color: rgba(0, 0, 0, 0)"></path>
</svg>
<h4><a id="AnnotationJDK50_0"></a>Annotation是从JDK5.0开始引入的新技术。<button class="cnblogs-toc-button" title="显示目录导航"></button></h4>
- Annotation 的作用:–不是程序本身,可以对程序作出解释。(这一点,跟注释没什么区别)–可以被其他程序 (比如:编译器等) 读取。(注解信息处理流程,是注解和注释的重大区别。如果没有注解信息处理流程,则注解毫无意义)
- Annotation 的格式:–注解是以“@注释名”在代码中存在的,还可以添加一些参数值,例如:@SuppressWarnings(value=“unchecked”)。
- Annotation 在哪里使用?–可以附加在 package,class,method,field 等上面,相当于给它们添加了额外的辅助信息,我们可以通过反射机制编程实现对这些元数据的访问。
注解语法
因为平常开发少见,相信有不少的人员会认为注解的地位不高。其实同 classs 和 interface 一样,注解也属于一种类型。它是在 Java SE 5.0 版本中开始引入的概念。
内置注解
1. @Override–定义在 java.lang.Override 中,此注释只适用于修辞方法,表示一个方法声明打算重写超类中的另一个方法声明。
2. @Deprecated–定义在 java.lang.Deprecated 中,此注释可用于修辞方法、属性、类,表示不鼓励程序员使用这样的元素,通常是因为它很危险或存在更好的选择。
3. @SuppressWarnings–定义在 java.lang.SuppressWarnings 中,用来抑制编译时的警告信息。–与前两个注释有所不同,你需要添加一个参数才能正确使用,这些参数值都是已经定义好了的,我们选择性的使用就好了,
参数如下:–@SuppressWarnings(“unchecked”)
–@SuppressWarnings(value={“unchecked”,“deprecation”})
注解的定义
- 使用 @interface 自定义注解时,自动继承了 java.lang.annotation.Annotation 接口
- 要点:–@interface 用来声明一个注解
- 格式为:
–public @interface 注解名 {定义体}
–其中的每一个方法实际上是声明了一个配置参数。
–方法的名称就是参数的名称 (注解中方法为参数)
–返回值类型就是参数的类型(返回值类型只能是基本类型、Class、String、enum)
–可以通过 default 来声明参数的默认值。
–如果只有一个参数成员,一般参数名为 value - 注意:注解元素必须要有值。我们定义注解元素时,经常使用空字符串、0 作为默认值。也经常使用负数 (比如:-1) 表示不存在的含义
注解通过 @interface 关键字自定义注解 @TableField。
package com.gqz.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TableField {
String columnName();
String type();
int length();
}
元注解
元注解是什么意思呢?
元注解是可以注解到注解上的注解,或者说元注解是一种基本注解,但是它能够应用到其它的注解上面。
如果难于理解的话,你可以这样理解。元注解也是一张标签,但是它是一张特殊的标签,它的作用和目的就是给其他普通的标签进行解释说明的。
元注解的作用就是负责注解其他注解。Java 定义了 5 个标准的 meta-annotation 类型,它们被用来提供对其它 annotation 类型作说明。
这些类型和它们所支持的类在 java.lang.annotation 包中可以找到
- @Target
- @Retention
- @Documented
- @Inherited
- @Repeatable //JDK1.8 新加入的
1、@Target
Target 是目标的意思,@Target 指定了注解运用的地方。
你可以这样理解,当一个注解被 @Target 注解时,这个注解就被限定了运用的场景。
类比到标签,原本标签是你想张贴到哪个地方就到哪个地方,但是因为 @Target 的存在,它张贴的地方就非常具体了,比如只能张贴到方法上、类上、方法参数上等等。
ElementType 取值 | 范围 |
---|---|
ElementType.ANNOTATION_TYPE | 可以给一个注解进行注解 |
ElementType.CONSTRUCTOR | 可以给构造方法进行注解 |
ElementType.FIELD | 可以给属性进行注解 |
ElementType.LOCAL_VARIABLE | 可以给局部变量进行注解 |
ElementType.METHOD | 可以给方法进行注解 |
ElementType.PACKAGE | 可以给一个包进行注解 |
ElementType.PARAMETER | 可以给一个方法内的参数进行注解 |
ElementType.TYPE | 可以给一个类型进行注解,比如类、接口、枚举 |
2、@Retention
Retention 的英文意为保留期的意思。
当 @Retention 应用到一个注解上的时候,它解释说明了这个注解的的存活时间。
它的取值如下:
RetentionPolicy 取值 | 生命周期 |
---|---|
RetentionPolicy.SOURCE | 注解只在源码阶段保留,在编译器进行编译时它将被丢弃忽视。 |
RetentionPolicy.CLASS | 注解只被保留到编译进行的时候,它并不会被加载到 JVM 中。 |
RetentionPolicy.RUNTIME | 注解可以保留到程序运行的时候,它会被加载进入到 JVM 中,所以在程序运行时可以获取到它们。 |
我们可以这样的方式来加深理解,@Retention 去给一张标签解释的时候,它指定了这张标签张贴的时间。@Retention 相当于给一张标签上面盖了一张时间戳,时间戳指明了标签张贴的时间周期。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
String value();
}
上面的代码中,我们指定 Table 可以在程序运行周期被获取到,因此它的生命周期非常的长。这样可以使用反射机制获取有关注解的信息。
3、@Documented
顾名思义,这个元注解肯定是和文档有关。它的作用是能够将注解中的元素包含到 Javadoc 中去。
4、@Inherited
Inherited 是继承的意思,但是它并不是说注解本身可以继承,而是说如果一个超类被 @Inherited 注解过的注解进行注解的话,那么如果它的子类没有被任何注解应用的话,那么这个子类就继承了超类的注解。
说的比较抽象。代码来解释。
@Inherited
@Retention(RetentionPolicy.RUNTIME)
public @interface Test {
}
@Test
public class A {}
public class B extends A {} //class B 同样被 @Test 注解
注解 Test 被 @Inherited 修饰,之后类 A 被 Test 注解,类 B 继承 A, 类 B 也拥有 Test 这个注解。
4、@Repeatable
Repeatable 自然是可重复的意思。@Repeatable 是 Java 1.8 才加进来的,所以算是一个新的特性。什么样的注解会多次应用呢?通常是注解的值可以同时取多个。
举个例子,一个人他既是程序员又是产品经理, 同时他还是个画家。
public @interface Persons {
Person[] value();
}
@Repeatable(Persons.class)
public @interface Person{
String role default "";
}
@Person(role="artist")
@Person(role="coder")
@Person(role="PM")
public class SuperMan{
}
注意上面的代码,@Repeatable 注解了 Person。而 @Repeatable 后面括号中的类相当于一个容器注解。
什么是容器注解呢?就是用来存放其它注解的地方。它本身也是一个注解。
我们再看看代码中的相关容器注解。
public @interface Persons {
Person[] value();
}
按照规定,它里面必须要有一个 value 的属性,属性类型是一个被 @Repeatable 注解过的注解数组,注意它是数组。
如果不好理解的话,可以这样理解。Persons 是一张总的标签,上面贴满了 Person 这种同类型但内容不一样的标签。把 Persons 给一个 SuperMan 贴上,相当于同时给他贴了程序员、产品经理、画家的标签。
我们可能对于 @Person(role=”PM”) 括号里面的内容感兴趣,它其实就是给 Person 这个注解的 role 属性赋值为 PM ,大家不明白正常,马上就讲到注解的属性这一块。
注解的属性
注解的属性也叫做成员变量。注解只有成员变量,没有方法。注解的成员变量在注解的定义中以“无形参的方法”形式来声明,其方法名定义了该成员变量的名字,其返回值定义了该成员变量的类型。
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
int id();
String msg();
}
上面代码定义了 TestAnnotation 这个注解中拥有 id 和 msg 两个属性。在使用的时候,我们应该给它们进行赋值。
赋值的方式是在注解的括号内以 value=”” 形式,多个属性之前用 ,隔开。
@TestAnnotation(id=3,msg="hello annotation")
public class Test {
}
需要注意的是,在注解中定义属性时它的类型必须是 8 种基本数据类型外加 类、接口、注解及它们的数组。
注解中属性可以有默认值,默认值需要用 default 关键值指定。比如:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotation {
public int id() default -1;
public String msg() default "Hi";
}
TestAnnotation 中 id 属性默认值为 -1,msg 属性默认值为 Hi。
它可以这样应用。
@TestAnnotation()
public class Test {
}
因为有默认值,所以无需要再在 @TestAnnotation 后面的括号里面进行赋值了,这一步可以省略。
另外,还有一种情况。如果一个注解内仅仅只有一个名字为 value 的属性时,应用这个注解时可以直接接属性值填写到括号内。
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Check {
String value();
}
上面代码中,Check 这个注解只有 value 这个属性。所以可以这样应用。
@Check("18")
int age;
这和下面的效果是一样的
@Check(value="18")
int age;
最后,还需要注意的一种情况是一个注解没有任何属性。比如
public @interface Perform {}
那么在应用这个注解的时候,括号都可以省略。例如:@Override 注解
@Perform
public void testMethod(){
}
Java 预置的注解
学习了上面相关的知识,我们已经可以自己定义一个注解了。其实 Java 语言本身已经提供了几个现成的注解。
@Deprecated
这个元素是用来标记过时的元素,想必大家在日常开发中经常碰到。编译器在编译阶段遇到这个注解时会发出提醒警告,告诉开发者正在调用一个过时的元素比如过时的方法、过时的类、过时的成员变量。
public class Hero {
@Deprecated
public void say(){
System.out.println("Noting has to say!");
}
public void speak(){
System.out.println("I have a dream!");
}
}
定义了一个 Hero 类,它有两个方法 say()和 speak() ,其中 say() 被 @Deprecated 注解。然后我们在 IDE 中分别调用它们。
可以看到,say() 方法上面被一条直线划了一条,这其实就是编译器识别后的提醒效果。
@Override
这个大家应该很熟悉了,提示子类要复写父类中被 @Override 修饰的方法
@SuppressWarnings
阻止警告的意思。之前说过调用被 @Deprecated 注解的方法后,编译器会警告提醒,而有时候开发者会忽略这种警告,他们可以在调用的地方通过 @SuppressWarnings 达到目的。
@SuppressWarnings("deprecation")
public void test1(){
Hero hero = new Hero();
hero.say();
hero.speak();
}
@SafeVarargs
参数安全类型注解。它的目的是提醒开发者不要用参数做一些不安全的操作, 它的存在会阻止编译器产生 unchecked 这样的警告。它是在 Java 1.7 的版本中加入的。
@SafeVarargs // Not actually safe!
static void m(List<String>... stringLists) {
Object[] array = stringLists;
List<Integer> tmpList = Arrays.asList(42);
array[0] = tmpList; // Semantically invalid, but compiles without warnings
String s = stringLists[0].get(0); // Oh no, ClassCastException at runtime!
}
上面的代码中,编译阶段不会报错,但是运行时会抛出 ClassCastException 这个异常,所以它虽然告诉开发者要妥善处理,但是开发者自己还是搞砸了。
Java 官方文档说,未来的版本会授权编译器对这种不安全的操作产生错误警告。
@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 表达式。这是另外的主题了,有兴趣的同学请自己搜索相关知识点学习。
注解的提取 (反射机制 重点部分)
我通过用标签来比作注解,前面的内容是讲怎么写注解,然后贴到哪个地方去,而现在我们要做的工作就是检阅这些标签内容。 形象的比喻就是你把这些注解标签在合适的时候撕下来,然后检阅上面的内容信息。
要想正确检阅注解,离不开一个手段,那就是反射。注解真正起作用的时候是其被提取出来处理。
注解与反射。
注解通过反射获取。首先可以通过 Class 对象的 isAnnotationPresent() 方法判断它是否应用了某个注解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
Demo
Class clazz = Class.forName("com.gqz.annotation.Student");
// 使用 isAnnotationPresent 方法判断一个类是否使用指定的注解
boolean isAnnotation = clazz.isAnnotationPresent(SuppressWarnings.class);
System.out.println(isAnnotation);
然后通过 getAnnotation() 方法来获取 Annotation 对象。
// 返回指定类型的注解
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
或者是 getAnnotations() 方法。
// 返回注解到这个元素上的所有注解
public Annotation[] getAnnotations() {}
前一种方法返回指定类型的注解,后一种方法返回注解到这个元素上的所有注解。
如果获取到的 Annotation 如果不为 null,则就可以调用它们的属性方法了。上面的例子中,只是检阅出了注解在类上的注解,其实属性、方法上的注解照样是可以的。
下面给出一个完整的例子,使用 ROM 通过在 java 类上面添加注解信息,过去到 SQL 语句。
测试注解 TestAnnotaion .class
package com.gqz.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface TestAnnotaion {
String value() default "gqz";
}
一个实体类 Student.class
package com.gqz.annotation;
@TestAnnotaion(value="ganquanzhong")
@Table("tb_student")
public class Student {
@TableField(columnName = "id",type = "int",length = 10)
private int id;
<span class="hljs-meta">@TableField(columnName = "name",type = "varchar" ,length = 10)</span>
<span class="hljs-keyword">private</span> String name;
<span class="hljs-meta">@TableField(columnName = "age",type = "int",length = 3)</span>
<span class="hljs-keyword">private</span> <span class="hljs-type">int</span> age;
<span class="hljs-keyword">public</span> <span class="hljs-type">int</span> <span class="hljs-title function_">getId</span><span class="hljs-params">()</span> {
<span class="hljs-keyword">return</span> id;
}
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setId</span><span class="hljs-params">(<span class="hljs-type">int</span> id)</span> {
<span class="hljs-built_in">this</span>.id = id;
}
<span class="hljs-keyword">public</span> String <span class="hljs-title function_">getName</span><span class="hljs-params">()</span> {
<span class="hljs-keyword">return</span> name;
}
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setName</span><span class="hljs-params">(String name)</span> {
<span class="hljs-built_in">this</span>.name = name;
}
<span class="hljs-keyword">public</span> <span class="hljs-type">int</span> <span class="hljs-title function_">getAge</span><span class="hljs-params">()</span> {
<span class="hljs-keyword">return</span> age;
}
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setAge</span><span class="hljs-params">(<span class="hljs-type">int</span> age)</span> {
<span class="hljs-built_in">this</span>.age = age;
}
}
注解表名 Table.class
package com.gqz.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Table {
String value();
}
注解表的字段 TableField.class
package com.gqz.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface TableField {
String columnName();
String type();
int length();
}
处理注解,提出信息 AnalysisTableAnnotation.class
package com.gqz.annotation;
import java.lang.annotation.Annotation;
import java.lang.reflect.Field;
/**
- 使用反射读取注解的信息,模拟处理注解信息的流程
- @ClassName: AnalysisTableAnnotation
- @Description: TODO(这里用一句话描述这个类的作用)
- @author ganquanzhong
- @date 2019 年 7 月 17 日 下午 1:50:14
*/
@SuppressWarnings(value = "all")
public class AnalysisTableAnnotation {
public static void main(String[] args) {
<span class="hljs-keyword">try</span> {
<span class="hljs-type">Class</span> <span class="hljs-variable">clazz</span> <span class="hljs-operator">=</span> Class.forName(<span class="hljs-string">"com.gqz.annotation.Student"</span>);
<span class="hljs-comment">//使用isAnnotationPresent方法判断一个类是否使用指定的注解</span>
System.out.println(<span class="hljs-string">"使用isAnnotationPresent方法判断一个类是否使用指定的注解"</span>);
<span class="hljs-type">boolean</span> <span class="hljs-variable">isAnnotation</span> <span class="hljs-operator">=</span> clazz.isAnnotationPresent(TestAnnotation01.class);
System.out.println(isAnnotation);
<span class="hljs-comment">//返回注解到这个元素上的所有注解</span>
System.out.println(<span class="hljs-string">"getAnnotation返回注解到这个元素上的所有注解"</span>);
Annotation[] annotations = clazz.getAnnotations();
<span class="hljs-keyword">for</span> (Annotation a : annotations) {
System.out.println(a);
}
<span class="hljs-comment">//返回指定类型的注解</span>
System.out.println(<span class="hljs-string">"getAnnotation返回指定类型的注解"</span>);
<span class="hljs-type">Table</span> <span class="hljs-variable">table</span> <span class="hljs-operator">=</span>(Table) clazz.getAnnotation(Table.class);
System.out.println(table.value());
<span class="hljs-comment">//获得类的属性注解信息</span>
System.out.println(<span class="hljs-string">"getDeclaredField获得类的属性注解信息"</span>);
<span class="hljs-type">Field</span> <span class="hljs-variable">f</span> <span class="hljs-operator">=</span> clazz.getDeclaredField(<span class="hljs-string">"id"</span>);
TableField field= f.getAnnotation(TableField.class);
System.out.println(field.type()+<span class="hljs-string">"------>"</span>+field.columnName()+<span class="hljs-string">"----->"</span>+field.length());
f = clazz.getDeclaredField(<span class="hljs-string">"name"</span>);
field= f.getAnnotation(TableField.class);
System.out.println(field.type()+<span class="hljs-string">"------>"</span>+field.columnName()+<span class="hljs-string">"----->"</span>+field.length());
f = clazz.getDeclaredField(<span class="hljs-string">"age"</span>);
field= f.getAnnotation(TableField.class);
System.out.println(field.type()+<span class="hljs-string">"------>"</span>+field.columnName()+<span class="hljs-string">"----->"</span>+field.length());
} <span class="hljs-keyword">catch</span> (Exception e) {
<span class="hljs-comment">// TODO Auto-generated catch block</span>
e.printStackTrace();
}
}
}
运行结果
使用isAnnotationPresent方法判断一个类是否使用指定的注解
false
getAnnotation返回注解到这个元素上的所有注解
@com.gqz.annotation.TestAnnotaion(value=ganquanzhong)
@com.gqz.annotation.Table(value=tb_student)
getAnnotation返回指定类型的注解
tb_student
getDeclaredField获得类的属性注解信息
int------>id----->10
varchar------>name----->10
int------>age----->3
注解的使用场景
我们不妨将目光放到 Java 官方文档上来。
文章开始的时候,我用标签来类比注解。但标签比喻只是我的手段,而不是目的。为的是让大家在初次学习注解时能够不被那些抽象的新概念搞懵。既然现在,我们已经对注解有所了解,我们不妨再仔细阅读官方最严谨的文档。
注解是一系列元数据,它提供数据用来解释程序代码,但是注解并非是所解释的代码本身的一部分。注解对于代码的运行效果没有直接影响。
注解有许多用处,主要如下:
- 提供信息给编译器: 编译器可以利用注解来探测错误和警告信息
- 编译阶段时的处理: 软件工具可以用来利用注解信息来生成代码、Html 文档或者做其它相应处理。
- 运行时的处理: 某些注解可以在程序运行的时候接受代码的提取
值得注意的是,注解不是代码本身的一部分.
官方文档的解释,注解主要针对的是编译器和其它工具软件 (SoftWare tool)。
当开发者使用了 Annotation 修饰了类、方法、Field 等成员之后,这些 Annotation 不会自己生效,必须由开发者提供相应的代码来提取并处理 Annotation 信息 . 这些处理提取和处理 Annotation 的代码统称为 APT(Annotation Processing Tool)。
现在,我们可以给自己答案了,注解有什么用?给谁用?给 编译器或者 APT 用的。如果,你还是没有搞清楚的话,我亲自写一个好了。
亲手自定义注解完成某个目的
我要写一个测试框架,测试程序员的代码有无明显的异常。
—— 程序员 A : 我写了一个类,它的名字叫做 NoBug,因为它所有的方法都没有错误。
—— 我:自信是好事,不过为了防止意外,让我测试一下如何?
—— 程序员 A: 怎么测试?
—— 我:把你写的代码的方法都加上 @Jiecha 这个注解就好了。
—— 程序员 A: 好的。
package ceshi;
import ceshi.Jiecha;
public class NoBug {
@Jiecha
public void suanShu(){
System.out.println("1234567890");
}
@Jiecha
public void jiafa(){
System.out.println("1+1="+1+1);
}
@Jiecha
public void jiefa(){
System.out.println("1-1="+(1-1));
}
@Jiecha
public void chengfa(){
System.out.println("3 x 5="+ 3*5);
}
@Jiecha
public void chufa(){
System.out.println("6 / 0="+ 6 / 0);
}
public void ziwojieshao(){
System.out.println("我写的程序没有 bug!");
}
}
上面的代码,有些方法上面运用了 @Jiecha 注解。
这个注解是我写的测试软件框架中定义的注解。
package ceshi;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(RetentionPolicy.RUNTIME)
public @interface Jiecha {
}
然后,我再编写一个测试类 TestTool 就可以测试 NoBug 相应的方法了。
package ceshi;
import java.lang.reflect.InvocationTargetException;
import java.lang.reflect.Method;
public class TestTool {
public static void main(String[] args) {
// TODO Auto-generated method stub
NoBug testobj = new NoBug();
// 获取 testObj 对象 clazz
Class clazz = testobj.getClass();
Method[] method = clazz.getDeclaredMethods();
<span class="hljs-comment">//用来记录测试产生的 log 信息</span>
<span class="hljs-type">StringBuilder</span> <span class="hljs-variable">log</span> <span class="hljs-operator">=</span> <span class="hljs-keyword">new</span> <span class="hljs-title class_">StringBuilder</span>();
<span class="hljs-comment">// 记录异常的次数</span>
<span class="hljs-type">int</span> <span class="hljs-variable">errornum</span> <span class="hljs-operator">=</span> <span class="hljs-number">0</span>;
<span class="hljs-keyword">for</span> ( Method m: method ) {
<span class="hljs-comment">// 只有被 @Jiecha 标注过的方法才进行测试</span>
<span class="hljs-keyword">if</span> ( m.isAnnotationPresent( Jiecha.class )) {
<span class="hljs-keyword">try</span> {
m.setAccessible(<span class="hljs-literal">true</span>);
m.invoke(testobj, <span class="hljs-literal">null</span>);
} <span class="hljs-keyword">catch</span> (Exception e) {
<span class="hljs-comment">// TODO Auto-generated catch block</span>
<span class="hljs-comment">//e.printStackTrace();</span>
errornum++;
log.append(m.getName());
log.append(<span class="hljs-string">" "</span>);
log.append(<span class="hljs-string">"has error:"</span>);
log.append(<span class="hljs-string">"\n\r caused by "</span>);
<span class="hljs-comment">//记录测试过程中,发生的异常的名称</span>
log.append(e.getCause().getClass().getSimpleName());
log.append(<span class="hljs-string">"\n\r"</span>);
<span class="hljs-comment">//记录测试过程中,发生的异常的具体信息</span>
log.append(e.getCause().getMessage());
log.append(<span class="hljs-string">"\n\r"</span>);
}
}
}
log.append(clazz.getSimpleName());
log.append(<span class="hljs-string">" has "</span>);
log.append(errornum);
log.append(<span class="hljs-string">" error."</span>);
<span class="hljs-comment">// 生成测试报告</span>
System.out.println(log.toString());
}
}
测试的结果是:
1234567890
1+1=11
1-1=0
3 x 5=15
chufa has error:
caused by ArithmeticException
/ by zero
NoBug has 1 error.
提示 NoBug 类中的 chufa() 这个方法有异常,这个异常名称叫做 ArithmeticException,原因是运算过程中进行了除 0 的操作。
所以,NoBug 这个类有 Bug。
这样,通过注解我完成了我自己的目的,那就是对别人的代码进行测试。
所以,再问我注解什么时候用?我只能告诉你,这取决于你想利用它干什么用。
注解应用实例
注解运用的地方太多了,如:
JUnit 这个是一个测试框架,典型使用方法如下:
public class ExampleUnitTest {
@Test
public void addition_isCorrect() throws Exception {
assertEquals(4, 2 + 2);
}
}
@Test 标记了要进行测试的方法 addition_isCorrect().
还有例如 ssm 框架等运用了大量的注解。
总结
如果注解难于理解,你就把它类同于标签,标签为了解释事物,注解为了解释代码。
注解的基本语法,创建如同接口,但是多了个 @ 符号。
注解的元注解。
注解的属性。
注解主要给编译器及工具类型的软件用的。
注解的提取需要借助于 Java 的反射技术,反射比较慢,所以注解使用时也需要谨慎计较时间成本。
Java 反射机制
动态语言–程序运行时,可以改变程序结构或变量类型。典型的语言:
- Python、ruby、javascript 等。
C,C++,JAVA 不是动态语言,JAVA 可以称之为“准动态语言”。
但是 JAVA 有一定的动态性,我们可以利用反射机制、字节码操作获得类似动态语言的特性。
JAVA 的动态性让编程的时候更加灵活!
如下 javascript 代码:
functiontest(){ vars ="vara=3;varb=5;alert(a+b);"; eval(s); }
反射机制 reflect
–指的是可以于运行时加载、探知、使用编译期间完全未知的类。
–程序在运行状态中,可以动态加载一个只有名称的类,对于任意一个已加载的类,都能够知道这个类的所有属性和方法;对于任意一个对象,都能够调用它的任意一个方法和属性;
Classc=Class.forName("com.gqz.test.User");
–加载完类之后,在堆内存中,就产生了一个 Class 类型的对象 。一个类只有一个 Class 对象,这个对象就包含了完整的类的结构信息。我们可以通过这个对象看到类的结构。这个对象就像一面镜子,透过这个镜子看到类的结构,所以,我们形象的称之为:反射、。
java.lang.Class 类十分特殊,用来表示 java 中类型 (class/interface/enum/annotation/primitivetype/void) 本身。
–Class 类的对象包含了某个被加载类的结构。一个被加载的类对应一个 Class 对象。
–当一个 class 被加载,或当加载器(classloader)的 defineClass() 被 JVM 调用,JVM 便自动产生一个 Class 对象。
•Class 类是 Reflection 的根源
–针对任何您想动态加载、运行的类,唯有先获得相应的 Class 对象
反射机制常用作用
- 动态加载类、动态获取类的信息(属性、方法、构造器)
- 动态构造对象
- 动态调用类和对象的任意方法、构造器
- 动态调用和处理属性
- 获取泛型信息
- 处理注解
下面通过一个案例演示反射获取类的信息:
反射操作类 User.class
package com.gqz.reflect.bean;
public class User {
private int id;
private String name;
private int age;
<span class="hljs-keyword">public</span> <span class="hljs-title function_">User</span><span class="hljs-params">()</span> {
<span class="hljs-built_in">super</span>();
}
<span class="hljs-keyword">public</span> <span class="hljs-title function_">User</span><span class="hljs-params">(<span class="hljs-type">int</span> id, String name, <span class="hljs-type">int</span> age)</span> {
<span class="hljs-built_in">super</span>();
<span class="hljs-built_in">this</span>.id = id;
<span class="hljs-built_in">this</span>.name = name;
<span class="hljs-built_in">this</span>.age = age;
}
<span class="hljs-keyword">public</span> <span class="hljs-type">int</span> <span class="hljs-title function_">getId</span><span class="hljs-params">()</span> {
<span class="hljs-keyword">return</span> id;
}
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setId</span><span class="hljs-params">(<span class="hljs-type">int</span> id)</span> {
<span class="hljs-built_in">this</span>.id = id;
}
<span class="hljs-keyword">public</span> String <span class="hljs-title function_">getName</span><span class="hljs-params">()</span> {
<span class="hljs-keyword">return</span> name;
}
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setName</span><span class="hljs-params">(String name)</span> {
<span class="hljs-built_in">this</span>.name = name;
}
<span class="hljs-keyword">public</span> <span class="hljs-type">int</span> <span class="hljs-title function_">getAge</span><span class="hljs-params">()</span> {
<span class="hljs-keyword">return</span> age;
}
<span class="hljs-keyword">public</span> <span class="hljs-keyword">void</span> <span class="hljs-title function_">setAge</span><span class="hljs-params">(<span class="hljs-type">int</span> age)</span> {
<span class="hljs-built_in">this</span>.age = age;
}
}
反射的使用
package com.gqz.reflect;
import java.lang.reflect.Constructor;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import com.gqz.reflect.bean.User;
@SuppressWarnings("all")
public class Demo01 {
public static void main(String[] args) {
String path="com.gqz.reflect.bean.User";
<span class="hljs-keyword">try</span> {
Class<User> clazz =(Class<User>)Class.forName(path);
System.out.println(clazz.hashCode());
<span class="hljs-comment">//通过反射API调用构造方法,构造对象</span>
System.out.println(<span class="hljs-string">"直接使用newInstance()调用无参构造方法实例"</span>);
<span class="hljs-type">User</span> <span class="hljs-variable">user</span> <span class="hljs-operator">=</span> clazz.newInstance();<span class="hljs-comment">//调用无参构造器</span>
System.out.println(user);
System.out.println(<span class="hljs-string">"调用指定构造方法实例"</span>);
Constructor<User> constructor = clazz.getDeclaredConstructor(<span class="hljs-type">int</span>.class,String.class,<span class="hljs-type">int</span>.class);<span class="hljs-comment">//获取指定的构造方法</span>
<span class="hljs-type">User</span> <span class="hljs-variable">user2</span> <span class="hljs-operator">=</span> constructor.newInstance(<span class="hljs-number">12</span>,<span class="hljs-string">"甘全中"</span>,<span class="hljs-number">32</span>);
System.out.println(user2+<span class="hljs-string">" name:"</span>+user2.getName());
<span class="hljs-comment">//通过反射API调用普通方法</span>
User user3= clazz.newInstance();
<span class="hljs-type">Method</span> <span class="hljs-variable">method</span> <span class="hljs-operator">=</span> clazz.getDeclaredMethod(<span class="hljs-string">"setName"</span>, String.class);
method.invoke(user3, <span class="hljs-string">"ganquanzhong"</span>); <span class="hljs-comment">//使用invoke</span>
System.out.println(user3.getName());
<span class="hljs-comment">//通过反射API操作属性</span>
User user4= clazz.newInstance();
<span class="hljs-type">Field</span> <span class="hljs-variable">fieldName</span> <span class="hljs-operator">=</span> clazz.getDeclaredField(<span class="hljs-string">"name"</span>);<span class="hljs-comment">//获取属性name</span>
fieldName.setAccessible(<span class="hljs-literal">true</span>);<span class="hljs-comment">//不能访问私有属性 通过setAccessible设置</span>
fieldName.set(user4, <span class="hljs-string">"chenrong"</span>);<span class="hljs-comment">//通过反射直接写属性</span>
System.out.println(fieldName.get(user4));<span class="hljs-comment">//通过反射直接获取属性</span>
} <span class="hljs-keyword">catch</span> (Exception e) {
<span class="hljs-comment">// TODO Auto-generated catch block</span>
e.printStackTrace();
}
}
}