全部产品
云市场

创建工程

更新时间:2020-03-18 15:56:51

SOFABoot 支持创建 Web 和 Core 两种类型的工程:

  • Web 工程:当使用 SOFABoot 开发一个 Web 程序时,相当于“基于 Spring Boot 的 Web 应用 + SOFA 中间件” 进行开发。
  • Core 工程:当使用 SOFABoot 开发一个 J2SE 程序(无 Web 页面访问),相当于“基于 Spring Boot 的非 Web 应用(无 servlet 依赖)+ SOFA 中间件” 进行开发。

本文将向您介绍如何在本地使用 Maven 工具创建 SOFABoot Web 工程 和 Core 工程。在开始创建前,请务必参考 前置条件,完成工程运行前的准备工作。

前置条件

为执行本文代码示例,您需要首先搭建 SOFABoot 的运行环境。具体步骤详见 搭建环境

操作步骤

  1. 以操作系统管理员身份打开命令行工具,定位到需要创建工程的目录,并运行以下命令:

    • 如果使用的是 Maven 默认安装目录下的 settings.xml,且已按照 搭建环境 中的要求,对原 settings.xml 进行了覆盖操作,则使用下述 Maven 命令进行创建。
      • Web 工程:
        1. mvn archetype:generate -DarchetypeGroupId=com.alipay.sofa -DarchetypeArtifactId=sofaboot-web-archetype -DarchetypeVersion=1.0-SNAPSHOT -DarchetypeCatalog=internal
      • Core 工程:
        1. mvn archetype:generate -DarchetypeGroupId=com.alipay.sofa -DarchetypeArtifactId=sofaboot-core-archetype -DarchetypeVersion=1.0-SNAPSHOT -DarchetypeCatalog=internal
    • 如果使用的是 Maven 自定义安装目录下的 settings.xml,且已按照 搭建环境 中的要求,对原 settings.xml 进行了覆盖操作,则使用下述 Maven 命令进行创建。
      • Web 工程:
        1. mvn -s "custom_settings_path" archetype:generate -DarchetypeGroupId=com.alipay.sofa -DarchetypeArtifactId=sofaboot-web-archetype -DarchetypeVersion=1.0-SNAPSHOT -DarchetypeCatalog=internal
      • Core 工程:
        1. mvn -s "custom_settings_path" archetype:generate -DarchetypeGroupId=com.alipay.sofa -DarchetypeArtifactId=sofaboot-core-archetype -DarchetypeVersion=1.0-SNAPSHOT -DarchetypeCatalog=internal

        注意:使用自定义路径下的 settings.xml 时,请勿直接复制 Maven 命令,请把 “custom_settings_path” 替换为真实的文件路径,例如:"C:\apache-maven-3.3.3\conf\settingsXXX.xml"

  2. 在执行过程中,会提示您输入以下信息,可根据实际情况进行配置:

    • groupId:是工程在 Maven 仓库中的唯一标识,一般为公司域名或组织域名的反写,如:com.yourCompanyName.sofa

      注意:请按照开发规范创建自己的 groupId,避免在扫描配置时出现问题。

    • artifactId:表示项目名称或应用名称,如:web-appcore-app
    • version:版本号。默认为 1.0-SNAPSHOT。SNAPSHOT 意为快照,说明该项目还在开发中,是不稳定的版本。此处可维持默认值。
    • package:应用包名。此处可不填。

      说明groupIdartifactIdversion 三个元素生成了一个 Maven 项目的基本坐标。

  3. 完成以上配置后,会向您再次确认信息。
    • 输入 Y,表示确认,继续安装;
    • 输入 N,表示取消,重新定义以上属性。
  4. 属性定义完成后,工程创建会继续进行。当看到以下信息时,表示工程创建完成。
    1. [INFO] ------------------------------------------------------------------------
    2. [INFO] BUILD SUCCESS
    3. [INFO] ------------------------------------------------------------------------
    4. [INFO] Total time: 28.298 s
    5. [INFO] Finished at: 2018-01-10T23:36:19+08:00
    6. [INFO] Final Memory: 15M/163M
    7. [INFO] ------------------------------------------------------------------------
  5. 请移步 版本说明,查看最新的 SOFABoot 版本,然后在步骤 1 中定位的目录中查看新建的工程文件夹(以 artifaceId 命名),然后在工程根目录下的主 pom.xml 中,修改 <parent>标签的版本号,示例如下:
    versionNo