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

Question

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

最好的地方放在哪里？

• 其他代码的子包中。我不喜欢这样，因为这意味着演示将包含在库jar文件中。
• 在一个新的maven神器里。这是可行的，但我希望将演示程序更紧密地连接到库源。
• 作为一个亚神器。还没试过呢。对于应该简单的事情，一切似乎有点复杂。

这样做有什么共同的模式吗？

Answer 1

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

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

您的库和演示程序可能应该共享一个父模块(类型为"pom"，而不是像其他模块那样的"jar“)，为您提供一个多模块工程。然后，您可以通过从这个父模块启动maven来构建这两个模块。

如果你想一起发布你的库和演示(你可以，但你不需要)，你也可以从父母那里做。

换句话说，并不是因为它们是单独的模块，封装在不同的工件中，它们就不能再紧密地连接起来了。一个多模块项目的不同模块仍然构成一个完整的项目。

Answer 2

您还没有编写它是什么样的实用程序库，但是如果它类似于apache，那么大多数演示都可以编写为JUnit测试，这些测试都放在相同的工件中。好的设计的JUnit测试了您的代码，并提供了如何使用实用程序的示例。

Answer 3

我更喜欢一个新的maven人工制品，它可以使您自己的工件变得干净。