3.3　编写测试代码

3.3　编写测试代码

为了使项目结构保持清晰，主代码与测试代码应该分别位于独立的目录中。3.2节讲过Maven项目中默认的主代码目录是src/main/java，对应地，Maven项目中默认的测试代码目录是src/test/java。因此，在编写测试用例之前，应当先创建该目录。

在Java世界中，由Kent Beck和Erich Gamma建立的JUnit是事实上的单元测试标准。要使用JUnit，首先需要为Hello World项目添加一个JUnit依赖，修改项目的POM如代码清单3-3所示：

代码清单3-3　为Hello World的POM添加依赖

＜?xml version="1.0"encoding="UTF-8"?＞

＜project xmlns="http://maven.apache.org/POM/4.0.0"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:schemaLocation="http://maven.apache.org/POM/4.0.0

http://maven.apache.org/maven-v4_0_0.xsd"＞

＜modelVersion＞4.0.0＜/modelVersion＞

＜groupId＞com.juvenxu.mvnbook＜/groupId＞

＜artifactId＞hello-world＜/artifactId＞

＜version＞1.0-SNAPSHOT＜/version＞

＜name＞Maven Hello World Project＜/name＞

＜dependencies＞

＜dependency＞

＜groupId＞junit＜/groupId＞

＜artifactId＞junit＜/artifactId＞

＜version＞4.7＜/version＞

＜scope＞test＜/scope＞

＜/dependency＞

＜/dependencies＞

＜/project＞

代码中添加了dependencies元素，该元素下可以包含多个dependency元素以声明项目的依赖。这里添加了一个依赖——groupId是junit,artifactId是junit,version是4.7。前面提到groupId、artifactId和version是任何一个Maven项目最基本的坐标，JUnit也不例外，有了这段声明，Maven就能够自动下载junit-4.7.jar。也许你会问，Maven从哪里下载这个jar呢？在Maven之前，可以去JUnit的官方网站下载分发包，有了Maven，它会自动访问中央仓库（http://repo1.maven.org/maven2/），下载需要的文件。读者也可以自己访问该仓库，打开路径junit/junit/4.7/，就能看到junit-4.7.pom和junit-4.7.jar。第6章会详细介绍Maven仓库及中央仓库。

上述POM代码中还有一个值为test的元素scope,scope为依赖范围，若依赖范围为test则表示该依赖只对测试有效。换句话说，测试代码中的import JUnit代码是没有问题的，但是如果在主代码中用import JUnit代码，就会造成编译错误。如果不声明依赖范围，那么默认值就是compile，表示该依赖对主代码和测试代码都有效。

配置了测试依赖，接着就可以编写测试类。回顾一下前面的HelloWorld类，现在要测试该类的sayHello（）方法，检查其返回值是否为“Hello Maven”。在src/test/java目录下创建文件，其内容如代码清单3-4所示：

代码清单3-4　Hello World的测试代码

package com.juvenxu.mvnbook.helloworld；

import static org.junit.Assert.assertEquals；

import org.junit.Test；

public class HelloWorldTest

{

@Test

public void testSayHello（）

{

HelloWorld helloWorld=new HelloWorld（）；

String result=helloWorld.sayHello（）；

assertEquals（"Hello Maven"，result）；

}

一个典型的单元测试包含三个步骤：①准备测试类及数据；②执行要测试的行为；③检查结果。上述样例首先初始化了一个要测试的HelloWorld实例，接着执行该实例的sayHello（）方法并保存结果到result变量中，最后使用JUnit框架的Assert类检查结果是否为我们期望的“Hello Maven”。在JUnit 3中，约定所有需要执行测试的方法都以test开头，这里使用了JUnit 4，但仍然遵循这一约定。在JUnit 4中，需要执行的测试方法都应该以@Test进行标注。

测试用例编写完毕之后就可以调用Maven执行测试。运行mvn clean test：

[INFO]

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－

[INFO] Building Maven Hello World Project

[INFO]task-segment: [clean, test]

[INFO]

[INFO] [clean:clean {execution: default-clean}]

[INFO] Deleting directory D:＼git-juven＼mvnbook＼code＼hello-world＼target

[INFO] [resources:resources {execution: default-resources}]

… Downloading: http:／／repo1.maven.org／maven2 ／

junit／junit／4.7 ／

junit-4.7.pom

1K downloaded (junit-4.7.pom)

[INFO] [compiler:compile {execution: default-compile}]

[INFO] Compiling 1 source file to D: ＼code＼hello-world＼target＼classes

[INFO] [resources:testResources {execution: default-testResources}]

…D

ownloading: http:／／repo1.maven.org／maven2 ／junit／junit／4.7 ／junit-4.7.jar

226K downloaded (junit-4.7.jar)

[INFO] [compiler:testCompile {execution: default-testCompile}]

[INFO] Compiling 1 source file to D:＼code＼hello-world＼target＼test-classes

[INFO]

[ERROR] BUILD FAILURE

[INFO]

[INFO] Compilation failure

D:＼code ＼ hello-world ＼ src ＼ test ＼ java ＼ com ＼ juvenxu ＼ mvnbook ＼ helloworld ＼ HelloWorldTest.

java:[8,5] -source 1.3 中不支持注释

（请使用-source 5 或更高版本以启用注释）

@ Test

[INFO]

[INFO] For more information, run Maven with the-e switch

…

不幸的是构建失败了，先耐心分析一下这段输出（为了本书的简洁，一些不重要的信息用省略号略去了）。命令行输入的是mvn clean test，而Maven实际执行的可不止这两个任务，还有clean:clean、resources:resources、compiler:compile、resources:testResources以及compiler:testCompile。暂时需要了解的是，在Maven执行测试（test）之前，它会先自动执行项目主资源处理、主代码编译、测试资源处理、测试代码编译等工作，这是Maven生命周期的一个特性。本书后续章节会详细解释Maven的生命周期。

从输出中还看到：Maven从中央仓库下载了junit-4.7.pom和junit-4.7.jar这两个文件到本地仓库（～/.m2/repository）中，供所有Maven项目使用。

构建在执行compiler:testCompile任务的时候失败了，Maven输出提示我们需要使用-source 5或更高版本以启动注释，也就是前面提到的JUnit 4的@Test注解。这是Maven初学者常常会遇到的一个问题。由于历史原因，Maven的核心插件之一——compiler插件默认只支持编译Java 1.3，因此需要配置该插件使其支持Java 5，见代码清单3-5。

代码清单3-5　配置maven-compiler-plugin支持Java 5

＜project＞

……

＜build＞

＜plugins＞

＜plugin＞

＜groupId＞org.apache.maven.plugins＜/groupId＞

＜artifactId＞maven-compiler-plugin＜/artifactId＞

＜configuration＞

＜source＞1.5＜/source＞

＜target＞1.5＜/target＞

＜/configuration＞

＜/plugin＞

＜/plugins＞

＜/build＞

……

＜/project＞

该POM省略了除插件配置以外的其他部分。我们暂且不去关心插件配置的细节，只需要知道compiler插件支持Java 5的编译。现在再执行mvn clean test，输出如下：

[INFO][compiler:testCompile{execution:default-testCompile}]

[INFO] Compiling 1 source file to D: ＼code＼hello-world＼target＼test-classes

[INFO] [surefire:test {execution: default-test}]

[INFO] Surefire report directory: D:＼code＼hello-world＼target＼surefire-reports

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－

T E S T S

－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－－

Running com.juvenxu.mvnbook.helloworld.HelloWorldTest

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.055 sec

Results :

Tests run: 1, Failures: 0, Errors: 0, Skipped: 0

[INFO]

[INFO] BUILD SUCCESSFUL

[INFO]

…

我们看到compiler:testCompile任务执行成功了，测试代码通过编译之后在target/test-classes下生成了二进制文件，紧接着surefire:test任务运行测试，surefire是Maven中负责执行测试的插件，这里它运行测试用例HelloWorldTest，并且输出测试报告，显示一共运行了多少测试，失败了多少，出错了多少，跳过了多少。显然，我们的测试通过了。

3.3 编写测试代码