Getting Started
本文概述了使用 webforJ archetypes 创建新的 webforJ 应用程序的步骤。archetypes 提供预配置的项目结构和起始代码，使您能够快速启动并运行项目。 要从 archetype 创建新的 webforJ 应用程序，您可以使用 startforJ 或 命令行。
在开始之前，请查看设置和使用 webforJ 的必要 前提条件。
使用 startforJ
创建新的 webforJ 应用程序最简单的方法是 startforJ，它基于所选的 webforJ archetype 生成一个最小的起始项目。这个起始项目包含所有必需的依赖项、配置文件和预制的布局，因此您可以立即开始构建。
使用 startforJ 自定义
当您使用 startforJ 创建应用程序时，可以通过提供以下信息来进行自定义：
- 基本项目元数据（应用名称、组 ID、构件 ID）
- webforJ 版本和 Java 版本
- 主题颜色和图标
- archetype
- 风味
有两种风味选项可供选择，默认是“webforJ Only”：
- webforJ Only：标准 webforJ 应用程序
- webforJ + Spring Boot：具有 Spring Boot 支持的 webforJ 应用程序
Spring Boot 风味仅在 webforJ 版本 25.02 及更高版本中可用。如果选择此选项，请确保选择兼容的版本。
webforJ 附带几个预定义的 archetypes，帮助您快速入门。有关可用 archetypes 的完整列表，请参见 archetypes 目录。
使用这些信息，startforJ 将根据您选择的 archetype 和自定义内容创建一个基本项目。 您可以选择将项目下载为 ZIP 文件或直接发布到 GitHub。
下载项目后，打开项目文件夹，在您的 IDE 中继续 运行应用程序。
使用命令行
如果您更喜欢使用命令行，您可以使用 Maven archetype 直接生成项目：
要创建和搭建一个新的 hello-world 项目， 请按照以下步骤进行：
- 导航到正确的目录: 打开终端并移动到您想创建新项目的文件夹。
- 运行 archetype:generate 命令: 使用下面的Maven命令，并根据您的项目需求自定义groupId、artifactId和版本。
- Bash/Zsh
- PowerShell
- Command Prompt
mvn -B archetype:generate \
-DarchetypeGroupId=com.webforj \
-DarchetypeArtifactId=webforj-archetype-hello-world \
-DarchetypeVersion=LATEST \
-DgroupId=org.example \
-DartifactId=my-app \
-Dversion=1.0-SNAPSHOT \
-Dflavor=webforj \
-DappName=MyApp
mvn -B archetype:generate `
-DarchetypeGroupId="com.webforj" `
-DarchetypeArtifactId="webforj-archetype-hello-world" `
-DarchetypeVersion="LATEST" `
-DgroupId="org.example" `
-DartifactId="my-app" `
-Dversion="1.0-SNAPSHOT" `
-Dflavor="webforj" `
-DappName="MyApp"
mvn -B archetype:generate ^
-DarchetypeGroupId="com.webforj" ^
-DarchetypeArtifactId="webforj-archetype-hello-world" ^
-DarchetypeVersion="LATEST" ^
-DgroupId="org.example" ^
-DartifactId="my-app" ^
-Dversion="1.0-SNAPSHOT" ^
-Dflavor="webforj" ^
-DappName="MyApp"
| 参数 | 解释 |
|---|---|
archetypeGroupId | 该原型的组ID为com.webforj。 |
archetypeArtifactId | 指定要使用的原型名称。 |
archetypeVersion | 指定要使用的原型版本。这确保生成的项目与特定的原型版本兼容。使用 LATEST 选择最新可用版本。 |
groupId | 表示生成项目的命名空间。通常结构类似于Java包，例如org.example，用于唯一识别您的组织或项目域。 |
artifactId | 指定生成项目的名称。它将是生成的工件和项目文件夹的名称。 |
version | 定义生成项目的版本。常见约定为 MAJOR.MINOR-SNAPSHOT，例如 1.0-SNAPSHOT，其中 SNAPSHOT 表示项目仍在开发中。 |
flavor | 选择项目风味:
|
appName | 项目 POM 文件中可选的参数。根据使用的 webforJ 原型，它可以作为应用程序的默认标题。 |
运行命令后，Maven将生成运行项目所需的项目文件。
运行应用程序
在运行应用程序之前，如果尚未安装 前提条件，请先进行安装。 然后，导航到项目的根目录并运行以下命令：
# 对于标准的 webforj 应用程序
mvn jetty:run
# 对于 webforj + Spring Boot
mvn spring-boot:run
服务器运行后，打开浏览器并访问 http://localhost:8080 来查看应用程序。