maven编写主代码与测试代码

3.2 编写主代码

项目主代码和测试代码不同,项目的主代码会被打包到最终的构件中(比如jar),而测试代码只在运行测试时用到,不会被打包。默认情况下,Maven假设项目主代码位于src/main/java目录,我们遵循Maven的约定,创建该目录,然后在该目录下创建文件com/juvenxu/mvnbook/helloworld/HelloWorld.java,其内容如代码清单3-2:

代码清单3-2:Hello World的主代码

Java代码  
  1. <span style="font-size: small;">package com.juvenxu.mvnbook.helloworld;
  2. public class HelloWorld
  3. {
  4. public String sayHello()
  5. {
  6. return "Hello Maven";
  7. }
  8. public static void main(String[] args)
  9. {
  10. System.out.print( new HelloWorld().sayHello() );
  11. }
  12. }
  13. </span>

这是一个简单的Java类,它有一个sayHello()方法,返回一个String。同时这个类还带有一个main方法,创建一个HelloWorld实例,调用sayHello()方法,并将结果输出到控制台。

关于该Java代码有两点需要注意。首先,在95%以上的情况下,我们应该把项目主代码放到src/main/java/目录下(遵循Maven的约定),而无须额外的配置,Maven会自动搜寻该目录找到项目主代码。其次,该Java类的包名是com.juvenxu.mvnbook.helloworld,这与我们之前在POM中定义的groupId和artifactId相吻合。一般来说,项目中Java类的包都应该基于项目的groupId和artifactId,这样更加清晰,更加符合逻辑,也方便搜索构件或者Java类。

代码编写完毕后,我们使用Maven进行编译,在项目根目录下运行命令 mvn clean compile ,我们会得到如下输出:

Java代码  
  1. <span style="font-size: small;">[INFO] Scanning for projects...
  2. [INFO] ------------------------------------------------------------------------
  3. [INFO] Building Maven Hello World Project
  4. [INFO]    task-segment: [clean, compile]
  5. [INFO] ------------------------------------------------------------------------
  6. [INFO] [clean:clean {execution: default-clean}]
  7. [INFO] Deleting directory D:\code\hello-world\target
  8. [INFO] [resources:resources {execution: default-resources}]
  9. [INFO] skip non existing resourceDirectory D: \code\hello-world\src\main\resources
  10. [INFO] [compiler:compile {execution: default-compile}]
  11. [INFO] Compiling 1 source file to D: \code\hello-world\target\classes
  12. [INFO] ------------------------------------------------------------------------
  13. [INFO] BUILD SUCCESSFUL
  14. [INFO] ------------------------------------------------------------------------
  15. [INFO] Total time: 1 second
  16. [INFO] Finished at: Fri Oct 09 02:08:09 CST 2009
  17. [INFO] Final Memory: 9M/16M
  18. [INFO] ------------------------------------------------------------------------
  19. </span>

clean告诉Maven清理输出目录target/,compile告诉Maven编译项目主代码,从输出中我们看到Maven首先执行了clean:clean任务,删除target/目录,默认情况下Maven构建的所有输出都在target/目录中;接着执行resources:resources任务(未定义项目资源,暂且略过);最后执行compiler:compile任务,将项目主代码编译至target/classes目录(编译好的类为com/juvenxu/mvnbook/helloworld/HelloWorld.Class)。

上文提到的clean:clean、resources:resources,以及compiler:compile对应了一些Maven插件及插件目标,比如clean:clean是clean插件的clean目标,compiler:compile是compiler插件的compile目标,后文会详细讲述Maven插件及其编写方法。

至此,Maven在没有任何额外的配置的情况下就执行了项目的清理和编译任务,接下来,我们编写一些单元测试代码并让Maven执行自动化测试。

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添加依赖

Java代码  
  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0"
  3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
  5. http://maven.apache.org/maven-v4_0_0.xsd">
  6. <modelVersion>4.0.0</modelVersion>
  7. <groupId>com.juvenxu.mvnbook</groupId>
  8. <artifactId>hello-world</artifactId>
  9. <version>1.0-SNAPSHOT</version>
  10. <name>Maven Hello World Project</name>
  11. <dependencies>
  12. <dependency>
  13. <groupId>junit</groupId>
  14. <artifactId>junit</artifactId>
  15. <version>4.7</version>
  16. <scope>test</scope>
  17. </dependency>
  18. </dependencies>
  19. </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的测试代码

Java代码  
  1. package com.juvenxu.mvnbook.helloworld;
  2. import static org.junit.Assert.assertEquals;
  3. import org.junit.Test;
  4. public class HelloWorldTest
  5. {
  6. @Test
  7. public void testSayHello()
  8. {
  9. HelloWorld helloWorld = new HelloWorld();
  10. String result = helloWorld.sayHello();
  11. assertEquals( "Hello Maven", result );
  12. }
  13. }

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

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

Java代码  
  1. [INFO] Scanning for projects...
  2. [INFO] ------------------------------------------------------------------------
  3. [INFO] Building Maven Hello World Project
  4. [INFO]    task-segment: [clean, test]
  5. [INFO] ------------------------------------------------------------------------
  6. [INFO] [clean:clean {execution: default-clean}]
  7. [INFO] Deleting directory D:\git-juven\mvnbook\code\hello-world\target
  8. [INFO] [resources:resources {execution: default-resources}]
  9. Downloading: http://repo1.maven.org/maven2/junit/junit/4.7/junit-4.7.pom
  10. 1K downloaded  (junit-4.7.pom)
  11. [INFO] [compiler:compile {execution: default-compile}]
  12. [INFO] Compiling 1 source file to D: \code\hello-world\target\classes
  13. [INFO] [resources:testResources {execution: default-testResources}]
  14. Downloading: http://repo1.maven.org/maven2/junit/junit/4.7/junit-4.7.jar
  15. 226K downloaded  (junit-4.7.jar)
  16. [INFO] [compiler:testCompile {execution: default-testCompile}]
  17. [INFO] Compiling 1 source file to D:\ code\hello-world\target\test-classes
  18. [INFO] ------------------------------------------------------------------------
  19. [ERROR] BUILD FAILURE
  20. [INFO] ------------------------------------------------------------------------
  21. [INFO] Compilation failure
  22. D:\code\hello-world\src\test\java\com\juvenxu\mvnbook\helloworld\HelloWorldTest.java:[8,5] -source 1.3 中不支持注释
  23. (请使用 -source 5 或更高版本以启用注释)
  24. @Test
  25. [INFO] ------------------------------------------------------------------------
  26. [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

Java代码  
  1. <project>
  2. <build>
  3. <plugins>
  4. <plugin>
  5. <groupId>org.apache.maven.plugins</groupId>
  6. <artifactId>maven-compiler-plugin</artifactId>
  7. <configuration>
  8. <source>1.5</source>
  9. <target>1.5</target>
  10. </configuration>
  11. </plugin>
  12. </plugins>
  13. </build>
  14. </project>

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

Java代码  
  1. [INFO] [compiler:testCompile {execution: default-testCompile}]
  2. [INFO] Compiling 1 source file to D: \code\hello-world\target\test-classes
  3. [INFO] [surefire:test {execution: default-test}]
  4. [INFO] Surefire report directory: D:\code\hello-world\target\surefire-reports
  5. -------------------------------------------------------
  6. T E S T S
  7. -------------------------------------------------------
  8. Running com.juvenxu.mvnbook.helloworld.HelloWorldTest
  9. Tests run: 1, Failures: 0, Errors: 0, Skipped: 0, Time elapsed: 0.055 sec
  10. Results :
  11. Tests run: 1, Failures: 0, Errors: 0, Skipped: 0
  12. [INFO] ------------------------------------------------------------------------
  13. [INFO] BUILD SUCCESSFUL
  14. [INFO] ------------------------------------------------------------------------

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

转载于:https://www.cnblogs.com/hoobey/p/6071182.html

mvn编写主代码与测试代码相关推荐

  1. 【camera】自动泊车-基于深度学习的视觉车位检测项目(课程设计--训练代码、测试代码、部署demo)(2)

    **基于深度学习的点定位回归和角度预测的车位检测 基于深度学习的点定位回归和角度预测 基于深度学习的角点检测和角度回归 ** 项目下载地址:训练代码.测试代码.部署demo 数据集百度网盘下载:数据集 ...

  2. apachejmeter_java源码_自定义编写jmeter的Java测试代码

    我们在做性能测试时,有时需要自己编写测试脚本,很多测试工具都支持自定义编写测试脚本,比如LoadRunner就有很多自定义脚本的协议,比如"C Vuser","JavaV ...

  3. 基于FPGA的多路抢答器设计程序代码与测试代码

    (1) 主程序代码: module who_is_the_best(clk,rset,start,rusher1,rusher2,rusher3,rusher4,rusher5,rusher6,tim ...

  4. SGM代码及其测试代码和结果

    SGM代码 github上边已经有很多开源的SGM代码了,下面就给出几个已经试过好用的代码,以免忘记下载的代码来自哪个连接. gishi523 /semi-global-matching :基于CSC ...

  5. idea2020shezhi代码检查级别_优秀的模糊测试代码是如何炼成的?

    所谓模糊测试,是指一种通过向目标系统提供非预期的输入并监视异常结果来发现软件漏洞的方法,它经过了近 20 年的发展,早已在程序员圈中成为一种主流漏洞挖掘技术.基于此,开发者们该如何编写良好的模糊测试代 ...

  6. 隐藏画质代码_优秀的模糊测试代码是如何炼成的?

    所谓模糊测试,是指一种通过向目标系统提供非预期的输入并监视异常结果来发现软件漏洞的方法,它经过了近 20 年的发展,早已在程序员圈中成为一种主流漏洞挖掘技术.基于此,开发者们该如何编写良好的模糊测试代 ...

  7. 优秀的模糊测试代码是如何炼成的?

    所谓模糊测试,是指一种通过向目标系统提供非预期的输入并监视异常结果来发现软件漏洞的方法,它经过了近 20 年的发展,早已在程序员圈中成为一种主流漏洞挖掘技术.基于此,开发者们该如何编写良好的模糊测试代 ...

  8. 【测试与自动化】介绍-框架-Jest-覆盖率-异步代码-e2e-Vue测试

    测试与自动化 软件测试和自动化测试介绍 前端自动化测试框架 使用Jest编写单元测试 统计测试覆盖率 使用Jest测试异步代码 使用Cypress进行e2e测试 测试 Vue 项目 软件测试和自动化测 ...

  9. Vivado 程序计数器(含测试代码)

    本篇文章使用Verilog语言编写实现带有优先级的83译码器,含有设计代码和测试代码. 一. 程序计数器,带有同步复位功能,有复位信号rst时,输出指令存储器使能信号为ce(0),表示指令存储器禁用, ...

最新文章

  1. R语言eval函数评估表达式或者字符串实战
  2. 为什么鸿蒙比安卓快,有人说华为鸿蒙比安卓快60%,你觉得可信吗,为什么?
  3. JConsole监控远程Tomcat服务器
  4. YunYang1994/tensorflow-yolov3 ValueError: cannot reshape array of size 43095 into shape (6) 解决办法
  5. keil5建立多文件的时候为什么总是出错
  6. Docker之Linux Cgroups
  7. 清华大学《操作系统》(二十二):文件系统
  8. [转载] Controller报错:java.lang.NoSuchMethodException: java.util.List.<init>()
  9. Ruby on Rails Exception:Routing Error
  10. mysql 入门 jdbc
  11. [网络流24题-9]试题库问题
  12. 超码、候选码、主码 与 外码
  13. matlab数字转换罗马数字,罗马数字(1到1000) 1到1000的叠加是多少
  14. 万物互联所必需的泛在物联网建设需要多少钱?成本低到不可想象
  15. Python:绘制动态地图-pyecharts
  16. 51单片机:LED流水灯(仿真+代码)
  17. 智能家居到智慧家庭-由远程操作设备到家庭智慧服务
  18. Windows DPC详解
  19. NETDMIS5.0自动测量圆柱2023
  20. 单源广度优先搜索 (leetcode经典例题 C++实现)

热门文章

  1. 访问量大如何增加服务器,服务器流量过大原因及解决方法
  2. 属性被分为八大类不包括_Python语言---私有属性
  3. bio java 例子_JAVA BIO 服务器与客户端实现示例
  4. 浏览器打印设置横向打印_爱普生打印机无线连接设置
  5. java 工作6年 面试_为什么不想搞Java了,6年经验去面试5分钟结束,现在Java面试为何这么难...
  6. angular点击按钮弹出页面_Win10提示“由于启动计算机时出现了页面文件配置问题”解决方法...
  7. Max retries exceeded with url 解决方案
  8. scala部分应用函数_Scala中的部分函数
  9. dig下载_DIG的完整形式是什么?
  10. 计算机图形学画线_在计算机图形学中直接使用线方程