java - 在哪里放置 Maven 构建库的演示/示例代码？

Question

我使用 maven 开发了一个小的 java 实用程序库。现在我想添加一些演示/示例代码来展示如何使用这个库。

放在哪里最好？

在与其他代码的子包中。我不喜欢这样，因为这意味着演示将包含在库 jar 文件中。

在一个新的 Maven Artifact 中。那行得通，但我希望演示更接近库源。

作为子 Artifact 。这个还没试过。对于应该简单的事情，似乎让一切都变得有点复杂。

有没有常见的模式来做到这一点？

Answer 1

如果是一些自己运行的示例代码片段并只是演示如何使用该库，那么将它们编写为单元测试，在同一个模块中。

如果它更像是一个单独的演示应用程序(用户甚至可能与之交互)，那么创建一个单独的 Artifact 。这是做这件事的标准方法。如果你真的想要，你可以把它放在同一个模块中，但放在不同的源目录中，但这只会让你自己更难。

你的库和你的演示应该共享一个父模块(类型为“pom”，而不是像其他的“jar”)，给你一个multi-module project .然后你可以通过从这个父模块启动 maven 来构建两者。

如果您想一起发布您的库和演示(您可以，但您不必这样做)，您也可以从父级执行此操作。

换句话说，并不是因为它们是单独的模块，打包在不同的 Artifact 中，它们就不能再紧密相连了。一个多模块项目的不同模块仍然构成一个完整的项目。