zl程序教程

您现在的位置是:首页 >  后端

当前栏目

Maven 项目模板

2023-09-14 09:14:11 时间

Maven 使用 archetype(原型) 来创建自定义的项目结构,形成 Maven 项目模板。

在前面章节我们学到 Maven 使用下面的命令来快速创建 java 项目: 

  1. mvn archetype:generate

什么是 archetype?

archetype 也就是原型,是一个 Maven 插件,准确说是一个项目模板,它的任务是根据模板创建一个项目结构。我们将使用 quickstart 原型插件创建一个简单的 java 应用程序。


使用项目模板

让我们打开命令控制台,跳转到 C:> MVN 目录并执行以下 mvn 命令:

  1. C:\MVN> mvn archetype:generate

Maven 将开始处理,并要求选择所需的原型:

  1. [INFO] Scanning for projects...
  2. [INFO] Searching repository for plugin with prefix: 'archetype'.
  3. [INFO] -------------------------------------------------------------------
  4. [INFO] Building Maven Default Project
  5. [INFO]task-segment: [archetype:generate] (aggregator-style)
  6. [INFO] -------------------------------------------------------------------
  7. [INFO] Preparing archetype:generate
  8. ...
  9. 600: remote -> org.trailsframework:trails-archetype (-)
  10. 601: remote -> org.trailsframework:trails-secure-archetype (-)
  11. 602: remote -> org.tynamo:tynamo-archetype (-)
  12. 603: remote -> org.wicketstuff.scala:wicket-scala-archetype (-)
  13. 604: remote -> org.wicketstuff.scala:wicketstuff-scala-archetype
  14. Basic setup for a project that combines Scala and Wicket,
  15. depending on the Wicket-Scala project.
  16. Includes an example Specs test.)
  17. 605: remote -> org.wikbook:wikbook.archetype (-)
  18. 606: remote -> org.xaloon.archetype:xaloon-archetype-wicket-jpa-glassfish (-)
  19. 607: remote -> org.xaloon.archetype:xaloon-archetype-wicket-jpa-spring (-)
  20. 608: remote -> org.xwiki.commons:xwiki-commons-component-archetype
  21. (Make it easy to create a maven project for creating XWiki Components.)
  22. 609: remote -> org.xwiki.rendering:xwiki-rendering-archetype-macro
  23. (Make it easy to create a maven project for creating XWiki Rendering Macros.)
  24. 610: remote -> org.zkoss:zk-archetype-component (The ZK Component archetype)
  25. 611: remote -> org.zkoss:zk-archetype-webapp (The ZK wepapp archetype)
  26. 612: remote -> ru.circumflex:circumflex-archetype (-)
  27. 613: remote -> se.vgregion.javg.maven.archetypes:javg-minimal-archetype (-)
  28. 614: remote -> sk.seges.sesam:sesam-annotation-archetype (-)
  29. Choose a number or apply filter
  30. (format: [groupId:]artifactId, case sensitive contains): 203:

按下 Enter 选择默认选项 (203:maven-archetype-quickstart)。


Maven 将询问原型的版本

  1. Choose org.apache.maven.archetypes:maven-archetype-quickstart version:
  2. 1: 1.0-alpha-1
  3. 2: 1.0-alpha-2
  4. 3: 1.0-alpha-3
  5. 4: 1.0-alpha-4
  6. 5: 1.0
  7. 6: 1.1
  8. Choose a number: 6:

按下 Enter 选择默认选项 (6: maven-archetype-quickstart:1.1)

Maven 将询问项目细节。按要求输入项目细节。如果要使用默认值则直接按 Enter 键。你也可以输入自己的值。

  1. Define value for property 'groupId': : com.companyname.insurance
  2. Define value for property 'artifactId': : health
  3. Define value for property 'version': 1.0-SNAPSHOT
  4. Define value for property 'package': com.companyname.insurance

Maven 将要求确认项目细节,按 Enter 或按 Y

  1. Confirm properties configuration:
  2. groupId: com.companyname.insurance
  3. artifactId: health
  4. version: 1.0-SNAPSHOT
  5. package: com.companyname.insurance
  6. Y:

现在 Maven 将开始创建项目结构,显示如下:

  1. [INFO] -----------------------------------------------------------------------
  2. [INFO] Using following parameters for creating project
  3. from Old (1.x) Archetype: maven-archetype-quickstart:1.1
  4. [INFO] -----------------------------------------------------------------------
  5. [INFO] Parameter: groupId, Value: com.companyname.insurance
  6. [INFO] Parameter: packageName, Value: com.companyname.insurance
  7. [INFO] Parameter: package, Value: com.companyname.insurance
  8. [INFO] Parameter: artifactId, Value: health
  9. [INFO] Parameter: basedir, Value: C:\MVN
  10. [INFO] Parameter: version, Value: 1.0-SNAPSHOT
  11. [INFO] project created from Old (1.x) Archetype in dir: C:\MVN\health
  12. [INFO] -----------------------------------------------------------------------
  13. [INFO] BUILD SUCCESSFUL
  14. [INFO] -----------------------------------------------------------------------
  15. [INFO] Total time: 4 minutes 12 seconds
  16. [INFO] Finished at: Fri Jul 13 11:10:12 IST 2012
  17. [INFO] Final Memory: 20M/90M
  18. [INFO] -----------------------------------------------------------------------

创建的项目

现在转到 C:\ > MVN 目录。你会看到一个名为 health 的 java 应用程序项目,就像在项目创建的时候建立的 artifactId 名称一样。 Maven 将创建一个有标准目录布局的项目,如下所示:


创建 pom.xml

Maven 为项目自动生成一个 pom.xml文件,如下所示:

  1. <project xmlns="http://maven.apache.org/POM/4.0.0"
  2. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
  4. http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5. <modelVersion>4.0.0</modelVersion>
  6. <groupId>com.companyname.insurance</groupId>
  7. <artifactId>health</artifactId>
  8. <version>1.0-SNAPSHOT</version>
  9. <packaging>jar</packaging>
  10. <name>health</name>
  11. <url>http://maven.apache.org</url>
  12. <properties>
  13. <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
  14. </properties>
  15. <dependencies>
  16. <dependency>
  17. <groupId>junit</groupId>
  18. <artifactId>junit</artifactId>
  19. <version>3.8.1</version>
  20. <scope>test</scope>
  21. </dependency>
  22. </dependencies>
  23. </project>

App.java

Maven 会自动生成一个测试的 java 文件 App.java。

路径:C:\MVN\consumerBanking\src\main\java\com\companyname\bank

  1. package com.companyname.insurance;
  2. /**
  3. * Hello world!
  4. *
  5. */
  6. public class App
  7. {
  8. public static void main( String[] args )
  9. {
  10. System.out.println( "Hello World!" );
  11. }
  12. }

AppTest.java

Maven 会自动生成一个 java 文件 AppTest.java。

路径为: C:\MVN\consumerBanking\src\test\java\com\companyname\bank

  1. package com.companyname.insurance;
  2. import junit.framework.Test;
  3. import junit.framework.TestCase;
  4. import junit.framework.TestSuite;
  5. /**
  6. * Unit test for simple App.
  7. */
  8. public class AppTest
  9. extends TestCase
  10. {
  11. /**
  12. * Create the test case
  13. *
  14. * @param testName name of the test case
  15. */
  16. public AppTest( String testName )
  17. {
  18. super( testName );
  19. }
  20. /**
  21. * @return the suite of tests being tested
  22. */
  23. public static Test suite()
  24. {
  25. return new TestSuite( AppTest.class );
  26. }
  27. /**
  28. * Rigourous Test :-)
  29. */
  30. public void testApp()
  31. {
  32. assertTrue( true );
  33. }
  34. }

就这样。现在你可以看到 Maven 的强大之处。你可以用 maven 简单的命令创建任何类型的项目,并且可以启动您的开发。