Java注解(Annotation)与JUnit单元测试

导读:本篇文章讲解 Java注解(Annotation)与JUnit单元测试,希望对大家有帮助,欢迎收藏,转发!站点地址:www.bmabk.com,来源:原文

也许你感觉自己的努力总是徒劳无功,但不必怀疑,你每天都离顶点更进一步。今天的你离顶点还遥遥无期。但你通过今天的努力,积蓄了明天勇攀高峰的力量。加油!

注解(Annotation)概述

  • ① 从 JDK 5.0 开始, Java 增加了对元数据(MetaData) 的支持, 也就是Annotation(注解)
  • ② Annotation 其实就是代码里的特殊标记, 这些标记可以在编译, 类加载, 运行时被读取, 并执行相应的处理通过使用 Annotation, 程序员可以在不改变原有逻辑的情况下, 在源文件中嵌入一些补充信息
  • ③Annotation 可以像修饰符一样被使用, 可用于修饰包,, 构造器, 方法, 成员变量, 参数, 局部变量的声明, 这些信息被保存在Annotation 的 “name=value” 对中。
  • ④在JavaSE中,注解的使用目的比较简单,例如标记过时的功能,忽略警告等。在JavaEE/Android中注解占据了更重要的角色,例如用来配置应用程序的任何切面,代替JavaEE旧版中所遗留的繁冗代码和XML配置等。
  • ⑤未来的开发模式都是基于注解的,JPA是基于注解的,Spring2.5以上都是基于注解的,Hibernate3.x以后也是基于注解的,现在的Struts2有一部分也是基于注解的了,注解是一种趋势,一定程度上可以说:框架 = 注解 + 反射 + 设计模式

常见的Annotation实例

  • ①生成文档相关的注释
  • ②在编译时进行格式检查(JDK内置的三个基本注解)
  • ③跟踪代码依赖性,实现替代配置文件功能

情况一

@author 标明开发该类模块的作者,多个作者之间使用“,”分割
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@since 从哪个版本开始增加的
@param 对方法中某参数的说明,如果没有参数就不能写
@return 对方法返回值的说明,如果方法的返回值类型是void就不能写
@exception 对方法可能抛出的异常进行说明 ,如果方法没有用throws显式抛出的异常就不能写
其中
@param @return 和 @exception 这三个标记都是只用于方法的。
@param的格式要求:@param 形参名 形参类型 形参说明
@return 的格式要求:@return 返回值类型 返回值说明
@exception的格式要求:@exception 异常类型 异常说明
@param和@exception可以并列多个

情况二

  • @Override: 限定重写父类方法, 该注解只能用于方法
  • @Deprecated: 用于表示所修饰的元素(类, 方法等)已过时。通常是因为
    所修饰的结构危险或存在更好的选择
  • @SuppressWarnings: 抑制编译器警告

说明:为什么要用@Override?直接重写当然也可以,当用@Override的时候编译器会自动帮你检测你是否进行了重写,这也就为你的程序提供了一个保障。避免了重写的时候输错了重写的方法名,而导致并没有重写父类中的方法的情况。

代码示例:

public class AnnotationTest{
	public static void main(String[] args) {
		@SuppressWarnings("unused")
		int a = 10;
	}
	@Deprecated
	public void print(){  //在编译器中这种过时的的方法都会被画一条线
		System.out.println("过时的方法");
	}
	@Override
	public String toString() {
		return "重写的toString方法()";
	}
}

自定义Annotation

注意点

  • 定义新的 Annotation 类型使用 @interface 关键字
  • 自定义注解自动继承了java.lang.annotation.Annotation接口
  • Annotation 的成员变量在 Annotation 定义中以无参数方法的形式来声明。其方法名和返回值定义了该成员的名字和类型。我们称为配置参数。类型只能是八种基本数据类型、String类型、Class类型、enum类型Annotation类型、以上所有类型的数组
  • 可以在定义 Annotation 的成员变量时为其指定初始值, 指定成员变量的初始值可使用 default 关键字
  • 如果只有一个参数成员,建议使用参数名为value
  • 如果定义的注解含有配置参数,那么使用时必须指定参数值,除非它有默认值。格式是“参数名 = 参数值”,如果只有一个参数成员,且名称为value,可以省略“value=”
  • 没有成员定义的 Annotation 称为标记; 包含成员变量的 Annotation 称为元数据 Annotation

例如:

public @interface MyAnnotation {

    String value() default "hello";
}

这个注解到底有什么作用,在反射和框架中会提到。
自定义注解必须配上注解的信息处理流程才有意义

JDK中的元注解

在理解元注解之前我们先理解元数据。那么什么是元数据呢,我们可以先看看下面的一段代码:

String name = "CSDN"

一个简单的赋值语句,在这个句子中我们可以说CSDN才是最主要的,他是真正我们想要的数据,而前面的String,name等这些东西都是起到一种修饰的作用,所以我们称它们为元数据也就是说对现有数据进行修饰的数据。那么同理我们也可以知道元注解的意思。

元注解:对现有的注解进行解释说明的注解

JDK5.0提供了4个标准的meta-annotation(元注解)类型:

  • Retention(一般自定义注解会指明)
  • Target(一般自定义注解会指明)
  • Documented(出现频率低)
  • Inherited(出现频率低)

@Retention

只能用于修饰一个 Annotation 定义, 用于指定该 Annotation 的生命周期, @Rentention 包含一个 RetentionPolicy 类型的成员变量, 使用@Rentention 时必须为该 value 成员变量指定值。
:这个RetentionPolicy是一个枚举类,它有三个对象分别是 SOURCE,CLASS,RUNTIME

public enum RetentionPolicy{
	SOURCE,
	CLASS,
	RUNTIME
}

@Rentention 成员变量的几个指定值:

  • RetentionPolicy.SOURCE:在源文件中有效(即源文件保留),编译器直接丢弃这种策略的注释
  • RetentionPolicy.CLASS:在class文件中有效(即class保留) , 当运行 Java 程序时, JVM 不会保留注解。 这是默认值
  • RetentionPolicy.RUNTIME:在运行时有效(即运行时保留),当运行 Java 程序时, JVM 会保留注释。程序可以通过反射获取该注释

例如:

@Retention(RetentionPolicy.SOURCE)
@interface MyAnnotation1{ }

@Retention(RetentionPolicy.RUNTIME)
@interface MyAnnotation2{ }

生命周期
也就是说只有声明为RUNTIME生命周期的注解,才能通过反射获取

@Target

用于修饰 Annotation 定义, 用于指定被修饰的 Annotation 能用于修饰哪些程序元素。 @Target 也包含一个名为 value 的成员变量。

target
例如:

@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
@Retention(RetentionPolicy.SOURCE)
public @interface SuppressWarnings {········}

而在Target中:

public @interface Target {
    /**
     * Returns an array of the kinds of elements an annotation type
     * can be applied to.
     * @return an array of the kinds of elements an annotation type
     * can be applied to
     */
    ElementType[] value();
}

这个ElementType同样也是一个枚举类:

public enum ElementType {
    /** Class, interface (including annotation type), or enum declaration */
    TYPE,

    /** Field declaration (includes enum constants) */
    FIELD,

    /** Method declaration */
    METHOD,

    /** Formal parameter declaration */
    PARAMETER,

    /** Constructor declaration */
    CONSTRUCTOR,

    /** Local variable declaration */
    LOCAL_VARIABLE,

    /** Annotation type declaration */
    ANNOTATION_TYPE,

    /** Package declaration */
    PACKAGE,

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
}

@Documented

用于指定被该元 Annotation 修饰的 Annotation 类将被javadoc 工具提取成文档。默认情况下,javadoc是不包括注解的。

注意:定义为Documented的注解必须设置Retention值为RUNTIME。

@Inherited

被它修饰的 Annotation 将具有继承性。如果某个类使用了被@Inherited 修饰的 Annotation, 则其子类将自动具有该注解。

JDK8中注解的新特性

  • 可重复注解
  • 类型注解

可重复注解

例如现在我要给Person类添加两个同类型的注解MyAnnotation。
在JDK8以前:
要先定义一个

public @interface MyAnnotations {

    MyAnnotation[] value();
}

然后:

@MyAnnotations({@MyAnnotation(value="hi"),@MyAnnotation(value="hi")})
class Person{······}

也就是说相当于定义了一个数组可以把多个都装起来。

而在JDK8以后,有了可重复注解的特性:

  • ① 在MyAnnotation上声明@Repeatable,成员值为MyAnnotations.class
  • ② MyAnnotation的Target和Retention等元注解与MyAnnotations相同。(如此编译时能通过,但发现在运行时不过,也就是说@Inherited也要相同)

相关代码:

@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE})
public @interface MyAnnotations {

    MyAnnotation[] value();
}
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {

    String value() default "hello";
}

就可以实现:

@MyAnnotation(value="hi")
@MyAnnotation(value="abc")
class Person{······}

类型注解

就是Target元注解新增了两个值

    /**
     * Type parameter declaration
     *
     * @since 1.8
     */
    TYPE_PARAMETER,

    /**
     * Use of a type
     *
     * @since 1.8
     */
    TYPE_USE
  • ElementType.TYPE_PARAMETER 表示该注解能写在类型变量的声明语句中(如:泛型声明)
  • ElementType.TYPE_USE 表示该注解能写在使用类型的任何语句中。

例如下面的代码:

class Generic<@MyAnnotation T>{

    public void show() throws @MyAnnotation RuntimeException{

        ArrayList<@MyAnnotation String> list = new ArrayList<>();

        int num = (@MyAnnotation int) 10L;
    }

}

第一个注解能去修饰泛型,就是因为Target中加入了TYPE_PARAMETER
后面三个注解能这么使用,是因为Target中加入了TYPE_USE。

@Inherited
@Repeatable(MyAnnotations.class)
@Retention(RetentionPolicy.RUNTIME)
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE,TYPE_PARAMETER,TYPE_USE})
public @interface MyAnnotation {

    String value() default "hello";
}

JUnit单元测试

测试分类

黑盒测试: 不需要写代码,给输入值,看程序是否能够输出期望的值。

白盒测试: 需要写代码的。关注程序具体的执行流程。

在这里插入图片描述

在这里插入图片描述

JUnit单元测试介绍

JUnit 是由 Erich Gamma 和 Kent Beck 编写的一个测试框架(regression testing framework),供Java开发人员编写单元测试之用。

JUnit测试是程序员测试,即所谓白盒测试,因为程序员知道被测试的软件如何(How)完成功能和完成什么样(What)的功能。

要使用JUnit,必须在项目的编译路径中引入JUnit的库,即相关的.class文件组成的jar包。jar就是一个压缩包,压缩包都是开发好的第三方(Oracle公司第一方,我们自己第二方,其他都是第三方)工具类,都是以class文件形式存在的。

引入本地JUnit.jar

第1步:在项目中File-Project Structure中操作:添加Libraries库

在这里插入图片描述

在这里插入图片描述

其中,junit-libs包内容如下:

在这里插入图片描述

一定要注意Junit模块支持需要两个文件:hamcrest&JUnit,如果少了hamcrest的jar包会报java.lang.Exception: No tests found matching

第2步:选择要在哪些module中应用JUnit库

在这里插入图片描述

第3步:检查是否应用成功

在这里插入图片描述

注意Scope:选择Compile,否则编译时,无法使用JUnit。

第4步:下次如果有新的模块要使用该libs库,这样操作即可

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

在这里插入图片描述

编写和运行@Test单元测试方法

JUnit4版本,要求@Test标记的方法必须满足如下要求:

  • 所在的类必须是public的,非抽象的,包含唯一的无参构造器。
  • @Test标记的方法本身必须是public,非抽象的,非静态的,void无返回值,()无参数的。
package com.atguigu.junit;

import org.junit.Test;

public class TestJUnit {
    @Test
    public void test01(){
        System.out.println("TestJUnit.test01");
    }

    @Test
    public void test02(){
        System.out.println("TestJUnit.test02");
    }

    @Test
    public void test03(){
        System.out.println("TestJUnit.test03");
    }
}

在这里插入图片描述

设置执行JUnit用例时支持控制台输入

1. 设置数据:

默认情况下,在单元测试方法中使用Scanner时,并不能实现控制台数据的输入。需要做如下设置:

idea64.exe.vmoptions配置文件中加入下面一行设置,重启idea后生效。

-Deditable.java.test.console=true

2. 配置文件位置:

在这里插入图片描述

在这里插入图片描述

添加完成之后,重启IDEA即可。

3. 如果上述位置设置不成功,需要继续修改如下位置

修改位置1:IDEA安装目录的bin目录(例如:D:\develop_tools\IDEA\IntelliJ IDEA 2022.1.2\bin)下的idea64.exe.vmoptions文件。

修改位置2:C盘的用户目录C:\Users\用户名\AppData\Roaming\JetBrains\IntelliJIdea2022.1 下的idea64.exe.vmoptions`件。

定义test测试方法模板

选中自定义的模板组,点击”+”(1.Live Template)来定义模板。

在这里插入图片描述

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。

文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/122326.html

(0)
飞熊的头像飞熊bm

相关推荐

发表回复

登录后才能评论
极客之音——专业性很强的中文编程技术网站,欢迎收藏到浏览器,订阅我们!