Getting Started
本文概述了使用 webforJ 原型 创建新的 webforJ 应用程序的步骤。原型提供了预配置的项目结构和初始代码,以便您可以快速启动和运行项目。 要从原型创建新的 webforJ 应用程序,可以使用 startforJ 或 命令行。
在开始之前,请查看设置和使用 webforJ 的必要 前提 条件。
使用 startforJ
创建新的 webforJ 应用程序的最简单方法是 startforJ,它基于所选的 webforJ 原型生成一个最小的初始项目。此初始项目包含所有必需的依赖项、配置文件和预制布局,以便您可以立即开始构建。
使用 startforJ 自定义
使用 startforJ 创建应用程序时,可以通过提供以下信息来自定义它:
- 基本项目元数据(应用名称、组 ID、工件 ID)
- webforJ 版本和 Java 版本
- 主题颜色和图标
- 原型
- 风味
有两种风味可供选择,其中“仅 webforJ”是默认选项:
- 仅 webforJ:标准 webforJ 应用程序
- webforJ + Spring Boot:支持 Spring Boot 的 webforJ 应用程序
Spring Boot 风味仅在 webforJ 版本 25.02 及更高版本中提供。如果选择此选项,请确保选择兼容的版本。
webforJ 附带多个预定义原型,以帮助您快速启动。有关可用原型的完整列表,请参见 原型目录。
使用这些信息,startforJ 将根据您选择的原型和自定义选项创建一个基本项目。 您可以选择将项目下载为 ZIP 文件,或直接发布到 GitHub。
下载项目后,在 IDE 中打开项目文件夹并继续 运行应用程序。
使用命令行
如果您更喜欢使用命令行,可以直接使用 Maven 原型生成项目:
要创建和搭建新的hello-world
项目,请按照以下步骤操作:
- 导航到正确的目录: 打开终端并移动到您想要创建新项目的文件夹。
- 运行archetype:generate命令: 使用下面的Maven命令,并根据您的项目需要自定义groupId、artifactId和version。
- 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用于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 来查看应用程序。
有关未授权项目中存在的水印的信息,请参见 许可证和水印。