Maven 约定

本文档定义了 Maven 建议项目采用的一些约定。如果您打算公开分发您的项目，这一点尤其重要。

工件命名

本节概述了 Maven 项目对象模型 (POM) 中使用的命名约定。本文档尝试统一项目命名它们发布的工件以供 Java 开发人员社区普遍使用的多种不同方式（无论它们是否使用 Maven）。

创建项目时您要做的第一件事是选择组 ID 和工件 ID。如果您正在构建一个项目以成为已经使用 Maven 的更大产品的一部分，您应该尝试遵循其他项目已经建立的任何模式以保持一致性。

这些标识符应仅由小写字母、数字和连字符组成。

通常，您应该选择一个描述整个产品的组 ID，以及作为您分发的每个项目的文件名基础的工件 ID。工件 ID 可能与组 ID 重叠，也可能不重叠。

例如：

maven : maven-core
maven : wagon-api

如前所述，工件 ID 应该是项目文件名的基础，因为默认情况下 Maven 将使用它和版本来组合文件名。强烈建议将版本作为文件名的一部分，以确保可以一目了然地确定版本，而无需检查可能不存在的清单，或将文件大小与官方版本进行比较。

在通过 Maven 存储库分发时，特别鼓励遵循这些准则，以确保它可以轻松地与其他项目一起使用，并减少冲突和混乱的风险。

目录结构

Maven 鼓励项目使用通用目录结构。有关这方面的更多信息，请参阅我们的标准目录结构简介。